AWS Config

2015/06/24 - AWS Config - 2 updated api methods

DescribeConfigurationRecorders (updated) Link ¶
Changes (response)
{'ConfigurationRecorders': {'recordingGroup': {'allSupported': 'boolean',
                                               'resourceTypes': ['AWS::EC2::CustomerGateway '
                                                                 '| '
                                                                 'AWS::EC2::EIP '
                                                                 '| '
                                                                 'AWS::EC2::Instance '
                                                                 '| '
                                                                 'AWS::EC2::InternetGateway '
                                                                 '| '
                                                                 'AWS::EC2::NetworkAcl '
                                                                 '| '
                                                                 'AWS::EC2::NetworkInterface '
                                                                 '| '
                                                                 'AWS::EC2::RouteTable '
                                                                 '| '
                                                                 'AWS::EC2::SecurityGroup '
                                                                 '| '
                                                                 'AWS::EC2::Subnet '
                                                                 '| '
                                                                 'AWS::CloudTrail::Trail '
                                                                 '| '
                                                                 'AWS::EC2::Volume '
                                                                 '| '
                                                                 'AWS::EC2::VPC '
                                                                 '| '
                                                                 'AWS::EC2::VPNConnection '
                                                                 '| '
                                                                 'AWS::EC2::VPNGateway']}}}

Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account.

Note

Currently, you can specify only one configuration recorder per account.

Request Syntax

client.describe_configuration_recorders(
    ConfigurationRecorderNames=[
        'string',
    ]
)
type ConfigurationRecorderNames

list

param ConfigurationRecorderNames

A list of configuration recorder names.

  • (string) --

rtype

dict

returns

Response Syntax

{
    'ConfigurationRecorders': [
        {
            'name': 'string',
            'roleARN': 'string',
            'recordingGroup': {
                'allSupported': True|False,
                'resourceTypes': [
                    'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway',
                ]
            }
        },
    ]
}

Response Structure

  • (dict) --

    The output for the DescribeConfigurationRecorders action.

    • ConfigurationRecorders (list) --

      A list that contains the descriptions of the specified configuration recorders.

      • (dict) --

        An object that represents the recording of configuration changes of an AWS resource.

        • name (string) --

          The name of the recorder. By default, AWS Config automatically assigns the name "default" when creating the configuration recorder. You cannot change the assigned name.

        • roleARN (string) --

          Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account.

        • recordingGroup (dict) --

          The recording group specifies either to record configurations for all supported resources or to provide a list of resource types to record. The list of resource types must be a subset of supported resource types.

          • allSupported (boolean) --

            Records all supported resource types in the recording group. For a list of supported resource types, see Supported resource types. If you specify allSupported , you cannot enumerate a list of resourceTypes .

          • resourceTypes (list) --

            A comma-separated list of strings representing valid AWS resource types (e.g., AWS::EC2::Instance or AWS::CloudTrail::Trail ). resourceTypes is only valid if you have chosen not to select allSupported . For a list of valid resourceTypes values, see the resourceType Value column in the following topic: Supported AWS Resource Types.

            • (string) --

PutConfigurationRecorder (updated) Link ¶
Changes (request)
{'ConfigurationRecorder': {'recordingGroup': {'allSupported': 'boolean',
                                              'resourceTypes': ['AWS::EC2::CustomerGateway '
                                                                '| '
                                                                'AWS::EC2::EIP '
                                                                '| '
                                                                'AWS::EC2::Instance '
                                                                '| '
                                                                'AWS::EC2::InternetGateway '
                                                                '| '
                                                                'AWS::EC2::NetworkAcl '
                                                                '| '
                                                                'AWS::EC2::NetworkInterface '
                                                                '| '
                                                                'AWS::EC2::RouteTable '
                                                                '| '
                                                                'AWS::EC2::SecurityGroup '
                                                                '| '
                                                                'AWS::EC2::Subnet '
                                                                '| '
                                                                'AWS::CloudTrail::Trail '
                                                                '| '
                                                                'AWS::EC2::Volume '
                                                                '| '
                                                                'AWS::EC2::VPC '
                                                                '| '
                                                                'AWS::EC2::VPNConnection '
                                                                '| '
                                                                'AWS::EC2::VPNGateway']}}}

Creates a new configuration recorder to record the selected resource configurations.

You can use this action to change the role roleARN and/or the recordingGroup of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.

Note

Currently, you can specify only one configuration recorder per account.

If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types.

Request Syntax

client.put_configuration_recorder(
    ConfigurationRecorder={
        'name': 'string',
        'roleARN': 'string',
        'recordingGroup': {
            'allSupported': True|False,
            'resourceTypes': [
                'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway',
            ]
        }
    }
)
type ConfigurationRecorder

dict

param ConfigurationRecorder

[REQUIRED]

The configuration recorder object that records each configuration change made to the resources.

  • name (string) --

    The name of the recorder. By default, AWS Config automatically assigns the name "default" when creating the configuration recorder. You cannot change the assigned name.

  • roleARN (string) --

    Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account.

  • recordingGroup (dict) --

    The recording group specifies either to record configurations for all supported resources or to provide a list of resource types to record. The list of resource types must be a subset of supported resource types.

    • allSupported (boolean) --

      Records all supported resource types in the recording group. For a list of supported resource types, see Supported resource types. If you specify allSupported , you cannot enumerate a list of resourceTypes .

    • resourceTypes (list) --

      A comma-separated list of strings representing valid AWS resource types (e.g., AWS::EC2::Instance or AWS::CloudTrail::Trail ). resourceTypes is only valid if you have chosen not to select allSupported . For a list of valid resourceTypes values, see the resourceType Value column in the following topic: Supported AWS Resource Types.

      • (string) --

returns

None