Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateReportGroup

Updates a report group.

Request Syntax


{
   "arn": "string",
   "exportConfig": { 
      "exportConfigType": "string",
      "s3Destination": { 
         "bucket": "string",
         "bucketOwner": "string",
         "encryptionDisabled": boolean,
         "encryptionKey": "string",
         "packaging": "string",
         "path": "string"
      }
   },
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

arn

The ARN of the report group to update.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

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.

Type: ReportExportConfig object

Required: No

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.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax


{
   "reportGroup": { 
      "arn": "string",
      "created": number,
      "exportConfig": { 
         "exportConfigType": "string",
         "s3Destination": { 
            "bucket": "string",
            "bucketOwner": "string",
            "encryptionDisabled": boolean,
            "encryptionKey": "string",
            "packaging": "string",
            "path": "string"
         }
      },
      "lastModified": number,
      "name": "string",
      "status": "string",
      "tags": [ 
         { 
            "key": "string",
            "value": "string"
         }
      ],
      "type": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

reportGroup

Information about the updated report group.

Type: ReportGroup object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidInputException

The input value that was provided is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified AWS resource cannot be found.

HTTP Status Code: 400