Amazonka.MediaStoreData.ListItems

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

This operation returns paginated results.

Creating a Request

data ListItems

See: newListItems smart constructor.

Constructors

ListItems'

Fields

• 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.

• 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.

• path :: Maybe Text

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

Instances

ToHeaders ListItems

Defined in Amazonka.MediaStoreData.ListItems

Methods

toHeaders :: ListItems -> [Header]

ToPath ListItems

Defined in Amazonka.MediaStoreData.ListItems

Methods

toPath :: ListItems -> ByteString

ToQuery ListItems

Defined in Amazonka.MediaStoreData.ListItems

Methods

toQuery :: ListItems -> QueryString

AWSPager ListItems

Defined in Amazonka.MediaStoreData.ListItems

Methods

page :: ListItems -> AWSResponse ListItems -> Maybe ListItems

AWSRequest ListItems

Defined in Amazonka.MediaStoreData.ListItems

Associated Types

type AWSResponse ListItems

Methods

request :: (Service -> Service) -> ListItems -> Request ListItems

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListItems -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListItems)))

Generic ListItems

Defined in Amazonka.MediaStoreData.ListItems

Associated Types

type Rep ListItems :: Type -> Type

Methods

from :: ListItems -> Rep ListItems x

to :: Rep ListItems x -> ListItems

Read ListItems

Defined in Amazonka.MediaStoreData.ListItems

Methods

readsPrec :: Int -> ReadS ListItems

readList :: ReadS [ListItems]

readPrec :: ReadPrec ListItems

readListPrec :: ReadPrec [ListItems]

Show ListItems

Defined in Amazonka.MediaStoreData.ListItems

Methods

showsPrec :: Int -> ListItems -> ShowS

show :: ListItems -> String

showList :: [ListItems] -> ShowS

NFData ListItems

Defined in Amazonka.MediaStoreData.ListItems

Methods

rnf :: ListItems -> ()

Eq ListItems

Defined in Amazonka.MediaStoreData.ListItems

Methods

(==) :: ListItems -> ListItems -> Bool

(/=) :: ListItems -> ListItems -> Bool

Hashable ListItems

Defined in Amazonka.MediaStoreData.ListItems

Methods

hashWithSalt :: Int -> ListItems -> Int

hash :: ListItems -> Int

type AWSResponse ListItems

Defined in Amazonka.MediaStoreData.ListItems

type AWSResponse ListItems = ListItemsResponse

type Rep ListItems

Defined in Amazonka.MediaStoreData.ListItems

type Rep ListItems = D1 ('MetaData "ListItems" "Amazonka.MediaStoreData.ListItems" "amazonka-mediastore-dataplane-2.0-44GQ5Qjo8OCLl5WCWLMoHm" 'False) (C1 ('MetaCons "ListItems'" '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 "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListItems :: ListItems

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: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.

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

Request Lenses

listItems_maxResults :: Lens' ListItems (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.

listItems_nextToken :: Lens' ListItems (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.

listItems_path :: Lens' ListItems (Maybe Text)

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

Destructuring the Response

data ListItemsResponse

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

Generic ListItemsResponse

Defined in Amazonka.MediaStoreData.ListItems

Associated Types

type Rep ListItemsResponse :: Type -> Type

Methods

from :: ListItemsResponse -> Rep ListItemsResponse x

to :: Rep ListItemsResponse x -> ListItemsResponse

Read ListItemsResponse

Defined in Amazonka.MediaStoreData.ListItems

Methods

readsPrec :: Int -> ReadS ListItemsResponse

readList :: ReadS [ListItemsResponse]

readPrec :: ReadPrec ListItemsResponse

readListPrec :: ReadPrec [ListItemsResponse]

Show ListItemsResponse

Defined in Amazonka.MediaStoreData.ListItems

Methods

showsPrec :: Int -> ListItemsResponse -> ShowS

show :: ListItemsResponse -> String

showList :: [ListItemsResponse] -> ShowS

NFData ListItemsResponse

Defined in Amazonka.MediaStoreData.ListItems

Methods

rnf :: ListItemsResponse -> ()

Eq ListItemsResponse

Defined in Amazonka.MediaStoreData.ListItems

Methods

(==) :: ListItemsResponse -> ListItemsResponse -> Bool

(/=) :: ListItemsResponse -> ListItemsResponse -> Bool

type Rep ListItemsResponse

Defined in Amazonka.MediaStoreData.ListItems

type Rep ListItemsResponse = D1 ('MetaData "ListItemsResponse" "Amazonka.MediaStoreData.ListItems" "amazonka-mediastore-dataplane-2.0-44GQ5Qjo8OCLl5WCWLMoHm" '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

Arguments

:: Int

$sel:httpStatus:ListItemsResponse'

-> ListItemsResponse

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.

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])

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

listItemsResponse_nextToken :: Lens' ListItemsResponse (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.

listItemsResponse_httpStatus :: Lens' ListItemsResponse Int

The response's http status code.