describe_principal_id_format

describe_principal_id_format(**kwargs)

Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.

By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.

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_principal_id_format(
    DryRun=True|False,
    Resources=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)

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 .
• Resources (list) --

  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

  • (string) --
• MaxResults (integer) -- The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
• NextToken (string) -- The token to request the next page of results.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • Principals (list) --

    Information about the ID format settings for the ARN.

    • (dict) --

      PrincipalIdFormat description

      • Arn (string) --

        PrincipalIdFormatARN description

      • Statuses (list) --

        PrincipalIdFormatStatuses description

        • (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.

  • NextToken (string) --

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.