AWS CLI Command Reference

[ aws . codebuild ]

create-report-group

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-report-group
--name <value>
--type <value>
--export-config <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the report group.

--type (string)

The type of report group.

Possible values:

  • TEST

  • CODE_COVERAGE

--export-config (structure)

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 -> (structure)

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.

Shorthand Syntax:

exportConfigType=string,s3Destination={bucket=string,bucketOwner=string,path=string,packaging=string,encryptionKey=string,encryptionDisabled=boolean}

JSON Syntax:

{
  "exportConfigType": "S3"|"NO_EXPORT",
  "s3Destination": {
    "bucket": "string",
    "bucketOwner": "string",
    "path": "string",
    "packaging": "ZIP"|"NONE",
    "encryptionKey": "string",
    "encryptionDisabled": true|false
  }
}

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

(structure)

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.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a report group in AWS CodeBuild.

The following create-report-group example creates a new report group.

aws codebuild create-report-group \
    --cli-input-json file://create-report-group-source.json

Contents of create-report-group-source.json:

{
    "name": "cli-created-report-group",
    "type": "TEST",
    "exportConfig": {
        "exportConfigType": "S3",
        "s3Destination": {
            "bucket": "my-s3-bucket",
            "path": "",
            "packaging": "ZIP",
            "encryptionDisabled": true
        }
    }
}

Output:

{
    "reportGroup": {
        "arn": "arn:aws:codebuild:<region-ID>:<user-ID>:report-group/cli-created-report-group",
        "name": "cli-created-report-group",
        "type": "TEST",
        "exportConfig": {
            "exportConfigType": "S3",
            "s3Destination": {
                "bucket": "my-s3-bucket",
                "path": "",
                "packaging": "ZIP",
                "encryptionDisabled": true
            }
        },
        "created": 1602020026.775,
        "lastModified": 1602020026.775
    }
}

For more information, see Working with report groups in the AWS CodeBuild User Guide.

Output

reportGroup -> (structure)

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 -> (structure)

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 -> (structure)

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 -> (timestamp)

The date and time this ReportGroup was created.

lastModified -> (timestamp)

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.

(structure)

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.

© Copyright 2018, Amazon Web Services. Created using Sphinx.