View a markdown version of this page

Use ModifyIdFormat with a CLI - AWS SDK Code Examples

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

Use ModifyIdFormat with a CLI

The following code examples show how to use ModifyIdFormat.

CLI
AWS CLI

Example 1: To enable the longer ID format for a resource

The following modify-id-format example enables the longer ID format for the instance resource type.

aws ec2 modify-id-format \ --resource instance \ --use-long-ids

This command produces no output.

For more information, see Manage your Amazon EC2 resources in the Amazon EC2 User Guide.

Example 2: To disable the longer ID format for a resource

The following modify-id-format example disables the longer ID format for the instance resource type.

aws ec2 modify-id-format \ --resource instance \ --no-use-long-ids

This command produces no output.

The following modify-id-format example enables the longer ID format for all supported resource types that are within their opt-in period.

aws ec2 modify-id-format \ --resource all-current \ --use-long-ids

This command produces no output.

For more information, see Manage your Amazon EC2 resources in the Amazon EC2 User Guide.

PowerShell
Tools for PowerShell V4

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

Edit-EC2IdFormat -Resource instance -UseLongId $true

Example 2: This example disables the longer ID format for the specified resource type.

Edit-EC2IdFormat -Resource instance -UseLongId $false
  • For API details, see ModifyIdFormat in AWS Tools for PowerShell Cmdlet Reference (V4).

Tools for PowerShell V5

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

Edit-EC2IdFormat -Resource instance -UseLongId $true

Example 2: This example disables the longer ID format for the specified resource type.

Edit-EC2IdFormat -Resource instance -UseLongId $false
  • For API details, see ModifyIdFormat in AWS Tools for PowerShell Cmdlet Reference (V5).