2021/02/18 - AWS CodeBuild - 4 updated api methods
Changes AWS CodeBuild now allows you to specify a separate bucket owner as part of the S3 destination in a report group.
{'reportGroups': {'exportConfig': {'s3Destination': {'bucketOwner': 'string'}}}}
Returns an array of report groups.
See also: AWS API Documentation
Request Syntax
client.batch_get_report_groups(
reportGroupArns=[
'string',
]
)
list
[REQUIRED]
An array of report group ARNs that identify the report groups to return.
(string) --
dict
Response Syntax
{
'reportGroups': [
{
'arn': 'string',
'name': 'string',
'type': 'TEST'|'CODE_COVERAGE',
'exportConfig': {
'exportConfigType': 'S3'|'NO_EXPORT',
's3Destination': {
'bucket': 'string',
'bucketOwner': 'string',
'path': 'string',
'packaging': 'ZIP'|'NONE',
'encryptionKey': 'string',
'encryptionDisabled': True|False
}
},
'created': datetime(2015, 1, 1),
'lastModified': datetime(2015, 1, 1),
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'status': 'ACTIVE'|'DELETING'
},
],
'reportGroupsNotFound': [
'string',
]
}
Response Structure
(dict) --
reportGroups (list) --
The array of report groups returned by BatchGetReportGroups .
(dict) --
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 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 (dict) --
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 (dict) --
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 AWS 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 : 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 (datetime) --
The date and time this ReportGroup was created.
lastModified (datetime) --
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.
(dict) --
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.
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.
reportGroupsNotFound (list) --
An array of ARNs passed to BatchGetReportGroups that are not associated with a ReportGroup .
(string) --
{'reports': {'exportConfig': {'s3Destination': {'bucketOwner': 'string'}}}}
Returns an array of reports.
See also: AWS API Documentation
Request Syntax
client.batch_get_reports(
reportArns=[
'string',
]
)
list
[REQUIRED]
An array of ARNs that identify the Report objects to return.
(string) --
dict
Response Syntax
{
'reports': [
{
'arn': 'string',
'type': 'TEST'|'CODE_COVERAGE',
'name': 'string',
'reportGroupArn': 'string',
'executionId': 'string',
'status': 'GENERATING'|'SUCCEEDED'|'FAILED'|'INCOMPLETE'|'DELETING',
'created': datetime(2015, 1, 1),
'expired': datetime(2015, 1, 1),
'exportConfig': {
'exportConfigType': 'S3'|'NO_EXPORT',
's3Destination': {
'bucket': 'string',
'bucketOwner': 'string',
'path': 'string',
'packaging': 'ZIP'|'NONE',
'encryptionKey': 'string',
'encryptionDisabled': True|False
}
},
'truncated': True|False,
'testSummary': {
'total': 123,
'statusCounts': {
'string': 123
},
'durationInNanoSeconds': 123
},
'codeCoverageSummary': {
'lineCoveragePercentage': 123.0,
'linesCovered': 123,
'linesMissed': 123,
'branchCoveragePercentage': 123.0,
'branchesCovered': 123,
'branchesMissed': 123
}
},
],
'reportsNotFound': [
'string',
]
}
Response Structure
(dict) --
reports (list) --
The array of Report objects returned by BatchGetReports .
(dict) --
Information about the results from running a series of test cases during the run of a build project. The test cases are specified in the buildspec for the build project using one or more paths to the test case files. You can specify any type of tests you want, such as unit tests, integration tests, and functional tests.
arn (string) --
The ARN of the report run.
type (string) --
The type of the report that was run.
CODE_COVERAGE
A code coverage report.
TEST
A test report.
name (string) --
The name of the report that was run.
reportGroupArn (string) --
The ARN of the report group associated with this report.
executionId (string) --
The ARN of the build run that generated this report.
status (string) --
The status of this report.
created (datetime) --
The date and time this report run occurred.
expired (datetime) --
The date and time a report expires. A report expires 30 days after it is created. An expired report is not available to view in CodeBuild.
exportConfig (dict) --
Information about where the raw data used to generate this report was 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 (dict) --
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 AWS 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 : 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.
truncated (boolean) --
A boolean that specifies if this report run is truncated. The list of test cases is truncated after the maximum number of test cases is reached.
testSummary (dict) --
A TestReportSummary object that contains information about this test report.
total (integer) --
The number of test cases in this TestReportSummary . The total includes truncated test cases.
statusCounts (dict) --
A map that contains the number of each type of status returned by the test results in this TestReportSummary .
(string) --
(integer) --
durationInNanoSeconds (integer) --
The number of nanoseconds it took to run all of the test cases in this report.
codeCoverageSummary (dict) --
A CodeCoverageReportSummary object that contains a code coverage summary for this report.
lineCoveragePercentage (float) --
The percentage of lines that are covered by your tests.
linesCovered (integer) --
The number of lines that are covered by your tests.
linesMissed (integer) --
The number of lines that are not covered by your tests.
branchCoveragePercentage (float) --
The percentage of branches that are covered by your tests.
branchesCovered (integer) --
The number of conditional branches that are covered by your tests.
branchesMissed (integer) --
The number of conditional branches that are not covered by your tests.
reportsNotFound (list) --
An array of ARNs passed to BatchGetReportGroups that are not associated with a Report .
(string) --
{'exportConfig': {'s3Destination': {'bucketOwner': 'string'}}}
Response {'reportGroup': {'exportConfig': {'s3Destination': {'bucketOwner': 'string'}}}}
Creates a report group. A report group contains a collection of reports.
See also: AWS API Documentation
Request Syntax
client.create_report_group(
name='string',
type='TEST'|'CODE_COVERAGE',
exportConfig={
'exportConfigType': 'S3'|'NO_EXPORT',
's3Destination': {
'bucket': 'string',
'bucketOwner': 'string',
'path': 'string',
'packaging': 'ZIP'|'NONE',
'encryptionKey': 'string',
'encryptionDisabled': True|False
}
},
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The name of the report group.
string
[REQUIRED]
The type of report group.
dict
[REQUIRED]
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 (dict) --
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 AWS 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 : 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.
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.
(dict) --
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.
dict
Response Syntax
{
'reportGroup': {
'arn': 'string',
'name': 'string',
'type': 'TEST'|'CODE_COVERAGE',
'exportConfig': {
'exportConfigType': 'S3'|'NO_EXPORT',
's3Destination': {
'bucket': 'string',
'bucketOwner': 'string',
'path': 'string',
'packaging': 'ZIP'|'NONE',
'encryptionKey': 'string',
'encryptionDisabled': True|False
}
},
'created': datetime(2015, 1, 1),
'lastModified': datetime(2015, 1, 1),
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'status': 'ACTIVE'|'DELETING'
}
}
Response Structure
(dict) --
reportGroup (dict) --
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 (dict) --
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 (dict) --
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 AWS 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 : 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 (datetime) --
The date and time this ReportGroup was created.
lastModified (datetime) --
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.
(dict) --
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.
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.
{'exportConfig': {'s3Destination': {'bucketOwner': 'string'}}}
Response {'reportGroup': {'exportConfig': {'s3Destination': {'bucketOwner': 'string'}}}}
Updates a report group.
See also: AWS API Documentation
Request Syntax
client.update_report_group(
arn='string',
exportConfig={
'exportConfigType': 'S3'|'NO_EXPORT',
's3Destination': {
'bucket': 'string',
'bucketOwner': 'string',
'path': 'string',
'packaging': 'ZIP'|'NONE',
'encryptionKey': 'string',
'encryptionDisabled': True|False
}
},
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The ARN of the report group to update.
dict
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.
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 (dict) --
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 AWS 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 : 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.
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.
(dict) --
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.
dict
Response Syntax
{
'reportGroup': {
'arn': 'string',
'name': 'string',
'type': 'TEST'|'CODE_COVERAGE',
'exportConfig': {
'exportConfigType': 'S3'|'NO_EXPORT',
's3Destination': {
'bucket': 'string',
'bucketOwner': 'string',
'path': 'string',
'packaging': 'ZIP'|'NONE',
'encryptionKey': 'string',
'encryptionDisabled': True|False
}
},
'created': datetime(2015, 1, 1),
'lastModified': datetime(2015, 1, 1),
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'status': 'ACTIVE'|'DELETING'
}
}
Response Structure
(dict) --
reportGroup (dict) --
Information about the updated report group.
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 (dict) --
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 (dict) --
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 AWS 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 : 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 (datetime) --
The date and time this ReportGroup was created.
lastModified (datetime) --
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.
(dict) --
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.
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.