AWS API Changes

2016/12/01 - AWS CodeBuild - 11 new api methods

Changes AWS CodeBuild is a fully-managed build service in the cloud. CodeBuild compiles source code, runs tests, and produces packages that are ready to deploy. CodeBuild eliminates the need to provision, manage, and scale your own build servers. CodeBuild scales continuously and processes multiple builds concurrently, so your builds are never waiting in a queue. You can get started quickly with CodeBuild’s prepackaged build environments, or you can use custom build environments to use your own build tools. With CodeBuild, you only pay by the minute.

ListProjects (new)

Link ¶

Gets a list of build project names, with each build project name representing a single build project.

See also: AWS API Documentation

Request Syntax

client.list_projects(
    sortBy='NAME'|'CREATED_TIME'|'LAST_MODIFIED_TIME',
    sortOrder='ASCENDING'|'DESCENDING',
    nextToken='string'
)

type sortBy

string

param sortBy

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

CREATED_TIME : List the build project names based on when each build project was created.
LAST_MODIFIED_TIME : List the build project names based on when information about each build project was last changed.
NAME : List the build project names 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.

type sortOrder

string

param sortOrder

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

ASCENDING : List the build project names in ascending order.
DESCENDING : List the build project names in descending order.

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

type nextToken

string

param nextToken

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 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.

rtype

dict

returns

Response Syntax

{
    'nextToken': 'string',
    'projects': [
        'string',
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  If there are more than 100 items in the list, only the first 100 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.
- projects (list) --
  
  The list of build project names, with each build project name representing a single build project.
  - (string) --

BatchGetBuilds (new)

Link ¶

Gets information about one or more builds.

See also: AWS API Documentation

Request Syntax

client.batch_get_builds(
    ids=[
        'string',
    ]
)

type ids

list

param ids

[REQUIRED]

The IDs of the builds to get information about.

(string) --

rtype

dict

returns

Response Syntax

{
    'builds': [
        {
            'id': 'string',
            'arn': 'string',
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'currentPhase': 'string',
            'buildStatus': 'SUCCEEDED'|'FAILED'|'FAULT'|'TIMED_OUT'|'IN_PROGRESS'|'STOPPED',
            'sourceVersion': 'string',
            'projectName': 'string',
            'phases': [
                {
                    'phaseType': 'SUBMITTED'|'PROVISIONING'|'DOWNLOAD_SOURCE'|'INSTALL'|'PRE_BUILD'|'BUILD'|'POST_BUILD'|'UPLOAD_ARTIFACTS'|'FINALIZING'|'COMPLETED',
                    'phaseStatus': 'SUCCEEDED'|'FAILED'|'FAULT'|'TIMED_OUT'|'IN_PROGRESS'|'STOPPED',
                    'startTime': datetime(2015, 1, 1),
                    'endTime': datetime(2015, 1, 1),
                    'durationInSeconds': 123,
                    'contexts': [
                        {
                            'statusCode': 'string',
                            'message': 'string'
                        },
                    ]
                },
            ],
            'source': {
                'type': 'CODECOMMIT'|'CODEPIPELINE'|'GITHUB'|'S3',
                'location': 'string',
                'buildspec': 'string',
                'auth': {
                    'type': 'OAUTH',
                    'resource': 'string'
                }
            },
            'artifacts': {
                'location': 'string',
                'sha256sum': 'string',
                'md5sum': 'string'
            },
            'environment': {
                'type': 'LINUX_CONTAINER',
                'image': 'string',
                'computeType': 'BUILD_GENERAL1_SMALL'|'BUILD_GENERAL1_MEDIUM'|'BUILD_GENERAL1_LARGE',
                'environmentVariables': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ]
            },
            'logs': {
                'groupName': 'string',
                'streamName': 'string',
                'deepLink': 'string'
            },
            'timeoutInMinutes': 123,
            'buildComplete': True|False,
            'initiator': 'string'
        },
    ],
    'buildsNotFound': [
        'string',
    ]
}

Response Structure

(dict) --
- builds (list) --
  
  Information about the requested builds.
  - (dict) --
    
    Information about a build.
    - id (string) --
      
      The build's unique ID.
    - arn (string) --
      
      The build's Amazon Resource Name (ARN).
    - startTime (datetime) --
      
      When the build process started, expressed in Unix time format.
    - endTime (datetime) --
      
      When the build process ended, expressed in Unix time format.
    - currentPhase (string) --
      
      The build's current build phase.
    - buildStatus (string) --
      
      The build's current status. Valid values include:
      - FAILED : The build failed.
      - FAULT : The build faulted.
      - IN_PROGRESS : The build is still in progress.
      - STOPPED : The build stopped.
      - SUCCEEDED : The build succeeded.
      - TIMED_OUT : The build timed out.
    - sourceVersion (string) --
      
      Any version identifier for the version of the source code to be built.
    - projectName (string) --
      
      The build project's name.
    - phases (list) --
      
      Information about all previous build phases that have completed, and information about any current build phase that has not yet completed.
      - (dict) --
        
        Information about a stage for a build.
        
        phaseType (string) --
        
        The build phase's name. Valid values include:
        
        BUILD : Core build activities typically occur in this build phase.
        
        COMPLETED : The build has completed.
        
        DOWNLOAD_SOURCE : Source code is being downloaded in this build phase.
        
        FINALIZING : The build process is completing in this build phase.
        
        INSTALL : Installation activities typically occur in this build phase.
        
        POST_BUILD : Post-build activities typically occur in this build phase.
        
        PRE_BUILD : Pre-build activities typically occur in this build phase.
        
        PROVISIONING : The build environment is being set up.
        
        SUBMITTED : The build has been submitted.
        
        UPLOAD_ARTIFACTS : Build output artifacts are being uploaded to output location.
        
        phaseStatus (string) --
        
        The build phase's current status. Valid values include:
        
        FAILED : The build phase failed.
        
        FAULT : The build phase faulted.
        
        IN_PROGRESS : The build phase is still in progress.
        
        STOPPED : The build phase stopped.
        
        SUCCEEDED : The build phase succeeded.
        
        TIMED_OUT : The build phase timed out.
        
        startTime (datetime) --
        
        When the build phase started, expressed in Unix time format.
        
        endTime (datetime) --
        
        When the build phase ended, expressed in Unix time format.
        
        durationInSeconds (integer) --
        
        How long, in seconds, between the build's phase starting and ending times.
        
        contexts (list) --
        
        Additional information about a build phase, especially to help troubleshoot a failed build.
        
        (dict) --
        
        Additional information about a build phase that has an error, which you can use to help troubleshoot a failed build.
        
        statusCode (string) --
        
        The status code for the context of the build phase.
        
        message (string) --
        
        An explanation of the build phase's context. This explanation may include a command ID and an exit code.
    - source (dict) --
      
      Information about the source code to be built.
      - type (string) --
        
        The type of repository that contains the source code to be built. Valid values include:
        
        CODECOMMIT : The source code is in an AWS CodeCommit repository.
        
        CODEPIPELINE : The source code settings are specified in the source action of a pipeline in AWS CodePipeline.
        
        GITHUB : The source code is in a GitHub repository.
        
        S3 : The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
      - location (string) --
        
        Information about the location of the source code to be built. Valid values include:
        
        For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
        
        For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).
        
        For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip )
        
        For source code in a GitHub repository, the HTTPS clone URL, including the user name and personal access token, to the repository that contains the source code and the build spec (for example, https://login-user-name:personal-access-token@github.com/repo-owner-name/repo-name.git ). For more information, see Creating an Access Token for Command-Line Use on the GitHub Help website.
      - buildspec (string) --
        
        The build spec declaration to use for this build project's related builds.
        
        If this value is not specified, a build spec must be included along with the source code to be built.
      - auth (dict) --
        
        Information about the authorization settings for AWS CodeBuild to access the source code to be built.
        
        This information is only for the AWS CodeBuild console's use. Your code should not get or set this information directly.
        
        type (string) --
        
        The authorization type to use. The only valid value is OAUTH , which represents the OAuth authorization type.
        
        resource (string) --
        
        The resource value that applies to the specified authorization type.
    - artifacts (dict) --
      
      Information about the build's output artifacts.
      - location (string) --
        
        Information about the build artifacts' location.
      - sha256sum (string) --
        
        The SHA-256 hash of the build artifact.
        
        You can use this hash along with a checksum tool to confirm both file integrity and authenticity.
        
        Note
        
        This value is available only if the related build project's packaging value is set to ZIP .
      - md5sum (string) --
        
        The MD5 hash of the build artifact.
        
        You can use this hash along with a checksum tool to confirm both file integrity and authenticity.
        
        Note
        
        This value is available only if the related build project's packaging value is set to ZIP .
    - environment (dict) --
      
      Information about the build environment for this build.
      - type (string) --
        
        The type of build environment to use for related builds.
        
        The only valid value is LINUX_CONTAINER , which represents a Linux-based build environment.
      - image (string) --
        
        The ID of the Docker image to use for this build project.
      - computeType (string) --
        
        Information about the compute resources the build project will use. Available values include:
        
        BUILD_GENERAL1_SMALL : Use up to 3 GB memory and 2 vCPUs for builds.
        
        BUILD_GENERAL1_MEDIUM : Use up to 7 GB memory and 4 vCPUs for builds.
        
        BUILD_GENERAL1_LARGE : Use up to 15 GB memory and 8 vCPUs for builds.
      - environmentVariables (list) --
        
        A set of environment variables to make available to builds for this build project.
        
        (dict) --
        
        Information about an environment variable for a build project or a build.
        
        name (string) --
        
        The environment variable's name or key.
        
        value (string) --
        
        The environment variable's value.
    - logs (dict) --
      
      Information about the build's logs in Amazon CloudWatch Logs.
      - groupName (string) --
        
        The name of the Amazon CloudWatch Logs group for the associated build logs.
      - streamName (string) --
        
        The name of the Amazon CloudWatch Logs stream for the associated build logs.
      - deepLink (string) --
        
        The URL to an individual build log in Amazon CloudWatch Logs.
    - timeoutInMinutes (integer) --
      
      How long in minutes for AWS CodeBuild to wait to timeout this build if it does not get marked as completed.
    - buildComplete (boolean) --
      
      Whether the build has finished. Valid values include true if completed; otherwise, false.
    - initiator (string) --
      
      The entity that started the build. Valid values include:
      - If AWS CodePipeline started the build, the pipeline's name, for example codepipeline/my-demo-pipeline .
      - If an AWS Identity and Access Management (IAM) user started the build, the user's name, for example MyUserName .
      - If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin .
- buildsNotFound (list) --
  
  The IDs of builds for which information could not be found.
  - (string) --

DeleteProject (new)

Link ¶

Deletes a build project.

See also: AWS API Documentation

Request Syntax

client.delete_project(
    name='string'
)

type name

string

param name

[REQUIRED]

The name of the build project to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

BatchGetProjects (new)

Link ¶

Gets information about one or more build projects.

See also: AWS API Documentation

Request Syntax

client.batch_get_projects(
    names=[
        'string',
    ]
)

type names

list

param names

[REQUIRED]

The names of the build projects to get information about.

(string) --

rtype

dict

returns

Response Syntax

{
    'projects': [
        {
            'name': 'string',
            'arn': 'string',
            'description': 'string',
            'source': {
                'type': 'CODECOMMIT'|'CODEPIPELINE'|'GITHUB'|'S3',
                'location': 'string',
                'buildspec': 'string',
                'auth': {
                    'type': 'OAUTH',
                    'resource': 'string'
                }
            },
            'artifacts': {
                'type': 'CODEPIPELINE'|'S3'|'NO_ARTIFACTS',
                'location': 'string',
                'path': 'string',
                'namespaceType': 'NONE'|'BUILD_ID',
                'name': 'string',
                'packaging': 'NONE'|'ZIP'
            },
            'environment': {
                'type': 'LINUX_CONTAINER',
                'image': 'string',
                'computeType': 'BUILD_GENERAL1_SMALL'|'BUILD_GENERAL1_MEDIUM'|'BUILD_GENERAL1_LARGE',
                'environmentVariables': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ]
            },
            'serviceRole': 'string',
            'timeoutInMinutes': 123,
            'encryptionKey': 'string',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'created': datetime(2015, 1, 1),
            'lastModified': datetime(2015, 1, 1)
        },
    ],
    'projectsNotFound': [
        'string',
    ]
}

Response Structure

(dict) --
- projects (list) --
  
  Information about the requested build projects.
  - (dict) --
    
    Information about a build project.
    - name (string) --
      
      The build project's name.
    - arn (string) --
      
      The build project's Amazon Resource Name (ARN).
    - description (string) --
      
      A meaningful description of the build project.
    - source (dict) --
      
      Information about the build project's build input source code.
      - type (string) --
        
        The type of repository that contains the source code to be built. Valid values include:
        
        CODECOMMIT : The source code is in an AWS CodeCommit repository.
        
        CODEPIPELINE : The source code settings are specified in the source action of a pipeline in AWS CodePipeline.
        
        GITHUB : The source code is in a GitHub repository.
        
        S3 : The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
      - location (string) --
        
        Information about the location of the source code to be built. Valid values include:
        
        For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
        
        For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).
        
        For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip )
        
        For source code in a GitHub repository, the HTTPS clone URL, including the user name and personal access token, to the repository that contains the source code and the build spec (for example, https://login-user-name:personal-access-token@github.com/repo-owner-name/repo-name.git ). For more information, see Creating an Access Token for Command-Line Use on the GitHub Help website.
      - buildspec (string) --
        
        The build spec declaration to use for this build project's related builds.
        
        If this value is not specified, a build spec must be included along with the source code to be built.
      - auth (dict) --
        
        Information about the authorization settings for AWS CodeBuild to access the source code to be built.
        
        This information is only for the AWS CodeBuild console's use. Your code should not get or set this information directly.
        
        type (string) --
        
        The authorization type to use. The only valid value is OAUTH , which represents the OAuth authorization type.
        
        resource (string) --
        
        The resource value that applies to the specified authorization type.
    - artifacts (dict) --
      
      Information about the build project's build output artifacts.
      - type (string) --
        
        The build output artifact's type. Valid values include:
        
        CODEPIPELINE : The build project with have build output generated through AWS CodePipeline.
        
        NO_ARTIFACTS : The build project will not produce any build output.
        
        S3 : The build project will store build output in Amazon Simple Storage Service (Amazon S3).
      - location (string) --
        
        Information about the build output artifact location, as follows:
        
        If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.
        
        If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
        
        If type is set to S3 , this is the name of the output bucket. If path is not also specified, then location can also specify the path of the output artifact in the output bucket.
      - path (string) --
        
        Along with namespaceType and name , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
        
        If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
        
        If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
        
        If type is set to S3 , this is the path to the output artifact. If path is not specified, then path will not be used.
        
        For example, if path is set to MyArtifacts , namespaceType is set to NONE , and name is set to MyArtifact.zip , then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip .
      - namespaceType (string) --
        
        Along with path and name , the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:
        
        If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
        
        If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
        
        If type is set to S3 , then valid values include:
        
        BUILD_ID : Include the build ID in the location of the build output artifact.
        
        NONE : Do not include the build ID. This is the default if namespaceType is not specified.
        
        For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip .
      - name (string) --
        
        Along with path and namespaceType , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
        
        If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
        
        If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
        
        If type is set to S3 , this is the name of the output artifact object.
        
        For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip .
      - packaging (string) --
        
        The type of build output artifact to create, as follows:
        
        If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.
        
        If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
        
        If type is set to S3 , valid values include:
        
        NONE : AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.
        
        ZIP : AWS CodeBuild will create in the output bucket a ZIP file containing the build output.
    - environment (dict) --
      
      Information about the build environment for this build project.
      - type (string) --
        
        The type of build environment to use for related builds.
        
        The only valid value is LINUX_CONTAINER , which represents a Linux-based build environment.
      - image (string) --
        
        The ID of the Docker image to use for this build project.
      - computeType (string) --
        
        Information about the compute resources the build project will use. Available values include:
        
        BUILD_GENERAL1_SMALL : Use up to 3 GB memory and 2 vCPUs for builds.
        
        BUILD_GENERAL1_MEDIUM : Use up to 7 GB memory and 4 vCPUs for builds.
        
        BUILD_GENERAL1_LARGE : Use up to 15 GB memory and 8 vCPUs for builds.
      - environmentVariables (list) --
        
        A set of environment variables to make available to builds for this build project.
        
        (dict) --
        
        Information about an environment variable for a build project or a build.
        
        name (string) --
        
        The environment variable's name or key.
        
        value (string) --
        
        The environment variable's value.
    - serviceRole (string) --
      
      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
    - timeoutInMinutes (integer) --
      
      How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait to timeout any related build that did not get marked as completed. The default is 60 minutes.
    - encryptionKey (string) --
      
      The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project's build output artifacts.
      
      This is expressed either as the CMK's Amazon Resource Name (ARN) or, if specified, the CMK's alias (using the format alias/alias-name ).
    - tags (list) --
      
      The tags for this build project.
      
      These tags are available for use by AWS services that support AWS CodeBuild build project tags.
      - (dict) --
        
        A tag, consisting of a key and a value.
        
        This tag is available for use by AWS services that support tags in AWS CodeBuild.
        
        key (string) --
        
        The tag's key.
        
        value (string) --
        
        The tag's value.
    - created (datetime) --
      
      When the build project was created, expressed in Unix time format.
    - lastModified (datetime) --
      
      When the build project's settings were last modified, expressed in Unix time format.
- projectsNotFound (list) --
  
  The names of build projects for which information could not be found.
  - (string) --

ListCuratedEnvironmentImages (new)

Link ¶

Gets information about Docker images that are managed by AWS CodeBuild.

See also: AWS API Documentation

Request Syntax

client.list_curated_environment_images()

rtype

dict

returns

Response Syntax

{
    'platforms': [
        {
            'platform': 'DEBIAN'|'AMAZON_LINUX'|'UBUNTU',
            'languages': [
                {
                    'language': 'JAVA'|'PYTHON'|'NODE_JS'|'RUBY'|'GOLANG'|'DOCKER'|'ANDROID'|'BASE',
                    'images': [
                        {
                            'name': 'string',
                            'description': 'string'
                        },
                    ]
                },
            ]
        },
    ]
}

Response Structure

(dict) --
- platforms (list) --
  
  Information about supported platforms for Docker images that are managed by AWS CodeBuild.
  - (dict) --
    
    A set of Docker images that are related by platform and are managed by AWS CodeBuild.
    - platform (string) --
      
      The platform's name.
    - languages (list) --
      
      The list of programming languages that are available for the specified platform.
      - (dict) --
        
        A set of Docker images that are related by programming language and are managed by AWS CodeBuild.
        
        language (string) --
        
        The programming language for the related set of Docker images.
        
        images (list) --
        
        The list of Docker images that are related by the specified programming language.
        
        (dict) --
        
        Information about a Docker image that is managed by AWS CodeBuild.
        
        name (string) --
        
        The Docker image's name.
        
        description (string) --
        
        The Docker image's description.

StopBuild (new)

Link ¶

Attempts to stop running a build.

Note

Completed builds cannot be stopped.

See also: AWS API Documentation

Request Syntax

client.stop_build(
    id='string'
)

type id

string

param id

[REQUIRED]

The ID of the build to attempt to stop running.

rtype

dict

returns

Response Syntax

{
    'build': {
        'id': 'string',
        'arn': 'string',
        'startTime': datetime(2015, 1, 1),
        'endTime': datetime(2015, 1, 1),
        'currentPhase': 'string',
        'buildStatus': 'SUCCEEDED'|'FAILED'|'FAULT'|'TIMED_OUT'|'IN_PROGRESS'|'STOPPED',
        'sourceVersion': 'string',
        'projectName': 'string',
        'phases': [
            {
                'phaseType': 'SUBMITTED'|'PROVISIONING'|'DOWNLOAD_SOURCE'|'INSTALL'|'PRE_BUILD'|'BUILD'|'POST_BUILD'|'UPLOAD_ARTIFACTS'|'FINALIZING'|'COMPLETED',
                'phaseStatus': 'SUCCEEDED'|'FAILED'|'FAULT'|'TIMED_OUT'|'IN_PROGRESS'|'STOPPED',
                'startTime': datetime(2015, 1, 1),
                'endTime': datetime(2015, 1, 1),
                'durationInSeconds': 123,
                'contexts': [
                    {
                        'statusCode': 'string',
                        'message': 'string'
                    },
                ]
            },
        ],
        'source': {
            'type': 'CODECOMMIT'|'CODEPIPELINE'|'GITHUB'|'S3',
            'location': 'string',
            'buildspec': 'string',
            'auth': {
                'type': 'OAUTH',
                'resource': 'string'
            }
        },
        'artifacts': {
            'location': 'string',
            'sha256sum': 'string',
            'md5sum': 'string'
        },
        'environment': {
            'type': 'LINUX_CONTAINER',
            'image': 'string',
            'computeType': 'BUILD_GENERAL1_SMALL'|'BUILD_GENERAL1_MEDIUM'|'BUILD_GENERAL1_LARGE',
            'environmentVariables': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ]
        },
        'logs': {
            'groupName': 'string',
            'streamName': 'string',
            'deepLink': 'string'
        },
        'timeoutInMinutes': 123,
        'buildComplete': True|False,
        'initiator': 'string'
    }
}

Response Structure

(dict) --
- build (dict) --
  
  Information about the build that was attempted to be stopped.
  - id (string) --
    
    The build's unique ID.
  - arn (string) --
    
    The build's Amazon Resource Name (ARN).
  - startTime (datetime) --
    
    When the build process started, expressed in Unix time format.
  - endTime (datetime) --
    
    When the build process ended, expressed in Unix time format.
  - currentPhase (string) --
    
    The build's current build phase.
  - buildStatus (string) --
    
    The build's current status. Valid values include:
    - FAILED : The build failed.
    - FAULT : The build faulted.
    - IN_PROGRESS : The build is still in progress.
    - STOPPED : The build stopped.
    - SUCCEEDED : The build succeeded.
    - TIMED_OUT : The build timed out.
  - sourceVersion (string) --
    
    Any version identifier for the version of the source code to be built.
  - projectName (string) --
    
    The build project's name.
  - phases (list) --
    
    Information about all previous build phases that have completed, and information about any current build phase that has not yet completed.
    - (dict) --
      
      Information about a stage for a build.
      - phaseType (string) --
        
        The build phase's name. Valid values include:
        
        BUILD : Core build activities typically occur in this build phase.
        
        COMPLETED : The build has completed.
        
        DOWNLOAD_SOURCE : Source code is being downloaded in this build phase.
        
        FINALIZING : The build process is completing in this build phase.
        
        INSTALL : Installation activities typically occur in this build phase.
        
        POST_BUILD : Post-build activities typically occur in this build phase.
        
        PRE_BUILD : Pre-build activities typically occur in this build phase.
        
        PROVISIONING : The build environment is being set up.
        
        SUBMITTED : The build has been submitted.
        
        UPLOAD_ARTIFACTS : Build output artifacts are being uploaded to output location.
      - phaseStatus (string) --
        
        The build phase's current status. Valid values include:
        
        FAILED : The build phase failed.
        
        FAULT : The build phase faulted.
        
        IN_PROGRESS : The build phase is still in progress.
        
        STOPPED : The build phase stopped.
        
        SUCCEEDED : The build phase succeeded.
        
        TIMED_OUT : The build phase timed out.
      - startTime (datetime) --
        
        When the build phase started, expressed in Unix time format.
      - endTime (datetime) --
        
        When the build phase ended, expressed in Unix time format.
      - durationInSeconds (integer) --
        
        How long, in seconds, between the build's phase starting and ending times.
      - contexts (list) --
        
        Additional information about a build phase, especially to help troubleshoot a failed build.
        
        (dict) --
        
        Additional information about a build phase that has an error, which you can use to help troubleshoot a failed build.
        
        statusCode (string) --
        
        The status code for the context of the build phase.
        
        message (string) --
        
        An explanation of the build phase's context. This explanation may include a command ID and an exit code.
  - source (dict) --
    
    Information about the source code to be built.
    - type (string) --
      
      The type of repository that contains the source code to be built. Valid values include:
      - CODECOMMIT : The source code is in an AWS CodeCommit repository.
      - CODEPIPELINE : The source code settings are specified in the source action of a pipeline in AWS CodePipeline.
      - GITHUB : The source code is in a GitHub repository.
      - S3 : The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
    - location (string) --
      
      Information about the location of the source code to be built. Valid values include:
      - For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
      - For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).
      - For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip )
      - For source code in a GitHub repository, the HTTPS clone URL, including the user name and personal access token, to the repository that contains the source code and the build spec (for example, https://login-user-name:personal-access-token@github.com/repo-owner-name/repo-name.git ). For more information, see Creating an Access Token for Command-Line Use on the GitHub Help website.
    - buildspec (string) --
      
      The build spec declaration to use for this build project's related builds.
      
      If this value is not specified, a build spec must be included along with the source code to be built.
    - auth (dict) --
      
      Information about the authorization settings for AWS CodeBuild to access the source code to be built.
      
      This information is only for the AWS CodeBuild console's use. Your code should not get or set this information directly.
      - type (string) --
        
        The authorization type to use. The only valid value is OAUTH , which represents the OAuth authorization type.
      - resource (string) --
        
        The resource value that applies to the specified authorization type.
  - artifacts (dict) --
    
    Information about the build's output artifacts.
    - location (string) --
      
      Information about the build artifacts' location.
    - sha256sum (string) --
      
      The SHA-256 hash of the build artifact.
      
      You can use this hash along with a checksum tool to confirm both file integrity and authenticity.
      
      Note
      
      This value is available only if the related build project's packaging value is set to ZIP .
    - md5sum (string) --
      
      The MD5 hash of the build artifact.
      
      You can use this hash along with a checksum tool to confirm both file integrity and authenticity.
      
      Note
      
      This value is available only if the related build project's packaging value is set to ZIP .
  - environment (dict) --
    
    Information about the build environment for this build.
    - type (string) --
      
      The type of build environment to use for related builds.
      
      The only valid value is LINUX_CONTAINER , which represents a Linux-based build environment.
    - image (string) --
      
      The ID of the Docker image to use for this build project.
    - computeType (string) --
      
      Information about the compute resources the build project will use. Available values include:
      - BUILD_GENERAL1_SMALL : Use up to 3 GB memory and 2 vCPUs for builds.
      - BUILD_GENERAL1_MEDIUM : Use up to 7 GB memory and 4 vCPUs for builds.
      - BUILD_GENERAL1_LARGE : Use up to 15 GB memory and 8 vCPUs for builds.
    - environmentVariables (list) --
      
      A set of environment variables to make available to builds for this build project.
      - (dict) --
        
        Information about an environment variable for a build project or a build.
        
        name (string) --
        
        The environment variable's name or key.
        
        value (string) --
        
        The environment variable's value.
  - logs (dict) --
    
    Information about the build's logs in Amazon CloudWatch Logs.
    - groupName (string) --
      
      The name of the Amazon CloudWatch Logs group for the associated build logs.
    - streamName (string) --
      
      The name of the Amazon CloudWatch Logs stream for the associated build logs.
    - deepLink (string) --
      
      The URL to an individual build log in Amazon CloudWatch Logs.
  - timeoutInMinutes (integer) --
    
    How long in minutes for AWS CodeBuild to wait to timeout this build if it does not get marked as completed.
  - buildComplete (boolean) --
    
    Whether the build has finished. Valid values include true if completed; otherwise, false.
  - initiator (string) --
    
    The entity that started the build. Valid values include:
    - If AWS CodePipeline started the build, the pipeline's name, for example codepipeline/my-demo-pipeline .
    - If an AWS Identity and Access Management (IAM) user started the build, the user's name, for example MyUserName .
    - If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin .

CreateProject (new)

Link ¶

Creates a build project.

See also: AWS API Documentation

Request Syntax

client.create_project(
    name='string',
    description='string',
    source={
        'type': 'CODECOMMIT'|'CODEPIPELINE'|'GITHUB'|'S3',
        'location': 'string',
        'buildspec': 'string',
        'auth': {
            'type': 'OAUTH',
            'resource': 'string'
        }
    },
    artifacts={
        'type': 'CODEPIPELINE'|'S3'|'NO_ARTIFACTS',
        'location': 'string',
        'path': 'string',
        'namespaceType': 'NONE'|'BUILD_ID',
        'name': 'string',
        'packaging': 'NONE'|'ZIP'
    },
    environment={
        'type': 'LINUX_CONTAINER',
        'image': 'string',
        'computeType': 'BUILD_GENERAL1_SMALL'|'BUILD_GENERAL1_MEDIUM'|'BUILD_GENERAL1_LARGE',
        'environmentVariables': [
            {
                'name': 'string',
                'value': 'string'
            },
        ]
    },
    serviceRole='string',
    timeoutInMinutes=123,
    encryptionKey='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type name

string

param name

[REQUIRED]

The build project's name.

type description

string

param description

A meaningful description of the build project.

type source

dict

param source

[REQUIRED]

Information about the build project's build input source code.

type (string) -- [REQUIRED]

The type of repository that contains the source code to be built. Valid values include:
- CODECOMMIT : The source code is in an AWS CodeCommit repository.
- CODEPIPELINE : The source code settings are specified in the source action of a pipeline in AWS CodePipeline.
- GITHUB : The source code is in a GitHub repository.
- S3 : The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
location (string) --

Information about the location of the source code to be built. Valid values include:
- For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
- For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).
- For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip )
- For source code in a GitHub repository, the HTTPS clone URL, including the user name and personal access token, to the repository that contains the source code and the build spec (for example, https://login-user-name:personal-access-token@github.com/repo-owner-name/repo-name.git ). For more information, see Creating an Access Token for Command-Line Use on the GitHub Help website.
buildspec (string) --

The build spec declaration to use for this build project's related builds.

If this value is not specified, a build spec must be included along with the source code to be built.
auth (dict) --

Information about the authorization settings for AWS CodeBuild to access the source code to be built.

This information is only for the AWS CodeBuild console's use. Your code should not get or set this information directly.
- type (string) -- [REQUIRED]
  
  The authorization type to use. The only valid value is OAUTH , which represents the OAuth authorization type.
- resource (string) --
  
  The resource value that applies to the specified authorization type.

type artifacts

dict

param artifacts

[REQUIRED]

Information about the build project's build output artifacts.

type (string) -- [REQUIRED]

The build output artifact's type. Valid values include:
- CODEPIPELINE : The build project with have build output generated through AWS CodePipeline.
- NO_ARTIFACTS : The build project will not produce any build output.
- S3 : The build project will store build output in Amazon Simple Storage Service (Amazon S3).
location (string) --

Information about the build output artifact location, as follows:
- If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.
- If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
- If type is set to S3 , this is the name of the output bucket. If path is not also specified, then location can also specify the path of the output artifact in the output bucket.
path (string) --

Along with namespaceType and name , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
- If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
- If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
- If type is set to S3 , this is the path to the output artifact. If path is not specified, then path will not be used.
For example, if path is set to MyArtifacts , namespaceType is set to NONE , and name is set to MyArtifact.zip , then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip .
namespaceType (string) --

Along with path and name , the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:
- If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
- If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
- If type is set to S3 , then valid values include:
  - BUILD_ID : Include the build ID in the location of the build output artifact.
  - NONE : Do not include the build ID. This is the default if namespaceType is not specified.
For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip .
name (string) --

Along with path and namespaceType , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
- If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
- If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
- If type is set to S3 , this is the name of the output artifact object.
For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip .
packaging (string) --

The type of build output artifact to create, as follows:
- If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.
- If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
- If type is set to S3 , valid values include:
  - NONE : AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.
  - ZIP : AWS CodeBuild will create in the output bucket a ZIP file containing the build output.

type environment

dict

param environment

[REQUIRED]

Information about the build project's build environment.

type (string) -- [REQUIRED]

The type of build environment to use for related builds.

The only valid value is LINUX_CONTAINER , which represents a Linux-based build environment.
image (string) -- [REQUIRED]

The ID of the Docker image to use for this build project.
computeType (string) -- [REQUIRED]

Information about the compute resources the build project will use. Available values include:
- BUILD_GENERAL1_SMALL : Use up to 3 GB memory and 2 vCPUs for builds.
- BUILD_GENERAL1_MEDIUM : Use up to 7 GB memory and 4 vCPUs for builds.
- BUILD_GENERAL1_LARGE : Use up to 15 GB memory and 8 vCPUs for builds.
environmentVariables (list) --

A set of environment variables to make available to builds for this build project.
- (dict) --
  
  Information about an environment variable for a build project or a build.
  - name (string) -- [REQUIRED]
    
    The environment variable's name or key.
  - value (string) -- [REQUIRED]
    
    The environment variable's value.

type serviceRole

string

param serviceRole

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

type timeoutInMinutes

integer

param timeoutInMinutes

How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.

type encryptionKey

string

param encryptionKey

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

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

type tags

list

param tags

A set of tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

(dict) --

A tag, consisting of a key and a value.

This tag is available for use by AWS services that support tags in AWS CodeBuild.
- key (string) --
  
  The tag's key.
- value (string) --
  
  The tag's value.

rtype

dict

returns

Response Syntax

{
    'project': {
        'name': 'string',
        'arn': 'string',
        'description': 'string',
        'source': {
            'type': 'CODECOMMIT'|'CODEPIPELINE'|'GITHUB'|'S3',
            'location': 'string',
            'buildspec': 'string',
            'auth': {
                'type': 'OAUTH',
                'resource': 'string'
            }
        },
        'artifacts': {
            'type': 'CODEPIPELINE'|'S3'|'NO_ARTIFACTS',
            'location': 'string',
            'path': 'string',
            'namespaceType': 'NONE'|'BUILD_ID',
            'name': 'string',
            'packaging': 'NONE'|'ZIP'
        },
        'environment': {
            'type': 'LINUX_CONTAINER',
            'image': 'string',
            'computeType': 'BUILD_GENERAL1_SMALL'|'BUILD_GENERAL1_MEDIUM'|'BUILD_GENERAL1_LARGE',
            'environmentVariables': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ]
        },
        'serviceRole': 'string',
        'timeoutInMinutes': 123,
        'encryptionKey': 'string',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'created': datetime(2015, 1, 1),
        'lastModified': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- project (dict) --
  
  Information about the build project that was created.
  - name (string) --
    
    The build project's name.
  - arn (string) --
    
    The build project's Amazon Resource Name (ARN).
  - description (string) --
    
    A meaningful description of the build project.
  - source (dict) --
    
    Information about the build project's build input source code.
    - type (string) --
      
      The type of repository that contains the source code to be built. Valid values include:
      - CODECOMMIT : The source code is in an AWS CodeCommit repository.
      - CODEPIPELINE : The source code settings are specified in the source action of a pipeline in AWS CodePipeline.
      - GITHUB : The source code is in a GitHub repository.
      - S3 : The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
    - location (string) --
      
      Information about the location of the source code to be built. Valid values include:
      - For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
      - For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).
      - For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip )
      - For source code in a GitHub repository, the HTTPS clone URL, including the user name and personal access token, to the repository that contains the source code and the build spec (for example, https://login-user-name:personal-access-token@github.com/repo-owner-name/repo-name.git ). For more information, see Creating an Access Token for Command-Line Use on the GitHub Help website.
    - buildspec (string) --
      
      The build spec declaration to use for this build project's related builds.
      
      If this value is not specified, a build spec must be included along with the source code to be built.
    - auth (dict) --
      
      Information about the authorization settings for AWS CodeBuild to access the source code to be built.
      
      This information is only for the AWS CodeBuild console's use. Your code should not get or set this information directly.
      - type (string) --
        
        The authorization type to use. The only valid value is OAUTH , which represents the OAuth authorization type.
      - resource (string) --
        
        The resource value that applies to the specified authorization type.
  - artifacts (dict) --
    
    Information about the build project's build output artifacts.
    - type (string) --
      
      The build output artifact's type. Valid values include:
      - CODEPIPELINE : The build project with have build output generated through AWS CodePipeline.
      - NO_ARTIFACTS : The build project will not produce any build output.
      - S3 : The build project will store build output in Amazon Simple Storage Service (Amazon S3).
    - location (string) --
      
      Information about the build output artifact location, as follows:
      - If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.
      - If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
      - If type is set to S3 , this is the name of the output bucket. If path is not also specified, then location can also specify the path of the output artifact in the output bucket.
    - path (string) --
      
      Along with namespaceType and name , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
      - If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
      - If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
      - If type is set to S3 , this is the path to the output artifact. If path is not specified, then path will not be used.
      For example, if path is set to MyArtifacts , namespaceType is set to NONE , and name is set to MyArtifact.zip , then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip .
    - namespaceType (string) --
      
      Along with path and name , the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:
      - If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
      - If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
      - If type is set to S3 , then valid values include:
        
        BUILD_ID : Include the build ID in the location of the build output artifact.
        
        NONE : Do not include the build ID. This is the default if namespaceType is not specified.
      For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip .
    - name (string) --
      
      Along with path and namespaceType , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
      - If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
      - If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
      - If type is set to S3 , this is the name of the output artifact object.
      For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip .
    - packaging (string) --
      
      The type of build output artifact to create, as follows:
      - If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.
      - If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
      - If type is set to S3 , valid values include:
        
        NONE : AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.
        
        ZIP : AWS CodeBuild will create in the output bucket a ZIP file containing the build output.
  - environment (dict) --
    
    Information about the build environment for this build project.
    - type (string) --
      
      The type of build environment to use for related builds.
      
      The only valid value is LINUX_CONTAINER , which represents a Linux-based build environment.
    - image (string) --
      
      The ID of the Docker image to use for this build project.
    - computeType (string) --
      
      Information about the compute resources the build project will use. Available values include:
      - BUILD_GENERAL1_SMALL : Use up to 3 GB memory and 2 vCPUs for builds.
      - BUILD_GENERAL1_MEDIUM : Use up to 7 GB memory and 4 vCPUs for builds.
      - BUILD_GENERAL1_LARGE : Use up to 15 GB memory and 8 vCPUs for builds.
    - environmentVariables (list) --
      
      A set of environment variables to make available to builds for this build project.
      - (dict) --
        
        Information about an environment variable for a build project or a build.
        
        name (string) --
        
        The environment variable's name or key.
        
        value (string) --
        
        The environment variable's value.
  - serviceRole (string) --
    
    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
  - timeoutInMinutes (integer) --
    
    How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait to timeout any related build that did not get marked as completed. The default is 60 minutes.
  - encryptionKey (string) --
    
    The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project's build output artifacts.
    
    This is expressed either as the CMK's Amazon Resource Name (ARN) or, if specified, the CMK's alias (using the format alias/alias-name ).
  - tags (list) --
    
    The tags for this build project.
    
    These tags are available for use by AWS services that support AWS CodeBuild build project tags.
    - (dict) --
      
      A tag, consisting of a key and a value.
      
      This tag is available for use by AWS services that support tags in AWS CodeBuild.
      - key (string) --
        
        The tag's key.
      - value (string) --
        
        The tag's value.
  - created (datetime) --
    
    When the build project was created, expressed in Unix time format.
  - lastModified (datetime) --
    
    When the build project's settings were last modified, expressed in Unix time format.

ListBuilds (new)

Link ¶

Gets a list of build IDs, with each build ID representing a single build.

See also: AWS API Documentation

Request Syntax

client.list_builds(
    sortOrder='ASCENDING'|'DESCENDING',
    nextToken='string'
)

type sortOrder

string

param sortOrder

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.

type nextToken

string

param nextToken

rtype

dict

returns

Response Syntax

{
    'ids': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- ids (list) --
  
  A list of build IDs, with each build ID representing a single build.
  - (string) --
- nextToken (string) --
  
  If there are more than 100 items in the list, only the first 100 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.

StartBuild (new)

Link ¶

Starts running a build.

See also: AWS API Documentation

Request Syntax

client.start_build(
    projectName='string',
    sourceVersion='string',
    artifactsOverride={
        'type': 'CODEPIPELINE'|'S3'|'NO_ARTIFACTS',
        'location': 'string',
        'path': 'string',
        'namespaceType': 'NONE'|'BUILD_ID',
        'name': 'string',
        'packaging': 'NONE'|'ZIP'
    },
    environmentVariablesOverride=[
        {
            'name': 'string',
            'value': 'string'
        },
    ],
    buildspecOverride='string',
    timeoutInMinutesOverride=123
)

type projectName

string

param projectName

[REQUIRED]

The name of the build project to start running a build.

type sourceVersion

string

param sourceVersion

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

For AWS CodeCommit or GitHub: the commit ID to use.
For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.

type artifactsOverride

dict

param artifactsOverride

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

type (string) -- [REQUIRED]

The build output artifact's type. Valid values include:
- CODEPIPELINE : The build project with have build output generated through AWS CodePipeline.
- NO_ARTIFACTS : The build project will not produce any build output.
- S3 : The build project will store build output in Amazon Simple Storage Service (Amazon S3).
location (string) --

Information about the build output artifact location, as follows:
- If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.
- If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
- If type is set to S3 , this is the name of the output bucket. If path is not also specified, then location can also specify the path of the output artifact in the output bucket.
path (string) --

Along with namespaceType and name , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
- If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
- If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
- If type is set to S3 , this is the path to the output artifact. If path is not specified, then path will not be used.
For example, if path is set to MyArtifacts , namespaceType is set to NONE , and name is set to MyArtifact.zip , then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip .
namespaceType (string) --

Along with path and name , the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:
- If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
- If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
- If type is set to S3 , then valid values include:
  - BUILD_ID : Include the build ID in the location of the build output artifact.
  - NONE : Do not include the build ID. This is the default if namespaceType is not specified.
For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip .
name (string) --

Along with path and namespaceType , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
- If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
- If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
- If type is set to S3 , this is the name of the output artifact object.
For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip .
packaging (string) --

The type of build output artifact to create, as follows:
- If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.
- If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
- If type is set to S3 , valid values include:
  - NONE : AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.
  - ZIP : AWS CodeBuild will create in the output bucket a ZIP file containing the build output.

type environmentVariablesOverride

list

param environmentVariablesOverride

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

(dict) --

Information about an environment variable for a build project or a build.
- name (string) -- [REQUIRED]
  
  The environment variable's name or key.
- value (string) -- [REQUIRED]
  
  The environment variable's value.

type buildspecOverride

string

param buildspecOverride

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

type timeoutInMinutesOverride

integer

param timeoutInMinutesOverride

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

rtype

dict

returns

Response Syntax

{
    'build': {
        'id': 'string',
        'arn': 'string',
        'startTime': datetime(2015, 1, 1),
        'endTime': datetime(2015, 1, 1),
        'currentPhase': 'string',
        'buildStatus': 'SUCCEEDED'|'FAILED'|'FAULT'|'TIMED_OUT'|'IN_PROGRESS'|'STOPPED',
        'sourceVersion': 'string',
        'projectName': 'string',
        'phases': [
            {
                'phaseType': 'SUBMITTED'|'PROVISIONING'|'DOWNLOAD_SOURCE'|'INSTALL'|'PRE_BUILD'|'BUILD'|'POST_BUILD'|'UPLOAD_ARTIFACTS'|'FINALIZING'|'COMPLETED',
                'phaseStatus': 'SUCCEEDED'|'FAILED'|'FAULT'|'TIMED_OUT'|'IN_PROGRESS'|'STOPPED',
                'startTime': datetime(2015, 1, 1),
                'endTime': datetime(2015, 1, 1),
                'durationInSeconds': 123,
                'contexts': [
                    {
                        'statusCode': 'string',
                        'message': 'string'
                    },
                ]
            },
        ],
        'source': {
            'type': 'CODECOMMIT'|'CODEPIPELINE'|'GITHUB'|'S3',
            'location': 'string',
            'buildspec': 'string',
            'auth': {
                'type': 'OAUTH',
                'resource': 'string'
            }
        },
        'artifacts': {
            'location': 'string',
            'sha256sum': 'string',
            'md5sum': 'string'
        },
        'environment': {
            'type': 'LINUX_CONTAINER',
            'image': 'string',
            'computeType': 'BUILD_GENERAL1_SMALL'|'BUILD_GENERAL1_MEDIUM'|'BUILD_GENERAL1_LARGE',
            'environmentVariables': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ]
        },
        'logs': {
            'groupName': 'string',
            'streamName': 'string',
            'deepLink': 'string'
        },
        'timeoutInMinutes': 123,
        'buildComplete': True|False,
        'initiator': 'string'
    }
}

Response Structure

(dict) --
- build (dict) --
  
  Information about the build to be run.
  - id (string) --
    
    The build's unique ID.
  - arn (string) --
    
    The build's Amazon Resource Name (ARN).
  - startTime (datetime) --
    
    When the build process started, expressed in Unix time format.
  - endTime (datetime) --
    
    When the build process ended, expressed in Unix time format.
  - currentPhase (string) --
    
    The build's current build phase.
  - buildStatus (string) --
    
    The build's current status. Valid values include:
    - FAILED : The build failed.
    - FAULT : The build faulted.
    - IN_PROGRESS : The build is still in progress.
    - STOPPED : The build stopped.
    - SUCCEEDED : The build succeeded.
    - TIMED_OUT : The build timed out.
  - sourceVersion (string) --
    
    Any version identifier for the version of the source code to be built.
  - projectName (string) --
    
    The build project's name.
  - phases (list) --
    
    Information about all previous build phases that have completed, and information about any current build phase that has not yet completed.
    - (dict) --
      
      Information about a stage for a build.
      - phaseType (string) --
        
        The build phase's name. Valid values include:
        
        BUILD : Core build activities typically occur in this build phase.
        
        COMPLETED : The build has completed.
        
        DOWNLOAD_SOURCE : Source code is being downloaded in this build phase.
        
        FINALIZING : The build process is completing in this build phase.
        
        INSTALL : Installation activities typically occur in this build phase.
        
        POST_BUILD : Post-build activities typically occur in this build phase.
        
        PRE_BUILD : Pre-build activities typically occur in this build phase.
        
        PROVISIONING : The build environment is being set up.
        
        SUBMITTED : The build has been submitted.
        
        UPLOAD_ARTIFACTS : Build output artifacts are being uploaded to output location.
      - phaseStatus (string) --
        
        The build phase's current status. Valid values include:
        
        FAILED : The build phase failed.
        
        FAULT : The build phase faulted.
        
        IN_PROGRESS : The build phase is still in progress.
        
        STOPPED : The build phase stopped.
        
        SUCCEEDED : The build phase succeeded.
        
        TIMED_OUT : The build phase timed out.
      - startTime (datetime) --
        
        When the build phase started, expressed in Unix time format.
      - endTime (datetime) --
        
        When the build phase ended, expressed in Unix time format.
      - durationInSeconds (integer) --
        
        How long, in seconds, between the build's phase starting and ending times.
      - contexts (list) --
        
        Additional information about a build phase, especially to help troubleshoot a failed build.
        
        (dict) --
        
        Additional information about a build phase that has an error, which you can use to help troubleshoot a failed build.
        
        statusCode (string) --
        
        The status code for the context of the build phase.
        
        message (string) --
        
        An explanation of the build phase's context. This explanation may include a command ID and an exit code.
  - source (dict) --
    
    Information about the source code to be built.
    - type (string) --
      
      The type of repository that contains the source code to be built. Valid values include:
      - CODECOMMIT : The source code is in an AWS CodeCommit repository.
      - CODEPIPELINE : The source code settings are specified in the source action of a pipeline in AWS CodePipeline.
      - GITHUB : The source code is in a GitHub repository.
      - S3 : The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
    - location (string) --
      
      Information about the location of the source code to be built. Valid values include:
      - For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
      - For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).
      - For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip )
      - For source code in a GitHub repository, the HTTPS clone URL, including the user name and personal access token, to the repository that contains the source code and the build spec (for example, https://login-user-name:personal-access-token@github.com/repo-owner-name/repo-name.git ). For more information, see Creating an Access Token for Command-Line Use on the GitHub Help website.
    - buildspec (string) --
      
      The build spec declaration to use for this build project's related builds.
      
      If this value is not specified, a build spec must be included along with the source code to be built.
    - auth (dict) --
      
      Information about the authorization settings for AWS CodeBuild to access the source code to be built.
      
      This information is only for the AWS CodeBuild console's use. Your code should not get or set this information directly.
      - type (string) --
        
        The authorization type to use. The only valid value is OAUTH , which represents the OAuth authorization type.
      - resource (string) --
        
        The resource value that applies to the specified authorization type.
  - artifacts (dict) --
    
    Information about the build's output artifacts.
    - location (string) --
      
      Information about the build artifacts' location.
    - sha256sum (string) --
      
      The SHA-256 hash of the build artifact.
      
      You can use this hash along with a checksum tool to confirm both file integrity and authenticity.
      
      Note
      
      This value is available only if the related build project's packaging value is set to ZIP .
    - md5sum (string) --
      
      The MD5 hash of the build artifact.
      
      You can use this hash along with a checksum tool to confirm both file integrity and authenticity.
      
      Note
      
      This value is available only if the related build project's packaging value is set to ZIP .
  - environment (dict) --
    
    Information about the build environment for this build.
    - type (string) --
      
      The type of build environment to use for related builds.
      
      The only valid value is LINUX_CONTAINER , which represents a Linux-based build environment.
    - image (string) --
      
      The ID of the Docker image to use for this build project.
    - computeType (string) --
      
      Information about the compute resources the build project will use. Available values include:
      - BUILD_GENERAL1_SMALL : Use up to 3 GB memory and 2 vCPUs for builds.
      - BUILD_GENERAL1_MEDIUM : Use up to 7 GB memory and 4 vCPUs for builds.
      - BUILD_GENERAL1_LARGE : Use up to 15 GB memory and 8 vCPUs for builds.
    - environmentVariables (list) --
      
      A set of environment variables to make available to builds for this build project.
      - (dict) --
        
        Information about an environment variable for a build project or a build.
        
        name (string) --
        
        The environment variable's name or key.
        
        value (string) --
        
        The environment variable's value.
  - logs (dict) --
    
    Information about the build's logs in Amazon CloudWatch Logs.
    - groupName (string) --
      
      The name of the Amazon CloudWatch Logs group for the associated build logs.
    - streamName (string) --
      
      The name of the Amazon CloudWatch Logs stream for the associated build logs.
    - deepLink (string) --
      
      The URL to an individual build log in Amazon CloudWatch Logs.
  - timeoutInMinutes (integer) --
    
    How long in minutes for AWS CodeBuild to wait to timeout this build if it does not get marked as completed.
  - buildComplete (boolean) --
    
    Whether the build has finished. Valid values include true if completed; otherwise, false.
  - initiator (string) --
    
    The entity that started the build. Valid values include:
    - If AWS CodePipeline started the build, the pipeline's name, for example codepipeline/my-demo-pipeline .
    - If an AWS Identity and Access Management (IAM) user started the build, the user's name, for example MyUserName .
    - If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin .

ListBuildsForProject (new)

Link ¶

Gets a list of build IDs for the specified build project, with each build ID representing a single build.

See also: AWS API Documentation

Request Syntax

client.list_builds_for_project(
    projectName='string',
    sortOrder='ASCENDING'|'DESCENDING',
    nextToken='string'
)

type projectName

string

param projectName

[REQUIRED]

The name of the build project to get a list of build IDs for.

type sortOrder

string

param sortOrder

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.

type nextToken

string

param nextToken

rtype

dict

returns

Response Syntax

{
    'ids': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- ids (list) --
  
  A list of build IDs for the specified build project, with each build ID representing a single build.
  - (string) --
- nextToken (string) --
  
  If there are more than 100 items in the list, only the first 100 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.

UpdateProject (new)

Link ¶

Changes the settings of an existing build project.

See also: AWS API Documentation

Request Syntax

client.update_project(
    name='string',
    description='string',
    source={
        'type': 'CODECOMMIT'|'CODEPIPELINE'|'GITHUB'|'S3',
        'location': 'string',
        'buildspec': 'string',
        'auth': {
            'type': 'OAUTH',
            'resource': 'string'
        }
    },
    artifacts={
        'type': 'CODEPIPELINE'|'S3'|'NO_ARTIFACTS',
        'location': 'string',
        'path': 'string',
        'namespaceType': 'NONE'|'BUILD_ID',
        'name': 'string',
        'packaging': 'NONE'|'ZIP'
    },
    environment={
        'type': 'LINUX_CONTAINER',
        'image': 'string',
        'computeType': 'BUILD_GENERAL1_SMALL'|'BUILD_GENERAL1_MEDIUM'|'BUILD_GENERAL1_LARGE',
        'environmentVariables': [
            {
                'name': 'string',
                'value': 'string'
            },
        ]
    },
    serviceRole='string',
    timeoutInMinutes=123,
    encryptionKey='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type name

string

param name

[REQUIRED]

The name of the existing build project to change settings.

Note

You cannot change an existing build project's name.

type description

string

param description

A new or replacement description of the build project.

type source

dict

param source

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

type (string) -- [REQUIRED]

The type of repository that contains the source code to be built. Valid values include:
- CODECOMMIT : The source code is in an AWS CodeCommit repository.
- CODEPIPELINE : The source code settings are specified in the source action of a pipeline in AWS CodePipeline.
- GITHUB : The source code is in a GitHub repository.
- S3 : The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
location (string) --

Information about the location of the source code to be built. Valid values include:
- For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
- For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).
- For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip )
- For source code in a GitHub repository, the HTTPS clone URL, including the user name and personal access token, to the repository that contains the source code and the build spec (for example, https://login-user-name:personal-access-token@github.com/repo-owner-name/repo-name.git ). For more information, see Creating an Access Token for Command-Line Use on the GitHub Help website.
buildspec (string) --

The build spec declaration to use for this build project's related builds.

If this value is not specified, a build spec must be included along with the source code to be built.
auth (dict) --

Information about the authorization settings for AWS CodeBuild to access the source code to be built.

This information is only for the AWS CodeBuild console's use. Your code should not get or set this information directly.
- type (string) -- [REQUIRED]
  
  The authorization type to use. The only valid value is OAUTH , which represents the OAuth authorization type.
- resource (string) --
  
  The resource value that applies to the specified authorization type.

type artifacts

dict

param artifacts

Information to be changed about the build project's build output artifacts.

type (string) -- [REQUIRED]

The build output artifact's type. Valid values include:
- CODEPIPELINE : The build project with have build output generated through AWS CodePipeline.
- NO_ARTIFACTS : The build project will not produce any build output.
- S3 : The build project will store build output in Amazon Simple Storage Service (Amazon S3).
location (string) --

Information about the build output artifact location, as follows:
- If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.
- If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
- If type is set to S3 , this is the name of the output bucket. If path is not also specified, then location can also specify the path of the output artifact in the output bucket.
path (string) --

Along with namespaceType and name , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
- If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
- If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
- If type is set to S3 , this is the path to the output artifact. If path is not specified, then path will not be used.
For example, if path is set to MyArtifacts , namespaceType is set to NONE , and name is set to MyArtifact.zip , then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip .
namespaceType (string) --

Along with path and name , the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:
- If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
- If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
- If type is set to S3 , then valid values include:
  - BUILD_ID : Include the build ID in the location of the build output artifact.
  - NONE : Do not include the build ID. This is the default if namespaceType is not specified.
For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip .
name (string) --

Along with path and namespaceType , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
- If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
- If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
- If type is set to S3 , this is the name of the output artifact object.
For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip .
packaging (string) --

The type of build output artifact to create, as follows:
- If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.
- If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
- If type is set to S3 , valid values include:
  - NONE : AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.
  - ZIP : AWS CodeBuild will create in the output bucket a ZIP file containing the build output.

type environment

dict

param environment

Information to be changed about the build project's build environment.

type (string) -- [REQUIRED]

The type of build environment to use for related builds.

The only valid value is LINUX_CONTAINER , which represents a Linux-based build environment.
image (string) -- [REQUIRED]

The ID of the Docker image to use for this build project.
computeType (string) -- [REQUIRED]

Information about the compute resources the build project will use. Available values include:
- BUILD_GENERAL1_SMALL : Use up to 3 GB memory and 2 vCPUs for builds.
- BUILD_GENERAL1_MEDIUM : Use up to 7 GB memory and 4 vCPUs for builds.
- BUILD_GENERAL1_LARGE : Use up to 15 GB memory and 8 vCPUs for builds.
environmentVariables (list) --

A set of environment variables to make available to builds for this build project.
- (dict) --
  
  Information about an environment variable for a build project or a build.
  - name (string) -- [REQUIRED]
    
    The environment variable's name or key.
  - value (string) -- [REQUIRED]
    
    The environment variable's value.

type serviceRole

string

param serviceRole

The replacement Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

type timeoutInMinutes

integer

param timeoutInMinutes

The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait to timeout any related build that did not get marked as completed.

type encryptionKey

string

param encryptionKey

The replacement AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project's build output artifacts.

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

type tags

list

param tags

The replacement set of tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

(dict) --

A tag, consisting of a key and a value.

This tag is available for use by AWS services that support tags in AWS CodeBuild.
- key (string) --
  
  The tag's key.
- value (string) --
  
  The tag's value.

rtype

dict

returns

Response Syntax

{
    'project': {
        'name': 'string',
        'arn': 'string',
        'description': 'string',
        'source': {
            'type': 'CODECOMMIT'|'CODEPIPELINE'|'GITHUB'|'S3',
            'location': 'string',
            'buildspec': 'string',
            'auth': {
                'type': 'OAUTH',
                'resource': 'string'
            }
        },
        'artifacts': {
            'type': 'CODEPIPELINE'|'S3'|'NO_ARTIFACTS',
            'location': 'string',
            'path': 'string',
            'namespaceType': 'NONE'|'BUILD_ID',
            'name': 'string',
            'packaging': 'NONE'|'ZIP'
        },
        'environment': {
            'type': 'LINUX_CONTAINER',
            'image': 'string',
            'computeType': 'BUILD_GENERAL1_SMALL'|'BUILD_GENERAL1_MEDIUM'|'BUILD_GENERAL1_LARGE',
            'environmentVariables': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ]
        },
        'serviceRole': 'string',
        'timeoutInMinutes': 123,
        'encryptionKey': 'string',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'created': datetime(2015, 1, 1),
        'lastModified': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- project (dict) --
  
  Information about the build project that was changed.
  - name (string) --
    
    The build project's name.
  - arn (string) --
    
    The build project's Amazon Resource Name (ARN).
  - description (string) --
    
    A meaningful description of the build project.
  - source (dict) --
    
    Information about the build project's build input source code.
    - type (string) --
      
      The type of repository that contains the source code to be built. Valid values include:
      - CODECOMMIT : The source code is in an AWS CodeCommit repository.
      - CODEPIPELINE : The source code settings are specified in the source action of a pipeline in AWS CodePipeline.
      - GITHUB : The source code is in a GitHub repository.
      - S3 : The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
    - location (string) --
      
      Information about the location of the source code to be built. Valid values include:
      - For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
      - For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).
      - For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip )
      - For source code in a GitHub repository, the HTTPS clone URL, including the user name and personal access token, to the repository that contains the source code and the build spec (for example, https://login-user-name:personal-access-token@github.com/repo-owner-name/repo-name.git ). For more information, see Creating an Access Token for Command-Line Use on the GitHub Help website.
    - buildspec (string) --
      
      The build spec declaration to use for this build project's related builds.
      
      If this value is not specified, a build spec must be included along with the source code to be built.
    - auth (dict) --
      
      Information about the authorization settings for AWS CodeBuild to access the source code to be built.
      
      This information is only for the AWS CodeBuild console's use. Your code should not get or set this information directly.
      - type (string) --
        
        The authorization type to use. The only valid value is OAUTH , which represents the OAuth authorization type.
      - resource (string) --
        
        The resource value that applies to the specified authorization type.
  - artifacts (dict) --
    
    Information about the build project's build output artifacts.
    - type (string) --
      
      The build output artifact's type. Valid values include:
      - CODEPIPELINE : The build project with have build output generated through AWS CodePipeline.
      - NO_ARTIFACTS : The build project will not produce any build output.
      - S3 : The build project will store build output in Amazon Simple Storage Service (Amazon S3).
    - location (string) --
      
      Information about the build output artifact location, as follows:
      - If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.
      - If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
      - If type is set to S3 , this is the name of the output bucket. If path is not also specified, then location can also specify the path of the output artifact in the output bucket.
    - path (string) --
      
      Along with namespaceType and name , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
      - If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
      - If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
      - If type is set to S3 , this is the path to the output artifact. If path is not specified, then path will not be used.
      For example, if path is set to MyArtifacts , namespaceType is set to NONE , and name is set to MyArtifact.zip , then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip .
    - namespaceType (string) --
      
      Along with path and name , the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:
      - If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
      - If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
      - If type is set to S3 , then valid values include:
        
        BUILD_ID : Include the build ID in the location of the build output artifact.
        
        NONE : Do not include the build ID. This is the default if namespaceType is not specified.
      For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip .
    - name (string) --
      
      Along with path and namespaceType , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
      - If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
      - If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
      - If type is set to S3 , this is the name of the output artifact object.
      For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip .
    - packaging (string) --
      
      The type of build output artifact to create, as follows:
      - If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.
      - If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
      - If type is set to S3 , valid values include:
        
        NONE : AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.
        
        ZIP : AWS CodeBuild will create in the output bucket a ZIP file containing the build output.
  - environment (dict) --
    
    Information about the build environment for this build project.
    - type (string) --
      
      The type of build environment to use for related builds.
      
      The only valid value is LINUX_CONTAINER , which represents a Linux-based build environment.
    - image (string) --
      
      The ID of the Docker image to use for this build project.
    - computeType (string) --
      
      Information about the compute resources the build project will use. Available values include:
      - BUILD_GENERAL1_SMALL : Use up to 3 GB memory and 2 vCPUs for builds.
      - BUILD_GENERAL1_MEDIUM : Use up to 7 GB memory and 4 vCPUs for builds.
      - BUILD_GENERAL1_LARGE : Use up to 15 GB memory and 8 vCPUs for builds.
    - environmentVariables (list) --
      
      A set of environment variables to make available to builds for this build project.
      - (dict) --
        
        Information about an environment variable for a build project or a build.
        
        name (string) --
        
        The environment variable's name or key.
        
        value (string) --
        
        The environment variable's value.
  - serviceRole (string) --
    
    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
  - timeoutInMinutes (integer) --
    
    How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait to timeout any related build that did not get marked as completed. The default is 60 minutes.
  - encryptionKey (string) --
    
    The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project's build output artifacts.
    
    This is expressed either as the CMK's Amazon Resource Name (ARN) or, if specified, the CMK's alias (using the format alias/alias-name ).
  - tags (list) --
    
    The tags for this build project.
    
    These tags are available for use by AWS services that support AWS CodeBuild build project tags.
    - (dict) --
      
      A tag, consisting of a key and a value.
      
      This tag is available for use by AWS services that support tags in AWS CodeBuild.
      - key (string) --
        
        The tag's key.
      - value (string) --
        
        The tag's value.
  - created (datetime) --
    
    When the build project was created, expressed in Unix time format.
  - lastModified (datetime) --
    
    When the build project's settings were last modified, expressed in Unix time format.