Amazonka.Batch.DescribeJobQueues

Describes one or more of your job queues.

This operation returns paginated results.

Creating a Request

data DescribeJobQueues

Contains the parameters for DescribeJobQueues.

See: newDescribeJobQueues smart constructor.

Constructors

DescribeJobQueues'

Fields

• jobQueues :: Maybe [Text]

  A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

• maxResults :: Maybe Int

  The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

• nextToken :: Maybe Text

  The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

  Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Instances

ToJSON DescribeJobQueues

Defined in Amazonka.Batch.DescribeJobQueues

Methods

toJSON :: DescribeJobQueues -> Value

toEncoding :: DescribeJobQueues -> Encoding

toJSONList :: [DescribeJobQueues] -> Value

toEncodingList :: [DescribeJobQueues] -> Encoding

ToHeaders DescribeJobQueues

Defined in Amazonka.Batch.DescribeJobQueues

Methods

toHeaders :: DescribeJobQueues -> [Header]

ToPath DescribeJobQueues

Defined in Amazonka.Batch.DescribeJobQueues

Methods

toPath :: DescribeJobQueues -> ByteString

ToQuery DescribeJobQueues

Defined in Amazonka.Batch.DescribeJobQueues

Methods

toQuery :: DescribeJobQueues -> QueryString

AWSPager DescribeJobQueues

Defined in Amazonka.Batch.DescribeJobQueues

Methods

page :: DescribeJobQueues -> AWSResponse DescribeJobQueues -> Maybe DescribeJobQueues

AWSRequest DescribeJobQueues

Defined in Amazonka.Batch.DescribeJobQueues

Associated Types

type AWSResponse DescribeJobQueues

Methods

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

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

Generic DescribeJobQueues

Defined in Amazonka.Batch.DescribeJobQueues

Associated Types

type Rep DescribeJobQueues :: Type -> Type

Methods

from :: DescribeJobQueues -> Rep DescribeJobQueues x

to :: Rep DescribeJobQueues x -> DescribeJobQueues

Read DescribeJobQueues

Defined in Amazonka.Batch.DescribeJobQueues

Methods

readsPrec :: Int -> ReadS DescribeJobQueues

readList :: ReadS [DescribeJobQueues]

readPrec :: ReadPrec DescribeJobQueues

readListPrec :: ReadPrec [DescribeJobQueues]

Show DescribeJobQueues

Defined in Amazonka.Batch.DescribeJobQueues

Methods

showsPrec :: Int -> DescribeJobQueues -> ShowS

show :: DescribeJobQueues -> String

showList :: [DescribeJobQueues] -> ShowS

NFData DescribeJobQueues

Defined in Amazonka.Batch.DescribeJobQueues

Methods

rnf :: DescribeJobQueues -> ()

Eq DescribeJobQueues

Defined in Amazonka.Batch.DescribeJobQueues

Methods

(==) :: DescribeJobQueues -> DescribeJobQueues -> Bool

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

Hashable DescribeJobQueues

Defined in Amazonka.Batch.DescribeJobQueues

Methods

hashWithSalt :: Int -> DescribeJobQueues -> Int

hash :: DescribeJobQueues -> Int

type AWSResponse DescribeJobQueues

Defined in Amazonka.Batch.DescribeJobQueues

type AWSResponse DescribeJobQueues = DescribeJobQueuesResponse

type Rep DescribeJobQueues

Defined in Amazonka.Batch.DescribeJobQueues

type Rep DescribeJobQueues = D1 ('MetaData "DescribeJobQueues" "Amazonka.Batch.DescribeJobQueues" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DescribeJobQueues'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobQueues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeJobQueues :: DescribeJobQueues

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

DescribeJobQueues, describeJobQueues_jobQueues - A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

$sel:maxResults:DescribeJobQueues', describeJobQueues_maxResults - The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

DescribeJobQueues, describeJobQueues_nextToken - The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Request Lenses

describeJobQueues_jobQueues :: Lens' DescribeJobQueues (Maybe [Text])

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

describeJobQueues_maxResults :: Lens' DescribeJobQueues (Maybe Int)

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

describeJobQueues_nextToken :: Lens' DescribeJobQueues (Maybe Text)

The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Destructuring the Response

data DescribeJobQueuesResponse

See: newDescribeJobQueuesResponse smart constructor.

Constructors

DescribeJobQueuesResponse'

Fields

• jobQueues :: Maybe [JobQueueDetail]

  The list of job queues.

• nextToken :: Maybe Text

  The nextToken value to include in a future DescribeJobQueues request. When the results of a DescribeJobQueues request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeJobQueuesResponse

Defined in Amazonka.Batch.DescribeJobQueues

Associated Types

type Rep DescribeJobQueuesResponse :: Type -> Type

Methods

from :: DescribeJobQueuesResponse -> Rep DescribeJobQueuesResponse x

to :: Rep DescribeJobQueuesResponse x -> DescribeJobQueuesResponse

Read DescribeJobQueuesResponse

Defined in Amazonka.Batch.DescribeJobQueues

Methods

readsPrec :: Int -> ReadS DescribeJobQueuesResponse

readList :: ReadS [DescribeJobQueuesResponse]

readPrec :: ReadPrec DescribeJobQueuesResponse

readListPrec :: ReadPrec [DescribeJobQueuesResponse]

Show DescribeJobQueuesResponse

Defined in Amazonka.Batch.DescribeJobQueues

Methods

showsPrec :: Int -> DescribeJobQueuesResponse -> ShowS

show :: DescribeJobQueuesResponse -> String

showList :: [DescribeJobQueuesResponse] -> ShowS

NFData DescribeJobQueuesResponse

Defined in Amazonka.Batch.DescribeJobQueues

Methods

rnf :: DescribeJobQueuesResponse -> ()

Eq DescribeJobQueuesResponse

Defined in Amazonka.Batch.DescribeJobQueues

Methods

(==) :: DescribeJobQueuesResponse -> DescribeJobQueuesResponse -> Bool

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

type Rep DescribeJobQueuesResponse

Defined in Amazonka.Batch.DescribeJobQueues

type Rep DescribeJobQueuesResponse = D1 ('MetaData "DescribeJobQueuesResponse" "Amazonka.Batch.DescribeJobQueues" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DescribeJobQueuesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobQueues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobQueueDetail])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeJobQueuesResponse

Arguments

:: Int

$sel:httpStatus:DescribeJobQueuesResponse'

-> DescribeJobQueuesResponse

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

DescribeJobQueues, describeJobQueuesResponse_jobQueues - The list of job queues.

DescribeJobQueues, describeJobQueuesResponse_nextToken - The nextToken value to include in a future DescribeJobQueues request. When the results of a DescribeJobQueues request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:DescribeJobQueuesResponse', describeJobQueuesResponse_httpStatus - The response's http status code.

Response Lenses

describeJobQueuesResponse_jobQueues :: Lens' DescribeJobQueuesResponse (Maybe [JobQueueDetail])

The list of job queues.

describeJobQueuesResponse_nextToken :: Lens' DescribeJobQueuesResponse (Maybe Text)

The nextToken value to include in a future DescribeJobQueues request. When the results of a DescribeJobQueues request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

describeJobQueuesResponse_httpStatus :: Lens' DescribeJobQueuesResponse Int

The response's http status code.