Amazonka.Batch.ListJobs

Returns a list of Batch jobs.

You must specify only one of the following items:

• A job queue ID to return a list of jobs in that job queue
• A multi-node parallel job ID to return a list of nodes for that job
• An array job ID to return a list of the children for that job

You can filter the results by job status with the jobStatus parameter. If you don't specify a status, only RUNNING jobs are returned.

This operation returns paginated results.

Creating a Request

data ListJobs

Contains the parameters for ListJobs.

See: newListJobs smart constructor.

Constructors

ListJobs'

Fields

• arrayJobId :: Maybe Text

  The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

• filters :: Maybe [KeyValuesPair]

  The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field, with the most recent jobs being first.

  JOB_NAME

  The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*), the filter matches any job name that begins with the string before the '*'. This corresponds to the jobName value. For example, test1 matches both Test1 and test1, and test1* matches both test1 and Test10. When the JOB_NAME filter is used, the results are grouped by the job name and version.

  JOB_DEFINITION

  The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the jobDefinition value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (*), the filter matches any job definition name that begins with the string before the '*'. For example, jd1 matches only jd1, and jd1* matches both jd1 and jd1A. The version of the job definition that's used doesn't affect the sort order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), the results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the ARN is used.

  BEFORE_CREATED_AT

  The value for the filter is the time that's before the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

  AFTER_CREATED_AT

  The value for the filter is the time that's after the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

• jobQueue :: Maybe Text

  The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

• jobStatus :: Maybe JobStatus

  The job status used to filter jobs in the specified queue. If the filters parameter is specified, the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a status, only RUNNING jobs are returned.

• maxResults :: Maybe Int

  The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs 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 ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListJobs returns up to 100 results and a nextToken value if applicable.

• multiNodeJobId :: Maybe Text

  The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

• nextToken :: Maybe Text

  The nextToken value returned from a previous paginated ListJobs 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 ListJobs

Defined in Amazonka.Batch.ListJobs

Methods

toJSON :: ListJobs -> Value

toEncoding :: ListJobs -> Encoding

toJSONList :: [ListJobs] -> Value

toEncodingList :: [ListJobs] -> Encoding

ToHeaders ListJobs

Defined in Amazonka.Batch.ListJobs

Methods

toHeaders :: ListJobs -> [Header]

ToPath ListJobs

Defined in Amazonka.Batch.ListJobs

Methods

toPath :: ListJobs -> ByteString

ToQuery ListJobs

Defined in Amazonka.Batch.ListJobs

Methods

toQuery :: ListJobs -> QueryString

AWSPager ListJobs

Defined in Amazonka.Batch.ListJobs

Methods

page :: ListJobs -> AWSResponse ListJobs -> Maybe ListJobs

AWSRequest ListJobs

Defined in Amazonka.Batch.ListJobs

Associated Types

type AWSResponse ListJobs

Methods

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

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

Generic ListJobs

Defined in Amazonka.Batch.ListJobs

Associated Types

type Rep ListJobs :: Type -> Type

Methods

from :: ListJobs -> Rep ListJobs x

to :: Rep ListJobs x -> ListJobs

Read ListJobs

Defined in Amazonka.Batch.ListJobs

Methods

readsPrec :: Int -> ReadS ListJobs

readList :: ReadS [ListJobs]

readPrec :: ReadPrec ListJobs

readListPrec :: ReadPrec [ListJobs]

Show ListJobs

Defined in Amazonka.Batch.ListJobs

Methods

showsPrec :: Int -> ListJobs -> ShowS

show :: ListJobs -> String

showList :: [ListJobs] -> ShowS

NFData ListJobs

Defined in Amazonka.Batch.ListJobs

Methods

rnf :: ListJobs -> ()

Eq ListJobs

Defined in Amazonka.Batch.ListJobs

Methods

(==) :: ListJobs -> ListJobs -> Bool

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

Hashable ListJobs

Defined in Amazonka.Batch.ListJobs

Methods

hashWithSalt :: Int -> ListJobs -> Int

hash :: ListJobs -> Int

type AWSResponse ListJobs

Defined in Amazonka.Batch.ListJobs

type AWSResponse ListJobs = ListJobsResponse

type Rep ListJobs

Defined in Amazonka.Batch.ListJobs

type Rep ListJobs = D1 ('MetaData "ListJobs" "Amazonka.Batch.ListJobs" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ListJobs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arrayJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyValuesPair])) :*: S1 ('MetaSel ('Just "jobQueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "multiNodeJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newListJobs :: ListJobs

Create a value of ListJobs 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:arrayJobId:ListJobs', listJobs_arrayJobId - The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

$sel:filters:ListJobs', listJobs_filters - The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field, with the most recent jobs being first.

JOB_NAME

The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*), the filter matches any job name that begins with the string before the '*'. This corresponds to the jobName value. For example, test1 matches both Test1 and test1, and test1* matches both test1 and Test10. When the JOB_NAME filter is used, the results are grouped by the job name and version.

JOB_DEFINITION

The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the jobDefinition value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (*), the filter matches any job definition name that begins with the string before the '*'. For example, jd1 matches only jd1, and jd1* matches both jd1 and jd1A. The version of the job definition that's used doesn't affect the sort order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), the results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the ARN is used.

BEFORE_CREATED_AT

The value for the filter is the time that's before the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

AFTER_CREATED_AT

The value for the filter is the time that's after the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

ListJobs, listJobs_jobQueue - The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

$sel:jobStatus:ListJobs', listJobs_jobStatus - The job status used to filter jobs in the specified queue. If the filters parameter is specified, the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a status, only RUNNING jobs are returned.

$sel:maxResults:ListJobs', listJobs_maxResults - The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs 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 ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListJobs returns up to 100 results and a nextToken value if applicable.

$sel:multiNodeJobId:ListJobs', listJobs_multiNodeJobId - The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

ListJobs, listJobs_nextToken - The nextToken value returned from a previous paginated ListJobs 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

listJobs_arrayJobId :: Lens' ListJobs (Maybe Text)

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

listJobs_filters :: Lens' ListJobs (Maybe [KeyValuesPair])

The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field, with the most recent jobs being first.

JOB_NAME

The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*), the filter matches any job name that begins with the string before the '*'. This corresponds to the jobName value. For example, test1 matches both Test1 and test1, and test1* matches both test1 and Test10. When the JOB_NAME filter is used, the results are grouped by the job name and version.

JOB_DEFINITION

The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the jobDefinition value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (*), the filter matches any job definition name that begins with the string before the '*'. For example, jd1 matches only jd1, and jd1* matches both jd1 and jd1A. The version of the job definition that's used doesn't affect the sort order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), the results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the ARN is used.

BEFORE_CREATED_AT

The value for the filter is the time that's before the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

AFTER_CREATED_AT

The value for the filter is the time that's after the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

listJobs_jobQueue :: Lens' ListJobs (Maybe Text)

The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

listJobs_jobStatus :: Lens' ListJobs (Maybe JobStatus)

The job status used to filter jobs in the specified queue. If the filters parameter is specified, the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a status, only RUNNING jobs are returned.

listJobs_maxResults :: Lens' ListJobs (Maybe Int)

The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs 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 ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListJobs returns up to 100 results and a nextToken value if applicable.

listJobs_multiNodeJobId :: Lens' ListJobs (Maybe Text)

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

listJobs_nextToken :: Lens' ListJobs (Maybe Text)

The nextToken value returned from a previous paginated ListJobs 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 ListJobsResponse

See: newListJobsResponse smart constructor.

Constructors

ListJobsResponse'

Fields

• nextToken :: Maybe Text

  The nextToken value to include in a future ListJobs request. When the results of a ListJobs 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.

• jobSummaryList :: [JobSummary]

  A list of job summaries that match the request.

Instances

Generic ListJobsResponse

Defined in Amazonka.Batch.ListJobs

Associated Types

type Rep ListJobsResponse :: Type -> Type

Methods

from :: ListJobsResponse -> Rep ListJobsResponse x

to :: Rep ListJobsResponse x -> ListJobsResponse

Read ListJobsResponse

Defined in Amazonka.Batch.ListJobs

Methods

readsPrec :: Int -> ReadS ListJobsResponse

readList :: ReadS [ListJobsResponse]

readPrec :: ReadPrec ListJobsResponse

readListPrec :: ReadPrec [ListJobsResponse]

Show ListJobsResponse

Defined in Amazonka.Batch.ListJobs

Methods

showsPrec :: Int -> ListJobsResponse -> ShowS

show :: ListJobsResponse -> String

showList :: [ListJobsResponse] -> ShowS

NFData ListJobsResponse

Defined in Amazonka.Batch.ListJobs

Methods

rnf :: ListJobsResponse -> ()

Eq ListJobsResponse

Defined in Amazonka.Batch.ListJobs

Methods

(==) :: ListJobsResponse -> ListJobsResponse -> Bool

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

type Rep ListJobsResponse

Defined in Amazonka.Batch.ListJobs

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

newListJobsResponse

Arguments

:: Int

$sel:httpStatus:ListJobsResponse'

-> ListJobsResponse

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

ListJobs, listJobsResponse_nextToken - The nextToken value to include in a future ListJobs request. When the results of a ListJobs 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:ListJobsResponse', listJobsResponse_httpStatus - The response's http status code.

$sel:jobSummaryList:ListJobsResponse', listJobsResponse_jobSummaryList - A list of job summaries that match the request.

Response Lenses

listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text)

The nextToken value to include in a future ListJobs request. When the results of a ListJobs 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.

listJobsResponse_httpStatus :: Lens' ListJobsResponse Int

The response's http status code.

listJobsResponse_jobSummaryList :: Lens' ListJobsResponse [JobSummary]

A list of job summaries that match the request.