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 name of the environment to create.

This name is visible to other IAM users in the same Amazon Web Services account.

The description of the environment to create.

A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no more than one time.

For more information, see Client Tokens in the Amazon EC2 API Reference.

[required] The type of instance to connect to the environment (for example, t2.micro).

The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.

[required] The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM) path.

We recommend using Amazon Linux 2023 as the AMI to create your environment as it is fully supported.

From December 16, 2024, Ubuntu 18.04 will be removed from the list of available imageIds for Cloud9. This change is necessary as Ubuntu 18.04 has ended standard support on May 31, 2023. This change will only affect direct API consumers, and not Cloud9 console users.

Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.

AMI aliases

• Amazon Linux 2: amazonlinux-2-x86_64

• Amazon Linux 2023 (recommended): amazonlinux-2023-x86_64

• Ubuntu 18.04: ubuntu-18.04-x86_64

• Ubuntu 22.04: ubuntu-22.04-x86_64

SSM paths

• Amazon Linux 2: ⁠resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64⁠

• Amazon Linux 2023 (recommended): ⁠resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64⁠

• Ubuntu 18.04: ⁠resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64⁠

• Ubuntu 22.04: ⁠resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64⁠

The number of minutes until the running instance is shut down after the environment has last been used.

The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any IAM principal. If this value is not specified, the ARN defaults to this environment's creator.

An array of key-value pairs that will be associated with the new Cloud9 development environment.

The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through Amazon EC2 Systems Manager).

For more information, see Accessing no-ingress EC2 instances with Amazon EC2 Systems Manager in the Cloud9 User Guide.

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 environment that contains the environment member you want to add.

[required] The Amazon Resource Name (ARN) of the environment member you want to add.

[required] The type of environment member permissions you want to associate with this environment member. Available values include:

• read-only: Has read-only access to the environment.

• read-write: Has read-write access to the environment.

[required] The ID of the environment to delete.

[required] The ID of the environment to delete the environment member from.

[required] The Amazon Resource Name (ARN) of the environment member to delete from the environment.

The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.

The ID of the environment to get environment member information about.

The type of environment member permissions to get information about. Available values include:

• owner: Owns the environment.

• read-only: Has read-only access to the environment.

• read-write: Has read-write access to the environment.

If no value is specified, information about all environment members are returned.

During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

The maximum number of environment members to get information about.

[required] The ID of the environment to get status information about.

[required] The IDs of individual environments to get information about.

During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

The maximum number of environments to get identifiers for.

[required] The Amazon Resource Name (ARN) of the Cloud9 development environment to get the tags for.

[required] The Amazon Resource Name (ARN) of the Cloud9 development environment to add tags to.

[required] The list of tags to add to the given Cloud9 development environment.

[required] The Amazon Resource Name (ARN) of the Cloud9 development environment to remove tags from.

[required] The tag names of the tags to remove from the given Cloud9 development environment.

[required] The ID of the environment to change settings.

A replacement name for the environment.

Any new or replacement description for the environment.

Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary credentials for an Cloud9 environment by using one of the following values:

• ENABLE

• DISABLE

Only the environment owner can change the status of managed temporary credentials. An AccessDeniedException is thrown if an attempt to turn on or turn off managed temporary credentials is made by an account that's not the environment owner.

[required] The ID of the environment for the environment member whose settings you want to change.

[required] The Amazon Resource Name (ARN) of the environment member whose settings you want to change.

[required] The replacement type of environment member permissions you want to associate with this environment member. Available values include:

• read-only: Has read-only access to the environment.

• read-write: Has read-write access to the environment.

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 RequestToken of the ProgressEvent object returned by the resource operation request.

[required] The name of the resource type.

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

If you do not specify a client token, one is generated for inclusion in the request.

For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.

[required] Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

Specify the desired state as one of the following:

• A JSON blob

• A local path containing the desired state in JSON data format

For more information, see Composing the desired state of the resource in the Amazon Web Services Cloud Control API User Guide.

For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the CloudFormation Users Guide.

[required] The name of the resource type.

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

If you do not specify a client token, one is generated for inclusion in the request.

For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.

[required] The identifier for the resource.

You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

[required] The name of the resource type.

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

[required] The identifier for the resource.

You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

[required] A unique token used to track the progress of the resource operation request.

Request tokens are included in the ProgressEvent type returned by a resource operation request.

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

The default is 20.

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

The filter criteria to apply to the requests returned.

[required] The name of the resource type.

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Reserved.

The resource model to use to select the resources to return.

[required] The name of the resource type.

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

If you do not specify a client token, one is generated for inclusion in the request.

For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.

[required] The identifier for the resource.

You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

[required] A JavaScript Object Notation (JSON) document listing the patch operations that represent the updates to apply to the current resource properties. For details, see Composing the patch document in the Amazon Web Services Cloud Control API User Guide.

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 name of the domain that contains the repository.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository to which the external connection is added.

[required] The name of the external connection to add to the repository. The following values are supported:

• public:npmjs - for the npm public repository.

• public:nuget-org - for the NuGet Gallery.

• public:pypi - for the Python Package Index.

• public:maven-central - for Maven Central.

• public:maven-googleandroid - for the Google Android repository.

• public:maven-gradleplugins - for the Gradle plugins repository.

• public:maven-commonsware - for the CommonsWare Android repository.

• public:maven-clojars - for the Clojars repository.

• public:ruby-gems-org - for RubyGems.org.

• public:crates-io - for Crates.io.

[required] The name of the domain that contains the source and destination repositories.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository that contains the package versions to be copied.

[required] The name of the repository into which package versions are copied.

[required] The format of the package versions to be copied.

The namespace of the package versions to be copied. The package component that specifies its namespace depends on its type. For example:

The namespace is required when copying package versions of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

[required] The name of the package that contains the versions to be copied.

The versions of the package to be copied.

You must specify versions or versionRevisions. You cannot specify both.

A list of key-value pairs. The keys are package versions and the values are package version revisions. A CopyPackageVersion operation succeeds if the specified versions in the source repository match the specified package version revision.

You must specify versions or versionRevisions. You cannot specify both.

Set to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the failedVersions field of the response with an ALREADY_EXISTS error code.

Set to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see Working with upstream repositories.

[required] The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.

The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an encryptionKey, your IAM role must have kms:DescribeKey and kms:CreateGrant permissions on the encryption key that is used. For more information, see DescribeKey in the Key Management Service API Reference and Key Management Service API Permissions Reference in the Key Management Service Developer Guide.

CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.

One or more tag key-value pairs for the domain.

[required] The name of the domain in which you want to create a package group.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The pattern of the package group to create. The pattern is also the identifier of the package group.

The contact information for the created package group.

A description of the package group.

One or more tag key-value pairs for the package group.

[required] The name of the domain that contains the created repository.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository to create.

A description of the created repository.

A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

One or more tag key-value pairs for the repository.

[required] The name of the domain to delete.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the domain associated with the resource policy to be deleted.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

The current revision of the resource policy to be deleted. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.

[required] The name of the domain that contains the package to delete.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository that contains the package to delete.

[required] The format of the requested package to delete.

The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting packages of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

[required] The name of the package to delete.

[required] The domain that contains the package group to be deleted.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The pattern of the package group to be deleted.

[required] The name of the domain that contains the package to delete.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository that contains the package versions to delete.

[required] The format of the package versions to delete.

The namespace of the package versions to be deleted. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting package versions of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

[required] The name of the package with the versions to delete.

[required] An array of strings that specify the versions of the package to delete.

The expected status of the package version to delete.

[required] The name of the domain that contains the repository to delete.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository to delete.

[required] The name of the domain that contains the repository associated with the resource policy to be deleted.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository that is associated with the resource policy to be deleted

The revision of the repository's resource policy to be deleted. This revision is used for optimistic locking, which prevents others from accidentally overwriting your changes to the repository's resource policy.

[required] A string that specifies the name of the requested domain.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the domain that contains the repository that contains the package.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository that contains the requested package.

[required] A format that specifies the type of the requested package.

The namespace of the requested package. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting packages of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

[required] The name of the requested package.

[required] The name of the domain that contains the package group.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The pattern of the requested package group.

[required] The name of the domain that contains the repository that contains the package version.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository that contains the package version.

[required] A format that specifies the type of the requested package version.

The namespace of the requested package version. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting package versions of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

[required] The name of the requested package version.

[required] A string that contains the package version (for example, ⁠3.5.2⁠).

[required] The name of the domain that contains the repository to describe.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] A string that specifies the name of the requested repository.

[required] The name of the domain that contains the repository from which to remove the external repository.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository from which the external connection will be removed.

[required] The name of the external connection to be removed from the repository.

[required] The name of the domain that contains the repository you want to dispose.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository that contains the package versions you want to dispose.

[required] A format that specifies the type of package versions you want to dispose.

The namespace of the package versions to be disposed. The package component that specifies its namespace depends on its type. For example:

The namespace is required when disposing package versions of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

[required] The name of the package with the versions you want to dispose.

[required] The versions of the package you want to dispose.

The revisions of the package versions you want to dispose.

The expected status of the package version to dispose.

[required] The name of the domain that contains the package from which to get the associated package group.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The format of the package from which to get the associated package group.

The namespace of the package from which to get the associated package group. The package component that specifies its namespace depends on its type. For example:

The namespace is required when getting associated package groups from packages of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

[required] The package from which to get the associated package group.

[required] The name of the domain that is in scope for the generated authorization token.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

The time, in seconds, that the generated authorization token is valid. Valid values are 0 and any number between 900 (15 minutes) and 43200 (12 hours). A value of 0 will set the expiration of the authorization token to the same expiration of the user's role's temporary credentials.

[required] The name of the domain to which the resource policy is attached.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the domain that contains the repository that contains the package version with the requested asset.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The repository that contains the package version with the requested asset.

[required] A format that specifies the type of the package version with the requested asset file.

The namespace of the package version with the requested asset file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting assets from package versions of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

[required] The name of the package that contains the requested asset.

[required] A string that contains the package version (for example, ⁠3.5.2⁠).

[required] The name of the requested asset.

The name of the package version revision that contains the requested asset.

[required] The name of the domain that contains the repository that contains the package version with the requested readme file.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The repository that contains the package with the requested readme file.

[required] A format that specifies the type of the package version with the requested readme file.

The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:

The namespace is required when requesting the readme from package versions of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

[required] The name of the package version that contains the requested readme file.

[required] A string that contains the package version (for example, ⁠3.5.2⁠).

[required] The name of the domain that contains the repository.

The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.

[required] The name of the repository.

[required] Returns which endpoint of a repository to return. A repository has one endpoint for each package format.

A string that specifies the type of endpoint.

[required] The name of the domain containing the repository whose associated resource policy is to be retrieved.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository whose associated resource policy is to be retrieved.

[required] The name of the domain that contains the package group from which to list allowed repositories.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The pattern of the package group from which to list allowed repositories.

[required] The origin configuration restriction type of which to list allowed repositories.

The maximum number of results to return per page.

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

[required] The name of the domain that contains the package group from which to list associated packages.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The pattern of the package group from which to list associated packages.

The maximum number of results to return per page.

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

When this flag is included, list_associated_packages will return a list of packages that would be associated with a package group, even if it does not exist.

The maximum number of results to return per page.

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

[required] The domain for which you want to list package groups.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

The maximum number of results to return per page.

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

A prefix for which to search package groups. When included, list_package_groups will return only package groups with patterns that match the prefix.

[required] The name of the domain that contains the repository associated with the package version assets.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository that contains the package that contains the requested package version assets.

[required] The format of the package that contains the requested package version assets.

The namespace of the package version that contains the requested package version assets. The package component that specifies its namespace depends on its type. For example:

The namespace is required requesting assets from package versions of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

[required] The name of the package that contains the requested package version assets.

[required] A string that contains the package version (for example, ⁠3.5.2⁠).

The maximum number of results to return per page.

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

[required] The name of the domain that contains the repository that contains the requested package version dependencies.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository that contains the requested package version.

[required] The format of the package with the requested dependencies.

The namespace of the package version with the requested dependencies. The package component that specifies its namespace depends on its type. For example:

The namespace is required when listing dependencies from package versions of the following formats:

• Maven

• The namespace of a Maven package version is its groupId.

• The namespace of an npm package version is its scope.

• Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

[required] The name of the package versions' package.

[required] A string that contains the package version (for example, ⁠3.5.2⁠).

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

[required] The name of the domain that contains the repository that contains the requested package versions.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository that contains the requested package versions.

[required] The format of the package versions you want to list.

The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:

The namespace is required when deleting package versions of the following formats:

• Maven

• Swift

• generic

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

[required] The name of the package for which you want to request package versions.

A string that filters the requested package versions by status.

How to sort the requested list of package versions.

The maximum number of results to return per page.

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

The originType used to filter package versions. Only package versions with the provided originType will be returned.

[required] The name of the domain that contains the repository that contains the requested packages.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository that contains the requested packages.

The format used to filter requested packages. Only packages from the provided format will be returned.

The namespace prefix used to filter requested packages. Only packages with a namespace that starts with the provided string value are returned. Note that although this option is called --namespace and not --namespace-prefix, it has prefix-matching behavior.

Each package format uses namespace as follows:

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

A prefix used to filter requested packages. Only packages with names that start with packagePrefix are returned.

The maximum number of results to return per page.

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

The value of the Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.

The value of the Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.

A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned.

The maximum number of results to return per page.

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

[required] The name of the domain that contains the returned list of repositories.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

Filter the list of repositories to only include those that are managed by the Amazon Web Services account ID.

A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned.

The maximum number of results to return per page.

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

[required] The name of the domain which contains the package group from which to list sub package groups.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The pattern of the package group from which to list sub package groups.

The maximum number of results to return per page.

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

[required] The Amazon Resource Name (ARN) of the resource to get tags for.

[required] The name of the domain that contains the repository that contains the package version to publish.

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository that the package version will be published to.

[required] A format that specifies the type of the package version with the requested asset file.

The only supported value is generic.

The namespace of the package version to publish.

[required] The name of the package version to publish.

[required] The package version to publish (for example, ⁠3.5.2⁠).

[required] The content of the asset to publish.

[required] The name of the asset to publish. Asset names can include Unicode letters and numbers, and the following special characters: ⁠~ ! @ ^ & ( ) - ` _ + [ ] { } ; , . `⁠

[ ]: R:%20

[required] The SHA256 hash of the assetContent to publish. This value must be calculated by the caller and provided with the request (see Publishing a generic package in the CodeArtifact User Guide).

This value is used as an integrity check to verify that the assetContent has not changed after it was originally sent.

Specifies whether the package version should remain in the unfinished state. If omitted, the package version status will be set to Published (see Package version status in the CodeArtifact User Guide).

Valid values: unfinished

[required] The name of the domain on which to set the resource policy.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.

[required] A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain.

[required] The name of the domain that contains the repository that contains the package.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository that contains the package.

[required] A format that specifies the type of the package to be updated.

The namespace of the package to be updated. The package component that specifies its namespace depends on its type. For example:

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

[required] The name of the package to be updated.

[required] A PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions. The upstream restriction determines if new package versions can be ingested or retained from external connections or upstream repositories. The publish restriction determines if new package versions can be published directly to the repository.

You must include both the desired upstream and publish restrictions.

[required] The name of the domain containing the repository to set the resource policy on.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository to set the resource policy on.

Sets the revision of the resource policy that specifies permissions to access the repository. This revision is used for optimistic locking, which prevents others from overwriting your changes to the repository's resource policy.

[required] A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided repository.

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

[required] The tags you want to modify or add to the resource.

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

[required] The tag key for each tag that you want to remove from the resource.

[required] The name of the domain which contains the package group to be updated.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The pattern of the package group to be updated.

Contact information which you want to update the requested package group with.

The description you want to update the requested package group with.

[required] The name of the domain which contains the package group for which to update the origin configuration.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The pattern of the package group for which to update the origin configuration.

The origin configuration settings that determine how package versions can enter repositories.

The repository name and restrictions to add to the allowed repository list of the specified package group.

The repository name and restrictions to remove from the allowed repository list of the specified package group.

[required] The name of the domain that contains the repository that contains the package versions with a status to be updated.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The repository that contains the package versions with the status you want to update.

[required] A format that specifies the type of the package with the statuses to update.

The namespace of the package version to be updated. The package component that specifies its namespace depends on its type. For example:

• The namespace of a Maven package version is its groupId.

• The namespace of an npm or Swift package version is its scope.

• The namespace of a generic package is its namespace.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

[required] The name of the package with the version statuses to update.

[required] An array of strings that specify the versions of the package with the statuses to update.

A map of package versions and package version revisions. The map key is the package version (for example, ⁠3.5.2⁠), and the map value is the package version revision.

The package version’s expected status before it is updated. If expectedStatus is provided, the package version's status is updated only if its status at the time update_package_versions_status is called matches expectedStatus.

[required] The status you want to change the package version status to.

[required] The name of the domain associated with the repository to update.

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

[required] The name of the repository to update.

An updated repository description.

A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

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 IDs of the builds to delete.

[required] An array that contains the batch build identifiers to retrieve.

[required] The IDs of the builds.

[required] The names or ARNs of the compute fleets.

[required] The names or ARNs of the build projects. To get information about a project shared with your Amazon Web Services account, its ARN must be specified. You cannot specify a shared project using its name.

[required] An array of report group ARNs that identify the report groups to return.

[required] An array of ARNs that identify the Report objects to return.

[required] The name of the compute fleet.

[required] The initial number of machines allocated to the fleet, which defines the number of builds that can run in parallel.

[required] The environment type of the compute fleet.

• The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).

• The environment type ARM_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).

• The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).

• The environment type LINUX_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).

• The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).

• The environment type MAC_ARM is available for Medium fleets only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), and EU (Frankfurt)

• The environment type MAC_ARM is available for Large fleets only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and Asia Pacific (Sydney).

• The environment type WINDOWS_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).

• The environment type WINDOWS_SERVER_2019_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).

• The environment type WINDOWS_SERVER_2022_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).

For more information, see Build environment compute types in the CodeBuild user guide.

[required] Information about the compute resources the compute fleet uses. Available values include:

• ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.

  If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.

• BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.

• BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.

• BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.

• BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.

• BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.

• BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

• BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

• BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

• BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

• BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

If you use BUILD_GENERAL1_SMALL:

• For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.

• For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.

• For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.

If you use BUILD_GENERAL1_LARGE:

• For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.

• For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.

• For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.

For more information, see On-demand environment types in the CodeBuild User Guide.

The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.

The scaling configuration of the compute fleet.

The compute fleet overflow behavior.

• For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.

• For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.

  If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface.

The proxy configuration of the compute fleet.

The Amazon Machine Image (AMI) of the compute fleet.

The service role associated with the compute fleet. For more information, see Allow a user to add a permission policy for a fleet service role in the CodeBuild User Guide.

A list of tag key and value pairs associated with this compute fleet.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

[required] The name of the build project.

A description that makes the build project easy to identify.

[required] Information about the build input source code for the build project.

An array of ProjectSource objects.

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

• For CodeCommit: the commit ID, branch, or Git tag to use.

• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

• For GitLab: the commit ID, branch, or Git tag to use.

• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

• For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take precedence over these secondarySourceVersions (at the project level).

[required] Information about the build output artifacts for the build project.

An array of ProjectArtifacts objects.

Stores recently used information so that it can be quickly accessed at a later time.

[required] Information about the build environment for the build project.

[required] The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.

The number of minutes a build is allowed to be queued before it times out.

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format ⁠alias/<alias-name>⁠).

A list of tag key and value pairs associated with this build project.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

If you're using compute fleets during project creation, do not provide vpcConfig.

Set this to true to generate a publicly accessible URL for your project's build badge.

Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.

An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

A ProjectBuildBatchConfig object that defines the batch build options for the project.

The maximum number of concurrent builds that are allowed for this project.

New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the retry_build API to automatically retry your build for up to 2 additional times.

[required] The name of the report group.

[required] The type of report group.

[required] A ReportExportConfig object that contains information about where the report group test results are exported.

A list of tag key and value pairs associated with this report group.

These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.

[required] The name of the CodeBuild project.

A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.

For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.

Specifies the type of build this webhook will trigger.

RUNNER_BUILDKITE_BUILD is only available for NO_SOURCE source type projects configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see Tutorial: Configure a CodeBuild-hosted Buildkite runner in the CodeBuild user guide.

If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.

manualCreation is only available for GitHub webhooks.

The scope configuration for global or organization webhooks.

Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

[required] The identifier of the batch build to delete.

[required] The ARN of the compute fleet.

[required] The name of the build project.

[required] The ARN of the report to delete.

[required] The ARN of the report group to delete.

If true, deletes any reports that belong to a report group before deleting the report group.

If false, you must delete any reports in the report group. Use list_reports_for_report_group to get the reports in a report group. Use delete_report to delete the reports. If you call delete_report_group for a report group that contains one or more reports, an exception is thrown.

[required] The ARN of the resource that is associated with the resource policy.

[required] The Amazon Resource Name (ARN) of the token.

[required] The name of the CodeBuild project.

[required] The ARN of the report for which test cases are returned.

The nextToken value returned from a previous call to describe_code_coverages. This specifies the next item to return. To return the beginning of the list, exclude this parameter.

The maximum number of results to return.

Specifies if the results are sorted in ascending or descending order.

Specifies how the results are sorted. Possible values are:

FILE_PATH

The results are sorted by file path.

LINE_COVERAGE_PERCENTAGE

The results are sorted by the percentage of lines that are covered.

The minimum line coverage percentage to report.

The maximum line coverage percentage to report.

[required] The ARN of the report for which test cases are returned.

During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

The maximum number of paginated test cases returned per response. Use nextToken to iterate pages in the list of returned TestCase objects. The default value is 100.

A TestCaseFilter object used to filter the returned reports.

[required] The ARN of the report group that contains the reports to analyze.

The number of reports to analyze. This operation always retrieves the most recent reports.

If this parameter is omitted, the most recent 100 reports are analyzed.

[required] The test report value to accumulate. This must be one of the following values:

Test reports:

DURATION

Accumulate the test run times for the specified reports.

PASS_RATE

Accumulate the percentage of tests that passed for the specified test reports.

TOTAL

Accumulate the total number of tests for the specified test reports.

Code coverage reports:

BRANCH_COVERAGE

Accumulate the branch coverage percentages for the specified test reports.

BRANCHES_COVERED

Accumulate the branches covered values for the specified test reports.

BRANCHES_MISSED

Accumulate the branches missed values for the specified test reports.

LINE_COVERAGE

Accumulate the line coverage percentages for the specified test reports.

LINES_COVERED

Accumulate the lines covered values for the specified test reports.

LINES_MISSED

Accumulate the lines not covered values for the specified test reports.

[required] The ARN of the resource that is associated with the resource policy.

The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.

[required] For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is either the access token or the app password. For the authType CODECONNECTIONS, this is the connectionArn. For the authType SECRETS_MANAGER, this is the secretArn.

[required] The source provider used for this project.

[required] The type of authentication used to connect to a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the CodeBuild console.

Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value is true.

[required] The name of the CodeBuild build project that the cache is reset for.

A BuildBatchFilter object that specifies the filters for the search.

The maximum number of results to return.

Specifies the sort order of the returned items. Valid values include:

• ASCENDING: List the batch build identifiers in ascending order by identifier.

• DESCENDING: List the batch build identifiers in descending order by identifier.

The nextToken value returned from a previous call to list_build_batches. This specifies the next item to return. To return the beginning of the list, exclude this parameter.

The name of the project.

A BuildBatchFilter object that specifies the filters for the search.

The maximum number of results to return.

Specifies the sort order of the returned items. Valid values include:

• ASCENDING: List the batch build identifiers in ascending order by identifier.

• DESCENDING: List the batch build identifiers in descending order by identifier.

The nextToken value returned from a previous call to list_build_batches_for_project. This specifies the next item to return. To return the beginning of the list, exclude this parameter.

The order to list build IDs. Valid values include:

• ASCENDING: List the build IDs in ascending order by build ID.

• DESCENDING: List the build IDs in descending order by build ID.

During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

[required] The name of the CodeBuild project.

The order to sort the results in. The results are sorted by build number, not the build identifier. If this is not specified, the results are sorted in descending order.

Valid values include:

• ASCENDING: List the build identifiers in ascending order, by build number.

• DESCENDING: List the build identifiers in descending order, by build number.

If the project has more than 100 builds, setting the sort order will result in an error.

During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

The maximum number of paginated compute fleets returned per response. Use nextToken to iterate pages in the list of returned compute fleets.

The order in which to list compute fleets. Valid values include:

• ASCENDING: List in ascending order.

• DESCENDING: List in descending order.

Use sortBy to specify the criterion to be used to list compute fleet names.

The criterion to be used to list compute fleet names. Valid values include:

• CREATED_TIME: List based on when each compute fleet was created.

• LAST_MODIFIED_TIME: List based on when information about each compute fleet was last changed.

• NAME: List based on each compute fleet's name.

Use sortOrder to specify in what order to list the compute fleet names based on the preceding criteria.

The criterion to be used to list build project names. Valid values include:

• CREATED_TIME: List based on when each build project was created.

• LAST_MODIFIED_TIME: List based on when information about each build project was last changed.

• NAME: List based on each build project's name.

Use sortOrder to specify in what order to list the build project names based on the preceding criteria.

The order in which to list build projects. Valid values include:

• ASCENDING: List in ascending order.

• DESCENDING: List in descending order.

Use sortBy to specify the criterion to be used to list build project names.

During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.

The criterion to be used to list build report groups. Valid values include:

• CREATED_TIME: List based on when each report group was created.

• LAST_MODIFIED_TIME: List based on when each report group was last changed.

• NAME: List based on each report group's name.

During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

The maximum number of paginated report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.

Specifies the sort order for the list of returned reports. Valid values are:

• ASCENDING: return reports in chronological order based on their creation date.

• DESCENDING: return reports in the reverse chronological order based on their creation date.

During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

The maximum number of paginated reports returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.

A ReportFilter object used to filter the returned reports.

[required] The ARN of the report group for which you want to return report ARNs.

During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

Use to specify whether the results are returned in ascending or descending order.

The maximum number of paginated reports in this report group returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.

A ReportFilter object used to filter the returned reports.

The criterion to be used to list build projects shared with the current Amazon Web Services account or user. Valid values include:

• ARN: List based on the ARN.

• MODIFIED_TIME: List based on when information about the shared project was last changed.

The order in which to list shared build projects. Valid values include:

• ASCENDING: List in ascending order.

• DESCENDING: List in descending order.

The maximum number of paginated shared build projects returned per response. Use nextToken to iterate pages in the list of returned Project objects. The default value is 100.

During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

The order in which to list shared report groups. Valid values include:

• ASCENDING: List in ascending order.

• DESCENDING: List in descending order.

The criterion to be used to list report groups shared with the current Amazon Web Services account or user. Valid values include:

• ARN: List based on the ARN.

• MODIFIED_TIME: List based on when information about the shared report group was last changed.

During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

The maximum number of paginated shared report groups per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.

[required] A JSON-formatted resource policy. For more information, see Sharing a Project and Sharing a Report Group in the CodeBuild User Guide.

[required] The ARN of the Project or ReportGroup resource you want to associate with a resource policy.

Specifies the identifier of the build to restart.

A unique, case sensitive identifier you provide to ensure the idempotency of the retry_build request. The token is included in the retry_build request and is valid for five minutes. If you repeat the retry_build request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.

Specifies the identifier of the batch build to restart.

A unique, case sensitive identifier you provide to ensure the idempotency of the retry_build_batch request. The token is included in the retry_build_batch request and is valid for five minutes. If you repeat the retry_build_batch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.

Specifies the type of retry to perform.

[required] The name of the CodeBuild build project to start running a build.

An array of ProjectSource objects.

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

GitLab

The commit ID, branch, or Git tag to use.

Bitbucket

The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Amazon S3

The version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

An array of ProjectArtifacts objects.

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

A source input type, for this build, that overrides the source input defined in the build project.

A location that overrides, for this build, the source location for the one defined in the build project.

An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket, GitHub, GitLab, or GitLab Self Managed.

The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.

Information about the Git submodules configuration for this build of an CodeBuild build project.

A buildspec file declaration that overrides the latest one defined in the build project, for this build only. The buildspec defined on the project is not changed.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.

Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket, an invalidInputException is thrown.

To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.

The status of a build triggered by a webhook is always reported to your source provider.

Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

A container type for this build that overrides the one specified in the build project.

The name of an image for this build that overrides the one specified in the build project.

The name of a compute type for this build that overrides the one specified in the build project.

The name of a certificate for this build that overrides the one specified in the build project.

A ProjectCache object specified for this build that overrides the one defined in the build project.

The name of a service role for this build that overrides the one specified in the build project.

Enable this flag to override privileged mode in the build project.

The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the latest setting already defined in the build project.

The number of minutes a build is allowed to be queued before it times out.

The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format ⁠alias/<alias-name>⁠).

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.

Log settings for this build that override the log settings defined in the build project.

The credentials for access to a private registry.

The type of credentials CodeBuild uses to pull images in your build. There are two valid values:

CODEBUILD

Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

SERVICE_ROLE

Specifies that CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.

Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.

A ProjectFleet object specified for this build that overrides the one defined in the build project.

The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the retry_build API to automatically retry your build for up to 2 additional times.

[required] The name of the project.

An array of ProjectSource objects that override the secondary sources defined in the batch build project.

An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project.

The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Bitbucket

The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Amazon S3

The version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.

An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.

An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.

The source input type that overrides the source input defined in the batch build project.

A location that overrides, for this batch build, the source location defined in the batch build project.

A SourceAuth object that overrides the one defined in the batch build project. This override applies only if the build project's source is BitBucket or GitHub.

The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any previous depth of history defined in the batch build project.

A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Enable this flag to override the insecure SSL setting that is specified in the batch build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

Set to true to report to your source provider the status of a batch build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

The status of a build triggered by a webhook is always reported to your source provider.

A container type for this batch build that overrides the one specified in the batch build project.

The name of an image for this batch build that overrides the one specified in the batch build project.

The name of a compute type for this batch build that overrides the one specified in the batch build project.

The name of a certificate for this batch build that overrides the one specified in the batch build project.

A ProjectCache object that specifies cache overrides.

The name of a service role for this batch build that overrides the one specified in the batch build project.

Enable this flag to override privileged mode in the batch build project.

Overrides the build timeout specified in the batch build project.

The number of minutes a batch build is allowed to be queued before it times out.

The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format ⁠alias/<alias-name>⁠).

A unique, case sensitive identifier you provide to ensure the idempotency of the start_build_batch request. The token is included in the start_build_batch request and is valid for five minutes. If you repeat the start_build_batch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.

A LogsConfig object that override the log settings defined in the batch build project.

A RegistryCredential object that overrides credentials for access to a private registry.

The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:

CODEBUILD

Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

SERVICE_ROLE

Specifies that CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.

A BuildBatchConfigOverride object that contains batch build configuration overrides.

Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.

[required] The ID of the build.

[required] The identifier of the batch build to stop.

[required] The ARN of the compute fleet.

The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.

The environment type of the compute fleet.

• The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).

• The environment type ARM_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).

• The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).

• The environment type LINUX_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).

• The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).

• The environment type MAC_ARM is available for Medium fleets only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), and EU (Frankfurt)

• The environment type MAC_ARM is available for Large fleets only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and Asia Pacific (Sydney).

• The environment type WINDOWS_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).

• The environment type WINDOWS_SERVER_2019_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).

• The environment type WINDOWS_SERVER_2022_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).

For more information, see Build environment compute types in the CodeBuild user guide.

Information about the compute resources the compute fleet uses. Available values include:

• ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.

  If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.

• BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.

• BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.

• BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.

• BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.

• BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.

• BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

• BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

• BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

• BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

• BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

If you use BUILD_GENERAL1_SMALL:

• For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.

• For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.

• For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.

If you use BUILD_GENERAL1_LARGE:

• For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.

• For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.

• For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.

For more information, see On-demand environment types in the CodeBuild User Guide.

The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.

The scaling configuration of the compute fleet.

The compute fleet overflow behavior.

• For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.

• For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.

  If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface.

The proxy configuration of the compute fleet.

The Amazon Machine Image (AMI) of the compute fleet.

The service role associated with the compute fleet. For more information, see Allow a user to add a permission policy for a fleet service role in the CodeBuild User Guide.

A list of tag key and value pairs associated with this compute fleet.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

[required] The name of the build project.

You cannot change a build project's name.

A new or replacement description of the build project.

Information to be changed about the build input source code for the build project.

An array of ProjectSource objects.

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

• For CodeCommit: the commit ID, branch, or Git tag to use.

• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

• For GitLab: the commit ID, branch, or Git tag to use.

• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

• For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

Information to be changed about the build output artifacts for the build project.

An array of ProjectArtifact objects.

Stores recently used information so that it can be quickly accessed at a later time.

Information to be changed about the build environment for the build project.

The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

The replacement value in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.

The number of minutes a build is allowed to be queued before it times out.

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format ⁠alias/<alias-name>⁠).

An updated list of tag key and value pairs associated with this build project.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

Set this to true to generate a publicly accessible URL for your project's build badge.

Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.

An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

The maximum number of concurrent builds that are allowed for this project.

New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

To remove this limit, set this value to -1.

The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the retry_build API to automatically retry your build for up to 2 additional times.

[required] The Amazon Resource Name (ARN) of the build project.

[required]

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

[required] The ARN of the report group to update.

Used to specify an updated export type. Valid values are:

• S3: The report results are exported to an S3 bucket.

• NO_EXPORT: The report results are not exported.

An updated list of tag key and value pairs associated with this report group.

These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.

[required] The name of the CodeBuild project.

A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.

An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT WebhookFilter.

Specifies the type of build this webhook will trigger.

RUNNER_BUILDKITE_BUILD is only available for NO_SOURCE source type projects configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see Tutorial: Configure a CodeBuild-hosted Buildkite runner in the CodeBuild user guide.

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 friendly name of the personal access token.

The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

[required] The name of the space.

[required] The name of the project in the space.

The source repository that contains the branch to clone into the Dev Environment.

A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

The user-defined alias for a Dev Environment.

Information about the integrated development environment (IDE) configured for a Dev Environment.

An IDE is required to create a Dev Environment. For Dev Environment creation, this field contains configuration information and must be provided.

[required] The Amazon EC2 instace type to use for the Dev Environment.

The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

[required] Information about the amount of storage allocated to the Dev Environment.

By default, a Dev Environment is configured to have 16GB of persistent storage when created from the Amazon CodeCatalyst console, but there is no default when programmatically creating a Dev Environment. Valid values for persistent storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.

The name of the connection that will be used to connect to Amazon VPC, if any.

[required] The name of the space.

[required] The friendly name of the project that will be displayed to users.

The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.

[required] The name of the space.

[required] The name of the project in the space.

[required] The name of the source repository. For more information about name requirements, see Quotas for source repositories.

The description of the source repository.

[required] The name of the space.

[required] The name of the project in the space.

[required] The name of the repository where you want to create a branch.

[required] The name for the branch you're creating.

The commit ID in an existing branch from which you want to create the new branch.

[required] The ID of the personal access token to delete. You can find the IDs of all PATs associated with your Amazon Web Services Builder ID in a space by calling list_access_tokens.

[required] The name of the space.

[required] The name of the project in the space.

[required] The system-generated unique ID of the Dev Environment you want to delete. To retrieve a list of Dev Environment IDs, use list_dev_environments.

[required] The name of the space.

[required] The name of the project in the space. To retrieve a list of project names, use list_projects.

[required] The name of the space.

[required] The name of the project in the space.

[required] The name of the source repository.

[required] The name of the space. To retrieve a list of space names, use list_spaces.

[required] The name of the space.

[required] The name of the project in the space.

[required] The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use list_dev_environments.

[required] The name of the space.

[required] The name of the project in the space.

[required] The name of the space.

[required] The name of the project in the space.

[required] The name of the source repository.

[required] The name of the space.

[required] The name of the project in the space.

[required] The name of the source repository.

[required] The name of the space.

[required] The name of the space.

The system-generated unique ID of the user.

The name of the user as displayed in Amazon CodeCatalyst.

[required] The name of the space.

[required] The ID of the workflow. To rerieve a list of workflow IDs, use list_workflows.

[required] The name of the project in the space.

[required] The name of the space.

[required] The ID of the workflow run. To retrieve a list of workflow run IDs, use list_workflow_runs.

[required] The name of the project in the space.

The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

A token returned from a call to this API to indicate the next batch of results to return, if any.