CodeBuild / Client / batch_get_command_executions

batch_get_command_executions

CodeBuild.Client.batch_get_command_executions(**kwargs)

Gets information about the command executions.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_command_executions(
    sandboxId='string',
    commandExecutionIds=[
        'string',
    ]
)
Parameters:

  • sandboxId (string) –

    [REQUIRED]

    A sandboxId or sandboxArn.

  • commandExecutionIds (list) –

    [REQUIRED]

    A comma separated list of commandExecutionIds.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'commandExecutions': [
        {
            'id': 'string',
            'sandboxId': 'string',
            'submitTime': datetime(2015, 1, 1),
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'status': 'string',
            'command': 'string',
            'type': 'SHELL',
            'exitCode': 'string',
            'standardOutputContent': 'string',
            'standardErrContent': 'string',
            'logs': {
                'groupName': 'string',
                'streamName': 'string',
                'deepLink': 'string',
                's3DeepLink': 'string',
                'cloudWatchLogsArn': 'string',
                's3LogsArn': 'string',
                'cloudWatchLogs': {
                    'status': 'ENABLED'|'DISABLED',
                    'groupName': 'string',
                    'streamName': 'string'
                },
                's3Logs': {
                    'status': 'ENABLED'|'DISABLED',
                    'location': 'string',
                    'encryptionDisabled': True|False,
                    'bucketOwnerAccess': 'NONE'|'READ_ONLY'|'FULL'
                }
            },
            'sandboxArn': 'string'
        },
    ],
    'commandExecutionsNotFound': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • commandExecutions (list) –

      Information about the requested command executions.

      • (dict) –

        Contains command execution information.

        • id (string) –

          The ID of the command execution.

        • sandboxId (string) –

          A sandboxId.

        • submitTime (datetime) –

          When the command execution process was initially submitted, expressed in Unix time format.

        • startTime (datetime) –

          When the command execution process started, expressed in Unix time format.

        • endTime (datetime) –

          When the command execution process ended, expressed in Unix time format.

        • status (string) –

          The status of the command execution.

        • command (string) –

          The command that needs to be executed.

        • type (string) –

          The command type.

        • exitCode (string) –

          The exit code to return upon completion.

        • standardOutputContent (string) –

          The text written by the command to stdout.

        • standardErrContent (string) –

          The text written by the command to stderr.

        • logs (dict) –

          Information about build logs in CloudWatch Logs.

          • groupName (string) –

            The name of the CloudWatch Logs group for the build logs.

          • streamName (string) –

            The name of the CloudWatch Logs stream for the build logs.

          • deepLink (string) –

            The URL to an individual build log in CloudWatch Logs. The log stream is created during the PROVISIONING phase of a build and the deeplink will not be valid until it is created.

          • s3DeepLink (string) –

            The URL to a build log in an S3 bucket.

          • cloudWatchLogsArn (string) –

            The ARN of the CloudWatch Logs stream for a build execution. Its format is arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}. The CloudWatch Logs stream is created during the PROVISIONING phase of a build and the ARN will not be valid until it is created. For more information, see Resources Defined by CloudWatch Logs.

          • s3LogsArn (string) –

            The ARN of S3 logs for a build project. Its format is arn:${Partition}:s3:::${BucketName}/${ObjectName}. For more information, see Resources Defined by Amazon S3.

          • cloudWatchLogs (dict) –

            Information about CloudWatch Logs for a build project.

            • status (string) –

              The current status of the logs in CloudWatch Logs for a build project. Valid values are:

              • ENABLED: CloudWatch Logs are enabled for this build project.

              • DISABLED: CloudWatch Logs are not enabled for this build project.

            • groupName (string) –

              The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.

            • streamName (string) –

              The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.

          • s3Logs (dict) –

            Information about S3 logs for a build project.

            • status (string) –

              The current status of the S3 build logs. Valid values are:

              • ENABLED: S3 build logs are enabled for this build project.

              • DISABLED: S3 build logs are not enabled for this build project.

            • location (string) –

              The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket, and your path prefix is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log.

            • encryptionDisabled (boolean) –

              Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.

            • bucketOwnerAccess (string) –

              Specifies the bucket owner’s access for objects that another account uploads to their Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has access to these objects. This property allows you to give the bucket owner access to these objects.

              Note

              To use this property, your CodeBuild service role must have the s3:PutBucketAcl permission. This permission allows CodeBuild to modify the access control list for the bucket.

              This property can be one of the following values:

              NONE

              The bucket owner does not have access to the objects. This is the default.

              READ_ONLY

              The bucket owner has read-only access to the objects. The uploading account retains ownership of the objects.

              FULL

              The bucket owner has full access to the objects. Object ownership is determined by the following criteria:

              • If the bucket is configured with the Bucket owner preferred setting, the bucket owner owns the objects. The uploading account will have object access as specified by the bucket’s policy.

              • Otherwise, the uploading account retains ownership of the objects.

              For more information about Amazon S3 object ownership, see Controlling ownership of uploaded objects using S3 Object Ownership in the Amazon Simple Storage Service User Guide.

        • sandboxArn (string) –

          A sandboxArn.

    • commandExecutionsNotFound (list) –

      The IDs of command executions for which information could not be found.

      • (string) –

Exceptions