Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Use DescribeIdFormat with a CLI - AWS SDK Code Examples

There are more AWS SDK examples available in the AWS Doc SDK Examples GitHub repo.

There are more AWS SDK examples available in the AWS Doc SDK Examples GitHub repo.

Use DescribeIdFormat with a CLI

The following code examples show how to use DescribeIdFormat.

CLI
AWS CLI

Example 1: To describe the ID format of a resource

The following describe-id-format example describes the ID format for security groups.

aws ec2 describe-id-format \ --resource security-group

In the following example output, the Deadline value indicates that the deadline for this resource type to permanently switch from the short ID format to the long ID format expired at 00:00 UTC on August 15, 2018.

{ "Statuses": [ { "Deadline": "2018-08-15T00:00:00.000Z", "Resource": "security-group", "UseLongIds": true } ] }

Example 2: To describe the ID format for all resources

The following describe-id-format example describes the ID format for all resource types. All resource types that supported the short ID format were switched to use the long ID format.

aws ec2 describe-id-format
PowerShell
Tools for PowerShell

Example 1: This example describes the ID format for the specified resource type.

Get-EC2IdFormat -Resource instance

Output:

Resource UseLongIds -------- ---------- instance False

Example 2: This example describes the ID formats for all resource types that support longer IDs.

Get-EC2IdFormat

Output:

Resource UseLongIds -------- ---------- reservation False instance False
  • For API details, see DescribeIdFormat in AWS Tools for PowerShell Cmdlet Reference.

AWS CLI

Example 1: To describe the ID format of a resource

The following describe-id-format example describes the ID format for security groups.

aws ec2 describe-id-format \ --resource security-group

In the following example output, the Deadline value indicates that the deadline for this resource type to permanently switch from the short ID format to the long ID format expired at 00:00 UTC on August 15, 2018.

{ "Statuses": [ { "Deadline": "2018-08-15T00:00:00.000Z", "Resource": "security-group", "UseLongIds": true } ] }

Example 2: To describe the ID format for all resources

The following describe-id-format example describes the ID format for all resource types. All resource types that supported the short ID format were switched to use the long ID format.

aws ec2 describe-id-format
PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.