EC2 / Client / describe_aggregate_id_format

describe_aggregate_id_format#

EC2.Client.describe_aggregate_id_format(**kwargs)#

Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).

This request only returns information about resource types that support longer IDs.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

See also: AWS API Documentation

Request Syntax

response = client.describe_aggregate_id_format(
    DryRun=True|False
)
Parameters:

DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'UseLongIdsAggregated': True|False,
    'Statuses': [
        {
            'Deadline': datetime(2015, 1, 1),
            'Resource': 'string',
            'UseLongIds': True|False
        },
    ]
}

Response Structure

  • (dict) –

    • UseLongIdsAggregated (boolean) –

      Indicates whether all resource types in the Region are configured to use longer IDs. This value is only true if all users are configured to use longer IDs for all resources types in the Region.

    • Statuses (list) –

      Information about each resource’s ID format.

      • (dict) –

        Describes the ID format for a resource.

        • Deadline (datetime) –

          The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.

        • Resource (string) –

          The type of resource.

        • UseLongIds (boolean) –

          Indicates whether longer IDs (17-character IDs) are enabled for the resource.