openapi: 3.0.0
info:
version: '2016-10-06'
x-release: v4
title: 'AWS CodeBuild Builds #X Amz Target=CodeBuild 20161006.ListReportGroups API'
description:
CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the CodeBuild User Guide.
x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: codebuild x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codebuild-2016-10-06.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://codebuild.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS CodeBuild multi-region endpoint - url: https://codebuild.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS CodeBuild multi-region endpoint - url: http://codebuild.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS CodeBuild endpoint for China (Beijing) and China (Ningxia) - url: https://codebuild.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS CodeBuild endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=CodeBuild 20161006.ListReportGroups' paths: /#X-Amz-Target=CodeBuild_20161006.ListReportGroups: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListReportGroups description: ' Gets a list ARNs for the report groups in the current Amazon Web Services account. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListReportGroupsOutput' examples: ListReportGroups200Example: summary: Default ListReportGroups 200 response x-microcks-default: true value: nextToken: example-value reportGroups: example-value '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: ListReportGroups480Example: summary: Default ListReportGroups 480 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListReportGroupsInput' examples: ListReportGroupsRequestExample: summary: Default ListReportGroups request x-microcks-default: true value: sortOrder: example-value sortBy: example-value nextToken: example-value maxResults: example-value parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeBuild_20161006.ListReportGroups summary: Amazon CodeBuild List Report Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=CodeBuild 20161006.ListReportGroups' components: schemas: ListReportGroupsInput: type: object title: ListReportGroupsInput properties: sortOrder: allOf: - $ref: '#/components/schemas/SortOrderType' - description: ' Used to specify the order to sort the list of returned report groups. Valid values areASCENDING and DESCENDING. '
sortBy:
allOf:
- $ref: '#/components/schemas/ReportGroupSortByType'
- description: 'The criterion to be used to list build report groups. Valid values include:
CREATED_TIME: List based on when each report group was created.
LAST_MODIFIED_TIME: List based on when each report group was last changed.
NAME: List based on each report group''s name.
maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned. '
maxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: ' The maximum number of paginated report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100. '
String:
type: string
PageSize:
type: integer
minimum: 1
maximum: 100
ReportGroupArns:
type: array
items:
$ref: '#/components/schemas/NonEmptyString'
minItems: 1
maxItems: 100
SortOrderType:
type: string
enum:
- ASCENDING
- DESCENDING
NonEmptyString:
type: string
minLength: 1
ReportGroupSortByType:
type: string
enum:
- NAME
- CREATED_TIME
- LAST_MODIFIED_TIME
ListReportGroupsOutput:
type: object
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned. '
reportGroups:
allOf:
- $ref: '#/components/schemas/ReportGroupArns'
- description: ' The list of ARNs for the report groups in the current Amazon Web Services account. '
InvalidInputException: {}
parameters:
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/codebuild/
x-hasEquivalentPaths: true