ListJobsRequest

public struct ListJobsRequest : AWSShape
extension Batch.ListJobsRequest: AWSPaginateStringToken

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let arrayJobId: String?

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

    Declaration

    Swift

    public let jobQueue: String?

  • The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

    Declaration

    Swift

    public let jobStatus: JobStatus?

  • 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 along with 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 is not used, then ListJobs returns up to 100 results and a nextToken value if applicable.

    Declaration

    Swift

    public let maxResults: Int?

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

    Declaration

    Swift

    public let multiNodeJobId: String?

  • 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. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

    Declaration

    Swift

    public let nextToken: String?

  • Undocumented

    Declaration

    Swift

    public init(arrayJobId: String? = nil, jobQueue: String? = nil, jobStatus: JobStatus? = nil, maxResults: Int? = nil, multiNodeJobId: String? = nil, nextToken: String? = nil)

Paginators