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

Class: Aws::EC2::Types::DescribeByoipCidrsRequest

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 DescribeByoipCidrsRequest data as a hash:

{
  dry_run: false,
  max_results: 1, # required
  next_token: "NextToken",
}

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)


9515
9516
9517
9518
9519
9520
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9515

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

#max_resultsInteger

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

Returns:

  • (Integer)


9515
9516
9517
9518
9519
9520
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9515

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

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


9515
9516
9517
9518
9519
9520
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9515

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