Class: Aws::EC2::Types::GetCoipPoolUsageRequest

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

{
  pool_id: "CoipPoolId", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
}

Constant Summary collapse

SENSITIVE =
[]

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)


26441
26442
26443
26444
26445
26446
26447
26448
26449
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26441

class GetCoipPoolUsageRequest < Struct.new(
  :pool_id,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::Filter>

The filters. The following are the possible values:

  • coip-address-usage.allocation-id

^ ^

  • coip-address-usage.aws-account-id

^ ^

  • coip-address-usage.aws-service

^ ^

  • coip-address-usage.co-ip

^

Returns:



26441
26442
26443
26444
26445
26446
26447
26448
26449
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26441

class GetCoipPoolUsageRequest < Struct.new(
  :pool_id,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  SENSITIVE = []
  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)


26441
26442
26443
26444
26445
26446
26447
26448
26449
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26441

class GetCoipPoolUsageRequest < Struct.new(
  :pool_id,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


26441
26442
26443
26444
26445
26446
26447
26448
26449
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26441

class GetCoipPoolUsageRequest < Struct.new(
  :pool_id,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#pool_idString

The ID of the address pool.

Returns:

  • (String)


26441
26442
26443
26444
26445
26446
26447
26448
26449
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26441

class GetCoipPoolUsageRequest < Struct.new(
  :pool_id,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end