Table Of Contents

Feedback

User Guide

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

[ aws . ec2 ]

describe-aggregate-id-format

Description

Describes the longer ID format settings for all resource types in a specific region. This request is useful for performing a quick audit to determine whether a specific region is fully opted in for longer IDs (17-character IDs).

This request only returns information about resource types that support longer IDs.

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 .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-aggregate-id-format
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--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 longer ID format settings for all resource types in a specific region

This example describes the overall longer ID format settings for the eu-west-1 Region. The output indicates that the following resource types can be enabled or disabled for longer IDs: 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.

The Deadline value 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 IAM users and IAM roles are configured to use longer IDs for all resource types, except vpc and subnet. One or more IAM users or IAM roles are not configured to use longer IDs for vpc and subnet resource types. UseLongIdsAggregated is false because not all IAM users and IAM roles are configured to use longer IDs for all resource types in the Region.

Command:

aws ec2 describe-aggregate-id-format --region eu-west-1

Output:

{
  "UseLongIdsAggregated": false,
  "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": true,
          "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

UseLongIdsAggregated -> (boolean)

Indicates whether all resource types in the region are configured to use longer IDs. This value is only true if all users are configured to use longer IDs for all resources types in the region.

Statuses -> (list)

Information about each resource's ID format.

(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.