CodeBuild / Client / create_report_group

create_report_group#

CodeBuild.Client.create_report_group(**kwargs)#

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

Request Syntax

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

Parameters:

name (string) –
[REQUIRED]

The name of the report group.
type (string) –
[REQUIRED]

The type of report group.
exportConfig (dict) –
[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.
  - bucketOwner (string) –
    
    The Amazon Web Services account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.
  - 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: CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified.
    - ZIP: 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.
tags (list) –
A list of tag key and value pairs associated with this report group.

These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
- (dict) –
  
  A tag, consisting of a key and a value.
  
  This tag is available for use by Amazon Web Services services that support tags in CodeBuild.
  - key (string) –
    
    The tag’s key.
  - value (string) –
    
    The tag’s value.

Return type:

dict

Returns:

Response Syntax

{
    'reportGroup': {
        'arn': 'string',
        'name': 'string',
        'type': 'TEST'|'CODE_COVERAGE',
        'exportConfig': {
            'exportConfigType': 'S3'|'NO_EXPORT',
            's3Destination': {
                'bucket': 'string',
                'bucketOwner': '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'
            },
        ],
        'status': 'ACTIVE'|'DELETING'
    }
}

Response Structure

(dict) –
- reportGroup (dict) –
  
  Information about the report group that was created.
  - arn (string) –
    
    The ARN of the ReportGroup.
  - name (string) –
    
    The name of the ReportGroup.
  - type (string) –
    
    The type of the ReportGroup. This can be one of the following values:
    
    CODE_COVERAGE
    
    The report group contains code coverage reports.
    
    TEST
    
    The report group contains test reports.
  - 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.
      - bucketOwner (string) –
        
        The Amazon Web Services account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.
      - 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: CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified.
        
        ZIP: 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 Amazon Web Services services that support CodeBuild report group tags.
    - (dict) –
      
      A tag, consisting of a key and a value.
      
      This tag is available for use by Amazon Web Services services that support tags in CodeBuild.
      - key (string) –
        
        The tag’s key.
      - value (string) –
        
        The tag’s value.
  - status (string) –
    
    The status of the report group. This property is read-only.
    
    This can be one of the following values:
    
    ACTIVE
    
    The report group is active.
    
    DELETING
    
    The report group is in the process of being deleted.

Exceptions

CodeBuild.Client.exceptions.InvalidInputException
CodeBuild.Client.exceptions.ResourceAlreadyExistsException
CodeBuild.Client.exceptions.AccountLimitExceededException