You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#job_definition_nameString

The name of the job definition to describe.

Returns:

  • (String)


1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1079

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

#job_definitionsArray<String>

A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.

Returns:

  • (Array<String>)


1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1079

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

#max_resultsInteger

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

Returns:

  • (Integer)


1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1079

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

#next_tokenString

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.

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.

Returns:

  • (String)


1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1079

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

#statusString

The status with which to filter job definitions.

Returns:

  • (String)


1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1079

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