report_groups

Creates, updates, deletes, gets or lists a report_groups resource.

Overview

Name	report_groups
Type	Resource
Id	aws.codebuild.report_groups

Fields

The following fields are returned by SELECT queries:

batch_get_report_groups

Name	Datatype	Description
report_groups	array	The array of report groups returned by BatchGetReportGroups.
report_groups_not_found	array	An array of ARNs passed to BatchGetReportGroups that are not associated with a ReportGroup.

list_report_groups

Name	Datatype	Description
report_group	string	The list of ARNs for the report groups in the current Amazon Web Services account.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_report_groups	select	region		Returns an array of report groups.
list_report_groups	select	region		Gets a list ARNs for the report groups in the current Amazon Web Services account.
create_report_group	insert	region, name, type, exportConfig		Creates a report group. A report group contains a collection of reports.
update_report_group	update	region, arn		Updates a report group.
delete_report_group	delete	region		Deletes a report group. Before you delete a report group, you must delete its reports.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

batch_get_report_groups

Returns an array of report groups.

SELECT
report_groups,
report_groups_not_found
FROM aws.codebuild.report_groups
WHERE region = '{{ region }}' -- required
;

list_report_groups

Gets a list ARNs for the report groups in the current Amazon Web Services account.

SELECT
report_group
FROM aws.codebuild.report_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_report_group

Creates a report group. A report group contains a collection of reports.

INSERT INTO aws.codebuild.report_groups (
name,
type,
exportConfig,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ type }}' /* required */,
'{{ exportConfig }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
report_group
;

Manifest

# Description fields are for documentation purposes
- name: report_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the report_groups resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the report group.
  - name: type
    value: "{{ type }}"
    description: |
      The type of report group.
    valid_values: ['TEST', 'CODE_COVERAGE']
  - name: exportConfig
    description: |
      A ReportExportConfig object that contains information about where the report group test results are exported.
    value:
      exportConfigType: "{{ exportConfigType }}"
      s3Destination:
        bucket: "{{ bucket }}"
        bucketOwner: "{{ bucketOwner }}"
        path: "{{ path }}"
        packaging: "{{ packaging }}"
        encryptionKey: "{{ encryptionKey }}"
        encryptionDisabled: {{ encryptionDisabled }}
  - name: tags
    description: |
      A list of tag key and value pairs associated with this report group. These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_report_group

Updates a report group.

UPDATE aws.codebuild.report_groups
SET 
arn = '{{ arn }}',
exportConfig = '{{ exportConfig }}',
tags = '{{ tags }}'
WHERE 
region = '{{ region }}' --required
AND arn = '{{ arn }}' --required
RETURNING
report_group;

DELETE examples

delete_report_group

Deletes a report group. Before you delete a report group, you must delete its reports.

DELETE FROM aws.codebuild.report_groups
WHERE region = '{{ region }}' --required
;