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

Class: Aws::DataPipeline::Types::SetStatusInput

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

Overview

Note:

When making an API call, you may pass SetStatusInput data as a hash:

{
  pipeline_id: "id", # required
  object_ids: ["id"], # required
  status: "string", # required
}

Contains the parameters for SetStatus.

Instance Attribute Summary collapse

Instance Attribute Details

#object_idsArray<String>

The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

Returns:

  • (Array<String>)


1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1268

class SetStatusInput < Struct.new(
  :pipeline_id,
  :object_ids,
  :status)
  include Aws::Structure
end

#pipeline_idString

The ID of the pipeline that contains the objects.

Returns:

  • (String)


1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1268

class SetStatusInput < Struct.new(
  :pipeline_id,
  :object_ids,
  :status)
  include Aws::Structure
end

#statusString

The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

Returns:

  • (String)


1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1268

class SetStatusInput < Struct.new(
  :pipeline_id,
  :object_ids,
  :status)
  include Aws::Structure
end