Class: Aws::MediaConvert::Types::ListPresetsRequest

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

{
  category: "__string",
  list_by: "NAME", # accepts NAME, CREATION_DATE, SYSTEM
  max_results: 1,
  next_token: "__string",
  order: "ASCENDING", # accepts ASCENDING, DESCENDING
}

You can send list presets requests with an empty body. Optionally, you can filter the response by category by specifying it in your request body. You can also optionally specify the maximum number, up to twenty, of queues to be returned.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#categoryString

Optionally, specify a preset category to limit responses to only presets from that category.

Returns:

  • (String)


12541
12542
12543
12544
12545
12546
12547
12548
12549
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12541

class ListPresetsRequest < Struct.new(
  :category,
  :list_by,
  :max_results,
  :next_token,
  :order)
  SENSITIVE = []
  include Aws::Structure
end

#list_byString

Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.

Returns:

  • (String)


12541
12542
12543
12544
12545
12546
12547
12548
12549
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12541

class ListPresetsRequest < Struct.new(
  :category,
  :list_by,
  :max_results,
  :next_token,
  :order)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

Optional. Number of presets, up to twenty, that will be returned at one time

Returns:

  • (Integer)


12541
12542
12543
12544
12545
12546
12547
12548
12549
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12541

class ListPresetsRequest < Struct.new(
  :category,
  :list_by,
  :max_results,
  :next_token,
  :order)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


12541
12542
12543
12544
12545
12546
12547
12548
12549
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12541

class ListPresetsRequest < Struct.new(
  :category,
  :list_by,
  :max_results,
  :next_token,
  :order)
  SENSITIVE = []
  include Aws::Structure
end

#orderString

Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

Returns:

  • (String)


12541
12542
12543
12544
12545
12546
12547
12548
12549
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 12541

class ListPresetsRequest < Struct.new(
  :category,
  :list_by,
  :max_results,
  :next_token,
  :order)
  SENSITIVE = []
  include Aws::Structure
end