describe_identity_id_format¶
Operation¶
describe_identity_id_format
¶
describe_identity_id_format(request: DescribeIdentityIdFormatInput | DescribeIdentityIdFormatInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIdentityIdFormatInputDict]) -> DescribeIdentityIdFormatOutput
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.
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.
These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeIdentityIdFormatInput | DescribeIdentityIdFormatInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeIdentityIdFormatInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeIdentityIdFormatOutput
|
An instance of |
describe_identity_id_format
async
¶
describe_identity_id_format(request: DescribeIdentityIdFormatInput | DescribeIdentityIdFormatInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIdentityIdFormatInputDict]) -> DescribeIdentityIdFormatOutput
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.
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.
These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeIdentityIdFormatInput | DescribeIdentityIdFormatInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeIdentityIdFormatInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeIdentityIdFormatOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeIdentityIdFormatInputDict
¶
Bases: TypedDict
Dictionary form of DescribeIdentityIdFormatInput.
Attributes¶
principal_arn
instance-attribute
¶
The ARN of the principal, which can be an IAM role, IAM user, or the root user.
resource
instance-attribute
¶
resource: 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
DescribeIdentityIdFormatInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeIdentityIdFormatInput structure.
Attributes¶
principal_arn
class-attribute
instance-attribute
¶
principal_arn: str | None = ...
The ARN of the principal, which can be an IAM role, IAM user, or the root user.
resource
class-attribute
instance-attribute
¶
resource: 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¶
DescribeIdentityIdFormatOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeIdentityIdFormatOutput structure.