libZSservicesZSamazonka-mediastore-dataplaneZSamazonka-mediastore-dataplane
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MediaStoreData.ListItems

Description

Provides a list of metadata entries about folders and objects in the specified folder.

This operation returns paginated results.

Synopsis

Creating a Request

data ListItems Source #

See: newListItems smart constructor.

Constructors

ListItems' 

Fields

  • path :: Maybe Text

    The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

  • nextToken :: Maybe Text

    The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

    Tokens expire after 15 minutes.

  • maxResults :: Maybe Natural

    The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value.

    If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.

Instances

Instances details
Eq ListItems Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

Read ListItems Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

Show ListItems Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

Generic ListItems Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

Associated Types

type Rep ListItems :: Type -> Type #

NFData ListItems Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

Methods

rnf :: ListItems -> () #

Hashable ListItems Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

AWSPager ListItems Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

AWSRequest ListItems Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

Associated Types

type AWSResponse ListItems #

ToHeaders ListItems Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

Methods

toHeaders :: ListItems -> [Header] #

ToPath ListItems Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

ToQuery ListItems Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

type Rep ListItems Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

type Rep ListItems = D1 ('MetaData "ListItems" "Amazonka.MediaStoreData.ListItems" "libZSservicesZSamazonka-mediastore-dataplaneZSamazonka-mediastore-dataplane" 'False) (C1 ('MetaCons "ListItems'" 'PrefixI 'True) (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListItems Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

newListItems :: ListItems Source #

Create a value of ListItems 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:path:ListItems', listItems_path - The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

$sel:nextToken:ListItems', listItems_nextToken - The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

Tokens expire after 15 minutes.

$sel:maxResults:ListItems', listItems_maxResults - The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value.

If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.

Request Lenses

listItems_path :: Lens' ListItems (Maybe Text) Source #

The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

listItems_nextToken :: Lens' ListItems (Maybe Text) Source #

The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

Tokens expire after 15 minutes.

listItems_maxResults :: Lens' ListItems (Maybe Natural) Source #

The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value.

If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.

Destructuring the Response

data ListItemsResponse Source #

See: newListItemsResponse smart constructor.

Constructors

ListItemsResponse' 

Fields

  • items :: Maybe [Item]

    The metadata entries for the folders and objects at the requested path.

  • nextToken :: Maybe Text

    The token that can be used in a request to view the next set of results. For example, you submit a ListItems request that matches 2,000 items with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value that can be used to fetch the next batch of results.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListItemsResponse Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

Read ListItemsResponse Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

Show ListItemsResponse Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

Generic ListItemsResponse Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

Associated Types

type Rep ListItemsResponse :: Type -> Type #

NFData ListItemsResponse Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

Methods

rnf :: ListItemsResponse -> () #

type Rep ListItemsResponse Source # 
Instance details

Defined in Amazonka.MediaStoreData.ListItems

type Rep ListItemsResponse = D1 ('MetaData "ListItemsResponse" "Amazonka.MediaStoreData.ListItems" "libZSservicesZSamazonka-mediastore-dataplaneZSamazonka-mediastore-dataplane" 'False) (C1 ('MetaCons "ListItemsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Item])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListItemsResponse Source #

Create a value of ListItemsResponse 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:items:ListItemsResponse', listItemsResponse_items - The metadata entries for the folders and objects at the requested path.

$sel:nextToken:ListItems', listItemsResponse_nextToken - The token that can be used in a request to view the next set of results. For example, you submit a ListItems request that matches 2,000 items with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value that can be used to fetch the next batch of results.

$sel:httpStatus:ListItemsResponse', listItemsResponse_httpStatus - The response's http status code.

Response Lenses

listItemsResponse_items :: Lens' ListItemsResponse (Maybe [Item]) Source #

The metadata entries for the folders and objects at the requested path.

listItemsResponse_nextToken :: Lens' ListItemsResponse (Maybe Text) Source #

The token that can be used in a request to view the next set of results. For example, you submit a ListItems request that matches 2,000 items with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value that can be used to fetch the next batch of results.

listItemsResponse_httpStatus :: Lens' ListItemsResponse Int Source #

The response's http status code.