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 externalDocs: description: Amazon Web Services documentation url: 'https://docs.aws.amazon.com/config/' 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) x-hasEquivalentPaths: true paths: /#X-Amz-Target=StarlingDoveService.BatchGetAggregateResourceConfig: post: operationId: BatchGetAggregateResourceConfig description: 'Returns the current configuration items for resources that are present in your Config aggregator. The operation also returns a list of resources that are not processed in the current
request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceIdentifiers list.
The API does not return results for deleted resources.
The API does not return tags and relationships.
Returns the BaseConfigurationItem for one or more requested resources. The operation also returns a list of resources that are not processed in the current request. If
there are no unprocessed resources, the operation returns an empty unprocessedResourceKeys list.
The API does not return results for deleted resources.
The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response.
Deletes the specified Config rule and all of its evaluation results.
Config sets the state of a rule to DELETING until the deletion is complete. You cannot update
a rule while it is in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException.
You
can check the state of a rule by using the DescribeConfigRules request.
Deletes the configuration recorder.
After the configuration recorder is deleted, Config will not record resource configuration changes until you create a new configuration recorder.
This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory
action, but you will not be able to access this information in the Config console until you create a new configuration recorder.
Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.
Config sets the conformance pack
to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.
Deletes the delivery channel.
Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.
' responses: '200': description: Success '480': description: NoSuchDeliveryChannelException content: application/json: schema: $ref: '#/components/schemas/NoSuchDeliveryChannelException' examples: DeleteDeliveryChannel480Example: summary: Default DeleteDeliveryChannel 480 x-microcks-default: true value: example '481': description: LastDeliveryChannelDeleteFailedException content: application/json: schema: $ref: '#/components/schemas/LastDeliveryChannelDeleteFailedException' examples: DeleteDeliveryChannel481Example: summary: Default DeleteDeliveryChannel 481 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteDeliveryChannelRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - StarlingDoveService.DeleteDeliveryChannel summary: Amazon Config Delete Delivery Channel x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.DeleteEvaluationResults: post: operationId: DeleteEvaluationResults description: 'Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your Amazon Web Services resources against the rule.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteEvaluationResultsResponse' examples: DeleteEvaluationResults200Example: summary: Default DeleteEvaluationResults 200 x-microcks-default: true value: {} '480': description: NoSuchConfigRuleException content: application/json: schema: $ref: '#/components/schemas/NoSuchConfigRuleException' examples: DeleteEvaluationResults480Example: summary: Default DeleteEvaluationResults 480 x-microcks-default: true value: example '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: DeleteEvaluationResults481Example: summary: Default DeleteEvaluationResults 481 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteEvaluationResultsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - StarlingDoveService.DeleteEvaluationResults summary: Amazon Config Delete Evaluation Results x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.DeleteOrganizationConfigRule: post: operationId: DeleteOrganizationConfigRule description: 'Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.
Only a management account and a delegated administrator
account can delete an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added.
Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.
' responses: '200': description: Success '480': description: NoSuchOrganizationConfigRuleException content: application/json: schema: $ref: '#/components/schemas/NoSuchOrganizationConfigRuleException' examples: DeleteOrganizationConfigRule480Example: summary: Default DeleteOrganizationConfigRule 480 x-microcks-default: true value: example '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: DeleteOrganizationConfigRule481Example: summary: Default DeleteOrganizationConfigRule 481 x-microcks-default: true value: example '482': description: OrganizationAccessDeniedException content: application/json: schema: $ref: '#/components/schemas/OrganizationAccessDeniedException' examples: DeleteOrganizationConfigRule482Example: summary: Default DeleteOrganizationConfigRule 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteOrganizationConfigRuleRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - StarlingDoveService.DeleteOrganizationConfigRule summary: Amazon Config Delete Organization Config Rule x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.DeleteOrganizationConformancePack: post: operationId: DeleteOrganizationConformancePack description: 'Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.
Only a management account
or a delegated administrator account can delete an organization conformance pack. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator
permissions are added.
Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.
' responses: '200': description: Success '480': description: NoSuchOrganizationConformancePackException content: application/json: schema: $ref: '#/components/schemas/NoSuchOrganizationConformancePackException' examples: DeleteOrganizationConformancePack480Example: summary: Default DeleteOrganizationConformancePack 480 x-microcks-default: true value: example '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: DeleteOrganizationConformancePack481Example: summary: Default DeleteOrganizationConformancePack 481 x-microcks-default: true value: example '482': description: OrganizationAccessDeniedException content: application/json: schema: $ref: '#/components/schemas/OrganizationAccessDeniedException' examples: DeleteOrganizationConformancePack482Example: summary: Default DeleteOrganizationConformancePack 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteOrganizationConformancePackRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - StarlingDoveService.DeleteOrganizationConformancePack summary: Amazon Config Delete Organization Conformance Pack x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.DeletePendingAggregationRequest: post: operationId: DeletePendingAggregationRequest description: Deletes pending authorization requests for a specified aggregator account in a specified region. responses: '200': description: Success '480': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: DeletePendingAggregationRequest480Example: summary: Default DeletePendingAggregationRequest 480 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeletePendingAggregationRequestRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - StarlingDoveService.DeletePendingAggregationRequest summary: Amazon Config Delete Pending Aggregation Request x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.DeleteRemediationConfiguration: post: operationId: DeleteRemediationConfiguration description: Deletes the remediation configuration. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteRemediationConfigurationResponse' examples: DeleteRemediationConfiguration200Example: summary: Default DeleteRemediationConfiguration 200 x-microcks-default: true value: {} '480': description: NoSuchRemediationConfigurationException content: application/json: schema: $ref: '#/components/schemas/NoSuchRemediationConfigurationException' examples: DeleteRemediationConfiguration480Example: summary: Default DeleteRemediationConfiguration 480 x-microcks-default: true value: example '481': description: RemediationInProgressException content: application/json: schema: $ref: '#/components/schemas/RemediationInProgressException' examples: DeleteRemediationConfiguration481Example: summary: Default DeleteRemediationConfiguration 481 x-microcks-default: true value: example '482': description: InsufficientPermissionsException content: application/json: schema: $ref: '#/components/schemas/InsufficientPermissionsException' examples: DeleteRemediationConfiguration482Example: summary: Default DeleteRemediationConfiguration 482 x-microcks-default: true value: example '483': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: DeleteRemediationConfiguration483Example: summary: Default DeleteRemediationConfiguration 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteRemediationConfigurationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - StarlingDoveService.DeleteRemediationConfiguration summary: Amazon Config Delete Remediation Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.DeleteRemediationExceptions: post: operationId: DeleteRemediationExceptions description:Deletes one or more remediation exceptions mentioned in the resource keys.
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, Config sends the following notifications using an Amazon SNS topic that you have specified.
Notification of the start of the delivery.
Notification of the completion of the delivery, if the delivery was successfully completed.
Notification of delivery failure, if the delivery failed.
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.
The results can return an empty result page, but
if you have a nextToken, the results are displayed on the next page.
Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services resources that do not comply with the rule.
A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.
If Config has no current evaluation results
for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions:
Config has never invoked an evaluation for the rule. To check
whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.
The
rule''s Lambda function is failing to send evaluation results to Config. Verify that the role you assigned to your configuration recorder includes the config:PutEvaluations permission.
If the rule is a custom rule, verify that the Lambda execution role includes the config:PutEvaluations permission.
The rule''s Lambda function has returned NOT_APPLICABLE
for all evaluation results. This can occur if the resources were deleted or removed from the rule''s scope.
Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.
A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.
If Config
has no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource:
Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime
and LastFailedInvocationTime.
The rule''s Lambda function is failing to send evaluation results to Config. Verify that the role that you assigned to your configuration
recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the Lambda execution role includes the config:PutEvaluations permission.
The rule''s Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule''s scope.
Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
>You can specify only one configuration recorder for each Amazon Web Services Region for each account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.
Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.
You can specify only one configuration recorder for each Amazon Web Services Region for each account.
Returns compliance details for each rule in that conformance pack.
You must provide exact rule names.
Provides one or more conformance packs deployment status.
If there are no conformance packs then you will see an empty result.
Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.
Currently, you can specify only one delivery channel per region in your account.
Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.
Currently, you can specify only one delivery channel per region in your account.
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.
Returns a list of organization Config rules.
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.
For accounts within an organzation
If you deploy
an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated
administrator account, you won''t be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational
rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks
APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.
Provides organization conformance pack deployment status for an organization.
The status is not considered successful until organization conformance pack 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 conformance pack names. They are only applicable, when you request all the organization conformance packs.
Returns a list of organization conformance packs.
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 conformance packs names. They are only applicable, when you request all the organization conformance packs.
For accounts within an organzation
If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance
pack in the delegated administrator account, you won''t be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account
or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks
APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.
Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.
Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.
Currently, Config supports only one retention configuration per region in your account.
Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
The results can return an empty result page. But if you have a nextToken, the
results are displayed on the next page.
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
Returns the resource counts across accounts and regions that are present in your Config aggregator. You can request the resource counts by providing filters and GroupByKey.
For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetAggregateDiscoveredResourceCountsResponse' examples: GetAggregateDiscoveredResourceCounts200Example: summary: Default GetAggregateDiscoveredResourceCounts 200 x-microcks-default: true value: TotalDiscoveredResources: example GroupByKey: example GroupedResourceCounts: example NextToken: example '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: GetAggregateDiscoveredResourceCounts480Example: summary: Default GetAggregateDiscoveredResourceCounts 480 x-microcks-default: true value: example '481': description: InvalidLimitException content: application/json: schema: $ref: '#/components/schemas/InvalidLimitException' examples: GetAggregateDiscoveredResourceCounts481Example: summary: Default GetAggregateDiscoveredResourceCounts 481 x-microcks-default: true value: example '482': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: GetAggregateDiscoveredResourceCounts482Example: summary: Default GetAggregateDiscoveredResourceCounts 482 x-microcks-default: true value: example '483': description: NoSuchConfigurationAggregatorException content: application/json: schema: $ref: '#/components/schemas/NoSuchConfigurationAggregatorException' examples: GetAggregateDiscoveredResourceCounts483Example: summary: Default GetAggregateDiscoveredResourceCounts 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetAggregateDiscoveredResourceCountsRequest' 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.GetAggregateDiscoveredResourceCounts summary: Amazon Config Get Aggregate Discovered Resource Counts x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.GetAggregateResourceConfig: post: operationId: GetAggregateResourceConfig description: Returns configuration item that is aggregated for your specific resource in a specific source account and region. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetAggregateResourceConfigResponse' examples: GetAggregateResourceConfig200Example: summary: Default GetAggregateResourceConfig 200 x-microcks-default: true value: ConfigurationItem: example '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: GetAggregateResourceConfig480Example: summary: Default GetAggregateResourceConfig 480 x-microcks-default: true value: example '481': description: NoSuchConfigurationAggregatorException content: application/json: schema: $ref: '#/components/schemas/NoSuchConfigurationAggregatorException' examples: GetAggregateResourceConfig481Example: summary: Default GetAggregateResourceConfig 481 x-microcks-default: true value: example '482': description: OversizedConfigurationItemException content: application/json: schema: $ref: '#/components/schemas/OversizedConfigurationItemException' examples: GetAggregateResourceConfig482Example: summary: Default GetAggregateResourceConfig 482 x-microcks-default: true value: example '483': description: ResourceNotDiscoveredException content: application/json: schema: $ref: '#/components/schemas/ResourceNotDiscoveredException' examples: GetAggregateResourceConfig483Example: summary: Default GetAggregateResourceConfig 483 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetAggregateResourceConfigRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - StarlingDoveService.GetAggregateResourceConfig summary: Amazon Config Get Aggregate Resource Config x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.GetComplianceDetailsByConfigRule: post: operationId: GetComplianceDetailsByConfigRule description: 'Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetComplianceDetailsByConfigRuleResponse' examples: GetComplianceDetailsByConfigRule200Example: summary: Default GetComplianceDetailsByConfigRule 200 x-microcks-default: true value: EvaluationResults: example NextToken: example '480': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: GetComplianceDetailsByConfigRule480Example: summary: Default GetComplianceDetailsByConfigRule 480 x-microcks-default: true value: example '481': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: GetComplianceDetailsByConfigRule481Example: summary: Default GetComplianceDetailsByConfigRule 481 x-microcks-default: true value: example '482': description: NoSuchConfigRuleException content: application/json: schema: $ref: '#/components/schemas/NoSuchConfigRuleException' examples: GetComplianceDetailsByConfigRule482Example: summary: Default GetComplianceDetailsByConfigRule 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetComplianceDetailsByConfigRuleRequest' 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.GetComplianceDetailsByConfigRule summary: Amazon Config Get Compliance Details by Config Rule x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.GetComplianceDetailsByResource: post: operationId: GetComplianceDetailsByResource description: 'Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last invoked, and whether the resource complies with each rule.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetComplianceDetailsByResourceResponse' examples: GetComplianceDetailsByResource200Example: summary: Default GetComplianceDetailsByResource 200 x-microcks-default: true value: EvaluationResults: example NextToken: example '480': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: GetComplianceDetailsByResource480Example: summary: Default GetComplianceDetailsByResource 480 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetComplianceDetailsByResourceRequest' parameters: - 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.GetComplianceDetailsByResource summary: Amazon Config Get Compliance Details by Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.GetComplianceSummaryByConfigRule: post: operationId: GetComplianceSummaryByConfigRule description: 'Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetComplianceSummaryByConfigRuleResponse' examples: GetComplianceSummaryByConfigRule200Example: summary: Default GetComplianceSummaryByConfigRule 200 x-microcks-default: true value: ComplianceSummary: example parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - StarlingDoveService.GetComplianceSummaryByConfigRule summary: Amazon Config Get Compliance Summary by Config Rule x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.GetComplianceSummaryByResourceType: post: operationId: GetComplianceSummaryByResourceType description: Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetComplianceSummaryByResourceTypeResponse' examples: GetComplianceSummaryByResourceType200Example: summary: Default GetComplianceSummaryByResourceType 200 x-microcks-default: true value: ComplianceSummariesByResourceType: example '480': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: GetComplianceSummaryByResourceType480Example: summary: Default GetComplianceSummaryByResourceType 480 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetComplianceSummaryByResourceTypeRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - StarlingDoveService.GetComplianceSummaryByResourceType summary: Amazon Config Get Compliance Summary by Resource Type x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.GetConformancePackComplianceDetails: post: operationId: GetConformancePackComplianceDetails description: Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetConformancePackComplianceDetailsResponse' examples: GetConformancePackComplianceDetails200Example: summary: Default GetConformancePackComplianceDetails 200 x-microcks-default: true value: ConformancePackName: example ConformancePackRuleEvaluationResults: example NextToken: example '480': description: InvalidLimitException content: application/json: schema: $ref: '#/components/schemas/InvalidLimitException' examples: GetConformancePackComplianceDetails480Example: summary: Default GetConformancePackComplianceDetails 480 x-microcks-default: true value: example '481': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: GetConformancePackComplianceDetails481Example: summary: Default GetConformancePackComplianceDetails 481 x-microcks-default: true value: example '482': description: NoSuchConformancePackException content: application/json: schema: $ref: '#/components/schemas/NoSuchConformancePackException' examples: GetConformancePackComplianceDetails482Example: summary: Default GetConformancePackComplianceDetails 482 x-microcks-default: true value: example '483': description: NoSuchConfigRuleInConformancePackException content: application/json: schema: $ref: '#/components/schemas/NoSuchConfigRuleInConformancePackException' examples: GetConformancePackComplianceDetails483Example: summary: Default GetConformancePackComplianceDetails 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: GetConformancePackComplianceDetails484Example: summary: Default GetConformancePackComplianceDetails 484 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetConformancePackComplianceDetailsRequest' 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.GetConformancePackComplianceDetails summary: Amazon Config Get Conformance Pack Compliance Details x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.GetConformancePackComplianceSummary: post: operationId: GetConformancePackComplianceSummary description: Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetConformancePackComplianceSummaryResponse' examples: GetConformancePackComplianceSummary200Example: summary: Default GetConformancePackComplianceSummary 200 x-microcks-default: true value: ConformancePackComplianceSummaryList: example NextToken: example '480': description: NoSuchConformancePackException content: application/json: schema: $ref: '#/components/schemas/NoSuchConformancePackException' examples: GetConformancePackComplianceSummary480Example: summary: Default GetConformancePackComplianceSummary 480 x-microcks-default: true value: example '481': description: InvalidLimitException content: application/json: schema: $ref: '#/components/schemas/InvalidLimitException' examples: GetConformancePackComplianceSummary481Example: summary: Default GetConformancePackComplianceSummary 481 x-microcks-default: true value: example '482': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: GetConformancePackComplianceSummary482Example: summary: Default GetConformancePackComplianceSummary 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetConformancePackComplianceSummaryRequest' 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.GetConformancePackComplianceSummary summary: Amazon Config Get Conformance Pack Compliance Summary x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.GetCustomRulePolicy: post: operationId: GetCustomRulePolicy description: Returns the policy definition containing the logic for your Config Custom Policy rule. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCustomRulePolicyResponse' examples: GetCustomRulePolicy200Example: summary: Default GetCustomRulePolicy 200 x-microcks-default: true value: PolicyText: example '480': description: NoSuchConfigRuleException content: application/json: schema: $ref: '#/components/schemas/NoSuchConfigRuleException' examples: GetCustomRulePolicy480Example: summary: Default GetCustomRulePolicy 480 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetCustomRulePolicyRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - StarlingDoveService.GetCustomRulePolicy summary: Amazon Config Get Custom Rule Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.GetDiscoveredResourceCounts: post: operationId: GetDiscoveredResourceCounts description: 'Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
Example
Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.
You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types.
Config returns the following:
The resource types (EC2 instances, IAM users, and S3 buckets).
The number of each resource type (25, 20, and 15).
The total number of all resources (60).
The response is paginated. By default, Config lists 100 ResourceCount objects on each page. You can customize this number with the limit parameter.
The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.
If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:
You are a new Config customer.
You just enabled resource recording.
It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
Returns a list of ConfigurationItems for the specified resource. The list contains details about each state of the resource during the specified time interval. If you
specified a retention period to retain your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns the ConfigurationItems
for the specified retention period.
The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can customize this number with the limit
parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.
Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make
another call, using the nextToken.
Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated, the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules.
To see additional information about the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, use the GetComplianceDetailsByResource API. For more information, see the Examples section.
Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region.
For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance then
the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.
Returns a list of conformance pack compliance scores. A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs. You can use it to identify, investigate, and understand the level of compliance in your conformance packs.
Conformance packs with no evaluation results will have a compliance score of INSUFFICIENT_DATA.
Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that Config has discovered, including those that Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.
You can specify either resource IDs or a resource name, but not both, in the same request.
The response is paginated. By default,
Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page
of results, run the request again and specify the string for the nextToken parameter.
Authorizes the aggregator account and region to collect data from the source account and region.
PutAggregationAuthorization is an idempotent API. Subsequent
requests won’t create a duplicate resource if one was already created. If a following request has different tags values, Config will ignore these differences and treat it as an idempotent
request of the previous. In this case, tags will not be updated, even if they are different.
Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account, see Service Limits in the Config Developer Guide.
There are two types of
rules: Config Managed Rules and Config Custom Rules. You can use PutConfigRule to create both Config Managed Rules and Config Custom Rules.
Config Managed Rules
are predefined, customizable rules created by Config. For a list of managed rules, see List of
Config Managed Rules. If you are adding an Config managed rule, you must specify the rule''s identifier for the SourceIdentifier key.
Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.
If you are adding a new Config Custom Lambda
rule, you first need to create an Lambda function that the rule invokes to evaluate your resources. When you use PutConfigRule to add a Custom Lambda rule to Config, you must specify
the Amazon Resource Name (ARN) that Lambda assigns to the function. You specify the ARN in the SourceIdentifier key. This key is part of the Source object, which is part
of the ConfigRule object.
For any new Config rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn
or the ConfigRuleId. These values are generated by Config for new rules.
If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName,
ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request.
For more information about developing and using Config rules, see Evaluating Resources with Config Rules in the Config Developer Guide.
PutConfigRule
is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, Config will ignore these differences
and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.
Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.
accountIds
that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call DescribeConfigurationAggregators to get the previous accounts
and then append new ones.
Config should be enabled in source accounts and regions you want to aggregate.
If your source type is an organization, you must be signed in to the
management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls EnableAwsServiceAccess
API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config calls ListDelegatedAdministrators API to verify whether the
caller is a valid delegated administrator.
To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide.
PutConfigurationAggregator is an idempotent API. Subsequent requests won’t create a duplicate
resource if one was already created. If a following request has different tags values, Config will ignore these differences and treat it as an idempotent request of the previous. In
this case, tags will not be updated, even if they are different.
Creates a new configuration recorder to record configuration changes for specified resource types.
You can also use this action to change the roleARN or the recordingGroup
of an existing recorder. For more information, see Managing the Configuration Recorder in
the Config Developer Guide.
You can specify only one configuration recorder for each Amazon Web Services Region for each account.
If the configuration recorder does not
have the recordingGroup field specified, the default is to record all supported resource types.
Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide.
This API creates a service-linked role AWSServiceRoleForConfigConforms in your account. The service-linked role is created only when the role does not exist in your
account.
You must specify only one of the follow parameters: TemplateS3Uri, TemplateBody or TemplateSSMDocumentDetails.
Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.
Before you can create a delivery channel, you must create a configuration recorder.
You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.
You can have only one delivery channel per region in your account.
Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many organization Config rules you can have per account, see Service Limits in the Config Developer Guide.
Only a management account and a delegated administrator can create or update an organization Config rule. When calling this API with a delegated administrator, you must ensure
Organizations ListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators.
This API enables organization service access through
the EnableAWSServiceAccess action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup in the management or delegated administrator account of your
organization. The service-linked role is created only when the role does not exist in the caller account. Config verifies the existence of role with GetRole action.
To use this
API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegated-administrator for config-multiaccountsetup.amazonaws.com.
There are two types of rules: Config Managed Rules and Config Custom Rules. You can use PutOrganizationConfigRule to create both Config Managed Rules and Config
Custom Rules.
Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List
of Config Managed Rules. If you are adding an Config managed rule, you must specify the rule''s identifier for the RuleIdentifier key.
Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.
If you are adding a new Config Custom Lambda
rule, you first need to create an Lambda function in the management account or a delegated administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in
the managed account that can be assumed by the Lambda function. When you use PutOrganizationConfigRule to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name
(ARN) that Lambda assigns to the function.
Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.
Make sure to specify one
of either OrganizationCustomPolicyRuleMetadata for Custom Policy rules, OrganizationCustomRuleMetadata for Custom Lambda rules, or OrganizationManagedRuleMetadata
for managed rules.
Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide.
Only a management
account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are
added. An organization can have up to 3 delegated administrators.
This API enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess
action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup in the management or delegated administrator account of your organization. The service-linked role
is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegate-admin
for config-multiaccountsetup.amazonaws.com.
Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.
You must
specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody
parameter.
Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the RemediationConfiguration object for
the Config rule. The Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target.
If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run.
This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.
For manual remediation configuration,
you need to provide a value for automationAssumeRole or use a value in the assumeRolefield to remediate your resources. The SSM automation document can use either as long
as it maps to a valid parameter.
However, for automatic remediation configuration, the only valid assumeRole field value is AutomationAssumeRole and you need to
provide a value for AutomationAssumeRole to remediate your resources.
A remediation exception is when a specified resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule.
Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until the given
Config rule for the specified resource evaluates the resource as NON_COMPLIANT. Once the resource has been evaluated as NON_COMPLIANT, you can add remediation exceptions
and change the remediation type back from Manual to Auto if you want to use auto-remediation. Otherwise, using auto-remediation before a NON_COMPLIANT evaluation result can delete resources
before the exception is applied.
Placing an exception can only be performed on resources that are NON_COMPLIANT. If you use this API for COMPLIANT
resources or resources that are NOT_APPLICABLE, a remediation exception will not be generated. For more information on the conditions that initiate the possible Config evaluation results,
see Concepts | Config Rules in the Config Developer Guide.
Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs.
The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.
When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.
Write-only schema properites are not recorded as part of the published configuration item.
Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information. The API creates the RetentionConfiguration
object and names the object as default. When you have a RetentionConfiguration object named default, calling the API modifies the default object.
Currently, Config supports only one retention configuration per region in your account.
Saves a new query or updates an existing saved query. The QueryName must be unique for a single Amazon Web Services account and a single Amazon Web Services Region. You
can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region.
PutStoredQuery is an idempotent API. Subsequent requests
won’t create a duplicate resource if one was already created. If a following request has different tags values, Config will ignore these differences and treat it as an idempotent request
of the previous. In this case, tags will not be updated, even if they are different.
Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the Query Components section in the Config Developer Guide.
If you run an aggregation query (i.e., using GROUP BY or using aggregate functions such as COUNT;
e.g., SELECT resourceId, COUNT(*) WHERE resourceType = ''AWS::IAM::Role'' GROUP BY resourceId) and do not specify the MaxResults or the Limit query parameters,
the default page size is set to 500.
If you run a non-aggregation query (i.e., not using GROUP BY or aggregate function; e.g., SELECT * WHERE resourceType = ''AWS::IAM::Role'')
and do not specify the MaxResults or the Limit query parameters, the default page size is set to 25.
Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the Query Components section in the Config Developer Guide.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SelectResourceConfigResponse' examples: SelectResourceConfig200Example: summary: Default SelectResourceConfig 200 x-microcks-default: true value: Results: example QueryInfo: example NextToken: example '480': description: InvalidExpressionException content: application/json: schema: $ref: '#/components/schemas/InvalidExpressionException' examples: SelectResourceConfig480Example: summary: Default SelectResourceConfig 480 x-microcks-default: true value: example '481': description: InvalidLimitException content: application/json: schema: $ref: '#/components/schemas/InvalidLimitException' examples: SelectResourceConfig481Example: summary: Default SelectResourceConfig 481 x-microcks-default: true value: example '482': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: SelectResourceConfig482Example: summary: Default SelectResourceConfig 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SelectResourceConfigRequest' 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.SelectResourceConfig summary: Amazon Config Select Resource Config x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.StartConfigRulesEvaluation: post: operationId: StartConfigRulesEvaluation description: 'Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want
to test that a rule you updated is working as expected. StartConfigRulesEvaluation does not re-record the latest configuration state for your resources. It re-runs an evaluation against
the last known state of your resources.
You can specify up to 25 Config rules per request.
An existing StartConfigRulesEvaluation call for the specified rules must complete
before you can call the API again. If you chose to have Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts.
You don''t need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, Config evaluates your resources against the rule automatically.
The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example:
You have a custom rule that evaluates your IAM resources every 24 hours.
You update your Lambda function to add additional conditions to your rule.
Instead of waiting for the next periodic evaluation,
you call the StartConfigRulesEvaluation API.
Config invokes your Lambda function and evaluates your IAM resources.
Your custom rule will still run periodic evaluations every 24 hours.
Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
You must have created at least one delivery channel to successfully start the configuration recorder.
responses: '200': description: Success '480': description: NoSuchConfigurationRecorderException content: application/json: schema: $ref: '#/components/schemas/NoSuchConfigurationRecorderException' examples: StartConfigurationRecorder480Example: summary: Default StartConfigurationRecorder 480 x-microcks-default: true value: example '481': description: NoAvailableDeliveryChannelException content: application/json: schema: $ref: '#/components/schemas/NoAvailableDeliveryChannelException' examples: StartConfigurationRecorder481Example: summary: Default StartConfigurationRecorder 481 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartConfigurationRecorderRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - StarlingDoveService.StartConfigurationRecorder summary: Amazon Config Start Configuration Recorder x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.StartRemediationExecution: post: operationId: StartRemediationExecution description:Runs an on-demand remediation for the specified Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous.
You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartRemediationExecutionResponse' examples: StartRemediationExecution200Example: summary: Default StartRemediationExecution 200 x-microcks-default: true value: FailureMessage: example FailedItems: example '480': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: StartRemediationExecution480Example: summary: Default StartRemediationExecution 480 x-microcks-default: true value: example '481': description: InsufficientPermissionsException content: application/json: schema: $ref: '#/components/schemas/InsufficientPermissionsException' examples: StartRemediationExecution481Example: summary: Default StartRemediationExecution 481 x-microcks-default: true value: example '482': description: NoSuchRemediationConfigurationException content: application/json: schema: $ref: '#/components/schemas/NoSuchRemediationConfigurationException' examples: StartRemediationExecution482Example: summary: Default StartRemediationExecution 482 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartRemediationExecutionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - StarlingDoveService.StartRemediationExecution summary: Amazon Config Start Remediation Execution x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=StarlingDoveService.StartResourceEvaluation: post: operationId: StartResourceEvaluation description: 'Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules. You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all of the Config rules in your account that match with the specified proactive mode and resource type.
Ensure you have the cloudformation:DescribeType role setup to validate the resource type schema.
You can find the Resource
type schema in "Amazon Web Services public extensions" within the CloudFormation registry or with the following CLI commmand: aws cloudformation describe-type --type-name "AWS::S3::Bucket"
--type RESOURCE.
For more information, see Managing extensions through the CloudFormation registry and Amazon Web Services resource and property types reference in the CloudFormation User Guide.
DescribeConfigurationRecorders action.
description: The request object for the DeleteConfigurationRecorder action.
NoSuchConfigurationRecorderException: {}
DeleteConformancePackRequest:
type: object
required:
- ConformancePackName
title: DeleteConformancePackRequest
properties:
ConformancePackName:
allOf:
- $ref: '#/components/schemas/ConformancePackName'
- description: Name of the conformance pack you want to delete.
NoSuchConformancePackException: {}
DeleteDeliveryChannelRequest:
type: object
required:
- DeliveryChannelName
title: DeleteDeliveryChannelRequest
properties:
DeliveryChannelName:
allOf:
- $ref: '#/components/schemas/ChannelName'
- description: The name of the delivery channel to delete.
description: 'The input for the DeleteDeliveryChannel action. The action accepts the following data, in JSON format. '
NoSuchDeliveryChannelException: {}
LastDeliveryChannelDeleteFailedException: {}
DeleteEvaluationResultsResponse:
type: object
properties: {}
description: The output when you delete the evaluation results for the specified Config rule.
DeleteEvaluationResultsRequest:
type: object
required:
- ConfigRuleName
title: DeleteEvaluationResultsRequest
properties:
ConfigRuleName:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit64'
- description: The name of the Config rule for which you want to delete the evaluation results.
description:
DeleteOrganizationConfigRuleRequest:
type: object
required:
- OrganizationConfigRuleName
title: DeleteOrganizationConfigRuleRequest
properties:
OrganizationConfigRuleName:
allOf:
- $ref: '#/components/schemas/OrganizationConfigRuleName'
- description: The name of organization Config rule that you want to delete.
NoSuchOrganizationConfigRuleException: {}
OrganizationAccessDeniedException: {}
DeleteOrganizationConformancePackRequest:
type: object
required:
- OrganizationConformancePackName
title: DeleteOrganizationConformancePackRequest
properties:
OrganizationConformancePackName:
allOf:
- $ref: '#/components/schemas/OrganizationConformancePackName'
- description: The name of organization conformance pack that you want to delete.
NoSuchOrganizationConformancePackException: {}
DeletePendingAggregationRequestRequest:
type: object
required:
- RequesterAccountId
- RequesterAwsRegion
title: DeletePendingAggregationRequestRequest
properties:
RequesterAccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: The 12-digit account ID of the account requesting to aggregate data.
RequesterAwsRegion:
allOf:
- $ref: '#/components/schemas/AwsRegion'
- description: The region requesting to aggregate data.
DeleteRemediationConfigurationResponse:
type: object
properties: {}
DeleteRemediationConfigurationRequest:
type: object
required:
- ConfigRuleName
title: DeleteRemediationConfigurationRequest
properties:
ConfigRuleName:
allOf:
- $ref: '#/components/schemas/ConfigRuleName'
- description: The name of the Config rule for which you want to delete remediation configuration.
ResourceType:
allOf:
- $ref: '#/components/schemas/String'
- description: The type of a resource.
NoSuchRemediationConfigurationException: {}
RemediationInProgressException: {}
InsufficientPermissionsException: {}
DeleteRemediationExceptionsResponse:
type: object
properties:
FailedBatches:
allOf:
- $ref: '#/components/schemas/FailedDeleteRemediationExceptionsBatches'
- description: Returns a list of failed delete remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.
DeleteRemediationExceptionsRequest:
type: object
required:
- ConfigRuleName
- ResourceKeys
title: DeleteRemediationExceptionsRequest
properties:
ConfigRuleName:
allOf:
- $ref: '#/components/schemas/ConfigRuleName'
- description: The name of the Config rule for which you want to delete remediation exception configuration.
ResourceKeys:
allOf:
- $ref: '#/components/schemas/RemediationExceptionResourceKeys'
- description: 'An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3
resource keys. '
NoSuchRemediationExceptionException: {}
DeleteResourceConfigRequest:
type: object
required:
- ResourceType
- ResourceId
title: DeleteResourceConfigRequest
properties:
ResourceType:
allOf:
- $ref: '#/components/schemas/ResourceTypeString'
- description: The type of the resource.
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: Unique identifier of the resource.
NoRunningConfigurationRecorderException: {}
DeleteRetentionConfigurationRequest:
type: object
required:
- RetentionConfigurationName
title: DeleteRetentionConfigurationRequest
properties:
RetentionConfigurationName:
allOf:
- $ref: '#/components/schemas/RetentionConfigurationName'
- description: The name of the retention configuration to delete.
NoSuchRetentionConfigurationException: {}
DeleteStoredQueryResponse:
type: object
properties: {}
DeleteStoredQueryRequest:
type: object
required:
- QueryName
title: DeleteStoredQueryRequest
properties:
QueryName:
allOf:
- $ref: '#/components/schemas/QueryName'
- description: The name of the query that you want to delete.
ResourceNotFoundException: {}
DeliverConfigSnapshotResponse:
type: object
properties:
configSnapshotId:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the snapshot that is being created.
description: 'The output for the DeliverConfigSnapshot action, in JSON format.'
DeliverConfigSnapshotRequest:
type: object
required:
- deliveryChannelName
title: DeliverConfigSnapshotRequest
properties:
deliveryChannelName:
allOf:
- $ref: '#/components/schemas/ChannelName'
- description: The name of the delivery channel through which the snapshot is delivered.
description: The input for the DeliverConfigSnapshot action.
DescribeAggregateComplianceByConfigRulesResponse:
type: object
properties:
AggregateComplianceByConfigRules:
allOf:
- $ref: '#/components/schemas/AggregateComplianceByConfigRuleList'
- description: Returns a list of AggregateComplianceByConfigRule object.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
DescribeAggregateComplianceByConfigRulesRequest:
type: object
required:
- ConfigurationAggregatorName
title: DescribeAggregateComplianceByConfigRulesRequest
properties:
ConfigurationAggregatorName:
allOf:
- $ref: '#/components/schemas/ConfigurationAggregatorName'
- description: The name of the configuration aggregator.
Filters:
allOf:
- $ref: '#/components/schemas/ConfigRuleComplianceFilters'
- description: 'Filters the results by ConfigRuleComplianceFilters object. '
Limit:
allOf:
- $ref: '#/components/schemas/GroupByAPILimit'
- description: 'The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
InvalidLimitException: {}
InvalidNextTokenException: {}
DescribeAggregateComplianceByConformancePacksResponse:
type: object
properties:
AggregateComplianceByConformancePacks:
allOf:
- $ref: '#/components/schemas/AggregateComplianceByConformancePackList'
- description: Returns the AggregateComplianceByConformancePack object.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
DescribeAggregateComplianceByConformancePacksRequest:
type: object
required:
- ConfigurationAggregatorName
title: DescribeAggregateComplianceByConformancePacksRequest
properties:
ConfigurationAggregatorName:
allOf:
- $ref: '#/components/schemas/ConfigurationAggregatorName'
- description: The name of the configuration aggregator.
Filters:
allOf:
- $ref: '#/components/schemas/AggregateConformancePackComplianceFilters'
- description: Filters the result by AggregateConformancePackComplianceFilters object.
Limit:
allOf:
- $ref: '#/components/schemas/Limit'
- description: 'The maximum number of conformance packs compliance details returned on each page. The default is maximum. If you specify 0, Config uses the default. '
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
DescribeAggregationAuthorizationsResponse:
type: object
properties:
AggregationAuthorizations:
allOf:
- $ref: '#/components/schemas/AggregationAuthorizationList'
- description: Returns a list of authorizations granted to various aggregator accounts and regions.
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.
DescribeAggregationAuthorizationsRequest:
type: object
title: DescribeAggregationAuthorizationsRequest
properties:
Limit:
allOf:
- $ref: '#/components/schemas/Limit'
- description: 'The maximum number of AggregationAuthorizations returned on each page. The default is maximum. If you specify 0, Config uses the default.'
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.
DescribeComplianceByConfigRuleResponse:
type: object
properties:
ComplianceByConfigRules:
allOf:
- $ref: '#/components/schemas/ComplianceByConfigRules'
- description: Indicates whether each of the specified Config rules is compliant.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The string that you use in a subsequent request to get the next page of results in a paginated response.
description:
DescribeComplianceByConfigRuleRequest:
type: object
title: DescribeComplianceByConfigRuleRequest
properties:
ConfigRuleNames:
allOf:
- $ref: '#/components/schemas/ConfigRuleNames'
- description: Specify one or more Config rule names to filter the results by rule.
ComplianceTypes:
allOf:
- $ref: '#/components/schemas/ComplianceTypes'
- description: Filters the results by compliance.
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.
description:
DescribeComplianceByResourceResponse:
type: object
properties:
ComplianceByResources:
allOf:
- $ref: '#/components/schemas/ComplianceByResources'
- description: Indicates whether the specified Amazon Web Services resource complies with all of the Config rules that evaluate it.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The string that you use in a subsequent request to get the next page of results in a paginated response.
description:
DescribeComplianceByResourceRequest:
type: object
title: DescribeComplianceByResourceRequest
properties:
ResourceType:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: 'The types of Amazon Web Services resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource
type is an Amazon Web Services account by specifying AWS::::Account.'
ResourceId:
allOf:
- $ref: '#/components/schemas/BaseResourceId'
- description: 'The ID of the Amazon Web Services resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify
a type for ResourceType.'
ComplianceTypes:
allOf:
- $ref: '#/components/schemas/ComplianceTypes'
- description: Filters the results by compliance.
Limit:
allOf:
- $ref: '#/components/schemas/Limit'
- description: 'The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
description:
DescribeConfigRuleEvaluationStatusResponse:
type: object
properties:
ConfigRulesEvaluationStatus:
allOf:
- $ref: '#/components/schemas/ConfigRuleEvaluationStatusList'
- description: Status information about your Config managed rules.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The string that you use in a subsequent request to get the next page of results in a paginated response.
description:
DescribeConfigRuleEvaluationStatusRequest:
type: object
title: DescribeConfigRuleEvaluationStatusRequest
properties:
ConfigRuleNames:
allOf:
- $ref: '#/components/schemas/ConfigRuleNames'
- description: 'The name of the Config managed rules for which you want status information. If you do not specify any names, Config returns status information for all Config managed rules that
you use.'
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.
Limit:
allOf:
- $ref: '#/components/schemas/RuleLimit'
- description: 'The number of rule evaluation results that you want returned.
This parameter is required if the rule limit for your account is more than the default of 150 rules.
For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide.
' description: DescribeConfigRulesResponse: type: object properties: ConfigRules: allOf: - $ref: '#/components/schemas/ConfigRules' - description: The details about your Config rules. NextToken: allOf: - $ref: '#/components/schemas/String' - description: The string that you use in a subsequent request to get the next page of results in a paginated response. description: DescribeConfigRulesRequest: type: object title: DescribeConfigRulesRequest properties: ConfigRuleNames: allOf: - $ref: '#/components/schemas/ConfigRuleNames' - description: 'The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.' NextToken: allOf: - $ref: '#/components/schemas/String' - description: ThenextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Filters:
allOf:
- $ref: '#/components/schemas/DescribeConfigRulesFilters'
- description: 'Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see
Evaluation Mode in the Config Developer Guide.'
description:
DescribeConfigurationAggregatorSourcesStatusResponse:
type: object
properties:
AggregatedSourceStatusList:
allOf:
- $ref: '#/components/schemas/AggregatedSourceStatusList'
- description: 'Returns an AggregatedSourceStatus object. '
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.
DescribeConfigurationAggregatorSourcesStatusRequest:
type: object
required:
- ConfigurationAggregatorName
title: DescribeConfigurationAggregatorSourcesStatusRequest
properties:
ConfigurationAggregatorName:
allOf:
- $ref: '#/components/schemas/ConfigurationAggregatorName'
- description: The name of the configuration aggregator.
UpdateStatus:
allOf:
- $ref: '#/components/schemas/AggregatedSourceStatusTypeList'
- description: Filters the status type.
Valid value FAILED indicates errors while moving data.
Valid value SUCCEEDED indicates the data was successfully moved.
Valid value OUTDATED indicates the data is not the most recent.
nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Limit:
allOf:
- $ref: '#/components/schemas/Limit'
- description: 'The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, Config uses the default.'
DescribeConfigurationAggregatorsResponse:
type: object
properties:
ConfigurationAggregators:
allOf:
- $ref: '#/components/schemas/ConfigurationAggregatorList'
- description: Returns a ConfigurationAggregators object.
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.
DescribeConfigurationAggregatorsRequest:
type: object
title: DescribeConfigurationAggregatorsRequest
properties:
ConfigurationAggregatorNames:
allOf:
- $ref: '#/components/schemas/ConfigurationAggregatorNameList'
- description: The name of the configuration aggregators.
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.
Limit:
allOf:
- $ref: '#/components/schemas/Limit'
- description: 'The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, Config uses the default.'
DescribeConfigurationRecorderStatusResponse:
type: object
properties:
ConfigurationRecordersStatus:
allOf:
- $ref: '#/components/schemas/ConfigurationRecorderStatusList'
- description: A list that contains status of the specified recorders.
description: 'The output for the DescribeConfigurationRecorderStatus action, in JSON format.'
DescribeConfigurationRecorderStatusRequest:
type: object
title: DescribeConfigurationRecorderStatusRequest
properties:
ConfigurationRecorderNames:
allOf:
- $ref: '#/components/schemas/ConfigurationRecorderNameList'
- description: 'The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.'
description: The input for the DescribeConfigurationRecorderStatus action.
DescribeConfigurationRecordersResponse:
type: object
properties:
ConfigurationRecorders:
allOf:
- $ref: '#/components/schemas/ConfigurationRecorderList'
- description: A list that contains the descriptions of the specified configuration recorders.
description: The output for the DescribeConfigurationRecorders action.
DescribeConfigurationRecordersRequest:
type: object
title: DescribeConfigurationRecordersRequest
properties:
ConfigurationRecorderNames:
allOf:
- $ref: '#/components/schemas/ConfigurationRecorderNameList'
- description: A list of configuration recorder names.
description: The input for the DescribeConfigurationRecorders action.
DescribeConformancePackComplianceResponse:
type: object
required:
- ConformancePackName
- ConformancePackRuleComplianceList
properties:
ConformancePackName:
allOf:
- $ref: '#/components/schemas/ConformancePackName'
- description: Name of the conformance pack.
ConformancePackRuleComplianceList:
allOf:
- $ref: '#/components/schemas/ConformancePackRuleComplianceList'
- description: Returns a list of ConformancePackRuleCompliance 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.
DescribeConformancePackComplianceRequest:
type: object
required:
- ConformancePackName
title: DescribeConformancePackComplianceRequest
properties:
ConformancePackName:
allOf:
- $ref: '#/components/schemas/ConformancePackName'
- description: Name of the conformance pack.
Filters:
allOf:
- $ref: '#/components/schemas/ConformancePackComplianceFilters'
- description: A ConformancePackComplianceFilters object.
Limit:
allOf:
- $ref: '#/components/schemas/DescribeConformancePackComplianceLimit'
- description: The maximum number of Config rules within a conformance pack are 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.
NoSuchConfigRuleInConformancePackException: {}
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.
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.
DescribeConformancePacksResponse:
type: object
properties:
ConformancePackDetails:
allOf:
- $ref: '#/components/schemas/ConformancePackDetailList'
- description: Returns a list of ConformancePackDetail 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.
DescribeConformancePacksRequest:
type: object
title: DescribeConformancePacksRequest
properties:
ConformancePackNames:
allOf:
- $ref: '#/components/schemas/ConformancePackNamesList'
- description: 'Comma-separated list of conformance pack names for which you want details. If you do not specify any names, Config returns details for all your conformance packs. '
Limit:
allOf:
- $ref: '#/components/schemas/PageSizeLimit'
- description: The maximum number of conformance packs 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.
DescribeDeliveryChannelStatusResponse:
type: object
properties:
DeliveryChannelsStatus:
allOf:
- $ref: '#/components/schemas/DeliveryChannelStatusList'
- description: A list that contains the status of a specified delivery channel.
description: The output for the DescribeDeliveryChannelStatus action.
DescribeDeliveryChannelStatusRequest:
type: object
title: DescribeDeliveryChannelStatusRequest
properties:
DeliveryChannelNames:
allOf:
- $ref: '#/components/schemas/DeliveryChannelNameList'
- description: A list of delivery channel names.
description: The input for the DeliveryChannelStatus action.
DescribeDeliveryChannelsResponse:
type: object
properties:
DeliveryChannels:
allOf:
- $ref: '#/components/schemas/DeliveryChannelList'
- description: A list that contains the descriptions of the specified delivery channel.
description: The output for the DescribeDeliveryChannels action.
DescribeDeliveryChannelsRequest:
type: object
title: DescribeDeliveryChannelsRequest
properties:
DeliveryChannelNames:
allOf:
- $ref: '#/components/schemas/DeliveryChannelNameList'
- description: A list of delivery channel names.
description: The input for the DescribeDeliveryChannels action.
DescribeOrganizationConfigRuleStatusesResponse:
type: object
properties:
OrganizationConfigRuleStatuses:
allOf:
- $ref: '#/components/schemas/OrganizationConfigRuleStatuses'
- description: A list of 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. '
DescribeOrganizationConfigRuleStatusesRequest:
type: object
title: DescribeOrganizationConfigRuleStatusesRequest
properties:
OrganizationConfigRuleNames:
allOf:
- $ref: '#/components/schemas/OrganizationConfigRuleNames'
- description: 'The names of organization Config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules.'
Limit:
allOf:
- $ref: '#/components/schemas/CosmosPageLimit'
- description: 'The maximum number of 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. '
DescribeOrganizationConfigRulesResponse:
type: object
properties:
OrganizationConfigRules:
allOf:
- $ref: '#/components/schemas/OrganizationConfigRules'
- description: Returns a list of OrganizationConfigRule 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. '
DescribeOrganizationConfigRulesRequest:
type: object
title: DescribeOrganizationConfigRulesRequest
properties:
OrganizationConfigRuleNames:
allOf:
- $ref: '#/components/schemas/OrganizationConfigRuleNames'
- description: 'The names of organization Config rules for which you want details. If you do not specify any names, Config returns details for all your organization Config rules.'
Limit:
allOf:
- $ref: '#/components/schemas/CosmosPageLimit'
- description: 'The maximum number of organization Config rules 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. '
DescribeOrganizationConformancePackStatusesResponse:
type: object
properties:
OrganizationConformancePackStatuses:
allOf:
- $ref: '#/components/schemas/OrganizationConformancePackStatuses'
- description: 'A list of OrganizationConformancePackStatus 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. '
DescribeOrganizationConformancePackStatusesRequest:
type: object
title: DescribeOrganizationConformancePackStatusesRequest
properties:
OrganizationConformancePackNames:
allOf:
- $ref: '#/components/schemas/OrganizationConformancePackNames'
- description: 'The names of organization conformance packs for which you want status details. If you do not specify any names, Config returns details for all your organization conformance packs. '
Limit:
allOf:
- $ref: '#/components/schemas/CosmosPageLimit'
- description: 'The maximum number of OrganizationConformancePackStatuses 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. '
DescribeOrganizationConformancePacksResponse:
type: object
properties:
OrganizationConformancePacks:
allOf:
- $ref: '#/components/schemas/OrganizationConformancePacks'
- description: Returns a list of OrganizationConformancePacks 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.
DescribeOrganizationConformancePacksRequest:
type: object
title: DescribeOrganizationConformancePacksRequest
properties:
OrganizationConformancePackNames:
allOf:
- $ref: '#/components/schemas/OrganizationConformancePackNames'
- description: The name that you assign to an organization conformance pack.
Limit:
allOf:
- $ref: '#/components/schemas/CosmosPageLimit'
- description: 'The maximum number of organization config packs 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.
DescribePendingAggregationRequestsResponse:
type: object
properties:
PendingAggregationRequests:
allOf:
- $ref: '#/components/schemas/PendingAggregationRequestList'
- description: Returns a PendingAggregationRequests object.
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.
DescribePendingAggregationRequestsRequest:
type: object
title: DescribePendingAggregationRequestsRequest
properties:
Limit:
allOf:
- $ref: '#/components/schemas/DescribePendingAggregationRequestsLimit'
- description: 'The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.'
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.
DescribeRemediationConfigurationsResponse:
type: object
properties:
RemediationConfigurations:
allOf:
- $ref: '#/components/schemas/RemediationConfigurations'
- description: Returns a remediation configuration object.
DescribeRemediationConfigurationsRequest:
type: object
required:
- ConfigRuleNames
title: DescribeRemediationConfigurationsRequest
properties:
ConfigRuleNames:
allOf:
- $ref: '#/components/schemas/ConfigRuleNames'
- description: 'A list of Config rule names of remediation configurations for which you want details. '
DescribeRemediationExceptionsResponse:
type: object
properties:
RemediationExceptions:
allOf:
- $ref: '#/components/schemas/RemediationExceptions'
- description: Returns a list of remediation exception objects.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
DescribeRemediationExceptionsRequest:
type: object
required:
- ConfigRuleName
title: DescribeRemediationExceptionsRequest
properties:
ConfigRuleName:
allOf:
- $ref: '#/components/schemas/ConfigRuleName'
- description: The name of the Config rule.
ResourceKeys:
allOf:
- $ref: '#/components/schemas/RemediationExceptionResourceKeys'
- description: 'An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3
resource keys. '
Limit:
allOf:
- $ref: '#/components/schemas/Limit'
- description: 'The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, Config uses the default.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
DescribeRemediationExecutionStatusResponse:
type: object
properties:
RemediationExecutionStatuses:
allOf:
- $ref: '#/components/schemas/RemediationExecutionStatuses'
- description: Returns a list of remediation execution statuses 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.
DescribeRemediationExecutionStatusRequest:
type: object
required:
- ConfigRuleName
title: DescribeRemediationExecutionStatusRequest
properties:
ConfigRuleName:
allOf:
- $ref: '#/components/schemas/ConfigRuleName'
- description: A list of Config rule names.
ResourceKeys:
allOf:
- $ref: '#/components/schemas/ResourceKeys'
- description: 'A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID. '
Limit:
allOf:
- $ref: '#/components/schemas/Limit'
- description: 'The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, Config uses the default. '
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.
DescribeRetentionConfigurationsResponse:
type: object
properties:
RetentionConfigurations:
allOf:
- $ref: '#/components/schemas/RetentionConfigurationList'
- description: Returns a retention configuration object.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. '
DescribeRetentionConfigurationsRequest:
type: object
title: DescribeRetentionConfigurationsRequest
properties:
RetentionConfigurationNames:
allOf:
- $ref: '#/components/schemas/RetentionConfigurationNameList'
- description: 'A list of names of retention configurations for which you want details. If you do not specify a name, Config returns details for all the retention configurations for that account.
Currently, Config supports only one retention configuration per region in your account.
nextToken string returned on a previous page that you use to get the next page of results in a paginated response. '
GetAggregateComplianceDetailsByConfigRuleResponse:
type: object
properties:
AggregateEvaluationResults:
allOf:
- $ref: '#/components/schemas/AggregateEvaluationResultList'
- description: Returns an AggregateEvaluationResults object.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
GetAggregateComplianceDetailsByConfigRuleRequest:
type: object
required:
- ConfigurationAggregatorName
- ConfigRuleName
- AccountId
- AwsRegion
title: GetAggregateComplianceDetailsByConfigRuleRequest
properties:
ConfigurationAggregatorName:
allOf:
- $ref: '#/components/schemas/ConfigurationAggregatorName'
- description: The name of the configuration aggregator.
ConfigRuleName:
allOf:
- $ref: '#/components/schemas/ConfigRuleName'
- description: The name of the Config rule for which you want compliance information.
AccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: The 12-digit account ID of the source account.
AwsRegion:
allOf:
- $ref: '#/components/schemas/AwsRegion'
- description: The source region from where the data is aggregated.
ComplianceType:
allOf:
- $ref: '#/components/schemas/ComplianceType'
- description: 'The resource compliance status.
For the GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only the COMPLIANT
and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.
nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
GetAggregateConfigRuleComplianceSummaryResponse:
type: object
properties:
GroupByKey:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: Groups the result based on ACCOUNT_ID or AWS_REGION.
AggregateComplianceCounts:
allOf:
- $ref: '#/components/schemas/AggregateComplianceCountList'
- description: Returns a list of AggregateComplianceCounts object.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
GetAggregateConfigRuleComplianceSummaryRequest:
type: object
required:
- ConfigurationAggregatorName
title: GetAggregateConfigRuleComplianceSummaryRequest
properties:
ConfigurationAggregatorName:
allOf:
- $ref: '#/components/schemas/ConfigurationAggregatorName'
- description: The name of the configuration aggregator.
Filters:
allOf:
- $ref: '#/components/schemas/ConfigRuleComplianceSummaryFilters'
- description: Filters the results based on the ConfigRuleComplianceSummaryFilters object.
GroupByKey:
allOf:
- $ref: '#/components/schemas/ConfigRuleComplianceSummaryGroupKey'
- description: Groups the result based on ACCOUNT_ID or AWS_REGION.
Limit:
allOf:
- $ref: '#/components/schemas/GroupByAPILimit'
- description: 'The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
GetAggregateConformancePackComplianceSummaryResponse:
type: object
properties:
AggregateConformancePackComplianceSummaries:
allOf:
- $ref: '#/components/schemas/AggregateConformancePackComplianceSummaryList'
- description: Returns a list of AggregateConformancePackComplianceSummary object.
GroupByKey:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
GetAggregateConformancePackComplianceSummaryRequest:
type: object
required:
- ConfigurationAggregatorName
title: GetAggregateConformancePackComplianceSummaryRequest
properties:
ConfigurationAggregatorName:
allOf:
- $ref: '#/components/schemas/ConfigurationAggregatorName'
- description: The name of the configuration aggregator.
Filters:
allOf:
- $ref: '#/components/schemas/AggregateConformancePackComplianceSummaryFilters'
- description: Filters the results based on the AggregateConformancePackComplianceSummaryFilters object.
GroupByKey:
allOf:
- $ref: '#/components/schemas/AggregateConformancePackComplianceSummaryGroupKey'
- description: Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.
Limit:
allOf:
- $ref: '#/components/schemas/Limit'
- description: 'The maximum number of results returned on each page. The default is maximum. If you specify 0, Config uses the default.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
GetAggregateDiscoveredResourceCountsResponse:
type: object
required:
- TotalDiscoveredResources
properties:
TotalDiscoveredResources:
allOf:
- $ref: '#/components/schemas/Long'
- description: The total number of resources that are present in an aggregator with the filters that you provide.
GroupByKey:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: 'The key passed into the request object. If GroupByKey is not provided, the result will be empty.'
GroupedResourceCounts:
allOf:
- $ref: '#/components/schemas/GroupedResourceCountList'
- description: Returns a list of GroupedResourceCount objects.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
GetAggregateDiscoveredResourceCountsRequest:
type: object
required:
- ConfigurationAggregatorName
title: GetAggregateDiscoveredResourceCountsRequest
properties:
ConfigurationAggregatorName:
allOf:
- $ref: '#/components/schemas/ConfigurationAggregatorName'
- description: The name of the configuration aggregator.
Filters:
allOf:
- $ref: '#/components/schemas/ResourceCountFilters'
- description: Filters the results based on the ResourceCountFilters object.
GroupByKey:
allOf:
- $ref: '#/components/schemas/ResourceCountGroupKey'
- description: The key to group the resource counts.
Limit:
allOf:
- $ref: '#/components/schemas/GroupByAPILimit'
- description: 'The maximum number of GroupedResourceCount objects returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses
the default.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. '
GetAggregateResourceConfigResponse:
type: object
properties:
ConfigurationItem:
allOf:
- $ref: '#/components/schemas/ConfigurationItem'
- description: Returns a ConfigurationItem object.
GetAggregateResourceConfigRequest:
type: object
required:
- ConfigurationAggregatorName
- ResourceIdentifier
title: GetAggregateResourceConfigRequest
properties:
ConfigurationAggregatorName:
allOf:
- $ref: '#/components/schemas/ConfigurationAggregatorName'
- description: The name of the configuration aggregator.
ResourceIdentifier:
allOf:
- $ref: '#/components/schemas/AggregateResourceIdentifier'
- description: An object that identifies aggregate resource.
OversizedConfigurationItemException: {}
ResourceNotDiscoveredException: {}
GetComplianceDetailsByConfigRuleResponse:
type: object
properties:
EvaluationResults:
allOf:
- $ref: '#/components/schemas/EvaluationResults'
- description: Indicates whether the Amazon Web Services resource complies with the specified Config rule.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The string that you use in a subsequent request to get the next page of results in a paginated response.
description:
GetComplianceDetailsByConfigRuleRequest:
type: object
required:
- ConfigRuleName
title: GetComplianceDetailsByConfigRuleRequest
properties:
ConfigRuleName:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit64'
- description: The name of the Config rule for which you want compliance information.
ComplianceTypes:
allOf:
- $ref: '#/components/schemas/ComplianceTypes'
- description: 'Filters the results by compliance.
INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule cannot be evaluated. However,
INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results.
nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
description:
GetComplianceDetailsByResourceResponse:
type: object
properties:
EvaluationResults:
allOf:
- $ref: '#/components/schemas/EvaluationResults'
- description: Indicates whether the specified Amazon Web Services resource complies each Config rule.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The string that you use in a subsequent request to get the next page of results in a paginated response.
description:
GetComplianceDetailsByResourceRequest:
type: object
title: GetComplianceDetailsByResourceRequest
properties:
ResourceType:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: The type of the Amazon Web Services resource for which you want compliance information.
ResourceId:
allOf:
- $ref: '#/components/schemas/BaseResourceId'
- description: The ID of the Amazon Web Services resource for which you want compliance information.
ComplianceTypes:
allOf:
- $ref: '#/components/schemas/ComplianceTypes'
- description: 'Filters the results by compliance.
INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule cannot be evaluated. However,
INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results.
nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
ResourceEvaluationId:
allOf:
- $ref: '#/components/schemas/ResourceEvaluationId'
- description: The unique ID of Amazon Web Services resource execution for which you want to retrieve evaluation results.
You need to only provide either a
ResourceEvaluationID or a ResourceID and ResourceType.
Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.
For this request, you
can specify an Amazon Web Services resource type such as AWS::EC2::Instance. You can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.
ConformancePackEvaluationResult 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.
GetConformancePackComplianceDetailsRequest:
type: object
required:
- ConformancePackName
title: GetConformancePackComplianceDetailsRequest
properties:
ConformancePackName:
allOf:
- $ref: '#/components/schemas/ConformancePackName'
- description: Name of the conformance pack.
Filters:
allOf:
- $ref: '#/components/schemas/ConformancePackEvaluationFilters'
- description: A ConformancePackEvaluationFilters object.
Limit:
allOf:
- $ref: '#/components/schemas/GetConformancePackComplianceDetailsLimit'
- description: 'The maximum number of evaluation results returned on each page. If you do no specify a number, Config uses the default. The default is 100.'
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.
GetConformancePackComplianceSummaryResponse:
type: object
properties:
ConformancePackComplianceSummaryList:
allOf:
- $ref: '#/components/schemas/ConformancePackComplianceSummaryList'
- description: 'A list of ConformancePackComplianceSummary objects. '
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
GetConformancePackComplianceSummaryRequest:
type: object
required:
- ConformancePackNames
title: GetConformancePackComplianceSummaryRequest
properties:
ConformancePackNames:
allOf:
- $ref: '#/components/schemas/ConformancePackNamesToSummarizeList'
- description: Names of conformance packs.
Limit:
allOf:
- $ref: '#/components/schemas/PageSizeLimit'
- description: The maximum number of conformance packs returned on each page.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
GetCustomRulePolicyResponse:
type: object
properties:
PolicyText:
allOf:
- $ref: '#/components/schemas/PolicyText'
- description: The policy definition containing the logic for your Config Custom Policy rule.
GetCustomRulePolicyRequest:
type: object
title: GetCustomRulePolicyRequest
properties:
ConfigRuleName:
allOf:
- $ref: '#/components/schemas/ConfigRuleName'
- description: The name of your Config Custom Policy rule.
GetDiscoveredResourceCountsResponse:
type: object
properties:
totalDiscoveredResources:
allOf:
- $ref: '#/components/schemas/Long'
- description: 'The total number of resources that Config is recording in the region for your account. If you specify resource types in the request, Config returns only the total number of resources for those resource types.
Example
Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of 60 resources.
You make a call to the GetDiscoveredResourceCounts action and specify the resource type, "AWS::EC2::Instances",
in the request.
Config returns 25 for totalDiscoveredResources.
ResourceCount objects. Each object is listed in descending order by the number of resources.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The string that you use in a subsequent request to get the next page of results in a paginated response.
GetDiscoveredResourceCountsRequest:
type: object
title: GetDiscoveredResourceCountsRequest
properties:
resourceTypes:
allOf:
- $ref: '#/components/schemas/ResourceTypes'
- description: 'The comma-separated list that specifies the resource types that you want Config to return (for example, "AWS::EC2::Instance", "AWS::IAM::User").
If a value for resourceTypes is not specified, Config returns all resource types that Config is recording in the region for your account.
If the configuration recorder is turned off, Config returns an empty list of ResourceCount objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of ResourceCount objects.
nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
GetOrganizationConfigRuleDetailedStatusResponse:
type: object
properties:
OrganizationConfigRuleDetailedStatus:
allOf:
- $ref: '#/components/schemas/OrganizationConfigRuleDetailedStatus'
- description: A list of MemberAccountStatus 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. '
GetOrganizationConfigRuleDetailedStatusRequest:
type: object
required:
- OrganizationConfigRuleName
title: GetOrganizationConfigRuleDetailedStatusRequest
properties:
OrganizationConfigRuleName:
allOf:
- $ref: '#/components/schemas/OrganizationConfigRuleName'
- description: The name of your organization Config rule for which you want status details for member accounts.
Filters:
allOf:
- $ref: '#/components/schemas/StatusDetailFilters'
- description: A StatusDetailFilters object.
Limit:
allOf:
- $ref: '#/components/schemas/CosmosPageLimit'
- description: 'The maximum number of OrganizationConfigRuleDetailedStatus returned on each page. If you do not 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. '
GetOrganizationConformancePackDetailedStatusResponse:
type: object
properties:
OrganizationConformancePackDetailedStatuses:
allOf:
- $ref: '#/components/schemas/OrganizationConformancePackDetailedStatuses'
- description: 'A list of OrganizationConformancePackDetailedStatus 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. '
GetOrganizationConformancePackDetailedStatusRequest:
type: object
required:
- OrganizationConformancePackName
title: GetOrganizationConformancePackDetailedStatusRequest
properties:
OrganizationConformancePackName:
allOf:
- $ref: '#/components/schemas/OrganizationConformancePackName'
- description: The name of organization conformance pack for which you want status details for member accounts.
Filters:
allOf:
- $ref: '#/components/schemas/OrganizationResourceDetailedStatusFilters'
- description: An OrganizationResourceDetailedStatusFilters object.
Limit:
allOf:
- $ref: '#/components/schemas/CosmosPageLimit'
- description: 'The maximum number of OrganizationConformancePackDetailedStatuses returned on each page. If you do not 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. '
GetOrganizationCustomRulePolicyResponse:
type: object
properties:
PolicyText:
allOf:
- $ref: '#/components/schemas/PolicyText'
- description: The policy definition containing the logic for your organization Config Custom Policy rule.
GetOrganizationCustomRulePolicyRequest:
type: object
required:
- OrganizationConfigRuleName
title: GetOrganizationCustomRulePolicyRequest
properties:
OrganizationConfigRuleName:
allOf:
- $ref: '#/components/schemas/OrganizationConfigRuleName'
- description: 'The name of your organization Config Custom Policy rule. '
GetResourceConfigHistoryResponse:
type: object
properties:
configurationItems:
allOf:
- $ref: '#/components/schemas/ConfigurationItemList'
- description: A list that contains the configuration history of one or more resources.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The string that you use in a subsequent request to get the next page of results in a paginated response.
description: The output for the GetResourceConfigHistory action.
GetResourceConfigHistoryRequest:
type: object
required:
- resourceType
- resourceId
title: GetResourceConfigHistoryRequest
properties:
resourceType:
allOf:
- $ref: '#/components/schemas/ResourceType'
- description: The resource type.
resourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the resource (for example., sg-xxxxxx).'
laterTime:
allOf:
- $ref: '#/components/schemas/LaterTime'
- description: 'The time stamp that indicates a later time. If not specified, current time is taken.'
earlierTime:
allOf:
- $ref: '#/components/schemas/EarlierTime'
- description: 'The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item
was recorded.'
chronologicalOrder:
allOf:
- $ref: '#/components/schemas/ChronologicalOrder'
- description: 'The chronological order for configuration items listed. By default, the results are listed in reverse chronological order.'
limit:
allOf:
- $ref: '#/components/schemas/Limit'
- description: 'The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.'
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
description: The input for the GetResourceConfigHistory action.
InvalidTimeRangeException: {}
GetResourceEvaluationSummaryResponse:
type: object
properties:
ResourceEvaluationId:
allOf:
- $ref: '#/components/schemas/ResourceEvaluationId'
- description: The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.
EvaluationMode:
allOf:
- $ref: '#/components/schemas/EvaluationMode'
- description: Lists results of the mode that you requested to retrieve the resource evaluation summary. The valid values are Detective or Proactive.
EvaluationStatus:
allOf:
- $ref: '#/components/schemas/EvaluationStatus'
- description: Returns an EvaluationStatus object.
EvaluationStartTimestamp:
allOf:
- $ref: '#/components/schemas/Date'
- description: The start timestamp when Config rule starts evaluating compliance for the provided resource details.
Compliance:
allOf:
- $ref: '#/components/schemas/ComplianceType'
- description: The compliance status of the resource evaluation summary.
EvaluationContext:
allOf:
- $ref: '#/components/schemas/EvaluationContext'
- description: Returns an EvaluationContext object.
ResourceDetails:
allOf:
- $ref: '#/components/schemas/ResourceDetails'
- description: Returns a ResourceDetails object.
GetResourceEvaluationSummaryRequest:
type: object
required:
- ResourceEvaluationId
title: GetResourceEvaluationSummaryRequest
properties:
ResourceEvaluationId:
allOf:
- $ref: '#/components/schemas/ResourceEvaluationId'
- description: The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.
GetStoredQueryResponse:
type: object
properties:
StoredQuery:
allOf:
- $ref: '#/components/schemas/StoredQuery'
- description: Returns a StoredQuery object.
GetStoredQueryRequest:
type: object
required:
- QueryName
title: GetStoredQueryRequest
properties:
QueryName:
allOf:
- $ref: '#/components/schemas/QueryName'
- description: The name of the query.
ListAggregateDiscoveredResourcesResponse:
type: object
properties:
ResourceIdentifiers:
allOf:
- $ref: '#/components/schemas/DiscoveredResourceIdentifierList'
- description: Returns a list of ResourceIdentifiers objects.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
ListAggregateDiscoveredResourcesRequest:
type: object
required:
- ConfigurationAggregatorName
- ResourceType
title: ListAggregateDiscoveredResourcesRequest
properties:
ConfigurationAggregatorName:
allOf:
- $ref: '#/components/schemas/ConfigurationAggregatorName'
- description: 'The name of the configuration aggregator. '
ResourceType:
allOf:
- $ref: '#/components/schemas/ResourceType'
- description: The type of resources that you want Config to list in the response.
Filters:
allOf:
- $ref: '#/components/schemas/ResourceFilters'
- description: Filters the results based on the ResourceFilters object.
Limit:
allOf:
- $ref: '#/components/schemas/Limit'
- description: 'The maximum number of resource identifiers returned on each page. You cannot specify a number greater than 100. If you specify 0, Config uses the default.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
ListConformancePackComplianceScoresResponse:
type: object
required:
- ConformancePackComplianceScores
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string that you can use to get the next page of results in a paginated response.
ConformancePackComplianceScores:
allOf:
- $ref: '#/components/schemas/ConformancePackComplianceScores'
- description: A list of ConformancePackComplianceScore objects.
ListConformancePackComplianceScoresRequest:
type: object
title: ListConformancePackComplianceScoresRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/ConformancePackComplianceScoresFilters'
- description: Filters the results based on the ConformancePackComplianceScoresFilters.
SortOrder:
allOf:
- $ref: '#/components/schemas/SortOrder'
- description: 'Determines the order in which conformance pack compliance scores are sorted. Either in ascending or descending order.
By default, conformance pack compliance scores are
sorted in alphabetical order by name of the conformance pack. Conformance pack compliance scores are sorted in reverse alphabetical order if you enter DESCENDING.
You can
sort conformance pack compliance scores by the numerical value of the compliance score by entering SCORE in the SortBy action. When compliance scores are sorted by
SCORE, conformance packs with a compliance score of INSUFFICIENT_DATA will be last when sorting by ascending order and first when sorting by descending order.
Sorts your conformance pack compliance scores in either ascending or descending order, depending on SortOrder.
By default, conformance pack compliance scores
are sorted in alphabetical order by name of the conformance pack. Enter SCORE, to sort conformance pack compliance scores by the numerical value of the compliance score.
nextToken string in a prior request that you can use to get the paginated response for the next set of conformance pack compliance scores.
ListDiscoveredResourcesResponse:
type: object
properties:
resourceIdentifiers:
allOf:
- $ref: '#/components/schemas/ResourceIdentifierList'
- description: 'The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.'
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The string that you use in a subsequent request to get the next page of results in a paginated response.
description:
ListDiscoveredResourcesRequest:
type: object
required:
- resourceType
title: ListDiscoveredResourcesRequest
properties:
resourceType:
allOf:
- $ref: '#/components/schemas/ResourceType'
- description: The type of resources that you want Config to list in the response.
resourceIds:
allOf:
- $ref: '#/components/schemas/ResourceIdList'
- description: 'The IDs of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has
discovered. You can list a minimum of 1 resourceID and a maximum of 20 resourceIds.'
resourceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: 'The custom name of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that
it has discovered.'
limit:
allOf:
- $ref: '#/components/schemas/Limit'
- description: 'The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.'
includeDeletedResources:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Specifies whether Config includes deleted resources in the results. By default, deleted resources are not included.'
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
description:
ListResourceEvaluationsResponse:
type: object
properties:
ResourceEvaluations:
allOf:
- $ref: '#/components/schemas/ResourceEvaluations'
- description: Returns a ResourceEvaluations object.
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.
ListResourceEvaluationsRequest:
type: object
title: ListResourceEvaluationsRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/ResourceEvaluationFilters'
- description: Returns a ResourceEvaluationFilters object.
Limit:
allOf:
- $ref: '#/components/schemas/ListResourceEvaluationsPageItemLimit'
- description: 'The maximum number of evaluations returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.'
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.
ListStoredQueriesResponse:
type: object
properties:
StoredQueryMetadata:
allOf:
- $ref: '#/components/schemas/StoredQueryMetadataList'
- description: A list of StoredQueryMetadata objects.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'If the previous paginated request didn''t return all of the remaining results, the response object''s NextToken parameter value is set to a token. To retrieve the
next set of results, call this action again and assign that token to the request object''s NextToken parameter. If there are no remaining results, the previous response object''s
NextToken parameter is set to null. '
ListStoredQueriesRequest:
type: object
title: ListStoredQueriesRequest
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
MaxResults:
allOf:
- $ref: '#/components/schemas/Limit'
- description: The maximum number of results to be returned with a single call.
ListTagsForResourceResponse:
type: object
properties:
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tags for the resource.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. '
ListTagsForResourceRequest:
type: object
required:
- ResourceArn
title: ListTagsForResourceRequest
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: 'The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator
and AggregatorAuthorization.'
Limit:
allOf:
- $ref: '#/components/schemas/Limit'
- description: 'The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, Config uses the default. '
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. '
PutAggregationAuthorizationResponse:
type: object
properties:
AggregationAuthorization:
allOf:
- $ref: '#/components/schemas/AggregationAuthorization'
- description: 'Returns an AggregationAuthorization object. '
PutAggregationAuthorizationRequest:
type: object
required:
- AuthorizedAccountId
- AuthorizedAwsRegion
title: PutAggregationAuthorizationRequest
properties:
AuthorizedAccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: The 12-digit account ID of the account authorized to aggregate data.
AuthorizedAwsRegion:
allOf:
- $ref: '#/components/schemas/AwsRegion'
- description: The region authorized to collect aggregated data.
Tags:
allOf:
- $ref: '#/components/schemas/TagsList'
- description: An array of tag object.
PutConfigRuleRequest:
type: object
required:
- ConfigRule
title: PutConfigRuleRequest
properties:
ConfigRule:
allOf:
- $ref: '#/components/schemas/ConfigRule'
- description: The rule that you want to add to your account.
Tags:
allOf:
- $ref: '#/components/schemas/TagsList'
- description: An array of tag object.
MaxNumberOfConfigRulesExceededException: {}
PutConfigurationAggregatorResponse:
type: object
properties:
ConfigurationAggregator:
allOf:
- $ref: '#/components/schemas/ConfigurationAggregator'
- description: Returns a ConfigurationAggregator object.
PutConfigurationAggregatorRequest:
type: object
required:
- ConfigurationAggregatorName
title: PutConfigurationAggregatorRequest
properties:
ConfigurationAggregatorName:
allOf:
- $ref: '#/components/schemas/ConfigurationAggregatorName'
- description: The name of the configuration aggregator.
AccountAggregationSources:
allOf:
- $ref: '#/components/schemas/AccountAggregationSourceList'
- description: 'A list of AccountAggregationSource object. '
OrganizationAggregationSource:
allOf:
- $ref: '#/components/schemas/OrganizationAggregationSource'
- description: An OrganizationAggregationSource object.
Tags:
allOf:
- $ref: '#/components/schemas/TagsList'
- description: An array of tag object.
LimitExceededException: {}
InvalidRoleException: {}
NoAvailableOrganizationException: {}
OrganizationAllFeaturesNotEnabledException: {}
PutConfigurationRecorderRequest:
type: object
required:
- ConfigurationRecorder
title: PutConfigurationRecorderRequest
properties:
ConfigurationRecorder:
allOf:
- $ref: '#/components/schemas/ConfigurationRecorder'
- description: An object for the configuration recorder to record configuration changes for specified resource types.
description: The input for the PutConfigurationRecorder action.
MaxNumberOfConfigurationRecordersExceededException: {}
InvalidConfigurationRecorderNameException: {}
InvalidRecordingGroupException: {}
PutConformancePackResponse:
type: object
properties:
ConformancePackArn:
allOf:
- $ref: '#/components/schemas/ConformancePackArn'
- description: ARN of the conformance pack.
PutConformancePackRequest:
type: object
required:
- ConformancePackName
title: PutConformancePackRequest
properties:
ConformancePackName:
allOf:
- $ref: '#/components/schemas/ConformancePackName'
- description: The unique name of the conformance pack you want to deploy.
TemplateS3Uri:
allOf:
- $ref: '#/components/schemas/TemplateS3Uri'
- description: 'The location of the file containing the template body (s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300 KB) that is located
in an Amazon S3 bucket in the same Region as the conformance pack.
You must have access to read Amazon S3 bucket.
A string containing the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes.
You can use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule) and remediation action (AWS::Config::RemediationConfiguration).
The name of the Amazon S3 bucket where Config stores conformance pack templates.
This field is optional.
The prefix for the Amazon S3 bucket.
This field is optional.
ConformancePackInputParameter objects.
TemplateSSMDocumentDetails:
allOf:
- $ref: '#/components/schemas/TemplateSSMDocumentDetails'
- description: 'An object of type TemplateSSMDocumentDetails, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document)
and the version of the SSM document that is used to create a conformance pack.'
ConformancePackTemplateValidationException: {}
MaxNumberOfConformancePacksExceededException: {}
PutDeliveryChannelRequest:
type: object
required:
- DeliveryChannel
title: PutDeliveryChannelRequest
properties:
DeliveryChannel:
allOf:
- $ref: '#/components/schemas/DeliveryChannel'
- description: The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket and to an Amazon SNS topic.
description: The input for the PutDeliveryChannel action.
MaxNumberOfDeliveryChannelsExceededException: {}
InvalidDeliveryChannelNameException: {}
NoSuchBucketException: {}
InvalidS3KeyPrefixException: {}
InvalidS3KmsKeyArnException: {}
InvalidSNSTopicARNException: {}
InsufficientDeliveryPolicyException: {}
PutEvaluationsResponse:
type: object
properties:
FailedEvaluations:
allOf:
- $ref: '#/components/schemas/Evaluations'
- description: Requests that failed because of a client or server error.
description:
PutEvaluationsRequest:
type: object
required:
- ResultToken
title: PutEvaluationsRequest
properties:
Evaluations:
allOf:
- $ref: '#/components/schemas/Evaluations'
- description: The assessments that the Lambda function performs. Each evaluation identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that
invokes the Lambda function.
ResultToken:
allOf:
- $ref: '#/components/schemas/String'
- description: An encrypted token that associates an evaluation with an Config rule. Identifies the rule and the event that triggered the evaluation.
TestMode:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Use this parameter to specify a test run for PutEvaluations. You can verify whether your Lambda function will deliver evaluation results to Config. No updates occur
to your existing evaluations, and evaluation results are not sent to Config.
When TestMode is true, PutEvaluations doesn''t require a valid
value for the ResultToken parameter, but the value cannot be null.
ExternalEvaluation object that provides details about compliance.
PutOrganizationConfigRuleResponse:
type: object
properties:
OrganizationConfigRuleArn:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: The Amazon Resource Name (ARN) of an organization Config rule.
PutOrganizationConfigRuleRequest:
type: object
required:
- OrganizationConfigRuleName
title: PutOrganizationConfigRuleRequest
properties:
OrganizationConfigRuleName:
allOf:
- $ref: '#/components/schemas/OrganizationConfigRuleName'
- description: The name that you assign to an organization Config rule.
OrganizationManagedRuleMetadata:
allOf:
- $ref: '#/components/schemas/OrganizationManagedRuleMetadata'
- description: An OrganizationManagedRuleMetadata object. This object specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource
along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.
OrganizationCustomRuleMetadata:
allOf:
- $ref: '#/components/schemas/OrganizationCustomRuleMetadata'
- description: 'An OrganizationCustomRuleMetadata object. This object specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource,
Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config
to run evaluations for the rule if the trigger type is periodic.'
ExcludedAccounts:
allOf:
- $ref: '#/components/schemas/ExcludedAccounts'
- description: A comma-separated list of accounts that you want to exclude from an organization Config rule.
OrganizationCustomPolicyRuleMetadata:
allOf:
- $ref: '#/components/schemas/OrganizationCustomPolicyRuleMetadata'
- description: 'An OrganizationCustomPolicyRuleMetadata object. This object specifies metadata for your organization''s Config Custom Policy rule. The metadata includes the runtime
system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types
that initiate Config to evaluate Amazon Web Services resources against a rule.'
MaxNumberOfOrganizationConfigRulesExceededException: {}
PutOrganizationConformancePackResponse:
type: object
properties:
OrganizationConformancePackArn:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: ARN of the organization conformance pack.
PutOrganizationConformancePackRequest:
type: object
required:
- OrganizationConformancePackName
title: PutOrganizationConformancePackRequest
properties:
OrganizationConformancePackName:
allOf:
- $ref: '#/components/schemas/OrganizationConformancePackName'
- description: Name of the organization conformance pack you want to create.
TemplateS3Uri:
allOf:
- $ref: '#/components/schemas/TemplateS3Uri'
- description: 'Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).
You must have access to read Amazon S3 bucket.
The name of the Amazon S3 bucket where Config stores conformance pack templates.
This field is optional. If used, it must be prefixed with awsconfigconforms.
The prefix for the Amazon S3 bucket.
This field is optional.
ConformancePackInputParameter objects.
ExcludedAccounts:
allOf:
- $ref: '#/components/schemas/ExcludedAccounts'
- description: A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.
MaxNumberOfOrganizationConformancePacksExceededException: {}
OrganizationConformancePackTemplateValidationException: {}
PutRemediationConfigurationsResponse:
type: object
properties:
FailedBatches:
allOf:
- $ref: '#/components/schemas/FailedRemediationBatches'
- description: Returns a list of failed remediation batch objects.
PutRemediationConfigurationsRequest:
type: object
required:
- RemediationConfigurations
title: PutRemediationConfigurationsRequest
properties:
RemediationConfigurations:
allOf:
- $ref: '#/components/schemas/RemediationConfigurations'
- description: A list of remediation configuration objects.
PutRemediationExceptionsResponse:
type: object
properties:
FailedBatches:
allOf:
- $ref: '#/components/schemas/FailedRemediationExceptionBatches'
- description: Returns a list of failed remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.
PutRemediationExceptionsRequest:
type: object
required:
- ConfigRuleName
- ResourceKeys
title: PutRemediationExceptionsRequest
properties:
ConfigRuleName:
allOf:
- $ref: '#/components/schemas/ConfigRuleName'
- description: The name of the Config rule for which you want to create remediation exception.
ResourceKeys:
allOf:
- $ref: '#/components/schemas/RemediationExceptionResourceKeys'
- description: 'An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3
resource keys. '
Message:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit1024'
- description: The message contains an explanation of the exception.
ExpirationTime:
allOf:
- $ref: '#/components/schemas/Date'
- description: The exception is automatically deleted after the expiration date.
PutResourceConfigRequest:
type: object
required:
- ResourceType
- SchemaVersionId
- ResourceId
- Configuration
title: PutResourceConfigRequest
properties:
ResourceType:
allOf:
- $ref: '#/components/schemas/ResourceTypeString'
- description: 'The type of the resource. The custom resource type must be registered with CloudFormation.
You cannot use the organization names “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::.
The configuration object of the resource in valid JSON format. It must match the schema registered with CloudFormation.
The configuration JSON must not exceed 64 KB.
Tags associated with the resource.
This field is not to be confused with the Amazon Web Services-wide tag feature for Amazon Web Services resources. Tags for
PutResourceConfig are tags that you supply for the configuration items of your custom resources.
Number of days Config stores your historical information.
Currently, only applicable to the configuration item history.
A list of StoredQuery objects. The mandatory fields are QueryName and Expression.
When you are creating a query, you must provide a query name and an expression. When you are updating a query, you must provide a query name but updating the description is optional.
Tags object.
TooManyTagsException: {}
ResourceConcurrentModificationException: {}
SelectAggregateResourceConfigResponse:
type: object
properties:
Results:
allOf:
- $ref: '#/components/schemas/Results'
- description: Returns the results for the SQL query.
QueryInfo:
$ref: '#/components/schemas/QueryInfo'
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. '
SelectAggregateResourceConfigRequest:
type: object
required:
- Expression
- ConfigurationAggregatorName
title: SelectAggregateResourceConfigRequest
properties:
Expression:
allOf:
- $ref: '#/components/schemas/Expression'
- description: 'The SQL query SELECT command. '
ConfigurationAggregatorName:
allOf:
- $ref: '#/components/schemas/ConfigurationAggregatorName'
- description: The name of the configuration aggregator.
Limit:
allOf:
- $ref: '#/components/schemas/Limit'
- description: 'The maximum number of query results returned on each page. '
MaxResults:
allOf:
- $ref: '#/components/schemas/Limit'
- description: The maximum number of query results returned on each page. Config also allows the Limit request parameter.
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. '
InvalidExpressionException: {}
SelectResourceConfigResponse:
type: object
properties:
Results:
allOf:
- $ref: '#/components/schemas/Results'
- description: Returns the results for the SQL query.
QueryInfo:
allOf:
- $ref: '#/components/schemas/QueryInfo'
- description: Returns the QueryInfo object.
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. '
SelectResourceConfigRequest:
type: object
required:
- Expression
title: SelectResourceConfigRequest
properties:
Expression:
allOf:
- $ref: '#/components/schemas/Expression'
- description: The SQL query SELECT command.
Limit:
allOf:
- $ref: '#/components/schemas/Limit'
- description: 'The maximum number of query results 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. '
StartConfigRulesEvaluationResponse:
type: object
properties: {}
description: The output when you start the evaluation for the specified Config rule.
StartConfigRulesEvaluationRequest:
type: object
title: StartConfigRulesEvaluationRequest
properties:
ConfigRuleNames:
allOf:
- $ref: '#/components/schemas/ReevaluateConfigRuleNames'
- description: The list of names of Config rules that you want to run evaluations for.
description:
StartConfigurationRecorderRequest:
type: object
required:
- ConfigurationRecorderName
title: StartConfigurationRecorderRequest
properties:
ConfigurationRecorderName:
allOf:
- $ref: '#/components/schemas/RecorderName'
- description: The name of the recorder object that records each configuration change made to the resources.
description: The input for the StartConfigurationRecorder action.
NoAvailableDeliveryChannelException: {}
StartRemediationExecutionResponse:
type: object
properties:
FailureMessage:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Returns a failure message. For example, the resource is already compliant.'
FailedItems:
allOf:
- $ref: '#/components/schemas/ResourceKeys'
- description: 'For resources that have failed to start execution, the API returns a resource key object.'
StartRemediationExecutionRequest:
type: object
required:
- ConfigRuleName
- ResourceKeys
title: StartRemediationExecutionRequest
properties:
ConfigRuleName:
allOf:
- $ref: '#/components/schemas/ConfigRuleName'
- description: The list of names of Config rules that you want to run remediation execution for.
ResourceKeys:
allOf:
- $ref: '#/components/schemas/ResourceKeys'
- description: 'A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID. '
StartResourceEvaluationResponse:
type: object
properties:
ResourceEvaluationId:
allOf:
- $ref: '#/components/schemas/ResourceEvaluationId'
- description: A unique ResourceEvaluationId that is associated with a single execution.
StartResourceEvaluationRequest:
type: object
required:
- ResourceDetails
- EvaluationMode
title: StartResourceEvaluationRequest
properties:
ResourceDetails:
allOf:
- $ref: '#/components/schemas/ResourceDetails'
- description: Returns a ResourceDetails object.
EvaluationContext:
allOf:
- $ref: '#/components/schemas/EvaluationContext'
- description: Returns an EvaluationContext object.
EvaluationMode:
allOf:
- $ref: '#/components/schemas/EvaluationMode'
- description: The mode of an evaluation. The valid values for this API are DETECTIVE and PROACTIVE.
EvaluationTimeout:
allOf:
- $ref: '#/components/schemas/EvaluationTimeout'
- description: 'The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default.'
ClientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: 'A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request.
Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error.
ConfigRule, ConfigurationAggregator
and AggregatorAuthorization.'
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: An array of tag object.
UntagResourceRequest:
type: object
required:
- ResourceArn
- TagKeys
title: UntagResourceRequest
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: 'The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator
and AggregatorAuthorization.'
TagKeys:
allOf:
- $ref: '#/components/schemas/TagKeyList'
- description: The keys of the tags to be removed.
ARN:
type: string
AccountAggregationSourceAccountList:
type: array
items:
$ref: '#/components/schemas/AccountId'
minItems: 1
Boolean:
type: boolean
AggregatorRegionList:
type: array
items:
$ref: '#/components/schemas/String'
minItems: 1
AccountAggregationSource:
type: object
required:
- AccountIds
properties:
AccountIds:
allOf:
- $ref: '#/components/schemas/AccountAggregationSourceAccountList'
- description: 'The 12-digit account ID of the account being aggregated. '
AllAwsRegions:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'If true, aggregate existing Config regions and future regions.'
AwsRegions:
allOf:
- $ref: '#/components/schemas/AggregatorRegionList'
- description: The source regions being aggregated.
description: A collection of accounts and regions.
AccountId:
type: string
pattern: '\d{12}'
AccountAggregationSourceList:
type: array
items:
$ref: '#/components/schemas/AccountAggregationSource'
minItems: 0
maxItems: 1
ConfigRuleName:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 128
Compliance:
type: object
properties:
ComplianceType:
allOf:
- $ref: '#/components/schemas/ComplianceType'
- description: 'Indicates whether an Amazon Web Services resource or Config rule is compliant.
A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.
A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.
Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the Amazon Web Services resource or Config
rule.
For the Compliance data type, Config supports only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. Config does not
support the NOT_APPLICABLE value for the Compliance data type.
NON_COMPLIANT, up to a maximum number.'
description: Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.
AwsRegion:
type: string
minLength: 1
maxLength: 64
AggregateComplianceByConfigRule:
type: object
properties:
ConfigRuleName:
allOf:
- $ref: '#/components/schemas/ConfigRuleName'
- description: The name of the Config rule.
Compliance:
allOf:
- $ref: '#/components/schemas/Compliance'
- description: Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.
AccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: The 12-digit account ID of the source account.
AwsRegion:
allOf:
- $ref: '#/components/schemas/AwsRegion'
- description: The source region from where the data is aggregated.
description: 'Indicates whether an Config rule is compliant based on account ID, region, compliance, and rule name.
A rule is compliant if all of the resources that the rule evaluated comply with it. It is noncompliant if any of these resources do not comply.
' AggregateComplianceByConfigRuleList: type: array items: $ref: '#/components/schemas/AggregateComplianceByConfigRule' ConformancePackName: type: string pattern: '[a-zA-Z][-a-zA-Z0-9]*' minLength: 1 maxLength: 256 AggregateConformancePackCompliance: type: object properties: ComplianceType: allOf: - $ref: '#/components/schemas/ConformancePackComplianceType' - description: The compliance status of the conformance pack. CompliantRuleCount: allOf: - $ref: '#/components/schemas/Integer' - description: The number of compliant Config Rules. NonCompliantRuleCount: allOf: - $ref: '#/components/schemas/Integer' - description: The number of noncompliant Config Rules. TotalRuleCount: allOf: - $ref: '#/components/schemas/Integer' - description: 'Total number of compliant rules, noncompliant rules, and the rules that do not have any applicable resources to evaluate upon resulting in insufficient data.' description: 'Provides the number of compliant and noncompliant rules within a conformance pack. Also provides the compliance status of the conformance pack and the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.
A conformance pack is compliant if all of the rules in a conformance packs are compliant. It is noncompliant if any of the rules are not compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules within a conformance pack cannot be evaluated due to insufficient data. If some of the rules in a conformance pack are compliant but the compliance status of other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance pack shows compliant.
' AggregateComplianceByConformancePack: type: object properties: ConformancePackName: allOf: - $ref: '#/components/schemas/ConformancePackName' - description: The name of the conformance pack. Compliance: allOf: - $ref: '#/components/schemas/AggregateConformancePackCompliance' - description: The compliance status of the conformance pack. AccountId: allOf: - $ref: '#/components/schemas/AccountId' - description: The 12-digit Amazon Web Services account ID of the source account. AwsRegion: allOf: - $ref: '#/components/schemas/AwsRegion' - description: The source Amazon Web Services Region from where the data is aggregated. description: 'Provides aggregate compliance of the conformance pack. Indicates whether a conformance pack is compliant based on the name of the conformance pack, account ID, and region.
A conformance pack is compliant if all of the rules in a conformance packs are compliant. It is noncompliant if any of the rules are not compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules within a conformance pack cannot be evaluated due to insufficient data. If some of the rules in a conformance pack are compliant but the compliance status of other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance pack shows compliant.
' AggregateComplianceByConformancePackList: type: array items: $ref: '#/components/schemas/AggregateComplianceByConformancePack' StringWithCharLimit256: type: string minLength: 1 maxLength: 256 ComplianceSummary: type: object properties: CompliantResourceCount: allOf: - $ref: '#/components/schemas/ComplianceContributorCount' - description: 'The number of Config rules or Amazon Web Services resources that are compliant, up to a maximum of 25 for rules and 100 for resources.' NonCompliantResourceCount: allOf: - $ref: '#/components/schemas/ComplianceContributorCount' - description: 'The number of Config rules or Amazon Web Services resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.' ComplianceSummaryTimestamp: allOf: - $ref: '#/components/schemas/Date' - description: The time that Config created the compliance summary. description: The number of Config rules or Amazon Web Services resources that are compliant and noncompliant. AggregateComplianceCount: type: object properties: GroupName: allOf: - $ref: '#/components/schemas/StringWithCharLimit256' - description: The 12-digit account ID or region based on the GroupByKey value. ComplianceSummary: allOf: - $ref: '#/components/schemas/ComplianceSummary' - description: The number of compliant and noncompliant Config rules. description: Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator. AggregateComplianceCountList: type: array items: $ref: '#/components/schemas/AggregateComplianceCount' ConformancePackComplianceType: type: string enum: - COMPLIANT - NON_COMPLIANT - INSUFFICIENT_DATA Integer: type: integer AggregateConformancePackComplianceCount: type: object properties: CompliantConformancePackCount: allOf: - $ref: '#/components/schemas/Integer' - description: Number of compliant conformance packs. NonCompliantConformancePackCount: allOf: - $ref: '#/components/schemas/Integer' - description: Number of noncompliant conformance packs. description: The number of conformance packs that are compliant and noncompliant. AggregateConformancePackComplianceFilters: type: object properties: ConformancePackName: allOf: - $ref: '#/components/schemas/ConformancePackName' - description: The name of the conformance pack. ComplianceType: allOf: - $ref: '#/components/schemas/ConformancePackComplianceType' - description: The compliance status of the conformance pack. AccountId: allOf: - $ref: '#/components/schemas/AccountId' - description: The 12-digit Amazon Web Services account ID of the source account. AwsRegion: allOf: - $ref: '#/components/schemas/AwsRegion' - description: The source Amazon Web Services Region from where the data is aggregated. description: 'Filters the conformance packs based on an account ID, region, compliance type, and the name of the conformance pack.' AggregateConformancePackComplianceSummary: type: object properties: ComplianceSummary: allOf: - $ref: '#/components/schemas/AggregateConformancePackComplianceCount' - description: 'Returns anAggregateConformancePackComplianceCount object. '
GroupName:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.
description: 'Provides a summary of compliance based on either account ID or region. '
AggregateConformancePackComplianceSummaryFilters:
type: object
properties:
AccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: The 12-digit Amazon Web Services account ID of the source account.
AwsRegion:
allOf:
- $ref: '#/components/schemas/AwsRegion'
- description: The source Amazon Web Services Region from where the data is aggregated.
description: 'Filters the results based on account ID and region. '
AggregateConformancePackComplianceSummaryGroupKey:
type: string
enum:
- ACCOUNT_ID
- AWS_REGION
AggregateConformancePackComplianceSummaryList:
type: array
items:
$ref: '#/components/schemas/AggregateConformancePackComplianceSummary'
EvaluationResultIdentifier:
type: object
properties:
EvaluationResultQualifier:
allOf:
- $ref: '#/components/schemas/EvaluationResultQualifier'
- description: 'Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.'
OrderingTimestamp:
allOf:
- $ref: '#/components/schemas/Date'
- description: 'The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification,
or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.'
ResourceEvaluationId:
allOf:
- $ref: '#/components/schemas/ResourceEvaluationId'
- description: A Unique ID for an evaluation result.
description: Uniquely identifies an evaluation result.
ComplianceType:
type: string
enum:
- COMPLIANT
- NON_COMPLIANT
- NOT_APPLICABLE
- INSUFFICIENT_DATA
Date:
type: string
format: date-time
AggregateEvaluationResult:
type: object
properties:
EvaluationResultIdentifier:
allOf:
- $ref: '#/components/schemas/EvaluationResultIdentifier'
- description: Uniquely identifies the evaluation result.
ComplianceType:
allOf:
- $ref: '#/components/schemas/ComplianceType'
- description: 'The resource compliance status.
For the AggregationEvaluationResult data type, Config supports only the COMPLIANT and NON_COMPLIANT.
Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value.
Filters the last updated status type.
Valid value FAILED indicates errors while moving data.
Valid value SUCCEEDED indicates the data was successfully moved.
Valid value OUTDATED indicates the data is not the most recent.
The configuration item status. The valid values are:
OK – The resource configuration has been updated
ResourceDiscovered – The resource was newly discovered
ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type
ResourceDeleted – The resource was deleted
ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type
The CIs do not incur any cost.
ComplianceResourceId.
TagKey:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit128'
- description: The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.
TagValue:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: 'The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must
also specify a value for TagKey.'
ComplianceResourceId:
allOf:
- $ref: '#/components/schemas/BaseResourceId'
- description: 'The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.'
description: 'Defines which resources trigger an evaluation for an Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource
type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group
changes in configuration.'
Source:
type: object
required:
- Owner
properties:
Owner:
allOf:
- $ref: '#/components/schemas/Owner'
- description: 'Indicates whether Amazon Web Services or the customer owns and manages the Config rule.
Config Managed Rules are predefined rules owned by Amazon Web Services. For more information, see Config Managed Rules in the Config developer guide.
Config Custom Rules are rules that you can develop either with Guard (CUSTOM_POLICY) or Lambda (CUSTOM_LAMBDA). For more information, see Config
Custom Rules in the Config developer guide.
For Config Managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see List
of Config Managed Rules.
For Config Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule''s Lambda function, such as arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name.
For Config Custom Policy rules, this field will be ignored.
' SourceDetails: allOf: - $ref: '#/components/schemas/SourceDetails' - description: 'Provides the source and the message types that cause Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.
If the owner is set to CUSTOM_POLICY, the only acceptable values for the Config rule trigger message
type are ConfigurationItemChangeNotification and OversizedConfigurationItemChangeNotification.
CUSTOM_POLICY.'
description: 'Provides the CustomPolicyDetails, the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA
for Custom Lambda rules), the rule identifier, and the events that cause the evaluation of your Amazon Web Services resources.'
StringWithCharLimit1024:
type: string
minLength: 1
maxLength: 1024
MaximumExecutionFrequency:
type: string
enum:
- One_Hour
- Three_Hours
- Six_Hours
- Twelve_Hours
- TwentyFour_Hours
ConfigRuleState:
type: string
enum:
- ACTIVE
- DELETING
- DELETING_RESULTS
- EVALUATING
EvaluationModes:
type: array
items:
$ref: '#/components/schemas/EvaluationModeConfiguration'
ConfigRule:
type: object
required:
- Source
properties:
ConfigRuleName:
allOf:
- $ref: '#/components/schemas/ConfigRuleName'
- description: The name that you assign to the Config rule. The name is required if you are adding a new rule.
ConfigRuleArn:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: The Amazon Resource Name (ARN) of the Config rule.
ConfigRuleId:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit64'
- description: The ID of the Config rule.
Description:
allOf:
- $ref: '#/components/schemas/EmptiableStringWithCharLimit256'
- description: The description that you provide for the Config rule.
Scope:
allOf:
- $ref: '#/components/schemas/Scope'
- description: 'Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
The scope can be empty.
Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda
rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.'
InputParameters:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit1024'
- description: 'A string, in JSON format, that is passed to the Config rule Lambda function.'
MaximumExecutionFrequency:
allOf:
- $ref: '#/components/schemas/MaximumExecutionFrequency'
- description: 'The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
This is for an Config managed rule that is triggered at a periodic frequency.
Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency
parameter.
Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
Config sets the state
of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.
Config sets
the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.
Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule
and all of its evaluations are erased and are no longer available.
Service principal name of the service that created the rule.
The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule.
Config rules evaluate the configuration settings of your Amazon Web Services resources. A rule can run when Config detects a configuration change to an Amazon Web Services resource or at a periodic frequency that you choose (for example, every 24 hours). There are two types of rules: Config Managed Rules and Config Custom Rules.
Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules.
Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.
For more information about developing and using Config rules, see Evaluating Resource with Config Rules in the Config Developer Guide.
You can use the Amazon Web Services CLI and Amazon Web Services SDKs if you want to create a rule that triggers evaluations for your resources when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
The rule compliance status.
For the ConfigRuleComplianceFilters data type, Config supports only COMPLIANT and NON_COMPLIANT. Config
does not support the NOT_APPLICABLE and the INSUFFICIENT_DATA values.
Indicates whether Config has evaluated your resources against the rule at least once.
true - Config has evaluated your Amazon Web Services
resources against the rule at least once.
false - Config has not finished evaluating your Amazon Web Services resources against the rule at least
once.
Successful or Failed.
LastDebugLogDeliveryStatusReason:
allOf:
- $ref: '#/components/schemas/String'
- description: The reason Config was not able to deliver a debug log. This is for the last failed attempt to retrieve a debug log for your Config Custom Policy rules.
LastDebugLogDeliveryTime:
allOf:
- $ref: '#/components/schemas/Date'
- description: The time Config last attempted to deliver a debug log for your Config Custom Policy rules.
description: 'Status information for your Config Managed rules and Config Custom Policy rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure.
This action does not return status information about Config Custom Lambda rules.
' ConfigRuleEvaluationStatusList: type: array items: $ref: '#/components/schemas/ConfigRuleEvaluationStatus' ConfigRuleNames: type: array items: $ref: '#/components/schemas/ConfigRuleName' minItems: 0 maxItems: 25 ConfigRules: type: array items: $ref: '#/components/schemas/ConfigRule' ConfigSnapshotDeliveryProperties: type: object properties: deliveryFrequency: allOf: - $ref: '#/components/schemas/MaximumExecutionFrequency' - description: The frequency with which Config delivers configuration snapshots. description: 'Provides options for how often Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel.
The frequency for a rule that triggers evaluations for your resources when Config delivers the configuration snapshot is set by one of two values, depending on which is less frequent:
The value for the deliveryFrequency
parameter within the delivery channel configuration, which sets how often Config delivers configuration snapshots. This value also sets how often Config invokes evaluations for Config rules.
The value for the MaximumExecutionFrequency parameter, which sets the maximum frequency with which Config invokes evaluations for the rule. For more information, see ConfigRule.
If the deliveryFrequency value is less frequent than the MaximumExecutionFrequency value for a rule, Config invokes the rule only as often as the deliveryFrequency
value.
For example, you want your rule to run evaluations when Config delivers the configuration snapshot.
You specify the MaximumExecutionFrequency
value for Six_Hours.
You then specify the delivery channel deliveryFrequency value for TwentyFour_Hours.
Because the value
for deliveryFrequency is less frequent than MaximumExecutionFrequency, Config invokes evaluations for the rule every 24 hours.
You should set the MaximumExecutionFrequency
value to be at least as frequent as the deliveryFrequency value. You can view the deliveryFrequency value by using the DescribeDeliveryChannnels action.
To update the deliveryFrequency with which Config delivers your configuration snapshots, use the PutDeliveryChannel action.
Status of the last attempted delivery.
Note Providing an SNS topic on a DeliveryChannel for Config is optional. If the SNS delivery is turned off, the last status will be Not_Applicable.
' lastErrorCode: allOf: - $ref: '#/components/schemas/String' - description: The error code from the last attempted delivery. lastErrorMessage: allOf: - $ref: '#/components/schemas/String' - description: The error message from the last attempted delivery. lastStatusChangeTime: allOf: - $ref: '#/components/schemas/Date' - description: The time from the last status change. description: A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic. ConfigurationAggregatorArn: type: string pattern: 'arn:aws[a-z\-]*:config:[a-z\-\d]+:\d+:config-aggregator/config-aggregator-[a-z\d]+' OrganizationAggregationSource: type: object required: - RoleArn properties: RoleArn: allOf: - $ref: '#/components/schemas/String' - description: ARN of the IAM role used to retrieve Amazon Web Services Organization details associated with the aggregator account. AwsRegions: allOf: - $ref: '#/components/schemas/AggregatorRegionList' - description: The source regions being aggregated. AllAwsRegions: allOf: - $ref: '#/components/schemas/Boolean' - description: 'If true, aggregate existing Config regions and future regions.' description: This object contains regions to set up the aggregator and an IAM role to retrieve organization details. ConfigurationAggregator: type: object properties: ConfigurationAggregatorName: allOf: - $ref: '#/components/schemas/ConfigurationAggregatorName' - description: The name of the aggregator. ConfigurationAggregatorArn: allOf: - $ref: '#/components/schemas/ConfigurationAggregatorArn' - description: The Amazon Resource Name (ARN) of the aggregator. AccountAggregationSources: allOf: - $ref: '#/components/schemas/AccountAggregationSourceList' - description: Provides a list of source accounts and regions to be aggregated. OrganizationAggregationSource: allOf: - $ref: '#/components/schemas/OrganizationAggregationSource' - description: Provides an organization and list of regions to be aggregated. CreationTime: allOf: - $ref: '#/components/schemas/Date' - description: The time stamp when the configuration aggregator was created. LastUpdatedTime: allOf: - $ref: '#/components/schemas/Date' - description: The time of the last update. CreatedBy: allOf: - $ref: '#/components/schemas/StringWithCharLimit256' - description: Amazon Web Services service that created the configuration aggregator. description: 'The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator. ' ConfigurationAggregatorList: type: array items: $ref: '#/components/schemas/ConfigurationAggregator' ConfigurationAggregatorNameList: type: array items: $ref: '#/components/schemas/ConfigurationAggregatorName' minItems: 0 maxItems: 10 ConfigurationItemMD5Hash: type: string Tags: type: object additionalProperties: $ref: '#/components/schemas/Value' RelatedEventList: type: array items: $ref: '#/components/schemas/RelatedEvent' RelationshipList: type: array items: $ref: '#/components/schemas/Relationship' ConfigurationItem: type: object properties: version: allOf: - $ref: '#/components/schemas/Version' - description: The version number of the resource configuration. accountId: allOf: - $ref: '#/components/schemas/AccountId' - description: The 12-digit Amazon Web Services account ID associated with the resource. configurationItemCaptureTime: allOf: - $ref: '#/components/schemas/ConfigurationItemCaptureTime' - description: The time when the configuration recording was initiated. configurationItemStatus: allOf: - $ref: '#/components/schemas/ConfigurationItemStatus' - description: 'The configuration item status. The valid values are:
OK – The resource configuration has been updated
ResourceDiscovered – The resource was newly discovered
ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type
ResourceDeleted – The resource was deleted
ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type
The CIs do not incur any cost.
Unique MD5 hash that represents the configuration item's state.
You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.
arn: allOf: - $ref: '#/components/schemas/ARN' - description: Amazon Resource Name (ARN) associated with the resource. resourceType: allOf: - $ref: '#/components/schemas/ResourceType' - description: The type of Amazon Web Services resource. resourceId: allOf: - $ref: '#/components/schemas/ResourceId' - description: 'The ID of the resource (for example,sg-xxxxxx).'
resourceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: 'The custom name of the resource, if available.'
awsRegion:
allOf:
- $ref: '#/components/schemas/AwsRegion'
- description: The region where the resource resides.
availabilityZone:
allOf:
- $ref: '#/components/schemas/AvailabilityZone'
- description: The Availability Zone associated with the resource.
resourceCreationTime:
allOf:
- $ref: '#/components/schemas/ResourceCreationTime'
- description: The time stamp when the resource was created.
tags:
allOf:
- $ref: '#/components/schemas/Tags'
- description: A mapping of key value tags associated with the resource.
relatedEvents:
allOf:
- $ref: '#/components/schemas/RelatedEventList'
- description: 'A list of CloudTrail event IDs.
A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail.
An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.
' relationships: allOf: - $ref: '#/components/schemas/RelationshipList' - description: A list of related Amazon Web Services resources. configuration: allOf: - $ref: '#/components/schemas/Configuration' - description: The description of the resource configuration. supplementaryConfiguration: allOf: - $ref: '#/components/schemas/SupplementaryConfiguration' - description: Configuration attributes that Config returns for certain resource types to supplement the information returned for theconfiguration parameter.
description: A list that contains detailed configurations of a specified resource.
ConfigurationItemList:
type: array
items:
$ref: '#/components/schemas/ConfigurationItem'
RecorderName:
type: string
minLength: 1
maxLength: 256
RecordingGroup:
type: object
properties:
allSupported:
allOf:
- $ref: '#/components/schemas/AllSupported'
- description: 'Specifies whether Config records configuration changes for all supported regional resource types.
If you set this field to true, when Config adds support
for a new type of regional resource, Config starts recording resources of that type automatically.
If you set this field to true, you cannot enumerate specific resource
types to record in the resourceTypes field of RecordingGroup, or to exclude in the
resourceTypes field of ExclusionByResourceTypes.
Specifies whether Config records configuration changes for all supported global resources.
Before you set this field to true, set the allSupported
field of RecordingGroup to true. Optionally, you can set the useOnly
field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES.
If you set this
field to true, when Config adds support for a new type of global resource in the Region where you set up the configuration recorder, Config starts recording resources of that
type automatically.
If you set this field to false but list global resource types in the resourceTypes field of RecordingGroup,
Config will still record configuration changes for those specified resource types regardless of if you set the includeGlobalResourceTypes field to false.
If you
do not want to record configuration changes to global resource types, make sure to not list them in the resourceTypes field in addition to setting the includeGlobalResourceTypes
field to false.
A comma-separated list that specifies which resource types Config records.
Optionally, you can set the useOnly field of RecordingStrategy
to INCLUSION_BY_RESOURCE_TYPES.
To record all configuration changes, set the allSupported field of RecordingGroup
to true, and either omit this field or don''t specify any resource types in this field. If you set the allSupported field to false and specify values
for resourceTypes, when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.
For a list of valid resourceTypes values, see the Resource Type Value column in Supported
Amazon Web Services resource Types in the Config developer guide.
Region Availability
Before specifying a resource type for Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.
An object that specifies how Config excludes resource types from being recorded by the configuration recorder.
To use this option, you must set the useOnly
field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES.
An object that specifies the recording strategy for the configuration recorder.
If you set the useOnly field of RecordingStrategy
to ALL_SUPPORTED_RESOURCE_TYPES, Config records configuration changes for all supported regional resource types. You also must set the allSupported field of RecordingGroup
to true. When Config adds support for a new type of regional resource, Config automatically starts recording resources of that type.
If you set the useOnly
field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES, Config records configuration
changes for only the resource types you specify in the resourceTypes field of RecordingGroup.
If you set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES,
Config records configuration changes for all supported resource types except the resource types that you specify as exemptions to exclude from being recorded in the resourceTypes
field of ExclusionByResourceTypes.
The recordingStrategy
field is optional when you set the allSupported field of RecordingGroup to true.
The recordingStrategy field is optional when you list resource types in the resourceTypes field of RecordingGroup.
The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.
If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.
For example, even if you set includeGlobalResourceTypes to false, global resource types will still be automatically recorded in this option unless those resource types are
specifically listed as exemptions in the resourceTypes field of exclusionByResourceTypes.
By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES
recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources
of that type automatically.
Specifies which resource types Config records for configuration changes. In the recording group, you specify whether you want to record all supported resource types or to include or exclude specific types of resources.
By default, Config records configuration changes for all supported types of Regional resources that Config discovers in the Amazon Web Services Region in which it is running. Regional resources are tied to a Region and can be used only in that Region. Examples of Regional resources are Amazon EC2 instances and Amazon EBS volumes.
You can also have Config record supported types of global resources. Global resources are not tied to a specific Region and can be used in all Regions. The global resource types that Config supports include IAM users, groups, roles, and customer managed policies.
Global resource types onboarded to Config recording after February 2022 will be recorded only in the service''s home Region for the commercial partition and Amazon Web Services GovCloud (US-West) for the Amazon Web Services GovCloud (US) partition. You can view the Configuration Items for these new global resource types only in their home Region and Amazon Web Services GovCloud (US-West).
If you don''t want Config to record all resources, you can specify which types of resources
Config records with the resourceTypes parameter.
For a list of supported resource types, see Supported Resource Types in the Config developer guide.
For more information and a table of the Home Regions for Global Resource Types Onboarded after February 2022, see Selecting Which Resources Config Records in the Config developer guide.
' ConfigurationRecorder: type: object properties: name: allOf: - $ref: '#/components/schemas/RecorderName' - description: 'The name of the configuration recorder. Config automatically assigns the name of "default" when creating the configuration recorder.
You cannot change the name of the configuration recorder after it has been created. To change the configuration recorder name, you must delete it and create a new configuration recorder with a new name.
' roleARN: allOf: - $ref: '#/components/schemas/String' - description: 'Amazon Resource Name (ARN) of the IAM role assumed by Config and used by the configuration recorder.
While the API model does not require this field, the server
will reject a request without a defined roleARN for the configuration recorder.
Pre-existing Config role
If you have used an Amazon Web Services service that uses Config, such as Security Hub or Control Tower, and an Config role has already been created, make sure that the IAM role that you use when setting up Config keeps the same minimum permissions as the already created Config role. You must do this so that the other Amazon Web Services service continues to run as expected.
For example, if Control Tower has an IAM role that allows Config to read Amazon Simple Storage Service (Amazon S3) objects, make sure that the same permissions are granted within the IAM role you use when setting up Config. Otherwise, it may interfere with how Control Tower operates. For more information about IAM roles for Config, see Identity and Access Management for Config in the Config Developer Guide.
Specifies which resource types Config records for configuration changes.
High Number of Config Evaluations
You may notice increased activity in your account during your initial month recording with Config when compared to subsequent months. During the initial bootstrapping process, Config runs evaluations on all the resources in your account that you have selected for Config to record.
If you are running ephemeral workloads, you may see increased activity from Config as it records configuration changes associated with creating and deleting these temporary resources. An ephemeral workload is a temporary use of computing resources that are loaded and run when needed. Examples include Amazon Elastic Compute Cloud (Amazon EC2) Spot Instances, Amazon EMR jobs, and Auto Scaling. If you want to avoid the increased activity from running ephemeral workloads, you can run these types of workloads in a separate account with Config turned off to avoid increased configuration recording and rule evaluations.
The current status of the configuration recorder.
For a detailed status of recording events over time, add your Config events to CloudWatch metrics and use CloudWatch metrics.
Filters the results by compliance.
The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.
INSUFFICIENT_DATA.
ConformancePackName:
allOf:
- $ref: '#/components/schemas/ConformancePackName'
- description: The name of the conformance pack.
LastUpdatedTime:
allOf:
- $ref: '#/components/schemas/LastUpdatedTime'
- description: The time that the conformance pack compliance score was last updated.
description: 'A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in
the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs. You can use it to identify, investigate, and understand the level of compliance
in your conformance packs.'
ConformancePackComplianceScores:
type: array
items:
$ref: '#/components/schemas/ConformancePackComplianceScore'
ConformancePackNameFilter:
type: array
items:
$ref: '#/components/schemas/ConformancePackName'
minItems: 1
maxItems: 25
ConformancePackComplianceScoresFilters:
type: object
required:
- ConformancePackNames
properties:
ConformancePackNames:
allOf:
- $ref: '#/components/schemas/ConformancePackNameFilter'
- description: 'The names of the conformance packs whose compliance scores you want to include in the conformance pack compliance score result set. You can include up to 25 conformance packs in
the ConformancePackNames array of strings, each with a character limit of 256 characters for the conformance pack name.'
description: 'A list of filters to apply to the conformance pack compliance score result set. '
ConformancePackComplianceSummary:
type: object
required:
- ConformancePackName
- ConformancePackComplianceStatus
properties:
ConformancePackName:
allOf:
- $ref: '#/components/schemas/ConformancePackName'
- description: The name of the conformance pack name.
ConformancePackComplianceStatus:
allOf:
- $ref: '#/components/schemas/ConformancePackComplianceType'
- description: The status of the conformance pack.
description: Summary includes the name and status of the conformance pack.
ConformancePackComplianceSummaryList:
type: array
items:
$ref: '#/components/schemas/ConformancePackComplianceSummary'
minItems: 1
maxItems: 5
ConformancePackId:
type: string
minLength: 1
maxLength: 1024
DeliveryS3Bucket:
type: string
minLength: 0
maxLength: 63
DeliveryS3KeyPrefix:
type: string
minLength: 0
maxLength: 1024
ConformancePackInputParameters:
type: array
items:
$ref: '#/components/schemas/ConformancePackInputParameter'
minItems: 0
maxItems: 60
TemplateSSMDocumentDetails:
type: object
required:
- DocumentName
properties:
DocumentName:
allOf:
- $ref: '#/components/schemas/SSMDocumentName'
- description: 'The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, Config checks only your account and Amazon Web Services
Region for the SSM document. If you want to use an SSM document from another Region or account, you must provide the ARN.'
DocumentVersion:
allOf:
- $ref: '#/components/schemas/SSMDocumentVersion'
- description: 'The version of the SSM document to use to create a conformance pack. By default, Config uses the latest version.
This field is optional.
This API allows you to create a conformance pack template with an Amazon Web Services Systems Manager document (SSM document). To deploy a conformance pack using an SSM document,
first create an SSM document with conformance pack content, and then provide the DocumentName in the PutConformancePack
API. You can also provide the DocumentVersion.
The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.
The name of the Amazon S3 bucket where Config stores conformance pack templates.
This field is optional.
The prefix for the Amazon S3 bucket.
This field is optional.
ConformancePackInputParameter objects.
LastUpdateRequestedTime:
allOf:
- $ref: '#/components/schemas/Date'
- description: 'The last time a conformation pack update was requested. '
CreatedBy:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: The Amazon Web Services service that created the conformance pack.
TemplateSSMDocumentDetails:
allOf:
- $ref: '#/components/schemas/TemplateSSMDocumentDetails'
- description: An object that contains the name or Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is
used to create a conformance pack.
description: Returns details of a conformance pack. A conformance pack is a collection of Config rules and remediation actions that can be easily deployed in an account and a region.
ConformancePackDetailList:
type: array
items:
$ref: '#/components/schemas/ConformancePackDetail'
minItems: 0
maxItems: 25
ConformancePackEvaluationFilters:
type: object
properties:
ConfigRuleNames:
allOf:
- $ref: '#/components/schemas/ConformancePackConfigRuleNames'
- description: Filters the results by Config rule names.
ComplianceType:
allOf:
- $ref: '#/components/schemas/ConformancePackComplianceType'
- description: Filters the results by compliance.
The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.
"AWS::EC2::Instance"). '
ResourceIds:
allOf:
- $ref: '#/components/schemas/ConformancePackComplianceResourceIds'
- description: 'Filters the results by resource IDs.
This is valid only when you provide resource type. If there is no resource type, you will see an error.
COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.
EvaluationResultIdentifier:
$ref: '#/components/schemas/EvaluationResultIdentifier'
ConfigRuleInvokedTime:
allOf:
- $ref: '#/components/schemas/Date'
- description: The time when Config rule evaluated Amazon Web Services resource.
ResultRecordedTime:
allOf:
- $ref: '#/components/schemas/Date'
- description: 'The time when Config recorded the evaluation result. '
Annotation:
allOf:
- $ref: '#/components/schemas/Annotation'
- description: 'Supplementary information about how the evaluation determined the compliance. '
description: 'The details of a conformance pack evaluation. Provides Config rule and Amazon Web Services resource type that was evaluated, the compliance of the conformance pack, related time stamps,
and supplementary information. '
ParameterName:
type: string
minLength: 0
maxLength: 255
ParameterValue:
type: string
minLength: 0
maxLength: 4096
ConformancePackInputParameter:
type: object
required:
- ParameterName
- ParameterValue
properties:
ParameterName:
allOf:
- $ref: '#/components/schemas/ParameterName'
- description: One part of a key-value pair.
ParameterValue:
allOf:
- $ref: '#/components/schemas/ParameterValue'
- description: 'Another part of the key-value pair. '
description: 'Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a
maximum length of 4096 characters.'
ConformancePackNamesList:
type: array
items:
$ref: '#/components/schemas/ConformancePackName'
minItems: 0
maxItems: 25
ConformancePackNamesToSummarizeList:
type: array
items:
$ref: '#/components/schemas/ConformancePackName'
minItems: 1
maxItems: 5
ControlsList:
type: array
items:
$ref: '#/components/schemas/StringWithCharLimit128'
minItems: 0
maxItems: 20
ConformancePackRuleCompliance:
type: object
properties:
ConfigRuleName:
allOf:
- $ref: '#/components/schemas/ConfigRuleName'
- description: Name of the Config rule.
ComplianceType:
allOf:
- $ref: '#/components/schemas/ConformancePackComplianceType'
- description: Compliance of the Config rule.
Controls:
allOf:
- $ref: '#/components/schemas/ControlsList'
- description: Controls for the conformance pack. A control is a process to prevent or detect problems while meeting objectives. A control can align with a specific compliance regime or map
to internal controls defined by an organization.
description: Compliance information of one or more Config rules within a conformance pack. You can filter using Config rule names and compliance types.
ConformancePackRuleComplianceList:
type: array
items:
$ref: '#/components/schemas/ConformancePackRuleCompliance'
minItems: 0
maxItems: 1000
ConformancePackRuleEvaluationResultsList:
type: array
items:
$ref: '#/components/schemas/ConformancePackEvaluationResult'
minItems: 0
maxItems: 100
ConformancePackState:
type: string
enum:
- CREATE_IN_PROGRESS
- CREATE_COMPLETE
- CREATE_FAILED
- DELETE_IN_PROGRESS
- DELETE_FAILED
StackArn:
type: string
minLength: 1
maxLength: 2048
ConformancePackStatusReason:
type: string
minLength: 0
maxLength: 2000
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:
CREATE_IN_PROGRESS when a conformance pack creation is in progress for an account.
CREATE_COMPLETE when a conformance pack has been successfully created in your account.
CREATE_FAILED when a conformance pack creation failed in your account.
DELETE_IN_PROGRESS when a conformance pack deletion is in progress.
DELETE_FAILED when a conformance pack deletion failed in your account.
false.
description: 'Provides the runtime system, policy definition, and whether debug logging enabled. You can specify the following CustomPolicyDetails parameter values only for Config Custom Policy rules.'
DebugLogDeliveryAccounts:
type: array
items:
$ref: '#/components/schemas/AccountId'
minItems: 0
maxItems: 1000
OrganizationConfigRuleName:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 64
OrganizationConformancePackName:
type: string
pattern: '[a-zA-Z][-a-zA-Z0-9]*'
minLength: 1
maxLength: 128
RemediationExceptionResourceKeys:
type: array
items:
$ref: '#/components/schemas/RemediationExceptionResourceKey'
minItems: 1
maxItems: 100
FailedDeleteRemediationExceptionsBatches:
type: array
items:
$ref: '#/components/schemas/FailedDeleteRemediationExceptionsBatch'
ResourceTypeString:
type: string
minLength: 1
maxLength: 196
RetentionConfigurationName:
type: string
pattern: '[\w\-]+'
minLength: 1
maxLength: 256
QueryName:
type: string
pattern: '^[a-zA-Z0-9-_]+$'
minLength: 1
maxLength: 64
DeliveryChannel:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/ChannelName'
- description: 'The name of the delivery channel. By default, Config assigns the name "default" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel
action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.'
s3BucketName:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.
If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon S3 Bucket in the Config Developer Guide.
' s3KeyPrefix: allOf: - $ref: '#/components/schemas/String' - description: The prefix for the specified Amazon S3 bucket. s3KmsKeyArn: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket. snsTopicARN: allOf: - $ref: '#/components/schemas/String' - description: 'The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.
If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon SNS Topic in the Config Developer Guide.
' configSnapshotDeliveryProperties: allOf: - $ref: '#/components/schemas/ConfigSnapshotDeliveryProperties' - description: The options for how often Config delivers configuration snapshots to the Amazon S3 bucket. description: The channel through which Config delivers notifications and updated configuration states. DeliveryChannelList: type: array items: $ref: '#/components/schemas/DeliveryChannel' DeliveryChannelNameList: type: array items: $ref: '#/components/schemas/ChannelName' DeliveryChannelStatus: type: object properties: name: allOf: - $ref: '#/components/schemas/String' - description: The name of the delivery channel. configSnapshotDeliveryInfo: allOf: - $ref: '#/components/schemas/ConfigExportDeliveryInfo' - description: A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket. configHistoryDeliveryInfo: allOf: - $ref: '#/components/schemas/ConfigExportDeliveryInfo' - description: A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket. configStreamDeliveryInfo: allOf: - $ref: '#/components/schemas/ConfigStreamDeliveryInfo' - description: A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic. description: 'The status of a specified delivery channel.
Valid values: Success | Failure
Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.
For the Evaluation data type, Config supports
only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for this data type.
Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function
for a custom Config rule cannot pass an INSUFFICIENT_DATA value to Config.
Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.
For the EvaluationResult data type, Config supports only
the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for the EvaluationResult
data type.
resourceTypes field to enter a comma-separated list of resource types
to exclude as exemptions.
SsmControls:
type: object
properties:
ConcurrentExecutionRatePercentage:
allOf:
- $ref: '#/components/schemas/Percentage'
- description: 'The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default
value is 10. '
ErrorPercentage:
allOf:
- $ref: '#/components/schemas/Percentage'
- description: 'The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example
10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when
the fifth error is received. '
description: Amazon Web Services Systems Manager (SSM) specific remediation controls.
ExecutionControls:
type: object
properties:
SsmControls:
allOf:
- $ref: '#/components/schemas/SsmControls'
- description: A SsmControls object.
description: The controls that Config uses for executing remediations.
Expression:
type: string
minLength: 1
maxLength: 4096
ExternalEvaluation:
type: object
required:
- ComplianceResourceType
- ComplianceResourceId
- ComplianceType
- OrderingTimestamp
properties:
ComplianceResourceType:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: 'The evaluated compliance resource type. Config accepts AWS::::Account resource type.'
ComplianceResourceId:
allOf:
- $ref: '#/components/schemas/BaseResourceId'
- description: The evaluated compliance resource ID. Config accepts only Amazon Web Services account ID.
ComplianceType:
allOf:
- $ref: '#/components/schemas/ComplianceType'
- description: 'The compliance of the Amazon Web Services resource. The valid values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.'
Annotation:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: 'Supplementary information about the reason of compliance. For example, this task was completed on a specific date.'
OrderingTimestamp:
allOf:
- $ref: '#/components/schemas/OrderingTimestamp'
- description: 'The time when the compliance was recorded. '
description: Identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that it was evaluated against.
FailedDeleteRemediationExceptionsBatch:
type: object
properties:
FailureMessage:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Returns a failure message for delete remediation exception. For example, Config creates an exception due to an internal error.'
FailedItems:
allOf:
- $ref: '#/components/schemas/RemediationExceptionResourceKeys'
- description: Returns remediation exception resource key object of the failed items.
description: List of each of the failed delete remediation exceptions with specific reasons.
FailedRemediationBatch:
type: object
properties:
FailureMessage:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Returns a failure message. For example, the resource is already compliant.'
FailedItems:
allOf:
- $ref: '#/components/schemas/RemediationConfigurations'
- description: Returns remediation configurations of the failed items.
description: List of each of the failed remediations with specific reasons.
FailedRemediationBatches:
type: array
items:
$ref: '#/components/schemas/FailedRemediationBatch'
FailedRemediationExceptionBatch:
type: object
properties:
FailureMessage:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Returns a failure message. For example, the auto-remediation has failed.'
FailedItems:
allOf:
- $ref: '#/components/schemas/RemediationExceptions'
- description: Returns remediation exception resource key object of the failed items.
description: List of each of the failed remediation exceptions with specific reasons.
FailedRemediationExceptionBatches:
type: array
items:
$ref: '#/components/schemas/FailedRemediationExceptionBatch'
FieldName:
type: string
FieldInfo:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/FieldName'
- description: Name of the field.
description: Details about the fields such as name of the field.
FieldInfoList:
type: array
items:
$ref: '#/components/schemas/FieldInfo'
ResourceCountFilters:
type: object
properties:
ResourceType:
allOf:
- $ref: '#/components/schemas/ResourceType'
- description: The type of the Amazon Web Services resource.
AccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: The 12-digit ID of the account.
Region:
allOf:
- $ref: '#/components/schemas/AwsRegion'
- description: The region where the account is located.
description: 'Filters the resource count based on account ID, region, and resource type.'
ResourceCountGroupKey:
type: string
enum:
- RESOURCE_TYPE
- ACCOUNT_ID
- AWS_REGION
Long:
type: integer
GroupedResourceCountList:
type: array
items:
$ref: '#/components/schemas/GroupedResourceCount'
ResourceTypes:
type: array
items:
$ref: '#/components/schemas/StringWithCharLimit256'
minItems: 0
maxItems: 20
GetConformancePackComplianceDetailsLimit:
type: integer
minimum: 0
maximum: 100
ResourceCounts:
type: array
items:
$ref: '#/components/schemas/ResourceCount'
StatusDetailFilters:
type: object
properties:
AccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: The 12-digit account ID of the member account within an organization.
MemberAccountRuleStatus:
allOf:
- $ref: '#/components/schemas/MemberAccountRuleStatus'
- description: 'Indicates deployment status for Config rule in the member account. When management account calls PutOrganizationConfigRule action for the first time, Config rule
status is created in the member account. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in the member account.
Config rule status is deleted when the management account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com.
Config sets the state of the rule to:
CREATE_SUCCESSFUL when Config rule has been created in the member account.
CREATE_IN_PROGRESS
when Config rule is being created in the member account.
CREATE_FAILED when Config rule creation has failed in the member account.
DELETE_FAILED
when Config rule deletion has failed in the member account.
DELETE_IN_PROGRESS when Config rule is being deleted in the member account.
DELETE_SUCCESSFUL
when Config rule has been deleted in the member account.
UPDATE_SUCCESSFUL when Config rule has been updated in the member account.
UPDATE_IN_PROGRESS
when Config rule is being updated in the member account.
UPDATE_FAILED when Config rule deletion has failed in the member account.
Indicates deployment status for conformance pack in a member account. When management account calls PutOrganizationConformancePack action for the first time, conformance
pack status is created in the member account. When management account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the
member account. Conformance pack status is deleted when the management account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com.
Config sets the state of the conformance pack to:
CREATE_SUCCESSFUL when conformance pack has been created in the member account.
CREATE_IN_PROGRESS when conformance pack is being created in the member account.
CREATE_FAILED when conformance pack creation has failed in the
member account.
DELETE_FAILED when conformance pack deletion has failed in the member account.
DELETE_IN_PROGRESS when conformance
pack is being deleted in the member account.
DELETE_SUCCESSFUL when conformance pack has been deleted in the member account.
UPDATE_SUCCESSFUL
when conformance pack has been updated in the member account.
UPDATE_IN_PROGRESS when conformance pack is being updated in the member account.
UPDATE_FAILED when conformance pack deletion has failed in the member account.
The schema type of the resource configuration.
You can find the Resource
type schema, or CFN_RESOURCE_SCHEMA, in "Amazon Web Services public extensions" within the CloudFormation registry or with the following CLI commmand: aws cloudformation
describe-type --type-name "AWS::S3::Bucket" --type RESOURCE.
For more information, see Managing extensions through the CloudFormation registry and Amazon Web Services resource and property types reference in the CloudFormation User Guide.
SELECT resourceId, resourceType, supplementaryConfiguration.BucketVersioningConfiguration.status WHERE resourceType = ''AWS::S3::Bucket''
AND supplementaryConfiguration.BucketVersioningConfiguration.status = ''Off''. '
description: Provides the details of a stored query.
GroupedResourceCount:
type: object
required:
- GroupName
- ResourceCount
properties:
GroupName:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: 'The name of the group that can be region, account ID, or resource type. For example, region1, region2 if the region was chosen as GroupByKey.'
ResourceCount:
allOf:
- $ref: '#/components/schemas/Long'
- description: The number of resources in the group.
description: The count of resources that are grouped by the group name.
IncludeGlobalResourceTypes:
type: boolean
ResourceFilters:
type: object
properties:
AccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: The 12-digit source account ID.
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the resource.
ResourceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the resource.
Region:
allOf:
- $ref: '#/components/schemas/AwsRegion'
- description: The source region.
description: 'Filters the results by resource account ID, region, resource ID, and resource name.'
SortOrder:
type: string
enum:
- ASCENDING
- DESCENDING
SortBy:
type: string
enum:
- SCORE
ResourceIdList:
type: array
items:
$ref: '#/components/schemas/ResourceId'
ResourceIdentifierList:
type: array
items:
$ref: '#/components/schemas/ResourceIdentifier'
ListResourceEvaluationsPageItemLimit:
type: integer
minimum: 0
maximum: 100
ResourceEvaluationFilters:
type: object
properties:
EvaluationMode:
allOf:
- $ref: '#/components/schemas/EvaluationMode'
- description: Filters all resource evaluations results based on an evaluation mode. the valid value for this API is Proactive.
TimeWindow:
allOf:
- $ref: '#/components/schemas/TimeWindow'
- description: Returns a TimeWindow object.
EvaluationContextIdentifier:
allOf:
- $ref: '#/components/schemas/EvaluationContextIdentifier'
- description: 'Filters evaluations for a given infrastructure deployment. For example: CFN Stack.'
description: Returns details of a resource evaluation based on the selected filter.
ResourceEvaluations:
type: array
items:
$ref: '#/components/schemas/ResourceEvaluation'
StoredQueryMetadataList:
type: array
items:
$ref: '#/components/schemas/StoredQueryMetadata'
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 1
maxItems: 50
MemberAccountRuleStatus:
type: string
enum:
- CREATE_SUCCESSFUL
- CREATE_IN_PROGRESS
- CREATE_FAILED
- DELETE_SUCCESSFUL
- DELETE_FAILED
- DELETE_IN_PROGRESS
- UPDATE_SUCCESSFUL
- UPDATE_IN_PROGRESS
- UPDATE_FAILED
MemberAccountStatus:
type: object
required:
- AccountId
- ConfigRuleName
- MemberAccountRuleStatus
properties:
AccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: The 12-digit account ID of a member account.
ConfigRuleName:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit64'
- description: The name of Config rule deployed in the member account.
MemberAccountRuleStatus:
allOf:
- $ref: '#/components/schemas/MemberAccountRuleStatus'
- description: 'Indicates deployment status for Config rule in the member account. When management account calls PutOrganizationConfigRule action for the first time, Config rule
status is created in the member account. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in the member account.
Config rule status is deleted when the management account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com.
Config sets the state of the rule to:
CREATE_SUCCESSFUL when Config rule has been created in the member account.
CREATE_IN_PROGRESS
when Config rule is being created in the member account.
CREATE_FAILED when Config rule creation has failed in the member account.
DELETE_FAILED
when Config rule deletion has failed in the member account.
DELETE_IN_PROGRESS when Config rule is being deleted in the member account.
DELETE_SUCCESSFUL
when Config rule has been deleted in the member account.
UPDATE_SUCCESSFUL when Config rule has been updated in the member account.
UPDATE_IN_PROGRESS
when Config rule is being updated in the member account.
UPDATE_FAILED when Config rule deletion has failed in the member account.
IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.'
InputParameters:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit2048'
- description: 'A string, in JSON format, that is passed to your organization Config rule Lambda function.'
MaximumExecutionFrequency:
allOf:
- $ref: '#/components/schemas/MaximumExecutionFrequency'
- description: 'The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.
By default,
rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:
ConfigurationItemChangeNotification
- Triggers an evaluation when Config delivers a configuration item as a result of a resource change.
OversizedConfigurationItemChangeNotification - Triggers
an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed
by Amazon SNS.
ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.
The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency
parameter.
The type of notification that triggers Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change triggered notification types:
ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.
OversizedConfigurationItemChangeNotification
- Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size
allowed by Amazon SNS.
OrganizationManagedRuleMetadata object.
OrganizationCustomRuleMetadata:
allOf:
- $ref: '#/components/schemas/OrganizationCustomRuleMetadata'
- description: An OrganizationCustomRuleMetadata object.
ExcludedAccounts:
allOf:
- $ref: '#/components/schemas/ExcludedAccounts'
- description: A comma-separated list of accounts excluded from organization Config rule.
LastUpdateTime:
allOf:
- $ref: '#/components/schemas/Date'
- description: The timestamp of the last update.
OrganizationCustomPolicyRuleMetadata:
allOf:
- $ref: '#/components/schemas/OrganizationCustomPolicyRuleMetadataNoPolicy'
- description: 'An object that specifies metadata for your organization''s Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled,
and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources
against a rule.'
description: An organization Config rule that has information about Config rules that Config creates in member accounts.
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
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.
The name of the Amazon S3 bucket where Config stores conformance pack templates.
This field is optional.
Any folder structure you want to add to an Amazon S3 bucket.
This field is optional.
ConformancePackInputParameter objects.
ExcludedAccounts:
allOf:
- $ref: '#/components/schemas/ExcludedAccounts'
- description: A comma-separated list of accounts excluded from organization conformance pack.
LastUpdateTime:
allOf:
- $ref: '#/components/schemas/Date'
- description: Last time when organization conformation pack was updated.
description: 'An organization conformance pack that has information about conformance packs that Config creates in member accounts. '
OrganizationResourceDetailedStatus:
type: string
enum:
- CREATE_SUCCESSFUL
- CREATE_IN_PROGRESS
- CREATE_FAILED
- DELETE_SUCCESSFUL
- DELETE_FAILED
- DELETE_IN_PROGRESS
- UPDATE_SUCCESSFUL
- UPDATE_IN_PROGRESS
- UPDATE_FAILED
OrganizationConformancePackDetailedStatus:
type: object
required:
- AccountId
- ConformancePackName
- Status
properties:
AccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: The 12-digit account ID of a member account.
ConformancePackName:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: The name of conformance pack deployed in the member account.
Status:
allOf:
- $ref: '#/components/schemas/OrganizationResourceDetailedStatus'
- description: 'Indicates deployment status for conformance pack in a member account. When management account calls PutOrganizationConformancePack action for the first time, conformance
pack status is created in the member account. When management account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the
member account. Conformance pack status is deleted when the management account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com.
Config sets the state of the conformance pack to:
CREATE_SUCCESSFUL when conformance pack has been created in the member account.
CREATE_IN_PROGRESS when conformance pack is being created in the member account.
CREATE_FAILED when conformance pack creation has failed in the
member account.
DELETE_FAILED when conformance pack deletion has failed in the member account.
DELETE_IN_PROGRESS when conformance
pack is being deleted in the member account.
DELETE_SUCCESSFUL when conformance pack has been deleted in the member account.
UPDATE_SUCCESSFUL
when conformance pack has been updated in the member account.
UPDATE_IN_PROGRESS when conformance pack is being updated in the member account.
UPDATE_FAILED when conformance pack deletion has failed in the member account.
Indicates deployment status of an organization conformance pack. When management account calls PutOrganizationConformancePack for the first time, conformance pack status is
created in all the member accounts. When management account calls PutOrganizationConformancePack for the second time, conformance pack status is updated in all the member accounts. Additionally,
conformance pack status is updated when one or more member accounts join or leave an organization. Conformance pack status is deleted when the management account deletes OrganizationConformancePack
in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.
Config sets the state of the conformance pack to:
CREATE_SUCCESSFUL
when an organization conformance pack has been successfully created in all the member accounts.
CREATE_IN_PROGRESS when an organization conformance pack creation
is in progress.
CREATE_FAILED when an organization conformance pack creation failed in one or more member accounts within that organization.
DELETE_FAILED when an organization conformance pack deletion failed in one or more member accounts within that organization.
DELETE_IN_PROGRESS
when an organization conformance pack deletion is in progress.
DELETE_SUCCESSFUL when an organization conformance pack has been successfully deleted from all
the member accounts.
UPDATE_SUCCESSFUL when an organization conformance pack has been successfully updated in all the member accounts.
UPDATE_IN_PROGRESS
when an organization conformance pack update is in progress.
UPDATE_FAILED when an organization conformance pack update failed in one or more member accounts
within that organization.
The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:
ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.
OversizedConfigurationItemChangeNotification
- Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum
size allowed by Amazon SNS.
Number of days Config stores your historical information.
Currently, only applicable to the configuration item history.
FieldInfo object.
description: Details about the query.
RecordingStrategy:
type: object
properties:
useOnly:
allOf:
- $ref: '#/components/schemas/RecordingStrategyType'
- description: 'The recording strategy for the configuration recorder.
If you set this option to ALL_SUPPORTED_RESOURCE_TYPES, Config records configuration changes
for all supported regional resource types. You also must set the allSupported field of RecordingGroup
to true.
When Config adds support for a new type of regional resource, Config automatically starts recording resources of that type. For a list of supported resource types, see Supported Resource Types in the Config developer guide.
If you set this option to INCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for only the resource types that you specify in the resourceTypes
field of RecordingGroup.
If you set this option to EXCLUSION_BY_RESOURCE_TYPES,
Config records configuration changes for all supported resource types, except the resource types that you specify as exemptions to exclude from being recorded in the resourceTypes
field of ExclusionByResourceTypes.
The recordingStrategy
field is optional when you set the allSupported field of RecordingGroup to true.
The recordingStrategy field is optional when you list resource types in the resourceTypes field of RecordingGroup.
The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.
If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.
For example, even if you set includeGlobalResourceTypes to false, global resource types will still be automatically recorded in this option unless those resource types are
specifically listed as exemptions in the resourceTypes field of exclusionByResourceTypes.
By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES
recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources
of that type automatically.
sg-xxxxxx).'
resourceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: 'The custom name of the related resource, if available.'
relationshipName:
allOf:
- $ref: '#/components/schemas/RelationshipName'
- description: The type of relationship with the related resource.
description: The relationship of the related resource to the main resource.
RemediationTargetType:
type: string
enum:
- SSM_DOCUMENT
RemediationParameters:
type: object
minProperties: 0
maxProperties: 25
additionalProperties:
$ref: '#/components/schemas/RemediationParameterValue'
RemediationConfiguration:
type: object
required:
- ConfigRuleName
- TargetType
- TargetId
properties:
ConfigRuleName:
allOf:
- $ref: '#/components/schemas/ConfigRuleName'
- description: The name of the Config rule.
TargetType:
allOf:
- $ref: '#/components/schemas/RemediationTargetType'
- description: 'The type of the target. Target executes remediation. For example, SSM document.'
TargetId:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: Target ID is the name of the SSM document.
TargetVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Version of the target. For example, version of the SSM document.
If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.
The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
' RetryAttemptSeconds: allOf: - $ref: '#/components/schemas/AutoRemediationAttemptSeconds' - description: 'Maximum time in seconds that Config runs auto-remediation. If you do not select a number, the default is 60 seconds.
For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.
' Arn: allOf: - $ref: '#/components/schemas/StringWithCharLimit1024' - description: Amazon Resource Name (ARN) of remediation configuration. CreatedByService: allOf: - $ref: '#/components/schemas/StringWithCharLimit1024' - description: 'Name of the service that owns the service-linked rule, if applicable.' description: 'An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.' RemediationException: type: object required: - ConfigRuleName - ResourceType - ResourceId properties: ConfigRuleName: allOf: - $ref: '#/components/schemas/ConfigRuleName' - description: The name of the Config rule. ResourceType: allOf: - $ref: '#/components/schemas/StringWithCharLimit256' - description: The type of a resource. ResourceId: allOf: - $ref: '#/components/schemas/StringWithCharLimit1024' - description: 'The ID of the resource (for example., sg-xxxxxx).' Message: allOf: - $ref: '#/components/schemas/StringWithCharLimit1024' - description: An explanation of an remediation exception. ExpirationTime: allOf: - $ref: '#/components/schemas/Date' - description: The time when the remediation exception will be deleted. description: 'An object that represents the details about the remediation exception. The details include the rule name, an explanation of an exception, the time when the exception will be deleted, the resource ID, and resource type. ' RemediationExceptionResourceKey: type: object properties: ResourceType: allOf: - $ref: '#/components/schemas/StringWithCharLimit256' - description: The type of a resource. ResourceId: allOf: - $ref: '#/components/schemas/StringWithCharLimit1024' - description: 'The ID of the resource (for example., sg-xxxxxx).' description: 'The details that identify a resource within Config, including the resource type and resource ID. ' RemediationExecutionState: type: string enum: - QUEUED - IN_PROGRESS - SUCCEEDED - FAILED ResourceKey: type: object required: - resourceType - resourceId properties: resourceType: allOf: - $ref: '#/components/schemas/ResourceType' - description: The resource type. resourceId: allOf: - $ref: '#/components/schemas/ResourceId' - description: 'The ID of the resource (for example., sg-xxxxxx). ' description: 'The details that identify a resource within Config, including the resource type and resource ID.' RemediationExecutionSteps: type: array items: $ref: '#/components/schemas/RemediationExecutionStep' RemediationExecutionStatus: type: object properties: ResourceKey: $ref: '#/components/schemas/ResourceKey' State: allOf: - $ref: '#/components/schemas/RemediationExecutionState' - description: ENUM of the values. StepDetails: allOf: - $ref: '#/components/schemas/RemediationExecutionSteps' - description: Details of every step. InvocationTime: allOf: - $ref: '#/components/schemas/Date' - description: Start time when the remediation was executed. LastUpdatedTime: allOf: - $ref: '#/components/schemas/Date' - description: The time when the remediation execution was last updated. description: Provides details of the current status of the invoked remediation action for that resource. RemediationExecutionStepState: type: string enum: - SUCCEEDED - PENDING - FAILED RemediationExecutionStep: type: object properties: Name: allOf: - $ref: '#/components/schemas/String' - description: The details of the step. State: allOf: - $ref: '#/components/schemas/RemediationExecutionStepState' - description: The valid status of the step. ErrorMessage: allOf: - $ref: '#/components/schemas/String' - description: An error message if the step was interrupted during execution. StartTime: allOf: - $ref: '#/components/schemas/Date' - description: The time when the step started. StopTime: allOf: - $ref: '#/components/schemas/Date' - description: The time when the step stopped. description: Name of the step from the SSM document. ResourceValue: type: object required: - Value properties: Value: allOf: - $ref: '#/components/schemas/ResourceValueType' - description: The value is a resource ID. description: The dynamic value of the resource. StaticValue: type: object required: - Values properties: Values: allOf: - $ref: '#/components/schemas/StaticParameterValues' - description: 'A list of values. For example, the ARN of the assumed role. ' description: The static value of the resource. RemediationParameterValue: type: object properties: ResourceValue: allOf: - $ref: '#/components/schemas/ResourceValue' - description: The value is dynamic and changes at run-time. StaticValue: allOf: - $ref: '#/components/schemas/StaticValue' - description: The value is static and does not change at run-time. description: The value is either a dynamic (resource) value or a static value. You must select either a dynamic value or a static value. ResourceConfiguration: type: string minLength: 1 maxLength: 51200 ResourceConfigurationSchemaType: type: string enum: - CFN_RESOURCE_SCHEMA ResourceCount: type: object properties: resourceType: allOf: - $ref: '#/components/schemas/ResourceType' - description: 'The resource type (for example,"AWS::EC2::Instance").'
count:
allOf:
- $ref: '#/components/schemas/Long'
- description: The number of resources.
description: An object that contains the resource type and the number of resources.
ResourceDeletionTime:
type: string
format: date-time
ResourceEvaluation:
type: object
properties:
ResourceEvaluationId:
allOf:
- $ref: '#/components/schemas/ResourceEvaluationId'
- description: The ResourceEvaluationId of a evaluation.
EvaluationMode:
allOf:
- $ref: '#/components/schemas/EvaluationMode'
- description: The mode of an evaluation. The valid values are Detective or Proactive.
EvaluationStartTimestamp:
allOf:
- $ref: '#/components/schemas/Date'
- description: The starting time of an execution.
description: Returns details of a resource evaluation.
TimeWindow:
type: object
properties:
StartTime:
allOf:
- $ref: '#/components/schemas/Date'
- description: The start time of an execution.
EndTime:
allOf:
- $ref: '#/components/schemas/Date'
- description: The end time of an execution. The end time must be after the start date.
description: Filters evaluation results based on start and end times.
ResourceIdentifier:
type: object
properties:
resourceType:
allOf:
- $ref: '#/components/schemas/ResourceType'
- description: The type of resource.
resourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the resource (for example, sg-xxxxxx).'
resourceName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The custom name of the resource (if available).
resourceDeletionTime:
allOf:
- $ref: '#/components/schemas/ResourceDeletionTime'
- description: The time that the resource was deleted.
description: 'The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.'
ResourceValueType:
type: string
enum:
- RESOURCE_ID
Results:
type: array
items:
$ref: '#/components/schemas/String'
SSMDocumentName:
type: string
pattern: '^[a-zA-Z0-9_\-.:/]{3,200}$'
SSMDocumentVersion:
type: string
pattern: '([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)'
SourceDetails:
type: array
items:
$ref: '#/components/schemas/SourceDetail'
minItems: 0
maxItems: 25
SourceDetail:
type: object
properties:
EventSource:
allOf:
- $ref: '#/components/schemas/EventSource'
- description: 'The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.'
MessageType:
allOf:
- $ref: '#/components/schemas/MessageType'
- description: 'The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:
ConfigurationItemChangeNotification
- Triggers an evaluation when Config delivers a configuration item as a result of a resource change.
OversizedConfigurationItemChangeNotification - Triggers
an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed
by Amazon SNS.
ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.
ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers a configuration snapshot.
If you want your custom rule to be
triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification.
The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency, then
MessageType must use the ScheduledNotification value.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency,
specify a valid value for the MaximumExecutionFrequency parameter.
Based on the valid value you choose, Config runs evaluations once for each valid value. For example,
if you choose Three_Hours, Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.
SourceDetail only for custom rules. '
StaticParameterValues:
type: array
items:
$ref: '#/components/schemas/StringWithCharLimit256'
minItems: 0
maxItems: 25
StoredQueryMetadata:
type: object
required:
- QueryId
- QueryArn
- QueryName
properties:
QueryId:
allOf:
- $ref: '#/components/schemas/QueryId'
- description: 'The ID of the query. '
QueryArn:
allOf:
- $ref: '#/components/schemas/QueryArn'
- description: 'Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.'
QueryName:
allOf:
- $ref: '#/components/schemas/QueryName'
- description: The name of the query.
Description:
allOf:
- $ref: '#/components/schemas/QueryDescription'
- description: A unique description for the query.
description: 'Returns details of a specific query. '
SupplementaryConfigurationValue:
type: string
SupplementaryConfigurationName:
type: string
TagKey:
type: string
minLength: 1
maxLength: 128
TagValue:
type: string
minLength: 0
maxLength: 256
Tag:
type: object
properties:
Key:
allOf:
- $ref: '#/components/schemas/TagKey'
- description: One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
Value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
description: 'The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.'
TagKeyList:
type: array
items:
$ref: '#/components/schemas/TagKey'
minItems: 1
maxItems: 50
Value:
type: string
security:
- hmac: []