class Aws::Batch::Types::DescribeJobDefinitionsRequest
Contains the parameters for `DescribeJobDefinitions`.
@note When making an API call, you may pass DescribeJobDefinitionsRequest
data as a hash: { job_definitions: ["String"], max_results: 1, job_definition_name: "String", status: "String", next_token: "String", }
@!attribute [rw] job_definitions
A list of up to 100 job definitions. Each entry in the list can either be an ARN of the form `arn:aws:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}` or a short version using the form `$\{JobDefinitionName\}:$\{Revision\}`. @return [Array<String>]
@!attribute [rw] max_results
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. @return [Integer]
@!attribute [rw] job_definition_name
The name of the job definition to describe. @return [String]
@!attribute [rw] status
The status used to filter job definitions. @return [String]
@!attribute [rw] next_token
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. <note markdown="1"> This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes. </note> @return [String]
@see docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitionsRequest AWS API Documentation
Constants
- SENSITIVE