[ aws . codebuild ]

batch-get-report-groups

Description

Returns an array of report groups.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  batch-get-report-groups
--report-group-arns <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--report-group-arns (list)

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

(string)

Syntax:

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

reportGroups -> (list)

The array of report groups returned by BatchGetReportGroups .

(structure)

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

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 -> (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 AWS services that support AWS CodeBuild report group tags.

(structure)

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)