Describe Identity Id Format

ec2_describe_identity_id_format

R Documentation

Describes the ID format settings for resources for the specified IAM user, IAM role, or root user¶

Description¶

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.

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

Usage¶

ec2_describe_identity_id_format(PrincipalArn, Resource)

Arguments¶

PrincipalArn: [required] The ARN of the principal, which can be an IAM role, IAM user, or the root user.
Resource: 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

Value¶

A list with the following syntax:

list(
  Statuses = list(
    list(
      Deadline = as.POSIXct(
        "2015-01-01"
      ),
      Resource = "string",
      UseLongIds = TRUE|FALSE
    )
  )
)

Request syntax¶

svc$describe_identity_id_format(
  PrincipalArn = "string",
  Resource = "string"
)