Class: Aws::Batch::Types::DescribeJobDefinitionsRequest

Inherits:

Struct

• Object
• Struct
• Aws::Batch::Types::DescribeJobDefinitionsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-batch/types.rb

Overview

Contains the parameters for ‘DescribeJobDefinitions`.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #job_definition_name ⇒ String

  The name of the job definition to describe.

• #job_definitions ⇒ Array<String>

  A list of up to 100 job definitions.

• #max_results ⇒ Integer

  The maximum number of results returned by ‘DescribeJobDefinitions` in paginated output.

• #next_token ⇒ String

  The ‘nextToken` value returned from a previous paginated `DescribeJobDefinitions` request where `maxResults` was used and the results exceeded the value of that parameter.

• #status ⇒ String

  The status used to filter job definitions.

Instance Attribute Details

#job_definition_name ⇒ String

The name of the job definition to describe.

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 2600

class DescribeJobDefinitionsRequest < Struct.new(
  :job_definitions,
  :max_results,
  :job_definition_name,
  :status,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#job_definitions ⇒ Array<String>

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`. This parameter can’t be used with other parameters.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-batch/types.rb', line 2600

class DescribeJobDefinitionsRequest < Struct.new(
  :job_definitions,
  :max_results,
  :job_definition_name,
  :status,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-batch/types.rb', line 2600

class DescribeJobDefinitionsRequest < Struct.new(
  :job_definitions,
  :max_results,
  :job_definition_name,
  :status,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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

</note>

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 2600

class DescribeJobDefinitionsRequest < Struct.new(
  :job_definitions,
  :max_results,
  :job_definition_name,
  :status,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status used to filter job definitions.

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 2600

class DescribeJobDefinitionsRequest < Struct.new(
  :job_definitions,
  :max_results,
  :job_definition_name,
  :status,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end