Amazonka.MediaConvert.ListQueues

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.

Creating a Request

data ListQueues

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.

• maxResults :: Maybe Natural

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

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

Instances

ToHeaders ListQueues

Defined in Amazonka.MediaConvert.ListQueues

Methods

toHeaders :: ListQueues -> [Header]

ToPath ListQueues

Defined in Amazonka.MediaConvert.ListQueues

Methods

toPath :: ListQueues -> ByteString

ToQuery ListQueues

Defined in Amazonka.MediaConvert.ListQueues

Methods

toQuery :: ListQueues -> QueryString

AWSPager ListQueues

Defined in Amazonka.MediaConvert.ListQueues

Methods

page :: ListQueues -> AWSResponse ListQueues -> Maybe ListQueues

AWSRequest ListQueues

Defined in Amazonka.MediaConvert.ListQueues

Associated Types

type AWSResponse ListQueues

Methods

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

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

Generic ListQueues

Defined in Amazonka.MediaConvert.ListQueues

Associated Types

type Rep ListQueues :: Type -> Type

Methods

from :: ListQueues -> Rep ListQueues x

to :: Rep ListQueues x -> ListQueues

Read ListQueues

Defined in Amazonka.MediaConvert.ListQueues

Methods

readsPrec :: Int -> ReadS ListQueues

readList :: ReadS [ListQueues]

readPrec :: ReadPrec ListQueues

readListPrec :: ReadPrec [ListQueues]

Show ListQueues

Defined in Amazonka.MediaConvert.ListQueues

Methods

showsPrec :: Int -> ListQueues -> ShowS

show :: ListQueues -> String

showList :: [ListQueues] -> ShowS

NFData ListQueues

Defined in Amazonka.MediaConvert.ListQueues

Methods

rnf :: ListQueues -> ()

Eq ListQueues

Defined in Amazonka.MediaConvert.ListQueues

Methods

(==) :: ListQueues -> ListQueues -> Bool

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

Hashable ListQueues

Defined in Amazonka.MediaConvert.ListQueues

Methods

hashWithSalt :: Int -> ListQueues -> Int

hash :: ListQueues -> Int

type AWSResponse ListQueues

Defined in Amazonka.MediaConvert.ListQueues

type AWSResponse ListQueues = ListQueuesResponse

type Rep ListQueues

Defined in Amazonka.MediaConvert.ListQueues

type Rep ListQueues = D1 ('MetaData "ListQueues" "Amazonka.MediaConvert.ListQueues" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "ListQueues'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "listBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueueListBy)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "order") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Order)))))

newListQueues :: ListQueues

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:maxResults:ListQueues', listQueues_maxResults - Optional. Number of queues, up to twenty, that will be returned at one time.

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.

Request Lenses

listQueues_listBy :: Lens' ListQueues (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.

listQueues_maxResults :: Lens' ListQueues (Maybe Natural)

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

listQueues_nextToken :: Lens' ListQueues (Maybe Text)

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

listQueues_order :: Lens' ListQueues (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.

Destructuring the Response

data ListQueuesResponse

See: newListQueuesResponse smart constructor.

Constructors

ListQueuesResponse'

Fields

• nextToken :: Maybe Text

  Use this string to request the next batch of queues.

• queues :: Maybe [Queue]

  List of queues.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListQueuesResponse

Defined in Amazonka.MediaConvert.ListQueues

Associated Types

type Rep ListQueuesResponse :: Type -> Type

Methods

from :: ListQueuesResponse -> Rep ListQueuesResponse x

to :: Rep ListQueuesResponse x -> ListQueuesResponse

Read ListQueuesResponse

Defined in Amazonka.MediaConvert.ListQueues

Methods

readsPrec :: Int -> ReadS ListQueuesResponse

readList :: ReadS [ListQueuesResponse]

readPrec :: ReadPrec ListQueuesResponse

readListPrec :: ReadPrec [ListQueuesResponse]

Show ListQueuesResponse

Defined in Amazonka.MediaConvert.ListQueues

Methods

showsPrec :: Int -> ListQueuesResponse -> ShowS

show :: ListQueuesResponse -> String

showList :: [ListQueuesResponse] -> ShowS

NFData ListQueuesResponse

Defined in Amazonka.MediaConvert.ListQueues

Methods

rnf :: ListQueuesResponse -> ()

Eq ListQueuesResponse

Defined in Amazonka.MediaConvert.ListQueues

Methods

(==) :: ListQueuesResponse -> ListQueuesResponse -> Bool

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

type Rep ListQueuesResponse

Defined in Amazonka.MediaConvert.ListQueues

type Rep ListQueuesResponse = D1 ('MetaData "ListQueuesResponse" "Amazonka.MediaConvert.ListQueues" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "ListQueuesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "queues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Queue])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListQueuesResponse

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:

ListQueues, listQueuesResponse_nextToken - Use this string to request the next batch of queues.

$sel:queues:ListQueuesResponse', listQueuesResponse_queues - List of queues.

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

Response Lenses

listQueuesResponse_nextToken :: Lens' ListQueuesResponse (Maybe Text)

Use this string to request the next batch of queues.

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

List of queues.

listQueuesResponse_httpStatus :: Lens' ListQueuesResponse Int

The response's http status code.