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 |
Describes a list of job definitions. You can specify a status
(such as
ACTIVE
) to only return job definitions that match that status.
This operation returns paginated results.
Synopsis
- data DescribeJobDefinitions = DescribeJobDefinitions' {
- status :: Maybe Text
- jobDefinitionName :: Maybe Text
- jobDefinitions :: Maybe [Text]
- nextToken :: Maybe Text
- maxResults :: Maybe Int
- newDescribeJobDefinitions :: DescribeJobDefinitions
- describeJobDefinitions_status :: Lens' DescribeJobDefinitions (Maybe Text)
- describeJobDefinitions_jobDefinitionName :: Lens' DescribeJobDefinitions (Maybe Text)
- describeJobDefinitions_jobDefinitions :: Lens' DescribeJobDefinitions (Maybe [Text])
- describeJobDefinitions_nextToken :: Lens' DescribeJobDefinitions (Maybe Text)
- describeJobDefinitions_maxResults :: Lens' DescribeJobDefinitions (Maybe Int)
- data DescribeJobDefinitionsResponse = DescribeJobDefinitionsResponse' {
- jobDefinitions :: Maybe [JobDefinition]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeJobDefinitionsResponse :: Int -> DescribeJobDefinitionsResponse
- describeJobDefinitionsResponse_jobDefinitions :: Lens' DescribeJobDefinitionsResponse (Maybe [JobDefinition])
- describeJobDefinitionsResponse_nextToken :: Lens' DescribeJobDefinitionsResponse (Maybe Text)
- describeJobDefinitionsResponse_httpStatus :: Lens' DescribeJobDefinitionsResponse Int
Creating a Request
data DescribeJobDefinitions Source #
Contains the parameters for DescribeJobDefinitions
.
See: newDescribeJobDefinitions
smart constructor.
DescribeJobDefinitions' | |
|
Instances
newDescribeJobDefinitions :: DescribeJobDefinitions Source #
Create a value of DescribeJobDefinitions
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:status:DescribeJobDefinitions'
, describeJobDefinitions_status
- The status used to filter job definitions.
$sel:jobDefinitionName:DescribeJobDefinitions'
, describeJobDefinitions_jobDefinitionName
- The name of the job definition to describe.
$sel:jobDefinitions:DescribeJobDefinitions'
, describeJobDefinitions_jobDefinitions
- A list of up to 100 job definitions. Each entry in the list can either
be an ARN of the form
arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}
or a short version using the form ${JobDefinitionName}:${Revision}
.
$sel:nextToken:DescribeJobDefinitions'
, describeJobDefinitions_nextToken
- The nextToken
value returned from a previous paginated
DescribeJobDefinitions
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.
This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
$sel:maxResults:DescribeJobDefinitions'
, describeJobDefinitions_maxResults
- The maximum number of results returned by DescribeJobDefinitions
in
paginated output. When this parameter is used, DescribeJobDefinitions
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 DescribeJobDefinitions
request with the
returned nextToken
value. This value can be between 1 and 100. If this
parameter isn't used, then DescribeJobDefinitions
returns up to 100
results and a nextToken
value if applicable.
Request Lenses
describeJobDefinitions_status :: Lens' DescribeJobDefinitions (Maybe Text) Source #
The status used to filter job definitions.
describeJobDefinitions_jobDefinitionName :: Lens' DescribeJobDefinitions (Maybe Text) Source #
The name of the job definition to describe.
describeJobDefinitions_jobDefinitions :: Lens' DescribeJobDefinitions (Maybe [Text]) Source #
A list of up to 100 job definitions. Each entry in the list can either
be an ARN of the form
arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}
or a short version using the form ${JobDefinitionName}:${Revision}
.
describeJobDefinitions_nextToken :: Lens' DescribeJobDefinitions (Maybe Text) Source #
The nextToken
value returned from a previous paginated
DescribeJobDefinitions
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.
This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
describeJobDefinitions_maxResults :: Lens' DescribeJobDefinitions (Maybe Int) Source #
The maximum number of results returned by DescribeJobDefinitions
in
paginated output. When this parameter is used, DescribeJobDefinitions
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 DescribeJobDefinitions
request with the
returned nextToken
value. This value can be between 1 and 100. If this
parameter isn't used, then DescribeJobDefinitions
returns up to 100
results and a nextToken
value if applicable.
Destructuring the Response
data DescribeJobDefinitionsResponse Source #
See: newDescribeJobDefinitionsResponse
smart constructor.
DescribeJobDefinitionsResponse' | |
|
Instances
newDescribeJobDefinitionsResponse Source #
Create a value of DescribeJobDefinitionsResponse
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:jobDefinitions:DescribeJobDefinitions'
, describeJobDefinitionsResponse_jobDefinitions
- The list of job definitions.
$sel:nextToken:DescribeJobDefinitions'
, describeJobDefinitionsResponse_nextToken
- The nextToken
value to include in a future DescribeJobDefinitions
request. When the results of a DescribeJobDefinitions
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:DescribeJobDefinitionsResponse'
, describeJobDefinitionsResponse_httpStatus
- The response's http status code.
Response Lenses
describeJobDefinitionsResponse_jobDefinitions :: Lens' DescribeJobDefinitionsResponse (Maybe [JobDefinition]) Source #
The list of job definitions.
describeJobDefinitionsResponse_nextToken :: Lens' DescribeJobDefinitionsResponse (Maybe Text) Source #
The nextToken
value to include in a future DescribeJobDefinitions
request. When the results of a DescribeJobDefinitions
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.
describeJobDefinitionsResponse_httpStatus :: Lens' DescribeJobDefinitionsResponse Int Source #
The response's http status code.