AWS API Changes

2020/05/21 - AWS CodeBuild - 3 updated api methods

Changes Update codebuild client to latest version

BatchGetReportGroups (updated)

Link ¶
Changes (response)

{'reportGroups': {'tags': [{'key': 'string', 'value': 'string'}]}}

Returns an array of report groups.

See also: AWS API Documentation

Request Syntax

client.batch_get_report_groups(
    reportGroupArns=[
        'string',
    ]
)

type reportGroupArns:

list

param reportGroupArns:

[REQUIRED]

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

(string) --

rtype:

dict

returns:

Response Syntax

{
    'reportGroups': [
        {
            'arn': 'string',
            'name': 'string',
            'type': 'TEST',
            'exportConfig': {
                'exportConfigType': 'S3'|'NO_EXPORT',
                's3Destination': {
                    'bucket': 'string',
                    'path': 'string',
                    'packaging': 'ZIP'|'NONE',
                    'encryptionKey': 'string',
                    'encryptionDisabled': True|False
                }
            },
            'created': datetime(2015, 1, 1),
            'lastModified': datetime(2015, 1, 1),
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ]
        },
    ],
    'reportGroupsNotFound': [
        'string',
    ]
}

Response Structure

(dict) --
- reportGroups (list) --
  
  The array of report groups returned by BatchGetReportGroups.
  - (dict) --
    
    A series of reports. Each report contains information about the results from running a series of test cases. You specify the test cases for a report group in the buildspec for a build project using one or more paths to the test case files.
    - arn (string) --
      
      The ARN of a ReportGroup.
    - name (string) --
      
      The name of a ReportGroup.
    - type (string) --
      
      The type of the ReportGroup. The one valid value is TEST.
    - exportConfig (dict) --
      
      Information about the destination where the raw data of this ReportGroup is exported.
      - exportConfigType (string) --
        
        The export configuration type. Valid values are:
        
        S3: The report results are exported to an S3 bucket.
        
        NO_EXPORT: The report results are not exported.
      - s3Destination (dict) --
        
        A S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported.
        
        bucket (string) --
        
        The name of the S3 bucket where the raw data of a report are exported.
        
        path (string) --
        
        The path to the exported report's raw data results.
        
        packaging (string) --
        
        The type of build output artifact to create. Valid values include:
        
        NONE: AWS CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified.
        
        ZIP: AWS CodeBuild creates a ZIP file with the raw data in the output bucket.
        
        encryptionKey (string) --
        
        The encryption key for the report's encrypted raw data.
        
        encryptionDisabled (boolean) --
        
        A boolean value that specifies if the results of a report are encrypted.
    - created (datetime) --
      
      The date and time this ReportGroup was created.
    - lastModified (datetime) --
      
      The date and time this ReportGroup was last modified.
    - tags (list) --
      
      A list of tag key and value pairs associated with this report group.
      
      These tags are available for use by AWS services that support AWS CodeBuild report group 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.
- reportGroupsNotFound (list) --
  
  An array of ARNs passed to BatchGetReportGroups that are not associated with a ReportGroup.
  - (string) --

CreateReportGroup (updated)

Link ¶
Changes (request, response)
Request

{'tags': [{'key': 'string', 'value': 'string'}]}

Response

{'reportGroup': {'tags': [{'key': 'string', 'value': 'string'}]}}

Creates a report group. A report group contains a collection of reports.

See also: AWS API Documentation

Request Syntax

client.create_report_group(
    name='string',
    type='TEST',
    exportConfig={
        'exportConfigType': 'S3'|'NO_EXPORT',
        's3Destination': {
            'bucket': 'string',
            'path': 'string',
            'packaging': 'ZIP'|'NONE',
            'encryptionKey': 'string',
            'encryptionDisabled': True|False
        }
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type name:

string

param name:

[REQUIRED]

The name of the report group.

type type:

string

param type:

[REQUIRED]

The type of report group.

type exportConfig:

dict

param exportConfig:

[REQUIRED]

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

exportConfigType (string) --

The export configuration type. Valid values are:
- S3: The report results are exported to an S3 bucket.
- NO_EXPORT: The report results are not exported.
s3Destination (dict) --

A S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported.
- bucket (string) --
  
  The name of the S3 bucket where the raw data of a report are exported.
- path (string) --
  
  The path to the exported report's raw data results.
- packaging (string) --
  
  The type of build output artifact to create. Valid values include:
  - NONE: AWS CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified.
  - ZIP: AWS CodeBuild creates a ZIP file with the raw data in the output bucket.
- encryptionKey (string) --
  
  The encryption key for the report's encrypted raw data.
- encryptionDisabled (boolean) --
  
  A boolean value that specifies if the results of a report are encrypted.

type tags:

list

param tags:

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

These tags are available for use by AWS services that support AWS CodeBuild report group 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

{
    'reportGroup': {
        'arn': 'string',
        'name': 'string',
        'type': 'TEST',
        'exportConfig': {
            'exportConfigType': 'S3'|'NO_EXPORT',
            's3Destination': {
                'bucket': 'string',
                'path': 'string',
                'packaging': 'ZIP'|'NONE',
                'encryptionKey': 'string',
                'encryptionDisabled': True|False
            }
        },
        'created': datetime(2015, 1, 1),
        'lastModified': datetime(2015, 1, 1),
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- reportGroup (dict) --
  
  Information about the report group that was created.
  - arn (string) --
    
    The ARN of a ReportGroup.
  - name (string) --
    
    The name of a ReportGroup.
  - type (string) --
    
    The type of the ReportGroup. The one valid value is TEST.
  - exportConfig (dict) --
    
    Information about the destination where the raw data of this ReportGroup is exported.
    - exportConfigType (string) --
      
      The export configuration type. Valid values are:
      - S3: The report results are exported to an S3 bucket.
      - NO_EXPORT: The report results are not exported.
    - s3Destination (dict) --
      
      A S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported.
      - bucket (string) --
        
        The name of the S3 bucket where the raw data of a report are exported.
      - path (string) --
        
        The path to the exported report's raw data results.
      - packaging (string) --
        
        The type of build output artifact to create. Valid values include:
        
        NONE: AWS CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified.
        
        ZIP: AWS CodeBuild creates a ZIP file with the raw data in the output bucket.
      - encryptionKey (string) --
        
        The encryption key for the report's encrypted raw data.
      - encryptionDisabled (boolean) --
        
        A boolean value that specifies if the results of a report are encrypted.
  - created (datetime) --
    
    The date and time this ReportGroup was created.
  - lastModified (datetime) --
    
    The date and time this ReportGroup was last modified.
  - tags (list) --
    
    A list of tag key and value pairs associated with this report group.
    
    These tags are available for use by AWS services that support AWS CodeBuild report group 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.

UpdateReportGroup (updated)

Link ¶
Changes (request, response)
Request

{'tags': [{'key': 'string', 'value': 'string'}]}

Response

{'reportGroup': {'tags': [{'key': 'string', 'value': 'string'}]}}

Updates a report group.

See also: AWS API Documentation

Request Syntax

client.update_report_group(
    arn='string',
    exportConfig={
        'exportConfigType': 'S3'|'NO_EXPORT',
        's3Destination': {
            'bucket': 'string',
            'path': 'string',
            'packaging': 'ZIP'|'NONE',
            'encryptionKey': 'string',
            'encryptionDisabled': True|False
        }
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type arn:

string

param arn:

[REQUIRED]

The ARN of the report group to update.

type exportConfig:

dict

param exportConfig:

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

S3: The report results are exported to an S3 bucket.
NO_EXPORT: The report results are not exported.

exportConfigType (string) --

The export configuration type. Valid values are:
- S3: The report results are exported to an S3 bucket.
- NO_EXPORT: The report results are not exported.
s3Destination (dict) --

A S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported.
- bucket (string) --
  
  The name of the S3 bucket where the raw data of a report are exported.
- path (string) --
  
  The path to the exported report's raw data results.
- packaging (string) --
  
  The type of build output artifact to create. Valid values include:
  - NONE: AWS CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified.
  - ZIP: AWS CodeBuild creates a ZIP file with the raw data in the output bucket.
- encryptionKey (string) --
  
  The encryption key for the report's encrypted raw data.
- encryptionDisabled (boolean) --
  
  A boolean value that specifies if the results of a report are encrypted.

type tags:

list

param tags:

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

These tags are available for use by AWS services that support AWS CodeBuild report group 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

{
    'reportGroup': {
        'arn': 'string',
        'name': 'string',
        'type': 'TEST',
        'exportConfig': {
            'exportConfigType': 'S3'|'NO_EXPORT',
            's3Destination': {
                'bucket': 'string',
                'path': 'string',
                'packaging': 'ZIP'|'NONE',
                'encryptionKey': 'string',
                'encryptionDisabled': True|False
            }
        },
        'created': datetime(2015, 1, 1),
        'lastModified': datetime(2015, 1, 1),
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- reportGroup (dict) --
  
  Information about the updated report group.
  - arn (string) --
    
    The ARN of a ReportGroup.
  - name (string) --
    
    The name of a ReportGroup.
  - type (string) --
    
    The type of the ReportGroup. The one valid value is TEST.
  - exportConfig (dict) --
    
    Information about the destination where the raw data of this ReportGroup is exported.
    - exportConfigType (string) --
      
      The export configuration type. Valid values are:
      - S3: The report results are exported to an S3 bucket.
      - NO_EXPORT: The report results are not exported.
    - s3Destination (dict) --
      
      A S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported.
      - bucket (string) --
        
        The name of the S3 bucket where the raw data of a report are exported.
      - path (string) --
        
        The path to the exported report's raw data results.
      - packaging (string) --
        
        The type of build output artifact to create. Valid values include:
        
        NONE: AWS CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified.
        
        ZIP: AWS CodeBuild creates a ZIP file with the raw data in the output bucket.
      - encryptionKey (string) --
        
        The encryption key for the report's encrypted raw data.
      - encryptionDisabled (boolean) --
        
        A boolean value that specifies if the results of a report are encrypted.
  - created (datetime) --
    
    The date and time this ReportGroup was created.
  - lastModified (datetime) --
    
    The date and time this ReportGroup was last modified.
  - tags (list) --
    
    A list of tag key and value pairs associated with this report group.
    
    These tags are available for use by AWS services that support AWS CodeBuild report group 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.