Describe Principal Id Format

ec2_describe_principal_id_format

R Documentation

Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference¶

Description¶

Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.

By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.

Usage¶

ec2_describe_principal_id_format(DryRun, Resources, MaxResults,
  NextToken)

Arguments¶

DryRun: 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.
Resources: 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
MaxResults: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
NextToken: The token to request the next page of results.

Value¶

A list with the following syntax:

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

Request syntax¶

svc$describe_principal_id_format(
  DryRun = TRUE|FALSE,
  Resources = list(
    "string"
  ),
  MaxResults = 123,
  NextToken = "string"
)