You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::DescribePrincipalIdFormatRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribePrincipalIdFormatRequest data as a hash:

{
  dry_run: false,
  resources: ["String"],
  max_results: 1,
  next_token: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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.

Returns:

  • (Boolean)


10511
10512
10513
10514
10515
10516
10517
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10511

class DescribePrincipalIdFormatRequest < Struct.new(
  :dry_run,
  :resources,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

Returns:

  • (Integer)


10511
10512
10513
10514
10515
10516
10517
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10511

class DescribePrincipalIdFormatRequest < Struct.new(
  :dry_run,
  :resources,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

The token to request the next page of results.

Returns:

  • (String)


10511
10512
10513
10514
10515
10516
10517
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10511

class DescribePrincipalIdFormatRequest < Struct.new(
  :dry_run,
  :resources,
  :max_results,
  :next_token)
  include Aws::Structure
end

#resourcesArray<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

Returns:

  • (Array<String>)


10511
10512
10513
10514
10515
10516
10517
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10511

class DescribePrincipalIdFormatRequest < Struct.new(
  :dry_run,
  :resources,
  :max_results,
  :next_token)
  include Aws::Structure
end