amazonka-route53-domains-2.0: Amazon Route 53 Domains SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Route53Domains.ListOperations

Description

Returns information about all of the operations that return an operation ID and that have ever been performed on domains that were registered by the current account.

This command runs only in the us-east-1 Region.

This operation returns paginated results.

Synopsis

Creating a Request

data ListOperations Source #

The ListOperations request includes the following elements.

See: newListOperations smart constructor.

Constructors

ListOperations' 

Fields

  • marker :: Maybe Text

    For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

  • maxItems :: Maybe Int

    Number of domains to be returned.

    Default: 20

  • sortBy :: Maybe ListOperationsSortAttributeName

    The sort type for returned values.

  • sortOrder :: Maybe SortOrder

    The sort order ofr returned values, either ascending or descending.

  • status :: Maybe [OperationStatus]

    The status of the operations.

  • submittedSince :: Maybe POSIX

    An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Unix time format and Coordinated Universal time (UTC).

  • type' :: Maybe [OperationType]

    An arrays of the domains operation types.

Instances

Instances details
ToJSON ListOperations Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

ToHeaders ListOperations Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

ToPath ListOperations Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

ToQuery ListOperations Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

AWSPager ListOperations Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

AWSRequest ListOperations Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

Associated Types

type AWSResponse ListOperations #

Generic ListOperations Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

Associated Types

type Rep ListOperations :: Type -> Type #

Read ListOperations Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

Show ListOperations Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

NFData ListOperations Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

Methods

rnf :: ListOperations -> () #

Eq ListOperations Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

Hashable ListOperations Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

type AWSResponse ListOperations Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

type Rep ListOperations Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

newListOperations :: ListOperations Source #

Create a value of ListOperations with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:marker:ListOperations', listOperations_marker - For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

$sel:maxItems:ListOperations', listOperations_maxItems - Number of domains to be returned.

Default: 20

$sel:sortBy:ListOperations', listOperations_sortBy - The sort type for returned values.

ListOperations, listOperations_sortOrder - The sort order ofr returned values, either ascending or descending.

ListOperations, listOperations_status - The status of the operations.

$sel:submittedSince:ListOperations', listOperations_submittedSince - An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Unix time format and Coordinated Universal time (UTC).

ListOperations, listOperations_type - An arrays of the domains operation types.

Request Lenses

listOperations_marker :: Lens' ListOperations (Maybe Text) Source #

For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

listOperations_maxItems :: Lens' ListOperations (Maybe Int) Source #

Number of domains to be returned.

Default: 20

listOperations_sortOrder :: Lens' ListOperations (Maybe SortOrder) Source #

The sort order ofr returned values, either ascending or descending.

listOperations_submittedSince :: Lens' ListOperations (Maybe UTCTime) Source #

An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Unix time format and Coordinated Universal time (UTC).

listOperations_type :: Lens' ListOperations (Maybe [OperationType]) Source #

An arrays of the domains operation types.

Destructuring the Response

data ListOperationsResponse Source #

The ListOperations response includes the following elements.

See: newListOperationsResponse smart constructor.

Constructors

ListOperationsResponse' 

Fields

Instances

Instances details
Generic ListOperationsResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

Associated Types

type Rep ListOperationsResponse :: Type -> Type #

Read ListOperationsResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

Show ListOperationsResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

NFData ListOperationsResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

Methods

rnf :: ListOperationsResponse -> () #

Eq ListOperationsResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

type Rep ListOperationsResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.ListOperations

type Rep ListOperationsResponse = D1 ('MetaData "ListOperationsResponse" "Amazonka.Route53Domains.ListOperations" "amazonka-route53-domains-2.0-6iruRSkjgLuDp958hFs0e" 'False) (C1 ('MetaCons "ListOperationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextPageMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "operations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OperationSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListOperationsResponse Source #

Create a value of ListOperationsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextPageMarker:ListOperationsResponse', listOperationsResponse_nextPageMarker - If there are more operations than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

$sel:operations:ListOperationsResponse', listOperationsResponse_operations - Lists summaries of the operations.

$sel:httpStatus:ListOperationsResponse', listOperationsResponse_httpStatus - The response's http status code.

Response Lenses

listOperationsResponse_nextPageMarker :: Lens' ListOperationsResponse (Maybe Text) Source #

If there are more operations than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.