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

Class: Aws::MediaConvert::Types::DescribeEndpointsRequest

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

Overview

Note:

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

{
  max_results: 1,
  mode: "DEFAULT", # accepts DEFAULT, GET_ONLY
  next_token: "__string",
}

Send an request with an empty body to the regional API endpoint to get your account API endpoint.

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

Optional. Max number of endpoints, up to twenty, that will be returned at one time.

Returns:

  • (Integer)


5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5072

class DescribeEndpointsRequest < Struct.new(
  :max_results,
  :mode,
  :next_token)
  include Aws::Structure
end

#modeString

Optional field, defaults to DEFAULT. Specify DEFAULT for this operation to return your endpoints if any exist, or to create an endpoint for you and return it if one doesn't already exist. Specify GET_ONLY to return your endpoints if any exist, or an empty list if none exist.

Returns:

  • (String)


5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5072

class DescribeEndpointsRequest < Struct.new(
  :max_results,
  :mode,
  :next_token)
  include Aws::Structure
end

#next_tokenString

Use this string, provided with the response to a previous request, to request the next batch of endpoints.

Returns:

  • (String)


5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5072

class DescribeEndpointsRequest < Struct.new(
  :max_results,
  :mode,
  :next_token)
  include Aws::Structure
end