Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

ModifyIdentityIdFormat

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.

The following resource types support longer IDs: instance | reservation | snapshot | volume. 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.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

PrincipalArn

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.

Type: String

Required: Yes

Resource

The type of resource: instance | reservation | snapshot | volume

Type: String

Required: Yes

UseLongIds

Indicates whether the resource should use longer IDs (17-character IDs)

Type: Boolean

Required: Yes

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

return

Is true if the request succeeds, and an error otherwise.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Example

Example

This example sets the UseLongIds parameter to true for instances launched by the IAM role 'EC2Role'. Instances launched by the IAM role receive longer IDs.

Sample Request

https://ec2.amazonaws.com/?Action=ModifyIdentityFormat
&Resource=instance
&UseLongIds=true
&PrincipalArn=arn:aws:iam::123456789012:role/EC2Role
&AUTHPARAMS

Sample Response

<ModifyIdentityIdFormatResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
  <requestId>92c1af09-cb4c-410e-8a96-example</requestId>
  <return>true</return>
</ModifyIdentityIdFormatResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: