CreateReportGroup
Creates a report group. A report group contains a collection of reports.
Request Syntax
{
"exportConfig": {
"exportConfigType": "string",
"s3Destination": {
"bucket": "string",
"bucketOwner": "string",
"encryptionDisabled": boolean,
"encryptionKey": "string",
"packaging": "string",
"path": "string"
}
},
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"type": "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.
- exportConfig
-
A
ReportExportConfigobject that contains information about where the report group test results are exported.Type: ReportExportConfig object
Required: Yes
- name
-
The name of the report group.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 128.
Required: Yes
- type
-
The type of report group.
Type: String
Valid Values:
TEST | CODE_COVERAGERequired: Yes
-
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.
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 report group that was created.
Type: ReportGroup object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccountLimitExceededException
-
An AWS service limit was exceeded for the calling AWS account.
HTTP Status Code: 400
- InvalidInputException
-
The input value that was provided is not valid.
HTTP Status Code: 400
- ResourceAlreadyExistsException
-
The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
