Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MediaConvert.ListQueues

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array.

This operation returns paginated results.

Synopsis

data ListQueues = ListQueues' {
- listBy :: Maybe QueueListBy
- nextToken :: Maybe Text
- order :: Maybe Order
- maxResults :: Maybe Natural
}
newListQueues :: ListQueues
listQueues_listBy :: Lens' ListQueues (Maybe QueueListBy)
listQueues_nextToken :: Lens' ListQueues (Maybe Text)
listQueues_order :: Lens' ListQueues (Maybe Order)
listQueues_maxResults :: Lens' ListQueues (Maybe Natural)
data ListQueuesResponse = ListQueuesResponse' {
- queues :: Maybe [Queue]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListQueuesResponse :: Int -> ListQueuesResponse
listQueuesResponse_queues :: Lens' ListQueuesResponse (Maybe [Queue])
listQueuesResponse_nextToken :: Lens' ListQueuesResponse (Maybe Text)
listQueuesResponse_httpStatus :: Lens' ListQueuesResponse Int

Creating a Request

data ListQueues Source #

See: newListQueues smart constructor.

Constructors

ListQueues'

Fields

listBy :: Maybe QueueListBy
Optional. When you request a list of queues, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by creation date.
nextToken :: Maybe Text
Use this string, provided with the response to a previous request, to request the next batch of queues.
order :: Maybe Order
Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
maxResults :: Maybe Natural
Optional. Number of queues, up to twenty, that will be returned at one time.

Instances

Instances details

Eq ListQueues Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Methods (==) :: ListQueues -> ListQueues -> Bool # (/=) :: ListQueues -> ListQueues -> Bool #
Read ListQueues Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Methods readsPrec :: Int -> ReadS ListQueues # readList :: ReadS [ListQueues] # readPrec :: ReadPrec ListQueues # readListPrec :: ReadPrec [ListQueues] #
Show ListQueues Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Methods showsPrec :: Int -> ListQueues -> ShowS # show :: ListQueues -> String # showList :: [ListQueues] -> ShowS #
Generic ListQueues Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Associated Types type Rep ListQueues :: Type -> Type # Methods from :: ListQueues -> Rep ListQueues x # to :: Rep ListQueues x -> ListQueues #
NFData ListQueues Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Methods rnf :: ListQueues -> () #
Hashable ListQueues Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Methods hashWithSalt :: Int -> ListQueues -> Int # hash :: ListQueues -> Int #
AWSPager ListQueues Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Methods page :: ListQueues -> AWSResponse ListQueues -> Maybe ListQueues #
AWSRequest ListQueues Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Associated Types type AWSResponse ListQueues # Methods request :: ListQueues -> Request ListQueues # response :: MonadResource m => Logger -> Service -> Proxy ListQueues -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListQueues))) #
ToHeaders ListQueues Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Methods toHeaders :: ListQueues -> [Header] #
ToPath ListQueues Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Methods toPath :: ListQueues -> ByteString #
ToQuery ListQueues Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Methods toQuery :: ListQueues -> QueryString #
type Rep ListQueues Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues type Rep ListQueues = D1 ('MetaData "ListQueues" "Amazonka.MediaConvert.ListQueues" "libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert" 'False) (C1 ('MetaCons "ListQueues'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "listBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueueListBy)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "order") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Order)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListQueues Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues type AWSResponse ListQueues = ListQueuesResponse

newListQueues :: ListQueues Source #

Create a value of ListQueues 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:listBy:ListQueues', listQueues_listBy - Optional. When you request a list of queues, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by creation date.

$sel:nextToken:ListQueues', listQueues_nextToken - Use this string, provided with the response to a previous request, to request the next batch of queues.

$sel:order:ListQueues', listQueues_order - Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

$sel:maxResults:ListQueues', listQueues_maxResults - Optional. Number of queues, up to twenty, that will be returned at one time.

Request Lenses

listQueues_listBy :: Lens' ListQueues (Maybe QueueListBy) Source #

Optional. When you request a list of queues, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by creation date.

listQueues_nextToken :: Lens' ListQueues (Maybe Text) Source #

Use this string, provided with the response to a previous request, to request the next batch of queues.

listQueues_order :: Lens' ListQueues (Maybe Order) Source #

Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

listQueues_maxResults :: Lens' ListQueues (Maybe Natural) Source #

Optional. Number of queues, up to twenty, that will be returned at one time.

Destructuring the Response

data ListQueuesResponse Source #

See: newListQueuesResponse smart constructor.

Constructors

ListQueuesResponse'
Fields queues :: Maybe [Queue] List of queues. nextToken :: Maybe Text Use this string to request the next batch of queues. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListQueuesResponse Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Methods (==) :: ListQueuesResponse -> ListQueuesResponse -> Bool # (/=) :: ListQueuesResponse -> ListQueuesResponse -> Bool #
Read ListQueuesResponse Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Methods readsPrec :: Int -> ReadS ListQueuesResponse # readList :: ReadS [ListQueuesResponse] # readPrec :: ReadPrec ListQueuesResponse # readListPrec :: ReadPrec [ListQueuesResponse] #
Show ListQueuesResponse Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Methods showsPrec :: Int -> ListQueuesResponse -> ShowS # show :: ListQueuesResponse -> String # showList :: [ListQueuesResponse] -> ShowS #
Generic ListQueuesResponse Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Associated Types type Rep ListQueuesResponse :: Type -> Type # Methods from :: ListQueuesResponse -> Rep ListQueuesResponse x # to :: Rep ListQueuesResponse x -> ListQueuesResponse #
NFData ListQueuesResponse Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues Methods rnf :: ListQueuesResponse -> () #
type Rep ListQueuesResponse Source #
Instance details Defined in Amazonka.MediaConvert.ListQueues type Rep ListQueuesResponse = D1 ('MetaData "ListQueuesResponse" "Amazonka.MediaConvert.ListQueues" "libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert" 'False) (C1 ('MetaCons "ListQueuesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Queue])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListQueuesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListQueuesResponse'`
-> ListQueuesResponse

Create a value of ListQueuesResponse 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:queues:ListQueuesResponse', listQueuesResponse_queues - List of queues.

$sel:nextToken:ListQueues', listQueuesResponse_nextToken - Use this string to request the next batch of queues.

$sel:httpStatus:ListQueuesResponse', listQueuesResponse_httpStatus - The response's http status code.

Response Lenses

listQueuesResponse_queues :: Lens' ListQueuesResponse (Maybe [Queue]) Source #

List of queues.

listQueuesResponse_nextToken :: Lens' ListQueuesResponse (Maybe Text) Source #

Use this string to request the next batch of queues.

listQueuesResponse_httpStatus :: Lens' ListQueuesResponse Int Source #

The response's http status code.