amazonka-resource-explorer-v2-2.0: Amazon Resource Explorer 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.ResourceExplorer2.ListViews

Description

Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you call this operation.

Always check the NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation returns paginated results.

Synopsis

Creating a Request

data ListViews Source #

See: newListViews smart constructor.

Constructors

ListViews' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

    An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • nextToken :: Maybe Text

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

Instances

Instances details
ToJSON ListViews Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

ToHeaders ListViews Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

Methods

toHeaders :: ListViews -> [Header] #

ToPath ListViews Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

ToQuery ListViews Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

AWSPager ListViews Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

AWSRequest ListViews Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

Associated Types

type AWSResponse ListViews #

Generic ListViews Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

Associated Types

type Rep ListViews :: Type -> Type #

Read ListViews Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

Show ListViews Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

NFData ListViews Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

Methods

rnf :: ListViews -> () #

Eq ListViews Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

Hashable ListViews Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

type AWSResponse ListViews Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

type Rep ListViews Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

type Rep ListViews = D1 ('MetaData "ListViews" "Amazonka.ResourceExplorer2.ListViews" "amazonka-resource-explorer-v2-2.0-DYDynTzMYCcKX3QLWjH6Yt" 'False) (C1 ('MetaCons "ListViews'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListViews :: ListViews Source #

Create a value of ListViews 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:ListViews', listViews_maxResults - The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

ListViews, listViews_nextToken - The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

Request Lenses

listViews_maxResults :: Lens' ListViews (Maybe Natural) Source #

The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listViews_nextToken :: Lens' ListViews (Maybe Text) Source #

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

Destructuring the Response

data ListViewsResponse Source #

See: newListViewsResponse smart constructor.

Constructors

ListViewsResponse' 

Fields

  • nextToken :: Maybe Text

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

  • views :: Maybe [Text]

    The list of views available in the Amazon Web Services Region in which you called this operation.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListViewsResponse Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

Associated Types

type Rep ListViewsResponse :: Type -> Type #

Read ListViewsResponse Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

Show ListViewsResponse Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

NFData ListViewsResponse Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

Methods

rnf :: ListViewsResponse -> () #

Eq ListViewsResponse Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

type Rep ListViewsResponse Source # 
Instance details

Defined in Amazonka.ResourceExplorer2.ListViews

type Rep ListViewsResponse = D1 ('MetaData "ListViewsResponse" "Amazonka.ResourceExplorer2.ListViews" "amazonka-resource-explorer-v2-2.0-DYDynTzMYCcKX3QLWjH6Yt" 'False) (C1 ('MetaCons "ListViewsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "views") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListViewsResponse Source #

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

ListViews, listViewsResponse_nextToken - If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

$sel:views:ListViewsResponse', listViewsResponse_views - The list of views available in the Amazon Web Services Region in which you called this operation.

$sel:httpStatus:ListViewsResponse', listViewsResponse_httpStatus - The response's http status code.

Response Lenses

listViewsResponse_nextToken :: Lens' ListViewsResponse (Maybe Text) Source #

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

listViewsResponse_views :: Lens' ListViewsResponse (Maybe [Text]) Source #

The list of views available in the Amazon Web Services Region in which you called this operation.

listViewsResponse_httpStatus :: Lens' ListViewsResponse Int Source #

The response's http status code.