amazonka-batch-2.0: Amazon Batch SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Batch.DescribeJobDefinitions

Description

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

Creating a Request

data DescribeJobDefinitions Source #

Contains the parameters for DescribeJobDefinitions.

See: newDescribeJobDefinitions smart constructor.

Constructors

DescribeJobDefinitions' 

Fields

  • jobDefinitionName :: Maybe Text

    The name of the job definition to describe.

  • jobDefinitions :: Maybe [Text]

    A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}.

  • maxResults :: Maybe Int

    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.

  • nextToken :: Maybe Text

    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.

    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.

  • status :: Maybe Text

    The status used to filter job definitions.

Instances

Instances details
ToJSON DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

ToHeaders DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

ToPath DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

ToQuery DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

AWSPager DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

AWSRequest DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Associated Types

type AWSResponse DescribeJobDefinitions #

Generic DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Associated Types

type Rep DescribeJobDefinitions :: Type -> Type #

Read DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Show DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

NFData DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Methods

rnf :: DescribeJobDefinitions -> () #

Eq DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Hashable DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

type AWSResponse DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

type Rep DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

type Rep DescribeJobDefinitions = D1 ('MetaData "DescribeJobDefinitions" "Amazonka.Batch.DescribeJobDefinitions" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DescribeJobDefinitions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobDefinitionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobDefinitions") '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)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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:

DescribeJobDefinitions, describeJobDefinitions_jobDefinitionName - The name of the job definition to describe.

DescribeJobDefinitions, describeJobDefinitions_jobDefinitions - A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}.

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

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.

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.

DescribeJobDefinitions, describeJobDefinitions_status - The status used to filter job definitions.

Request Lenses

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 in the format arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}.

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.

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.

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.

describeJobDefinitions_status :: Lens' DescribeJobDefinitions (Maybe Text) Source #

The status used to filter job definitions.

Destructuring the Response

data DescribeJobDefinitionsResponse Source #

See: newDescribeJobDefinitionsResponse smart constructor.

Constructors

DescribeJobDefinitionsResponse' 

Fields

  • jobDefinitions :: Maybe [JobDefinition]

    The list of job definitions.

  • nextToken :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeJobDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Associated Types

type Rep DescribeJobDefinitionsResponse :: Type -> Type #

Read DescribeJobDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Show DescribeJobDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

NFData DescribeJobDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Eq DescribeJobDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

type Rep DescribeJobDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

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

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:

DescribeJobDefinitions, describeJobDefinitionsResponse_jobDefinitions - The list of job definitions.

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