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

Class: Aws::APIGateway::Types::GetBasePathMappingsRequest

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

Overview

Note:

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

{
  domain_name: "String", # required
  position: "String",
  limit: 1,
}

A request to get information about a collection of BasePathMapping resources.

Instance Attribute Summary collapse

Instance Attribute Details

#domain_nameString

The domain name of a BasePathMapping resource.

Returns:

  • (String)


2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2868

class GetBasePathMappingsRequest < Struct.new(
  :domain_name,
  :position,
  :limit)
  include Aws::Structure
end

#limitInteger

The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.

Returns:

  • (Integer)


2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2868

class GetBasePathMappingsRequest < Struct.new(
  :domain_name,
  :position,
  :limit)
  include Aws::Structure
end

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)


2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2868

class GetBasePathMappingsRequest < Struct.new(
  :domain_name,
  :position,
  :limit)
  include Aws::Structure
end