Class: Aws::APIGateway::Types::GetDocumentationPartsRequest

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

Overview

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Returns:

  • (Integer)


2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
# File 'lib/aws-sdk-apigateway/types.rb', line 2410

class GetDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :type,
  :name_query,
  :path,
  :position,
  :limit,
  :location_status)
  SENSITIVE = []
  include Aws::Structure
end

#location_statusString

The status of the API documentation parts to retrieve. Valid values are ‘DOCUMENTED` for retrieving DocumentationPart resources with content and `UNDOCUMENTED` for DocumentationPart resources without content.

Returns:

  • (String)


2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
# File 'lib/aws-sdk-apigateway/types.rb', line 2410

class GetDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :type,
  :name_query,
  :path,
  :position,
  :limit,
  :location_status)
  SENSITIVE = []
  include Aws::Structure
end

#name_queryString

The name of API entities of the to-be-retrieved documentation parts.

Returns:

  • (String)


2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
# File 'lib/aws-sdk-apigateway/types.rb', line 2410

class GetDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :type,
  :name_query,
  :path,
  :position,
  :limit,
  :location_status)
  SENSITIVE = []
  include Aws::Structure
end

#pathString

The path of API entities of the to-be-retrieved documentation parts.

Returns:

  • (String)


2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
# File 'lib/aws-sdk-apigateway/types.rb', line 2410

class GetDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :type,
  :name_query,
  :path,
  :position,
  :limit,
  :location_status)
  SENSITIVE = []
  include Aws::Structure
end

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)


2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
# File 'lib/aws-sdk-apigateway/types.rb', line 2410

class GetDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :type,
  :name_query,
  :path,
  :position,
  :limit,
  :location_status)
  SENSITIVE = []
  include Aws::Structure
end

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
# File 'lib/aws-sdk-apigateway/types.rb', line 2410

class GetDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :type,
  :name_query,
  :path,
  :position,
  :limit,
  :location_status)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of API entities of the to-be-retrieved documentation parts.

Returns:

  • (String)


2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
# File 'lib/aws-sdk-apigateway/types.rb', line 2410

class GetDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :type,
  :name_query,
  :path,
  :position,
  :limit,
  :location_status)
  SENSITIVE = []
  include Aws::Structure
end