Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Describes a list of job definitions. You can specify a status
(such as ACTIVE
) to only return job definitions that match that status.
Synopsis
- describeJobDefinitions :: DescribeJobDefinitions
- data DescribeJobDefinitions
- djdStatus :: Lens' DescribeJobDefinitions (Maybe Text)
- djdJobDefinitionName :: Lens' DescribeJobDefinitions (Maybe Text)
- djdJobDefinitions :: Lens' DescribeJobDefinitions [Text]
- djdNextToken :: Lens' DescribeJobDefinitions (Maybe Text)
- djdMaxResults :: Lens' DescribeJobDefinitions (Maybe Int)
- describeJobDefinitionsResponse :: Int -> DescribeJobDefinitionsResponse
- data DescribeJobDefinitionsResponse
- djdrsJobDefinitions :: Lens' DescribeJobDefinitionsResponse [JobDefinition]
- djdrsNextToken :: Lens' DescribeJobDefinitionsResponse (Maybe Text)
- djdrsResponseStatus :: Lens' DescribeJobDefinitionsResponse Int
Creating a Request
describeJobDefinitions :: DescribeJobDefinitions Source #
Creates a value of DescribeJobDefinitions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
djdStatus
- The status with which to filter job definitions.djdJobDefinitionName
- The name of the job definition to describe.djdJobDefinitions
- A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.djdNextToken
- ThenextToken
value returned from a previous paginatedDescribeJobDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
when there are no more results to return.djdMaxResults
- The maximum number of results returned byDescribeJobDefinitions
in paginated output. When this parameter is used,DescribeJobDefinitions
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeJobDefinitions
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenDescribeJobDefinitions
returns up to 100 results and anextToken
value if applicable.
data DescribeJobDefinitions Source #
See: describeJobDefinitions
smart constructor.
Instances
Request Lenses
djdStatus :: Lens' DescribeJobDefinitions (Maybe Text) Source #
The status with which to filter job definitions.
djdJobDefinitionName :: Lens' DescribeJobDefinitions (Maybe Text) Source #
The name of the job definition to describe.
djdJobDefinitions :: Lens' DescribeJobDefinitions [Text] Source #
A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.
djdNextToken :: 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.
djdMaxResults :: 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 along with 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 is not used, then DescribeJobDefinitions
returns up to 100 results and a nextToken
value if applicable.
Destructuring the Response
describeJobDefinitionsResponse Source #
Creates a value of DescribeJobDefinitionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
djdrsJobDefinitions
- The list of job definitions.djdrsNextToken
- ThenextToken
value to include in a futureDescribeJobDefinitions
request. When the results of aDescribeJobDefinitions
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.djdrsResponseStatus
- -- | The response status code.
data DescribeJobDefinitionsResponse Source #
See: describeJobDefinitionsResponse
smart constructor.
Instances
Response Lenses
djdrsJobDefinitions :: Lens' DescribeJobDefinitionsResponse [JobDefinition] Source #
The list of job definitions.
djdrsNextToken :: 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.
djdrsResponseStatus :: Lens' DescribeJobDefinitionsResponse Int Source #
- - | The response status code.