Skip to content

EC2  >  Operations  >  describe_principal_id_format

describe_principal_id_format

Operation

describe_principal_id_format async

describe_principal_id_format(request: DescribePrincipalIdFormatInput | DescribePrincipalIdFormatInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribePrincipalIdFormatOutput
describe_principal_id_format(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribePrincipalIdFormatInputDict]) -> DescribePrincipalIdFormatOutput

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribePrincipalIdFormatOutput

An instance of DescribePrincipalIdFormatOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribePrincipalIdFormatInput dataclass

Bases: _SerdeShape

Dataclass for DescribePrincipalIdFormatInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token to request the next page of results.

resources class-attribute instance-attribute
resources: list[str] | None = ...

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

Dictionaries

DescribePrincipalIdFormatInputDict

Bases: TypedDict

Dictionary form of DescribePrincipalIdFormatInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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.

max_results instance-attribute
max_results: int | None

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

next_token instance-attribute
next_token: str | None

The token to request the next page of results.

resources instance-attribute
resources: Sequence[str] | None

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

Output

DescribePrincipalIdFormatOutput dataclass

Bases: _SerdeShape

Dataclass for DescribePrincipalIdFormatOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

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

principals class-attribute instance-attribute
principals: list[PrincipalIdFormat] | None = ...

Information about the ID format settings for the ARN.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.