AWS Config

2019/07/09 - AWS Config - 5 new api methods

Changes  Update config client to latest version

DeleteOrganizationConfigRule (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_organization_config_rule(
    OrganizationConfigRuleName='string'
)
type OrganizationConfigRuleName:

string

param OrganizationConfigRuleName:

[REQUIRED]

returns:

None

DescribeOrganizationConfigRules (new) Link ¶

See also: AWS API Documentation

Request Syntax

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

list

param OrganizationConfigRuleNames:

  • (string) --

type Limit:

integer

param Limit:

type NextToken:

string

param NextToken:

rtype:

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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • OrganizationConfigRules (list) --

      • (dict) --

        • OrganizationConfigRuleName (string) --

        • OrganizationConfigRuleArn (string) --

        • OrganizationManagedRuleMetadata (dict) --

          • Description (string) --

          • RuleIdentifier (string) --

          • InputParameters (string) --

          • MaximumExecutionFrequency (string) --

          • ResourceTypesScope (list) --

            • (string) --

          • ResourceIdScope (string) --

          • TagKeyScope (string) --

          • TagValueScope (string) --

        • OrganizationCustomRuleMetadata (dict) --

          • Description (string) --

          • LambdaFunctionArn (string) --

          • OrganizationConfigRuleTriggerTypes (list) --

            • (string) --

          • InputParameters (string) --

          • MaximumExecutionFrequency (string) --

          • ResourceTypesScope (list) --

            • (string) --

          • ResourceIdScope (string) --

          • TagKeyScope (string) --

          • TagValueScope (string) --

        • ExcludedAccounts (list) --

          • (string) --

        • LastUpdateTime (datetime) --

    • NextToken (string) --

GetOrganizationConfigRuleDetailedStatus (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.get_organization_config_rule_detailed_status(
    OrganizationConfigRuleName='string',
    Filters={
        'AccountId': 'string',
        'MemberAccountRuleStatus': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'
    },
    Limit=123,
    NextToken='string'
)
type OrganizationConfigRuleName:

string

param OrganizationConfigRuleName:

[REQUIRED]

type Filters:

dict

param Filters:

  • AccountId (string) --

  • MemberAccountRuleStatus (string) --

type Limit:

integer

param Limit:

type NextToken:

string

param NextToken:

rtype:

dict

returns:

Response Syntax

{
    'OrganizationConfigRuleDetailedStatus': [
        {
            'AccountId': 'string',
            'ConfigRuleName': 'string',
            'MemberAccountRuleStatus': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS',
            'ErrorCode': 'string',
            'ErrorMessage': 'string',
            'LastUpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • OrganizationConfigRuleDetailedStatus (list) --

      • (dict) --

        • AccountId (string) --

        • ConfigRuleName (string) --

        • MemberAccountRuleStatus (string) --

        • ErrorCode (string) --

        • ErrorMessage (string) --

        • LastUpdateTime (datetime) --

    • NextToken (string) --

DescribeOrganizationConfigRuleStatuses (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.describe_organization_config_rule_statuses(
    OrganizationConfigRuleNames=[
        'string',
    ],
    Limit=123,
    NextToken='string'
)
type OrganizationConfigRuleNames:

list

param OrganizationConfigRuleNames:

  • (string) --

type Limit:

integer

param Limit:

type NextToken:

string

param NextToken:

rtype:

dict

returns:

Response Syntax

{
    'OrganizationConfigRuleStatuses': [
        {
            'OrganizationConfigRuleName': 'string',
            'OrganizationRuleStatus': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS',
            'ErrorCode': 'string',
            'ErrorMessage': 'string',
            'LastUpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • OrganizationConfigRuleStatuses (list) --

      • (dict) --

        • OrganizationConfigRuleName (string) --

        • OrganizationRuleStatus (string) --

        • ErrorCode (string) --

        • ErrorMessage (string) --

        • LastUpdateTime (datetime) --

    • NextToken (string) --

PutOrganizationConfigRule (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.put_organization_config_rule(
    OrganizationConfigRuleName='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',
    ]
)
type OrganizationConfigRuleName:

string

param OrganizationConfigRuleName:

[REQUIRED]

type OrganizationManagedRuleMetadata:

dict

param OrganizationManagedRuleMetadata:

  • Description (string) --

  • RuleIdentifier (string) -- [REQUIRED]

  • InputParameters (string) --

  • MaximumExecutionFrequency (string) --

  • ResourceTypesScope (list) --

    • (string) --

  • ResourceIdScope (string) --

  • TagKeyScope (string) --

  • TagValueScope (string) --

type OrganizationCustomRuleMetadata:

dict

param OrganizationCustomRuleMetadata:

  • Description (string) --

  • LambdaFunctionArn (string) -- [REQUIRED]

  • OrganizationConfigRuleTriggerTypes (list) -- [REQUIRED]

    • (string) --

  • InputParameters (string) --

  • MaximumExecutionFrequency (string) --

  • ResourceTypesScope (list) --

    • (string) --

  • ResourceIdScope (string) --

  • TagKeyScope (string) --

  • TagValueScope (string) --

type ExcludedAccounts:

list

param ExcludedAccounts:

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'OrganizationConfigRuleArn': 'string'
}

Response Structure

  • (dict) --

    • OrganizationConfigRuleArn (string) --