Class: Aws::Route53Domains::Types::ListDomainsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Route53Domains::Types::ListDomainsRequest
- Defined in:
- gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb
Overview
When making an API call, you may pass ListDomainsRequest data as a hash:
{
filter_conditions: [
{
name: "DomainName", # required, accepts DomainName, Expiry
operator: "LE", # required, accepts LE, GE, BEGINS_WITH
values: ["Value"], # required
},
],
sort_condition: {
name: "DomainName", # required, accepts DomainName, Expiry
sort_order: "ASC", # required, accepts ASC, DESC
},
marker: "PageMarker",
max_items: 1,
}
The ListDomains request includes the following elements.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#filter_conditions ⇒ Array<Types::FilterCondition>
A complex type that contains information about the filters applied during the
ListDomains
request. -
#marker ⇒ String
For an initial request for a list of domains, omit this element.
-
#max_items ⇒ Integer
Number of domains to be returned.
-
#sort_condition ⇒ Types::SortCondition
A complex type that contains information about the requested ordering of domains in the returned list.
Instance Attribute Details
#filter_conditions ⇒ Array<Types::FilterCondition>
A complex type that contains information about the filters applied
during the ListDomains
request. The filter conditions can include
domain name and domain expiration.
1776 1777 1778 1779 1780 1781 1782 1783 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 1776 class ListDomainsRequest < Struct.new( :filter_conditions, :sort_condition, :marker, :max_items) SENSITIVE = [] include Aws::Structure end |
#marker ⇒ String
For an initial request for a list of domains, omit this element. If
the number of domains that are associated with the current Amazon
Web Services account is greater than the value that you specified
for MaxItems
, you can use Marker
to return additional domains.
Get the value of NextPageMarker
from the previous response, and
submit another request that includes the value of NextPageMarker
in the Marker
element.
Constraints: The marker must match the value specified in the previous request.
1776 1777 1778 1779 1780 1781 1782 1783 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 1776 class ListDomainsRequest < Struct.new( :filter_conditions, :sort_condition, :marker, :max_items) SENSITIVE = [] include Aws::Structure end |
#max_items ⇒ Integer
Number of domains to be returned.
Default: 20
1776 1777 1778 1779 1780 1781 1782 1783 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 1776 class ListDomainsRequest < Struct.new( :filter_conditions, :sort_condition, :marker, :max_items) SENSITIVE = [] include Aws::Structure end |
#sort_condition ⇒ Types::SortCondition
A complex type that contains information about the requested ordering of domains in the returned list.
1776 1777 1778 1779 1780 1781 1782 1783 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 1776 class ListDomainsRequest < Struct.new( :filter_conditions, :sort_condition, :marker, :max_items) SENSITIVE = [] include Aws::Structure end |