openapi: 3.0.0
info:
version: '2014-11-12'
x-release: v4
title: 'AWS Config #X Amz Target=StarlingDoveService.BatchGetAggregateResourceConfig #X Amz Target=StarlingDoveService.BatchGetAggregateResourceConfig #X Amz Target=StarlingDoveService.PutOrganizationConfigRule API'
description: <fullname>Config</fullname> <p>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 <a href="https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported Amazon Web Services resources</a>.</p> <p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. 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 <a href="https://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html">What Is Config</a> in the <i>Config Developer Guide</i>.</p>
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: config
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/config-2014-11-12.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://config.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Config Service multi-region endpoint
- url: https://config.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Config Service multi-region endpoint
- url: http://config.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Config Service endpoint for China (Beijing) and China (Ningxia)
- url: https://config.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Config Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=StarlingDoveService.PutOrganizationConfigRule'
paths:
/#X-Amz-Target=StarlingDoveService.PutOrganizationConfigRule:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: PutOrganizationConfigRule
description: '<p>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 <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html"> <b>Service Limits</b> </a> in the <i>Config Developer Guide</i>.</p> <p> 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 <code>ListDelegatedAdministrator</code> permissions are added. An organization can have up to 3 delegated administrators.</p> <p>This API enables organization service access through the <code>EnableAWSServiceAccess</code> action and creates a service-linked role <code>AWSServiceRoleForConfigMultiAccountSetup</code> 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 <code>GetRole</code> action.</p> <p>To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization <code>register-delegated-administrator</code> for <code>config-multiaccountsetup.amazonaws.com</code>. </p> <p>There are two types of rules: <i>Config Managed Rules</i> and <i>Config Custom Rules</i>. You can use <code>PutOrganizationConfigRule</code> to create both Config Managed Rules and Config Custom Rules.</p> <p>Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html">List of Config Managed Rules</a>. If you are adding an Config managed rule, you must specify the rule''s identifier for the <code>RuleIdentifier</code> key.</p> <p>Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions (<a href="https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function"> Lambda Developer Guide</a>) and with Guard (<a href="https://github.com/aws-cloudformation/cloudformation-guard">Guard GitHub Repository</a>), a policy-as-code language. Config custom rules created with Lambda are called <i>Config Custom Lambda Rules</i> and Config custom rules created with Guard are called <i>Config Custom Policy Rules</i>.</p> <p>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 <code>PutOrganizationConfigRule</code> to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function.</p> <note> <p>Prerequisite: Ensure you call <code>EnableAllFeatures</code> API to enable all features in an organization.</p> <p>Make sure to specify one of either <code>OrganizationCustomPolicyRuleMetadata</code> for Custom Policy rules, <code>OrganizationCustomRuleMetadata</code> for Custom Lambda rules, or <code>OrganizationManagedRuleMetadata</code> for managed rules.</p> </note>'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutOrganizationConfigRuleResponse'
examples:
PutOrganizationConfigRule200Example:
summary: Default PutOrganizationConfigRule 200
x-microcks-default: true
value:
OrganizationConfigRuleArn: example
'480':
description: MaxNumberOfOrganizationConfigRulesExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/MaxNumberOfOrganizationConfigRulesExceededException'
examples:
PutOrganizationConfigRule480Example:
summary: Default PutOrganizationConfigRule 480
x-microcks-default: true
value: example
'481':
description: ResourceInUseException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceInUseException'
examples:
PutOrganizationConfigRule481Example:
summary: Default PutOrganizationConfigRule 481
x-microcks-default: true
value: example
'482':
description: InvalidParameterValueException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
examples:
PutOrganizationConfigRule482Example:
summary: Default PutOrganizationConfigRule 482
x-microcks-default: true
value: example
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
PutOrganizationConfigRule483Example:
summary: Default PutOrganizationConfigRule 483
x-microcks-default: true
value: example
'484':
description: OrganizationAccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationAccessDeniedException'
examples:
PutOrganizationConfigRule484Example:
summary: Default PutOrganizationConfigRule 484
x-microcks-default: true
value: example
'485':
description: NoAvailableOrganizationException
content:
application/json:
schema:
$ref: '#/components/schemas/NoAvailableOrganizationException'
examples:
PutOrganizationConfigRule485Example:
summary: Default PutOrganizationConfigRule 485
x-microcks-default: true
value: example
'486':
description: OrganizationAllFeaturesNotEnabledException
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationAllFeaturesNotEnabledException'
examples:
PutOrganizationConfigRule486Example:
summary: Default PutOrganizationConfigRule 486
x-microcks-default: true
value: example
'487':
description: InsufficientPermissionsException
content:
application/json:
schema:
$ref: '#/components/schemas/InsufficientPermissionsException'
examples:
PutOrganizationConfigRule487Example:
summary: Default PutOrganizationConfigRule 487
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutOrganizationConfigRuleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- StarlingDoveService.PutOrganizationConfigRule
summary: Amazon Config Put Organization Config Rule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=StarlingDoveService.PutOrganizationConfigRule'
components:
schemas:
ResourceInUseException: {}
DebugLogDeliveryAccounts:
type: array
items:
$ref: '#/components/schemas/AccountId'
minItems: 0
maxItems: 1000
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 <code>OrganizationManagedRuleMetadata</code> 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 <code>OrganizationCustomRuleMetadata</code> 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 <code>OrganizationCustomPolicyRuleMetadata</code> 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.
StringWithCharLimit256:
type: string
minLength: 1
maxLength: 256
PolicyText:
type: string
minLength: 0
maxLength: 10000
MaximumExecutionFrequency:
type: string
enum:
- One_Hour
- Three_Hours
- Six_Hours
- Twelve_Hours
- TwentyFour_Hours
ExcludedAccounts:
type: array
items:
$ref: '#/components/schemas/AccountId'
minItems: 0
maxItems: 1000
PolicyRuntime:
type: string
pattern: guard\-2\.x\.x
minLength: 1
maxLength: 64
OrganizationConfigRuleName:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 64
OrganizationCustomRuleMetadata:
type: object
required:
- LambdaFunctionArn
- OrganizationConfigRuleTriggerTypes
properties:
Description:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256Min0'
- description: The description that you provide for your organization Config rule.
LambdaFunctionArn:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: The lambda function ARN.
OrganizationConfigRuleTriggerTypes:
allOf:
- $ref: '#/components/schemas/OrganizationConfigRuleTriggerTypes'
- description: <p>The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:</p> <ul> <li> <p> <code>ConfigurationItemChangeNotification</code> - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.</p> </li> <li> <p> <code>OversizedConfigurationItemChangeNotification</code> - 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.</p> </li> <li> <p> <code>ScheduledNotification</code> - Triggers a periodic evaluation at the frequency specified for <code>MaximumExecutionFrequency</code>.</p> </li> </ul>
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: <p>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 <a>ConfigSnapshotDeliveryProperties</a>.</p> <note> <p>By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the <code>MaximumExecutionFrequency</code> parameter.</p> </note>
ResourceTypesScope:
allOf:
- $ref: '#/components/schemas/ResourceTypesScope'
- description: The type of the Amazon Web Services resource that was evaluated.
ResourceIdScope:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit768'
- description: The ID of the Amazon Web Services resource that was evaluated.
TagKeyScope:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit128'
- 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. '
TagValueScope:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- 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: ' 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.'
InsufficientPermissionsException: {}
OrganizationConfigRuleTriggerType:
type: string
enum:
- ConfigurationItemChangeNotification
- OversizedConfigurationItemChangeNotification
- ScheduledNotification
InvalidParameterValueException: {}
StringWithCharLimit128:
type: string
minLength: 1
maxLength: 128
OrganizationAllFeaturesNotEnabledException: {}
OrganizationConfigRuleTriggerTypeNoSN:
type: string
enum:
- ConfigurationItemChangeNotification
- OversizedConfigurationItemChangeNotification
StringWithCharLimit2048:
type: string
minLength: 1
maxLength: 2048
OrganizationCustomPolicyRuleMetadata:
type: object
required:
- PolicyRuntime
- PolicyText
properties:
Description:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256Min0'
- description: The description that you provide for your organization Config Custom Policy rule.
OrganizationConfigRuleTriggerTypes:
allOf:
- $ref: '#/components/schemas/OrganizationConfigRuleTriggerTypeNoSNs'
- description: <p>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:</p> <ul> <li> <p> <code>ConfigurationItemChangeNotification</code> - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.</p> </li> <li> <p> <code>OversizedConfigurationItemChangeNotification</code> - 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.</p> </li> </ul>
InputParameters:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit2048'
- description: A string, in JSON format, that is passed to your organization Config Custom Policy rule.
MaximumExecutionFrequency:
allOf:
- $ref: '#/components/schemas/MaximumExecutionFrequency'
- description: The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see <a>ConfigSnapshotDeliveryProperties</a>.
ResourceTypesScope:
allOf:
- $ref: '#/components/schemas/ResourceTypesScope'
- description: The type of the Amazon Web Services resource that was evaluated.
ResourceIdScope:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit768'
- description: The ID of the Amazon Web Services resource that was evaluated.
TagKeyScope:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit128'
- 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.
TagValueScope:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- 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).
PolicyRuntime:
allOf:
- $ref: '#/components/schemas/PolicyRuntime'
- description: The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the <a href="https://github.com/aws-cloudformation/cloudformation-guard">Guard GitHub Repository</a>.
PolicyText:
allOf:
- $ref: '#/components/schemas/PolicyText'
- description: The policy definition containing the logic for your organization Config Custom Policy rule.
DebugLogDeliveryAccounts:
allOf:
- $ref: '#/components/schemas/DebugLogDeliveryAccounts'
- description: A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.
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.
StringWithCharLimit768:
type: string
minLength: 1
maxLength: 768
PutOrganizationConfigRuleResponse:
type: object
properties:
OrganizationConfigRuleArn:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: The Amazon Resource Name (ARN) of an organization Config rule.
StringWithCharLimit256Min0:
type: string
minLength: 0
maxLength: 256
NoAvailableOrganizationException: {}
MaxNumberOfOrganizationConfigRulesExceededException: {}
OrganizationManagedRuleMetadata:
type: object
required:
- RuleIdentifier
properties:
Description:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256Min0'
- description: The description that you provide for your organization Config rule.
RuleIdentifier:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- description: For organization config managed rules, a predefined identifier from a list. For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a managed rule, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using Config managed rules</a>.
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: <p>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.</p> <note> <p>By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the <code>MaximumExecutionFrequency</code> parameter.</p> </note>
ResourceTypesScope:
allOf:
- $ref: '#/components/schemas/ResourceTypesScope'
- description: The type of the Amazon Web Services resource that was evaluated.
ResourceIdScope:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit768'
- description: The ID of the Amazon Web Services resource that was evaluated.
TagKeyScope:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit128'
- 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. '
TagValueScope:
allOf:
- $ref: '#/components/schemas/StringWithCharLimit256'
- 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: ' 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.'
AccountId:
type: string
pattern: \d{12}
OrganizationConfigRuleTriggerTypes:
type: array
items:
$ref: '#/components/schemas/OrganizationConfigRuleTriggerType'
OrganizationConfigRuleTriggerTypeNoSNs:
type: array
items:
$ref: '#/components/schemas/OrganizationConfigRuleTriggerTypeNoSN'
OrganizationAccessDeniedException: {}
ResourceTypesScope:
type: array
items:
$ref: '#/components/schemas/StringWithCharLimit256'
minItems: 0
maxItems: 100
ValidationException: {}
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/config/
x-hasEquivalentPaths: true