Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.

[required] A custom domain endpoint to associate. Specify a root domain (for example, example.com), a subdomain (for example, login.example.com or admin.login.example.com), or a wildcard (for example, ⁠*.example.com⁠).

Set to true to associate the subdomain www.DomainName with the App Runner service in addition to the base domain.

Default: true

[required] A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.

Prior to the release of Auto scale configuration enhancements, the name DefaultConfiguration was reserved.

This restriction is no longer in place. You can now manage DefaultConfiguration the same way you manage your custom auto scaling configurations. This means you can do the following with the DefaultConfiguration that App Runner provides:

• Create new revisions of the DefaultConfiguration.

• Delete the revisions of the DefaultConfiguration.

• Delete the auto scaling configuration for which the App Runner DefaultConfiguration was created.

• If you delete the auto scaling configuration you can create another custom auto scaling configuration with the same DefaultConfiguration name. The original DefaultConfiguration resource provided by App Runner remains in your account unless you make changes to it.

The maximum number of concurrent requests that you want an instance to process. If the number of concurrent requests exceeds this limit, App Runner scales up your service.

Default: 100

The minimum number of instances that App Runner provisions for your service. The service always has at least MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.

App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.

Default: 1

The maximum number of instances that your service scales up to. At most MaxSize instances actively serve traffic for your service.

Default: 25

A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.

[required] A name for the new connection. It must be unique across all App Runner connections for the Amazon Web Services account in the Amazon Web Services Region.

[required] The source repository provider.

A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.

[required] A name for the observability configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.

The name DefaultConfiguration is reserved. You can't use it to create a new observability configuration, and you can't create a revision of it.

When you want to use your own observability configuration for your App Runner service, create a configuration with a different name, and then provide it when you create or update your service.

The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.

A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.

[required] A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.

[required] The source to deploy to the App Runner service. It can be a code or an image repository.

The runtime configuration of instances (scaling units) of your service.

An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.

An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default, App Runner uses an Amazon Web Services managed key.

The settings for the health check that App Runner performs to monitor the health of the App Runner service.

The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration.

Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3

Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability

Configuration settings related to network traffic of the web application that the App Runner service runs.

The observability configuration of your service.

[required] A name for the VPC connector.

[required] A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

App Runner currently only provides support for IPv4.

A list of IDs of security groups that App Runner should use for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.

[required] The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.

[required] A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your Amazon Web Services account in the Amazon Web Services Region.

[required] Specifications for the customer’s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.

An optional list of metadata items that you can associate with the VPC Ingress Connection resource. A tag is a key-value pair.

[required] The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to delete.

The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is deleted.

Set to true to delete all of the revisions associated with the AutoScalingConfigurationArn parameter value.

When DeleteAllRevisions is set to true, the only valid value for the Amazon Resource Name (ARN) is a partial ARN ending with: .../name.

[required] The Amazon Resource Name (ARN) of the App Runner connection that you want to delete.

[required] The Amazon Resource Name (ARN) of the App Runner observability configuration that you want to delete.

The ARN can be a full observability configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is deleted.

[required] The Amazon Resource Name (ARN) of the App Runner service that you want to delete.

[required] The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to delete.

The ARN must be a full VPC connector ARN.

[required] The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want to delete.

[required] The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want a description for.

The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is described.

[required] The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

The maximum number of results that each response (result page) can include. It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

[required] The Amazon Resource Name (ARN) of the App Runner observability configuration that you want a description for.

The ARN can be a full observability configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is described.

[required] The Amazon Resource Name (ARN) of the App Runner service that you want a description for.

[required] The Amazon Resource Name (ARN) of the App Runner VPC connector that you want a description for.

The ARN must be a full VPC connector ARN.

[required] The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want a description for.

[required] The Amazon Resource Name (ARN) of the App Runner service that you want to disassociate a custom domain name from.

[required] The domain name that you want to disassociate from the App Runner service.

The name of the App Runner auto scaling configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner returns revisions of all active configurations.

Set to true to list only the latest revision for each requested configuration name.

Set to false to list all revisions for each requested configuration name.

Default: true

The maximum number of results to include in each response (result page). It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

If specified, only this connection is returned. If not specified, the result isn't filtered by name.

The maximum number of results to include in each response (result page). Used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

The name of the App Runner observability configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner returns revisions of all active configurations.

Set to true to list only the latest revision for each requested configuration name.

Set to false to list all revisions for each requested configuration name.

Default: true

The maximum number of results to include in each response (result page). It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

[required] The Amazon Resource Name (ARN) of the App Runner service that you want a list of operations for.

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

The maximum number of results to include in each response (result page). It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

The maximum number of results to include in each response (result page). It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

[required] The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to list the services for.

The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is used.

The maximum number of results to include in each response (result page). It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

[required] The Amazon Resource Name (ARN) of the resource that a tag list is requested for.

It must be the ARN of an App Runner resource.

The maximum number of results to include in each response (result page). It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

The VPC Ingress Connections to be listed based on either the Service Arn or Vpc Endpoint Id, or both.

The maximum number of results to include in each response (result page). It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

[required] The Amazon Resource Name (ARN) of the App Runner service that you want to pause.

[required] The Amazon Resource Name (ARN) of the App Runner service that you want to resume.

[required] The Amazon Resource Name (ARN) of the App Runner service that you want to manually deploy to.

[required] The Amazon Resource Name (ARN) of the resource that you want to update tags for.

It must be the ARN of an App Runner resource.

[required] A list of tag key-value pairs to add or update. If a key is new to the resource, the tag is added with the provided value. If a key is already associated with the resource, the value of the tag is updated.

[required] The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

It must be the ARN of an App Runner resource.

[required] A list of tag keys that you want to remove.

[required] The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to set as the default.

The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is set as the default.

[required] The Amazon Resource Name (ARN) of the App Runner service that you want to update.

The source configuration to apply to the App Runner service.

You can change the configuration of the code or image repository that the service uses. However, you can't switch from code to image or the other way around. This means that you must provide the same structure member of SourceConfiguration that you originally included when you created the service. Specifically, you can include either CodeRepository or ImageRepository. To update the source configuration, set the values to members of the structure that you include.

The runtime configuration to apply to instances (scaling units) of your service.

The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with the App Runner service.

The settings for the health check that App Runner performs to monitor the health of the App Runner service.

Configuration settings related to network traffic of the web application that the App Runner service runs.

The observability configuration of your service.

[required] The Amazon Resource Name (Arn) for the App Runner VPC Ingress Connection resource that you want to update.

[required] Specifications for the customer’s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to update the VPC Ingress Connection resource.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The Batch job ID of the job to cancel.

[required] A message to attach to the job that explains the reason for canceling it. This message is returned by future describe_jobs operations on the job. It is also recorded in the Batch activity logs.

This parameter has as limit of 1024 characters.

[required] The name for your compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

[required] The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the Batch User Guide.

The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out.

Compute environments in a DISABLED state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Batch User Guide.

When an instance is idle, the instance scales down to the minvCpus value. However, the instance size doesn't change. For example, consider a c5.8xlarge instance with a minvCpus value of 4 and a desiredvCpus value of 36. This instance doesn't scale down to a c5.large instance.

The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved.

This parameter is only supported when the type parameter is set to UNMANAGED.

Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the Batch User Guide.

The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

If your account already created the Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the Batch service-linked role in your account.

If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of ⁠/foo/⁠, specify ⁠/foo/bar⁠ as the role name. For more information, see Friendly names and paths in the IAM User Guide.

Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

These tags can be updated or removed using the tag_resource and untag_resource API operations. These tags don't propagate to the underlying compute resources.

The details for the Amazon EKS cluster that supports the compute environment.

Reserved.

[required] The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

The Amazon Resource Name (ARN) of the fair-share scheduling policy. Job queues that don't have a fair-share scheduling policy are scheduled in a first-in, first-out (FIFO) model. After a job queue has a fair-share scheduling policy, it can be replaced but can't be removed.

The format is aws:Partition:batch:Region:Account:scheduling-policy/Name .

An example is aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

A job queue without a fair-share scheduling policy is scheduled as a FIFO job queue and can't have a fair-share scheduling policy added. Jobs queues with a fair-share scheduling policy can have a maximum of 500 active share identifiers. When the limit has been reached, submissions of any jobs that add a new share identifier fail.

[required] The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

[required] The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources in Batch User Guide.

The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed. (Note: The minimum value for maxTimeSeconds is 600 (10 minutes) and its maximum value is 86,400 (24 hours).)

[required] The name of the fair-share scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

The fair-share scheduling policy details.

The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

These tags can be updated or removed using the tag_resource and untag_resource API operations.

[required] The name or Amazon Resource Name (ARN) of the compute environment to delete.

[required] The short name or full Amazon Resource Name (ARN) of the queue to delete.

[required] The Amazon Resource Name (ARN) of the scheduling policy to delete.

[required] The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister.

A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

The maximum number of cluster results returned by describe_compute_environments in paginated output. When this parameter is used, describe_compute_environments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another describe_compute_environments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then describe_compute_environments returns up to 100 results and a nextToken value if applicable.

The nextToken value returned from a previous paginated describe_compute_environments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format ⁠arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}⁠ or a short version using the form ⁠${JobDefinitionName}:${Revision}⁠. This parameter can't be used with other parameters.

The maximum number of results returned by describe_job_definitions in paginated output. When this parameter is used, describe_job_definitions only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another describe_job_definitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then describe_job_definitions returns up to 100 results and a nextToken value if applicable.

The name of the job definition to describe.

The status used to filter job definitions.

The nextToken value returned from a previous paginated describe_job_definitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

The maximum number of results returned by describe_job_queues in paginated output. When this parameter is used, describe_job_queues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another describe_job_queues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then describe_job_queues returns up to 100 results and a nextToken value if applicable.

The nextToken value returned from a previous paginated describe_job_queues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

[required] A list of up to 100 job IDs.

[required] A list of up to 100 scheduling policy Amazon Resource Name (ARN) entries.

[required] The job queue’s name or full queue Amazon Resource Name (ARN).

The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

The job status used to filter jobs in the specified queue. If the filters parameter is specified, the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a status, only RUNNING jobs are returned.

The maximum number of results returned by list_jobs in a paginated output. When this parameter is used, list_jobs returns up to maxResults results in a single page and a nextToken response element, if applicable. The remaining results of the initial request can be seen by sending another list_jobs request with the returned nextToken value.

The following outlines key parameters and limitations:

• The minimum value is 1.

• When --job-status is used, Batch returns up to 1000 values.

• When --filters is used, Batch returns up to 100 values.

• If neither parameter is used, then list_jobs returns up to 1000 results (jobs that are in the RUNNING status) and a nextToken value, if applicable.

The nextToken value returned from a previous paginated list_jobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field, with the most recent jobs being first.

JOB_NAME

The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (), the filter matches any job name that begins with the string before the ''. This corresponds to the jobName value. For example, test1 matches both Test1 and test1, and ⁠test1*⁠ matches both test1 and Test10. When the JOB_NAME filter is used, the results are grouped by the job name and version.

JOB_DEFINITION

The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the jobDefinition value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (), the filter matches any job definition name that begins with the string before the ''. For example, jd1 matches only jd1, and ⁠jd1*⁠ matches both jd1 and jd1A. The version of the job definition that's used doesn't affect the sort order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form ⁠arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}⁠), the results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the ARN is used.

BEFORE_CREATED_AT

The value for the filter is the time that's before the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

AFTER_CREATED_AT

The value for the filter is the time that's after the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

The maximum number of results that's returned by list_scheduling_policies in paginated output. When this parameter is used, list_scheduling_policies only returns maxResults results in a single page and a nextToken response element. You can see the remaining results of the initial request by sending another list_scheduling_policies request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, list_scheduling_policies returns up to 100 results and a nextToken value if applicable.

The nextToken value that's returned from a previous paginated list_scheduling_policies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

[required] The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

[required] The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

[required] The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.

• If the value is container, then one of the following is required: containerProperties, ecsProperties, or eksProperties.

• If the value is multinode, then nodeProperties is required.

If the job is run on Fargate resources, then multinode isn't supported.

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a submit_job request override any corresponding parameter defaults from the job definition.

The scheduling priority for jobs that are submitted with this job definition. This only affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

The minimum supported value is 0 and the maximum supported value is 9999.

An object with properties specific to Amazon ECS-based single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties. This must not be specified for Amazon EKS-based job definitions.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

An object with properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the Batch User Guide.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

If the job runs on Amazon EKS resources, then you must not specify nodeProperties.

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a submit_job operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

If the job runs on Amazon EKS resources, then you must not specify propagateTags.

The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a submit_job operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Batch User Guide.

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.

An object with properties that are specific to Amazon EKS-based jobs. This must not be specified for Amazon ECS based job definitions.

An object with properties that are specific to Amazon ECS-based jobs. This must not be specified for Amazon EKS-based job definitions.

[required] The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

[required] The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

The share identifier for the job. Don't specify this parameter if the job queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.

This string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).

The scheduling priority for the job. This only affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling priority in the job definition and works only within a single share identifier.

The minimum supported value is 0 and the maximum supported value is 9999.

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the Batch User Guide.

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

[required] The job definition used by this job. This value can be one of definition-name, definition-name:revision, or the Amazon Resource Name (ARN) for the job definition, with or without the revision (arn:aws:batch:region:account:job-definition/definition-name:revision , or arn:aws:batch:region:account:job-definition/definition-name ).

If the revision is not specified, then the latest active revision is used.

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a submit_job request override any corresponding parameter defaults from the job definition.

An object with properties that override the defaults for the job definition that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container, which is specified in the job definition or the Docker image, with a command override. You can also override existing environment variables on a container or add new environment variables to it with an environment override.

A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

This parameter isn't applicable to jobs that are running on Fargate resources; use containerOverrides instead.

The retry strategy to use for failed jobs from this submit_job operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state. When specified, this overrides the tag propagation setting in the job definition.

The timeout configuration for this submit_job operation. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon EKS resources.

An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon ECS resources.

[required] The Amazon Resource Name (ARN) of the resource that tags are added to. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

[required] The tags that you apply to the resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

[required] The Batch job ID of the job to terminate.

[required] A message to attach to the job that explains the reason for canceling it. This message is returned by future describe_jobs operations on the job. It is also recorded in the Batch activity logs.

This parameter has as limit of 1024 characters.

[required] The Amazon Resource Name (ARN) of the resource from which to delete tags. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

[required] The keys of the tags to be removed.

[required] The name or full Amazon Resource Name (ARN) of the compute environment to update.

The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out.

Compute environments in a DISABLED state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Batch User Guide.

When an instance is idle, the instance scales down to the minvCpus value. However, the instance size doesn't change. For example, consider a c5.8xlarge instance with a minvCpus value of 4 and a desiredvCpus value of 36. This instance doesn't scale down to a c5.large instance.

The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this parameter for a managed compute environment. This parameter is only used for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved.

Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the Batch User Guide.

The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Batch User Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (recommended) or prefix the role name with the path.

Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

Specifies the updated infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

Reserved.

[required] The name or the Amazon Resource Name (ARN) of the job queue.

Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

Amazon Resource Name (ARN) of the fair-share scheduling policy. Once a job queue is created, the fair-share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed. (Note: The minimum value for maxTimeSeconds is 600 (10 minutes) and its maximum value is 86,400 (24 hours).)

[required] The Amazon Resource Name (ARN) of the scheduling policy to update.

The fair-share policy scheduling details.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The ARN of the Amazon Braket job to cancel.

[required] The client token associated with the request.

[required] The ARN of the task to cancel.

[required] Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.

The list of Amazon Braket resources associated with the hybrid job.

Information about the output locations for job checkpoint data.

[required] A unique token that guarantees that the call to this API is idempotent.

[required] The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.

Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.

A list of parameters that specify the name and type of input data and where it is located.

[required] Configuration of the resource instances to use while running the hybrid job on Amazon Braket.

[required] The name of the Amazon Braket job.

[required] The path to the S3 location where you want to store job artifacts and the encryption key used to store them.

[required] The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the users' s3 buckets.

The user-defined criteria that specifies when a job stops running.

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

[required] The action associated with the task.

The list of Amazon Braket resources associated with the quantum task.

[required] The client token associated with the request.

[required] The ARN of the device to run the task on.

The parameters for the device to run the task on.

The token for an Amazon Braket job that associates it with the quantum task.

[required] The S3 bucket to store task result files in.

[required] The key prefix for the location in the S3 bucket to store task results in.

[required] The number of shots to use for the task.

Tags to be added to the quantum task you're creating.

[required] The ARN of the device to retrieve.

A list of attributes to return information for.

[required] The ARN of the job to retrieve.

A list of attributes to return information for.

[required] The ARN of the task to retrieve.

[required] Specify the resourceArn for the resource whose tags to display.

[required] The filter values to use to search for a device.

The maximum number of results to return in the response.

A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.

[required] The filter values to use when searching for a job.

The maximum number of results to return in the response.

A token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.

[required] Array of SearchQuantumTasksFilter objects.

Maximum number of results to return in the response.

A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.

[required] Specify the resourceArn of the resource to which a tag will be added.

[required] Specify the tags to add to the resource.

[required] Specify the resourceArn for the resource from which to remove the tags.

[required] Specify the keys for the tags to remove from the resource.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The target resource type of the recommendation preference to delete.

The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

An object that describes the scope of the recommendation preference to delete.

You can delete recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

[required] The name of the recommendation preference to delete.

The identification numbers of the export jobs to return.

An export job ID is returned when you create an export using the export_auto_scaling_group_recommendations or export_ec2_instance_recommendations actions.

All export jobs created in the last seven days are returned if this parameter is omitted.

An array of objects to specify a filter that returns a more specific list of export jobs.

The token to advance to the next page of export jobs.

The maximum number of export jobs to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

The IDs of the Amazon Web Services accounts for which to export Auto Scaling group recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.

This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

You can specify multiple account IDs per request.

An array of objects to specify a filter that exports a more specific set of Auto Scaling group recommendations.

The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

[required] An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.

You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permissions policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.

The format of the export file.

The only export file format currently supported is Csv.

Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.

The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

An object to specify the preferences for the Auto Scaling group recommendations to export.

The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.

This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

You can specify multiple account IDs per request.

An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.

The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

[required]

The format of the export file.

The only export file format currently supported is Csv.

Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.

The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

The IDs of the Amazon Web Services accounts for which to export instance recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.

This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

You can specify multiple account IDs per request.

An array of objects to specify a filter that exports a more specific set of instance recommendations.

The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

[required] An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.

You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permissions policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.

The format of the export file.

The only export file format currently supported is Csv.

Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.

The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

An object to specify the preferences for the Amazon EC2 instance recommendations to export.

The Amazon Web Services account IDs for the export Amazon ECS service recommendations.

If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.

This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.

If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.

You can specify multiple account IDs per request.

An array of objects to specify a filter that exports a more specific set of Amazon ECS service recommendations.

The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

[required]

The format of the export file.

The CSV file is the only export file format currently supported.

If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the organization.

The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.

If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.

The Amazon Web Services account IDs for the export idle resource recommendations.

If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.

This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.

If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.

You can specify multiple account IDs per request.

An array of objects to specify a filter that exports a more specific set of idle resource recommendations.

The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

[required]

The format of the export file. The CSV file is the only export file format currently supported.

If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the organization.

The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.

If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.

The IDs of the Amazon Web Services accounts for which to export Lambda function recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.

This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

You can specify multiple account IDs per request.

An array of objects to specify a filter that exports a more specific set of Lambda function recommendations.

The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

[required]

The format of the export file.

The only export file format currently supported is Csv.

Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.

The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

The IDs of the Amazon Web Services accounts for which to export license recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.

This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.

If this parameter is omitted, recommendations for member accounts aren't included in the export.

You can specify multiple account IDs per request.

An array of objects to specify a filter that exports a more specific set of license recommendations.

The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

[required]

The format of the export file.

A CSV file is the only export format currently supported.

Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.

The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file .

This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

The Amazon Web Services account IDs for the export Amazon RDS recommendations.

If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.

This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.

If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.

You can specify multiple account IDs per request.

An array of objects to specify a filter that exports a more specific set of Amazon RDS recommendations.

The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

[required]

The format of the export file.

The CSV file is the only export file format currently supported.

If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the organization.

The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.

If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.

The ID of the Amazon Web Services account for which to return Auto Scaling group recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return Auto Scaling group recommendations.

Only one account ID can be specified per request.

The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.

The token to advance to the next page of Auto Scaling group recommendations.

The maximum number of Auto Scaling group recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

An array of objects to specify a filter that returns a more specific list of Auto Scaling group recommendations.

An object to specify the preferences for the Auto Scaling group recommendations to return in the response.

The Amazon Resource Name (ARN) of the volumes for which to return recommendations.

The token to advance to the next page of volume recommendations.

The maximum number of volume recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

An array of objects to specify a filter that returns a more specific list of volume recommendations.

The ID of the Amazon Web Services account for which to return volume recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return volume recommendations.

Only one account ID can be specified per request.

The Amazon Resource Name (ARN) of the instances for which to return recommendations.

The token to advance to the next page of instance recommendations.

The maximum number of instance recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

An array of objects to specify a filter that returns a more specific list of instance recommendations.

The ID of the Amazon Web Services account for which to return instance recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.

Only one account ID can be specified per request.

An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.

[required] The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.

[required] The statistic of the projected metrics.

[required] The granularity, in seconds, of the projected metrics data points.

[required] The timestamp of the first projected metrics data point to return.

[required] The timestamp of the last projected metrics data point to return.

An object to specify the preferences for the Amazon EC2 recommendation projected metrics to return in the response.

[required] The ARN that identifies the Amazon ECS service.

The following is the format of the ARN:

arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name

[required] The statistic of the projected metrics.

[required] The granularity, in seconds, of the projected metrics data points.

[required] The timestamp of the first projected metrics data point to return.

[required] The timestamp of the last projected metrics data point to return.

The ARN that identifies the Amazon ECS service.

The following is the format of the ARN:

arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name

The token to advance to the next page of Amazon ECS service recommendations.

The maximum number of Amazon ECS service recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

An array of objects to specify a filter that returns a more specific list of Amazon ECS service recommendations.

Return the Amazon ECS service recommendations to the specified Amazon Web Services account IDs.

If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon ECS service recommendations to specific member accounts.

You can only specify one account ID per request.

[required] The Amazon Resource Name (ARN) of the resource for which to confirm effective recommendation preferences. Only EC2 instance and Auto Scaling group ARNs are currently supported.

An array of objects to specify a filter that returns a more specific list of account enrollment statuses.

The token to advance to the next page of account enrollment statuses.

The maximum number of account enrollment statuses to return with a single request. You can specify up to 100 statuses to return with each request.

To retrieve the remaining results, make another request with the returned nextToken value.

The ARN that identifies the idle resource.

The token to advance to the next page of idle resource recommendations.

The maximum number of idle resource recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

An array of objects to specify a filter that returns a more specific list of idle resource recommendations.

Return the idle resource recommendations to the specified Amazon Web Services account IDs.

If your account is the management account or the delegated administrator of an organization, use this parameter to return the idle resource recommendations to specific member accounts.

You can only specify one account ID per request.

The order to sort the idle resource recommendations.

The Amazon Resource Name (ARN) of the functions for which to return recommendations.

You can specify a qualified or unqualified ARN. If you specify an unqualified ARN without a function version suffix, Compute Optimizer will return recommendations for the latest (⁠$LATEST⁠) version of the function. If you specify a qualified ARN with a version suffix, Compute Optimizer will return recommendations for the specified function version. For more information about using function versions, see Using versions in the Lambda Developer Guide.

The ID of the Amazon Web Services account for which to return function recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return function recommendations.

Only one account ID can be specified per request.

An array of objects to specify a filter that returns a more specific list of function recommendations.

The token to advance to the next page of function recommendations.

The maximum number of function recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

The ARN that identifies the Amazon EC2 instance.

The following is the format of the ARN:

arn:aws:ec2:region:aws_account_id:instance/instance-id

The token to advance to the next page of license recommendations.

The maximum number of license recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

An array of objects to specify a filter that returns a more specific list of license recommendations.

The ID of the Amazon Web Services account for which to return license recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return license recommendations.

Only one account ID can be specified per request.

[required] The ARN that identifies the Amazon RDS.

The following is the format of the ARN:

arn:aws:rds:{region}:{accountId}:db:{resourceName}

[required] The statistic of the projected metrics.

[required] The granularity, in seconds, of the projected metrics data points.

[required] The timestamp of the first projected metrics data point to return.

[required] The timestamp of the last projected metrics data point to return.

The ARN that identifies the Amazon RDS.

The following is the format of the ARN:

arn:aws:rds:{region}:{accountId}:db:{resourceName}

The following is the format of a DB Cluster ARN:

arn:aws:rds:{region}:{accountId}:cluster:{resourceName}

The token to advance to the next page of Amazon RDS recommendations.

The maximum number of Amazon RDS recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

An array of objects to specify a filter that returns a more specific list of Amazon RDS recommendations.

Return the Amazon RDS recommendations to the specified Amazon Web Services account IDs.

If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon RDS recommendations to specific member accounts.

You can only specify one account ID per request.

[required] The target resource type of the recommendation preference for which to return preferences.

The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

An object that describes the scope of the recommendation preference to return.

You can return recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

The token to advance to the next page of recommendation preferences.

The maximum number of recommendation preferences to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

The ID of the Amazon Web Services account for which to return recommendation summaries.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return recommendation summaries.

Only one account ID can be specified per request.

The token to advance to the next page of recommendation summaries.

The maximum number of recommendation summaries to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

[required] The target resource type of the recommendation preference to create.

The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

An object that describes the scope of the recommendation preference to create.

You can create recommendation preferences at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

You cannot create recommendation preferences for Auto Scaling groups at the organization and account levels. You can create recommendation preferences for Auto Scaling groups only at the resource level by specifying a scope name of ResourceArn and a scope value of the Auto Scaling group Amazon Resource Name (ARN). This will configure the preference for all instances that are part of the specified Auto Scaling group. You also cannot create recommendation preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for standalone instances.

The status of the enhanced infrastructure metrics recommendation preference to create or update.

Specify the Active status to activate the preference, or specify Inactive to deactivate the preference.

For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

The status of the inferred workload types recommendation preference to create or update.

The inferred workload type feature is active by default. To deactivate it, create a recommendation preference.

Specify the Inactive status to deactivate the feature, or specify Active to activate it.

For more information, see Inferred workload types in the Compute Optimizer User Guide.

The provider of the external metrics recommendation preference to create or update.

Specify a valid provider in the source field to activate the preference. To delete this preference, see the delete_recommendation_preferences action.

This preference can only be set for the Ec2Instance resource type.

For more information, see External metrics ingestion in the Compute Optimizer User Guide.

The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. When this preference isn't specified, we use the default value DAYS_14.

You can only set this preference for the Amazon EC2 instance and Auto Scaling group resource types.

• Amazon EC2 instance lookback preferences can be set at the organization, account, and resource levels.

• Auto Scaling group lookback preferences can only be set at the resource level.

The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. When this preference isn't specified, we use the following default values.

CPU utilization:

• P99_5 for threshold

• PERCENT_20 for headroom

Memory utilization:

• PERCENT_20 for headroom

• You can only set CPU and memory utilization preferences for the Amazon EC2 instance resource type.

• The threshold setting isn’t available for memory utilization.

The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an includeList or excludeList. If the preference is an empty set of resource type values, an error occurs.

You can only set this preference for the Amazon EC2 instance and Auto Scaling group resource types.

The status of the savings estimation mode preference to create or update.

Specify the AfterDiscounts status to activate the preference, or specify BeforeDiscounts to deactivate the preference.

Only the account manager or delegated administrator of your organization can activate this preference.

For more information, see Savings estimation mode in the Compute Optimizer User Guide.

[required] The new enrollment status of the account.

The following status options are available:

• Active - Opts in your account to the Compute Optimizer service. Compute Optimizer begins analyzing the configuration and utilization metrics of your Amazon Web Services resources after you opt in. For more information, see Metrics analyzed by Compute Optimizer in the Compute Optimizer User Guide.

• Inactive - Opts out your account from the Compute Optimizer service. Your account's recommendations and related metrics data will be deleted from Compute Optimizer after you opt out.

The Pending and Failed options cannot be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account.

Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The Elastic IP address you are accepting for transfer.

tag:\<key\> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

[required] The ID of the Capacity Reservation for which to accept the request.

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

[required] The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.

The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.

The ID of the transit gateway multicast domain.

The ID of the transit gateway attachment.

The IDs of the subnets to associate with the transit gateway multicast domain.

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

[required] The ID of the transit gateway attachment.

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

[required] The ID of the attachment.

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

[required] The ID of the VPC endpoint service.

[required] The IDs of the interface VPC endpoints.

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

[required] The ID of the VPC peering connection. You must specify this parameter in the request.

[required] The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.

The public 2-byte or 4-byte ASN that you want to advertise.

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

• us-east-1-dfw-2

• us-west-2-lax-1

• us-west-2-phx-2

You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

The network (vpc).

The Elastic IP address to recover or an IPv4 address from an address pool.

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

The tags to assign to the Elastic IP address.