ConfigService / Client / describe_organization_config_rules

describe_organization_config_rules#

ConfigService.Client.describe_organization_config_rules(**kwargs)#

Returns a list of organization Config rules.

Note

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 organization

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.

Request Syntax

response = client.describe_organization_config_rules(
    OrganizationConfigRuleNames=[
        'string',
    ],
    Limit=123,
    NextToken='string'
)

Parameters:

OrganizationConfigRuleNames (list) –
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.
- (string) –
Limit (integer) – 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 (string) – The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Return type:

dict

Returns:

Response Syntax

{
    'OrganizationConfigRules': [
        {
            'OrganizationConfigRuleName': 'string',
            'OrganizationConfigRuleArn': 'string',
            'OrganizationManagedRuleMetadata': {
                'Description': 'string',
                'RuleIdentifier': 'string',
                'InputParameters': 'string',
                'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours',
                'ResourceTypesScope': [
                    'string',
                ],
                'ResourceIdScope': 'string',
                'TagKeyScope': 'string',
                'TagValueScope': 'string'
            },
            'OrganizationCustomRuleMetadata': {
                'Description': 'string',
                'LambdaFunctionArn': 'string',
                'OrganizationConfigRuleTriggerTypes': [
                    'ConfigurationItemChangeNotification'|'OversizedConfigurationItemChangeNotification'|'ScheduledNotification',
                ],
                'InputParameters': 'string',
                'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours',
                'ResourceTypesScope': [
                    'string',
                ],
                'ResourceIdScope': 'string',
                'TagKeyScope': 'string',
                'TagValueScope': 'string'
            },
            'ExcludedAccounts': [
                'string',
            ],
            'LastUpdateTime': datetime(2015, 1, 1),
            'OrganizationCustomPolicyRuleMetadata': {
                'Description': 'string',
                'OrganizationConfigRuleTriggerTypes': [
                    'ConfigurationItemChangeNotification'|'OversizedConfigurationItemChangeNotification',
                ],
                'InputParameters': 'string',
                'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours',
                'ResourceTypesScope': [
                    'string',
                ],
                'ResourceIdScope': 'string',
                'TagKeyScope': 'string',
                'TagValueScope': 'string',
                'PolicyRuntime': 'string',
                'DebugLogDeliveryAccounts': [
                    'string',
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- OrganizationConfigRules (list) –
  
  Returns a list of OrganizationConfigRule objects.
  - (dict) –
    
    An organization Config rule that has information about Config rules that Config creates in member accounts.
    - OrganizationConfigRuleName (string) –
      
      The name that you assign to organization Config rule.
    - OrganizationConfigRuleArn (string) –
      
      Amazon Resource Name (ARN) of organization Config rule.
    - OrganizationManagedRuleMetadata (dict) –
      
      An OrganizationManagedRuleMetadata object.
      - Description (string) –
        
        The description that you provide for your organization Config rule.
      - RuleIdentifier (string) –
        
        For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.
      - InputParameters (string) –
        
        A string, in JSON format, that is passed to your organization Config rule Lambda function.
      - MaximumExecutionFrequency (string) –
        
        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.
        
        Note
        By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
      - ResourceTypesScope (list) –
        
        The type of the Amazon Web Services resource that was evaluated.
        
        (string) –
      - ResourceIdScope (string) –
        
        The ID of the Amazon Web Services resource that was evaluated.
      - TagKeyScope (string) –
        
        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 (string) –
        
        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
    - OrganizationCustomRuleMetadata (dict) –
      
      An OrganizationCustomRuleMetadata object.
      - Description (string) –
        
        The description that you provide for your organization Config rule.
      - LambdaFunctionArn (string) –
        
        The lambda function ARN.
      - OrganizationConfigRuleTriggerTypes (list) –
        
        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.
        
        (string) –
      - InputParameters (string) –
        
        A string, in JSON format, that is passed to your organization Config rule Lambda function.
      - MaximumExecutionFrequency (string) –
        
        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.
        
        Note
        By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
      - ResourceTypesScope (list) –
        
        The type of the Amazon Web Services resource that was evaluated.
        
        (string) –
      - ResourceIdScope (string) –
        
        The ID of the Amazon Web Services resource that was evaluated.
      - TagKeyScope (string) –
        
        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 (string) –
        
        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
    - ExcludedAccounts (list) –
      
      A comma-separated list of accounts excluded from organization Config rule.
      - (string) –
    - LastUpdateTime (datetime) –
      
      The timestamp of the last update.
    - OrganizationCustomPolicyRuleMetadata (dict) –
      
      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 (string) –
        
        The description that you provide for your organization Config Custom Policy rule.
      - OrganizationConfigRuleTriggerTypes (list) –
        
        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.
        
        (string) –
      - InputParameters (string) –
        
        A string, in JSON format, that is passed to your organization Config Custom Policy rule.
      - MaximumExecutionFrequency (string) –
        
        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 ConfigSnapshotDeliveryProperties.
      - ResourceTypesScope (list) –
        
        The type of the Amazon Web Services resource that was evaluated.
        
        (string) –
      - ResourceIdScope (string) –
        
        The ID of the Amazon Web Services resource that was evaluated.
      - TagKeyScope (string) –
        
        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 (string) –
        
        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 (string) –
        
        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 Guard GitHub Repository.
      - DebugLogDeliveryAccounts (list) –
        
        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.
        
        (string) –
- NextToken (string) –
  
  The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Exceptions

ConfigService.Client.exceptions.NoSuchOrganizationConfigRuleException
ConfigService.Client.exceptions.InvalidNextTokenException
ConfigService.Client.exceptions.InvalidLimitException
ConfigService.Client.exceptions.OrganizationAccessDeniedException