openapi: 3.0.0 info: version: '2014-11-12' x-release: v4 title: 'AWS Config #X Amz Target=StarlingDoveService.BatchGetAggregateResourceConfig #X Amz Target=StarlingDoveService.BatchGetAggregateResourceConfig #X Amz Target=StarlingDoveService.DescribeConformancePackStatus API' description: Config

Config provides a way to keep track of the configurations of all the Amazon Web Services resources associated with your Amazon Web Services account. You can use Config to get the current and historical configurations of each Amazon Web Services resource and also to get information about the relationship between the resources. An Amazon Web Services resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by Config, see Supported Amazon Web Services resources.

You can access and manage Config through the Amazon Web Services Management Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config API, or the Amazon Web Services SDKs for Config. This reference guide contains documentation for the Config API and the Amazon Web Services CLI commands that you can use to manage Config. The Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process. For detailed information about Config features and their associated actions or commands, as well as how to work with Amazon Web Services Management Console, see What Is Config in the Config Developer 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: config x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/config-2014-11-12.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://config.{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 Config Service multi-region endpoint - url: https://config.{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 Config Service multi-region endpoint - url: http://config.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Config Service endpoint for China (Beijing) and China (Ningxia) - url: https://config.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Config Service endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=StarlingDoveService.DescribeConformancePackStatus' paths: /#X-Amz-Target=StarlingDoveService.DescribeConformancePackStatus: 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: DescribeConformancePackStatus description:

Provides one or more conformance packs deployment status.

If there are no conformance packs then you will see an empty result.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeConformancePackStatusResponse' examples: DescribeConformancePackStatus200Example: summary: Default DescribeConformancePackStatus 200 x-microcks-default: true value: ConformancePackStatusDetails: example NextToken: example '480': description: InvalidLimitException content: application/json: schema: $ref: '#/components/schemas/InvalidLimitException' examples: DescribeConformancePackStatus480Example: summary: Default DescribeConformancePackStatus 480 x-microcks-default: true value: example '481': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: DescribeConformancePackStatus481Example: summary: Default DescribeConformancePackStatus 481 x-microcks-default: true value: example '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: DescribeConformancePackStatus482Example: summary: Default DescribeConformancePackStatus 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeConformancePackStatusRequest' parameters: - name: Limit 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: - StarlingDoveService.DescribeConformancePackStatus summary: Amazon Config Describe Conformance Pack Status x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=StarlingDoveService.DescribeConformancePackStatus' components: parameters: 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 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 schemas: ConformancePackState: type: string enum: - CREATE_IN_PROGRESS - CREATE_COMPLETE - CREATE_FAILED - DELETE_IN_PROGRESS - DELETE_FAILED DescribeConformancePackStatusResponse: type: object properties: ConformancePackStatusDetails: allOf: - $ref: '#/components/schemas/ConformancePackStatusDetailsList' - description: A list of ConformancePackStatusDetail objects. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The nextToken string returned in a previous request that you use to request the next page of results in a paginated response. ConformancePackNamesList: type: array items: $ref: '#/components/schemas/ConformancePackName' minItems: 0 maxItems: 25 DescribeConformancePackStatusRequest: type: object title: DescribeConformancePackStatusRequest properties: ConformancePackNames: allOf: - $ref: '#/components/schemas/ConformancePackNamesList' - description: Comma-separated list of conformance pack names. Limit: allOf: - $ref: '#/components/schemas/PageSizeLimit' - description: The maximum number of conformance packs status returned on each page. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The nextToken string returned in a previous request that you use to request the next page of results in a paginated response. Date: type: string format: date-time ConformancePackId: type: string minLength: 1 maxLength: 1024 StackArn: type: string minLength: 1 maxLength: 2048 InvalidNextTokenException: {} InvalidParameterValueException: {} ConformancePackName: type: string pattern: '[a-zA-Z][-a-zA-Z0-9]*' minLength: 1 maxLength: 256 InvalidLimitException: {} ConformancePackStatusDetail: type: object required: - ConformancePackName - ConformancePackId - ConformancePackArn - ConformancePackState - StackArn - LastUpdateRequestedTime properties: ConformancePackName: allOf: - $ref: '#/components/schemas/ConformancePackName' - description: Name of the conformance pack. ConformancePackId: allOf: - $ref: '#/components/schemas/ConformancePackId' - description: ID of the conformance pack. ConformancePackArn: allOf: - $ref: '#/components/schemas/ConformancePackArn' - description: Amazon Resource Name (ARN) of comformance pack. ConformancePackState: allOf: - $ref: '#/components/schemas/ConformancePackState' - description:

Indicates deployment status of conformance pack.

Config sets the state of the conformance pack to:

StackArn: allOf: - $ref: '#/components/schemas/StackArn' - description: 'Amazon Resource Name (ARN) of CloudFormation stack. ' ConformancePackStatusReason: allOf: - $ref: '#/components/schemas/ConformancePackStatusReason' - description: The reason of conformance pack creation failure. LastUpdateRequestedTime: allOf: - $ref: '#/components/schemas/Date' - description: Last time when conformation pack creation and update was requested. LastUpdateCompletedTime: allOf: - $ref: '#/components/schemas/Date' - description: Last time when conformation pack creation and update was successful. description: Status details of a conformance pack. ConformancePackArn: type: string minLength: 1 maxLength: 2048 ConformancePackStatusReason: type: string minLength: 0 maxLength: 2000 PageSizeLimit: type: integer minimum: 0 maximum: 20 ConformancePackStatusDetailsList: type: array items: $ref: '#/components/schemas/ConformancePackStatusDetail' minItems: 0 maxItems: 25 NextToken: type: string 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/config/ x-hasEquivalentPaths: true