Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . codebuild ]

update-report-group

Description

Updates a report group.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-report-group
--arn <value>
[--export-config <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--arn (string)

The ARN of the report group to update.

--export-config (structure)

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.

Shorthand Syntax:

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

JSON Syntax:

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

--tags (list)

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.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

reportGroup -> (structure)

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