/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Batch { namespace Model { /** *

Contains the parameters for ListJobs.

See Also:

* AWS * API Reference

*/ class ListJobsRequest : public BatchRequest { public: AWS_BATCH_API ListJobsRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "ListJobs"; } AWS_BATCH_API Aws::String SerializePayload() const override; /** *

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

*/ inline const Aws::String& GetJobQueue() const{ return m_jobQueue; } /** *

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

*/ inline bool JobQueueHasBeenSet() const { return m_jobQueueHasBeenSet; } /** *

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

*/ inline void SetJobQueue(const Aws::String& value) { m_jobQueueHasBeenSet = true; m_jobQueue = value; } /** *

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

*/ inline void SetJobQueue(Aws::String&& value) { m_jobQueueHasBeenSet = true; m_jobQueue = std::move(value); } /** *

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

*/ inline void SetJobQueue(const char* value) { m_jobQueueHasBeenSet = true; m_jobQueue.assign(value); } /** *

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

*/ inline ListJobsRequest& WithJobQueue(const Aws::String& value) { SetJobQueue(value); return *this;} /** *

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

*/ inline ListJobsRequest& WithJobQueue(Aws::String&& value) { SetJobQueue(std::move(value)); return *this;} /** *

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

*/ inline ListJobsRequest& WithJobQueue(const char* value) { SetJobQueue(value); return *this;} /** *

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

*/ inline const Aws::String& GetArrayJobId() const{ return m_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.

*/ inline bool ArrayJobIdHasBeenSet() const { return m_arrayJobIdHasBeenSet; } /** *

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

*/ inline void SetArrayJobId(const Aws::String& value) { m_arrayJobIdHasBeenSet = true; m_arrayJobId = value; } /** *

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

*/ inline void SetArrayJobId(Aws::String&& value) { m_arrayJobIdHasBeenSet = true; m_arrayJobId = std::move(value); } /** *

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

*/ inline void SetArrayJobId(const char* value) { m_arrayJobIdHasBeenSet = true; m_arrayJobId.assign(value); } /** *

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

*/ inline ListJobsRequest& WithArrayJobId(const Aws::String& value) { SetArrayJobId(value); return *this;} /** *

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

*/ inline ListJobsRequest& WithArrayJobId(Aws::String&& value) { SetArrayJobId(std::move(value)); return *this;} /** *

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

*/ inline ListJobsRequest& WithArrayJobId(const char* value) { SetArrayJobId(value); return *this;} /** *

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.

*/ inline const Aws::String& GetMultiNodeJobId() const{ return m_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.

*/ inline bool MultiNodeJobIdHasBeenSet() const { return m_multiNodeJobIdHasBeenSet; } /** *

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.

*/ inline void SetMultiNodeJobId(const Aws::String& value) { m_multiNodeJobIdHasBeenSet = true; m_multiNodeJobId = value; } /** *

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.

*/ inline void SetMultiNodeJobId(Aws::String&& value) { m_multiNodeJobIdHasBeenSet = true; m_multiNodeJobId = std::move(value); } /** *

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.

*/ inline void SetMultiNodeJobId(const char* value) { m_multiNodeJobIdHasBeenSet = true; m_multiNodeJobId.assign(value); } /** *

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.

*/ inline ListJobsRequest& WithMultiNodeJobId(const Aws::String& value) { SetMultiNodeJobId(value); return *this;} /** *

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.

*/ inline ListJobsRequest& WithMultiNodeJobId(Aws::String&& value) { SetMultiNodeJobId(std::move(value)); return *this;} /** *

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.

*/ inline ListJobsRequest& WithMultiNodeJobId(const char* value) { SetMultiNodeJobId(value); return *this;} /** *

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.

*/ inline const JobStatus& GetJobStatus() const{ return m_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.

*/ inline bool JobStatusHasBeenSet() const { return m_jobStatusHasBeenSet; } /** *

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.

*/ inline void SetJobStatus(const JobStatus& value) { m_jobStatusHasBeenSet = true; m_jobStatus = value; } /** *

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.

*/ inline void SetJobStatus(JobStatus&& value) { m_jobStatusHasBeenSet = true; m_jobStatus = std::move(value); } /** *

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.

*/ inline ListJobsRequest& WithJobStatus(const JobStatus& value) { SetJobStatus(value); return *this;} /** *

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.

*/ inline ListJobsRequest& WithJobStatus(JobStatus&& value) { SetJobStatus(std::move(value)); return *this;} /** *

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.

*/ inline int GetMaxResults() const{ return m_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.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

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.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

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.

*/ inline ListJobsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

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.

*/ inline const Aws::String& GetNextToken() const{ return m_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.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

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.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

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.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

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.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

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.

*/ inline ListJobsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

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.

*/ inline ListJobsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

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.

*/ inline ListJobsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

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.

*/ inline const Aws::Vector& GetFilters() const{ return m_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.

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

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.

*/ inline void SetFilters(const Aws::Vector& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

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.

*/ inline void SetFilters(Aws::Vector&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

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.

*/ inline ListJobsRequest& WithFilters(const Aws::Vector& value) { SetFilters(value); return *this;} /** *

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.

*/ inline ListJobsRequest& WithFilters(Aws::Vector&& value) { SetFilters(std::move(value)); return *this;} /** *

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.

*/ inline ListJobsRequest& AddFilters(const KeyValuesPair& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** *

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.

*/ inline ListJobsRequest& AddFilters(KeyValuesPair&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } private: Aws::String m_jobQueue; bool m_jobQueueHasBeenSet = false; Aws::String m_arrayJobId; bool m_arrayJobIdHasBeenSet = false; Aws::String m_multiNodeJobId; bool m_multiNodeJobIdHasBeenSet = false; JobStatus m_jobStatus; bool m_jobStatusHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; Aws::Vector m_filters; bool m_filtersHasBeenSet = false; }; } // namespace Model } // namespace Batch } // namespace Aws