ec2_modify_identity_id_format {aws.ecx}R Documentation

Modify Identity Id Format

Description

Modify Identity Id Format

Usage

ec2_modify_identity_id_format(
  PrincipalArn,
  Resource,
  UseLongIds,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

PrincipalArn

Character. The ARN of the principal, which can be an IAM user, IAM role, or the root user.

Resource

Character. The type of resource: bundle \| conversion-task \| customer-gateway \| dhcp-options \|...

UseLongIds

Logical. Indicates whether the resource should use longer IDs (17-character IDs)

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

PrincipalArn

The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.

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 \| 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 \| vpn-gateway.

Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.

UseLongIds

Indicates whether the resource should use longer IDs (17-character IDs)


[Package aws.ecx version 1.0.5 Index]