Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ec2 ]

describe-id-format

Description

Describes the ID format settings for your resources on a per-region basis, for example, to view which resource types 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.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway .

These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the modify-id-format command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-id-format
[--resource <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--resource (string)

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To describe the ID format for your resources

This example describes the ID format for all resource types that support longer IDs. The output indicates that the 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, and vpn-gateway resource types can be enabled or disabled for longer IDs. The Deadline for the reservation, instance, volume, and snapshot resource types indicates that the deadline for those resources expired at 00:00 UTC on December 15, 2016. It also shows that all of the resource types, except vpc, subnet, and security-group, are configured to use longer IDs.

Command:

aws ec2 describe-id-format

Output:

{
  "Statuses": [
    {
      "Resource": "reservation",
      "Deadline": "2016-12-15T12:00:00.000Z",
      "UseLongIds": true
    },
    {
      "Resource": "instance",
      "Deadline": "2016-12-15T12:00:00.000Z",
      "UseLongIds": true
    },
    {
      "Resource": "volume",
      "Deadline": "2016-12-15T12:00:00.000Z",
      "UseLongIds": true
    },
    {
      "Resource": "snapshot",
      "Deadline": "2016-12-15T12:00:00.000Z",
      "UseLongIds": true
    },
    {
      "UseLongIds": true,
      "Resource": "network-interface-attachment"
    },
    {
      "UseLongIds": true,
      "Resource": "network-interface"
    },
    {
      "UseLongIds": true,
      "Resource": "elastic-ip-allocation"
    },
    {
      "UseLongIds": true,
      "Resource": "elastic-ip-association"
    },
    {
      "UseLongIds": false,
      "Resource": "vpc"
    },
    {
      "UseLongIds": false,
      "Resource": "subnet"
    },
    {
      "UseLongIds": true,
      "Resource": "route-table"
    },
    {
      "UseLongIds": true,
      "Resource": "route-table-association"
    },
    {
      "UseLongIds": true,
      "Resource": "network-acl"
    },
    {
      "UseLongIds": true,
      "Resource": "network-acl-association"
    },
    {
      "UseLongIds": true,
      "Resource": "dhcp-options"
    },
    {
      "UseLongIds": true,
      "Resource": "internet-gateway"
    },
    {
      "UseLongIds": true,
      "Resource": "vpc-cidr-block-association"
    },
    {
      "UseLongIds": true,
      "Resource": "vpc-ipv6-cidr-block-association"
    },
    {
      "UseLongIds": true,
      "Resource": "subnet-ipv6-cidr-block-association"
    },
    {
      "UseLongIds": true,
      "Resource": "vpc-peering-connection"
    },
    {
      "UseLongIds": false,
      "Resource": "security-group"
    },
    {
      "UseLongIds": true,
      "Resource": "flow-log"
    },
    {
      "UseLongIds": true,
      "Resource": "conversion-task"
    },
    {
      "UseLongIds": true,
      "Resource": "export-task"
    },
    {
      "UseLongIds": true,
      "Resource": "import-task"
    },
    {
      "UseLongIds": true,
      "Resource": "image"
    },
    {
      "UseLongIds": true,
      "Resource": "bundle"
    },
    {
      "UseLongIds": true,
      "Resource": "vpc-endpoint"
    },
    {
      "UseLongIds": true,
      "Resource": "customer-gateway"
    },
    {
      "UseLongIds": true,
      "Resource": "vpn-connection"
    },
    {
      "UseLongIds": true,
      "Resource": "vpn-gateway"
    }
  ]
}

Output

Statuses -> (list)

Information about the ID format for the resource.

(structure)

Describes the ID format for a resource.

Deadline -> (timestamp)

The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.

Resource -> (string)

The type of resource.

UseLongIds -> (boolean)

Indicates whether longer IDs (17-character IDs) are enabled for the resource.