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.DescribeOrganizationConfigRuleStatuses' paths: /#X-Amz-Target=StarlingDoveService.DescribeOrganizationConfigRuleStatuses: 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: DescribeOrganizationConfigRuleStatuses description:Provides organization Config rule deployment status for an organization.
The status is not considered successful until organization Config rule is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.
OrganizationConfigRuleStatus objects.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. '
OrganizationConfigRuleNames:
type: array
items:
$ref: '#/components/schemas/StringWithCharLimit64'
minItems: 0
maxItems: 25
NoSuchOrganizationConfigRuleException: {}
OrganizationConfigRuleName:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 64
OrganizationConfigRuleStatuses:
type: array
items:
$ref: '#/components/schemas/OrganizationConfigRuleStatus'
Date:
type: string
format: date-time
InvalidNextTokenException: {}
CosmosPageLimit:
type: integer
minimum: 0
maximum: 100
InvalidLimitException: {}
OrganizationConfigRuleStatus:
type: object
required:
- OrganizationConfigRuleName
- OrganizationRuleStatus
properties:
OrganizationConfigRuleName:
allOf:
- $ref: '#/components/schemas/OrganizationConfigRuleName'
- description: The name that you assign to organization Config rule.
OrganizationRuleStatus:
allOf:
- $ref: '#/components/schemas/OrganizationRuleStatus'
- description: Indicates deployment status of an organization Config rule. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in all the member accounts. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in all the member accounts. Additionally, Config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the management account deletes OrganizationConfigRule in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.
Config sets the state of the rule to:
CREATE_SUCCESSFUL when an organization Config rule has been successfully created in all the member accounts.
CREATE_IN_PROGRESS when an organization Config rule creation is in progress.
CREATE_FAILED when an organization Config rule creation failed in one or more member accounts within that organization.
DELETE_FAILED when an organization Config rule deletion failed in one or more member accounts within that organization.
DELETE_IN_PROGRESS when an organization Config rule deletion is in progress.
DELETE_SUCCESSFUL when an organization Config rule has been successfully deleted from all the member accounts.
UPDATE_SUCCESSFUL when an organization Config rule has been successfully updated in all the member accounts.
UPDATE_IN_PROGRESS when an organization Config rule update is in progress.
UPDATE_FAILED when an organization Config rule update failed in one or more member accounts within that organization.
OrganizationConfigRuleStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. '
String:
type: string
OrganizationRuleStatus:
type: string
enum:
- CREATE_SUCCESSFUL
- CREATE_IN_PROGRESS
- CREATE_FAILED
- DELETE_SUCCESSFUL
- DELETE_FAILED
- DELETE_IN_PROGRESS
- UPDATE_SUCCESSFUL
- UPDATE_IN_PROGRESS
- UPDATE_FAILED
OrganizationAccessDeniedException: {}
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