amazonka-cloudcontrol-2.0: Amazon Cloud Control API 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.CloudControl.ListResourceRequests

Description

Returns existing resource operation requests. This includes requests of all status types. For more information, see Listing active resource operation requests in the Amazon Web Services Cloud Control API User Guide.

Resource operation requests expire after 7 days.

This operation returns paginated results.

Synopsis

Creating a Request

data ListResourceRequests Source #

See: newListResourceRequests smart constructor.

Constructors

ListResourceRequests' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    The default is 20.

  • nextToken :: Maybe Text

    If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

  • resourceRequestStatusFilter :: Maybe ResourceRequestStatusFilter

    The filter criteria to apply to the requests returned.

Instances

Instances details
ToJSON ListResourceRequests Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

ToHeaders ListResourceRequests Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

ToPath ListResourceRequests Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

ToQuery ListResourceRequests Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

AWSPager ListResourceRequests Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

AWSRequest ListResourceRequests Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

Associated Types

type AWSResponse ListResourceRequests #

Generic ListResourceRequests Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

Associated Types

type Rep ListResourceRequests :: Type -> Type #

Read ListResourceRequests Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

Show ListResourceRequests Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

NFData ListResourceRequests Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

Methods

rnf :: ListResourceRequests -> () #

Eq ListResourceRequests Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

Hashable ListResourceRequests Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

type AWSResponse ListResourceRequests Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

type Rep ListResourceRequests Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

type Rep ListResourceRequests = D1 ('MetaData "ListResourceRequests" "Amazonka.CloudControl.ListResourceRequests" "amazonka-cloudcontrol-2.0-J9DMMWxCmrC2c0fQs7XDnF" 'False) (C1 ('MetaCons "ListResourceRequests'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceRequestStatusFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceRequestStatusFilter)))))

newListResourceRequests :: ListResourceRequests Source #

Create a value of ListResourceRequests 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:maxResults:ListResourceRequests', listResourceRequests_maxResults - The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

The default is 20.

ListResourceRequests, listResourceRequests_nextToken - If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

$sel:resourceRequestStatusFilter:ListResourceRequests', listResourceRequests_resourceRequestStatusFilter - The filter criteria to apply to the requests returned.

Request Lenses

listResourceRequests_maxResults :: Lens' ListResourceRequests (Maybe Natural) Source #

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

The default is 20.

listResourceRequests_nextToken :: Lens' ListResourceRequests (Maybe Text) Source #

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Destructuring the Response

data ListResourceRequestsResponse Source #

See: newListResourceRequestsResponse smart constructor.

Constructors

ListResourceRequestsResponse' 

Fields

  • nextToken :: Maybe Text

    If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResources again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

  • resourceRequestStatusSummaries :: Maybe [ProgressEvent]

    The requests that match the specified filter criteria.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListResourceRequestsResponse Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

Associated Types

type Rep ListResourceRequestsResponse :: Type -> Type #

Show ListResourceRequestsResponse Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

NFData ListResourceRequestsResponse Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

Eq ListResourceRequestsResponse Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

type Rep ListResourceRequestsResponse Source # 
Instance details

Defined in Amazonka.CloudControl.ListResourceRequests

type Rep ListResourceRequestsResponse = D1 ('MetaData "ListResourceRequestsResponse" "Amazonka.CloudControl.ListResourceRequests" "amazonka-cloudcontrol-2.0-J9DMMWxCmrC2c0fQs7XDnF" 'False) (C1 ('MetaCons "ListResourceRequestsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "resourceRequestStatusSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProgressEvent])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListResourceRequestsResponse Source #

Create a value of ListResourceRequestsResponse 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:

ListResourceRequests, listResourceRequestsResponse_nextToken - If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResources again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

$sel:resourceRequestStatusSummaries:ListResourceRequestsResponse', listResourceRequestsResponse_resourceRequestStatusSummaries - The requests that match the specified filter criteria.

$sel:httpStatus:ListResourceRequestsResponse', listResourceRequestsResponse_httpStatus - The response's http status code.

Response Lenses

listResourceRequestsResponse_nextToken :: Lens' ListResourceRequestsResponse (Maybe Text) Source #

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResources again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.