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

DescribeIdentityIdFormat

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: instance | reservation | snapshot | volume.

These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.

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 role, IAM user, or the root user.

Type: String

Required: Yes

Resource

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

Type: String

Required: No

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

statusSet

Information about the ID format for the resources.

Type: array of IdFormat objects

Errors

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

Example

Example

This example describes the ID format for the IAM role 'EC2Role'.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=DescribeIdentityIdFormat &PrincipalArn=arn:aws:iam::123456789012:role/EC2Role &AUTHPARAMS

Sample Response

Copy
<DescribeIdentityIdFormatResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <statuses> <item> <resource>instance</resource> <useLongIds>true</useLongIds> <deadline>2016-11-01T21:34:34.000Z</deadline> </item> <item> <resource>reservation</resource> <useLongIds>false</useLongIds> <deadline>2016-11-01T21:34:34.000Z</deadline> </item> <item> <resource>volume</resource> <useLongIds>false</useLongIds> <deadline>2016-11-01T21:34:34.000Z</deadline> </item> <item> <resource>snapshot</resource> <useLongIds>false</useLongIds> <deadline>2016-11-01T21:34:34.000Z</deadline> </item> </DescribeIdentityIdFormatResponse>

See Also

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