modify_identity_id_format¶
Operation¶
async
¶
modify_identity_id_format(input: ModifyIdentityIdFormatInput, plugins: list[Plugin] | None = None) -> ModifyIdentityIdFormatOutput
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource
types that are within the opt-in period. Resources currently in their
opt-in period include: bundle | conversion-task |
customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image |
import-task | internet-gateway | network-acl |
network-acl-association | network-interface |
network-interface-attachment | prefix-list | route-table |
route-table-association | security-group | subnet |
subnet-cidr-block-association | vpc | vpc-cidr-block-association
| vpc-endpoint | vpc-peering-connection | vpn-connection |
vpn-gateway.
For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.
Resources created with longer IDs are visible to all IAM roles and
users, regardless of these settings and provided that they have
permission to use the relevant Describe command for the resource type.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyIdentityIdFormatInput
|
An instance of |
required |
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 |
|---|---|
ModifyIdentityIdFormatOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyIdentityIdFormatInput structure.
Attributes¶
class-attribute
instance-attribute
¶
principal_arn: str | None = ...
The ARN of the principal, which can be an IAM user, IAM role, or the
root user. Specify all to modify the ID format for all IAM users, IAM
roles, and the root user of the account.
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 | internet-gateway | network-acl |
network-acl-association | network-interface |
network-interface-attachment | prefix-list | route-table |
route-table-association | security-group | subnet |
subnet-cidr-block-association | vpc | vpc-cidr-block-association
| vpc-endpoint | vpc-peering-connection | vpn-connection |
vpn-gateway.
Alternatively, use the all-current option to include all resource
types that are currently within their opt-in period for longer IDs.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyIdentityIdFormatOutput structure.