EC2 / Client / describe_identity_id_format

describe_identity_id_format#

EC2.Client.describe_identity_id_format(**kwargs)#

Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.

Request Syntax

response = client.describe_identity_id_format(
    PrincipalArn='string',
    Resource='string'
)

Parameters:

PrincipalArn (string) –
[REQUIRED]

The ARN of the principal, which can be an IAM role, IAM user, or the root user.
Resource (string) – The type of resource: 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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- Statuses (list) –
  
  Information about the ID format for the resources.
  - (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.