Class: Aws::S3Control::Types::CreateJobRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The Amazon Web Services account ID that creates the job.

Returns:

  • (String)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1192

class CreateJobRequest < Struct.new(
  :account_id,
  :confirmation_required,
  :operation,
  :report,
  :client_request_token,
  :manifest,
  :description,
  :priority,
  :role_arn,
  :tags,
  :manifest_generator)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_tokenString

An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1192

class CreateJobRequest < Struct.new(
  :account_id,
  :confirmation_required,
  :operation,
  :report,
  :client_request_token,
  :manifest,
  :description,
  :priority,
  :role_arn,
  :tags,
  :manifest_generator)
  SENSITIVE = []
  include Aws::Structure
end

#confirmation_requiredBoolean

Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

Returns:

  • (Boolean)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1192

class CreateJobRequest < Struct.new(
  :account_id,
  :confirmation_required,
  :operation,
  :report,
  :client_request_token,
  :manifest,
  :description,
  :priority,
  :role_arn,
  :tags,
  :manifest_generator)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

Returns:

  • (String)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1192

class CreateJobRequest < Struct.new(
  :account_id,
  :confirmation_required,
  :operation,
  :report,
  :client_request_token,
  :manifest,
  :description,
  :priority,
  :role_arn,
  :tags,
  :manifest_generator)
  SENSITIVE = []
  include Aws::Structure
end

#manifestTypes::JobManifest

Configuration parameters for the manifest.

Returns:



1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1192

class CreateJobRequest < Struct.new(
  :account_id,
  :confirmation_required,
  :operation,
  :report,
  :client_request_token,
  :manifest,
  :description,
  :priority,
  :role_arn,
  :tags,
  :manifest_generator)
  SENSITIVE = []
  include Aws::Structure
end

#manifest_generatorTypes::JobManifestGenerator

The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.



1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1192

class CreateJobRequest < Struct.new(
  :account_id,
  :confirmation_required,
  :operation,
  :report,
  :client_request_token,
  :manifest,
  :description,
  :priority,
  :role_arn,
  :tags,
  :manifest_generator)
  SENSITIVE = []
  include Aws::Structure
end

#operationTypes::JobOperation

The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

Returns:



1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1192

class CreateJobRequest < Struct.new(
  :account_id,
  :confirmation_required,
  :operation,
  :report,
  :client_request_token,
  :manifest,
  :description,
  :priority,
  :role_arn,
  :tags,
  :manifest_generator)
  SENSITIVE = []
  include Aws::Structure
end

#priorityInteger

The numerical priority for this job. Higher numbers indicate higher priority.

Returns:

  • (Integer)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1192

class CreateJobRequest < Struct.new(
  :account_id,
  :confirmation_required,
  :operation,
  :report,
  :client_request_token,
  :manifest,
  :description,
  :priority,
  :role_arn,
  :tags,
  :manifest_generator)
  SENSITIVE = []
  include Aws::Structure
end

#reportTypes::JobReport

Configuration parameters for the optional job-completion report.

Returns:



1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1192

class CreateJobRequest < Struct.new(
  :account_id,
  :confirmation_required,
  :operation,
  :report,
  :client_request_token,
  :manifest,
  :description,
  :priority,
  :role_arn,
  :tags,
  :manifest_generator)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.

Returns:

  • (String)


1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1192

class CreateJobRequest < Struct.new(
  :account_id,
  :confirmation_required,
  :operation,
  :report,
  :client_request_token,
  :manifest,
  :description,
  :priority,
  :role_arn,
  :tags,
  :manifest_generator)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::S3Tag>

A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

Returns:



1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1192

class CreateJobRequest < Struct.new(
  :account_id,
  :confirmation_required,
  :operation,
  :report,
  :client_request_token,
  :manifest,
  :description,
  :priority,
  :role_arn,
  :tags,
  :manifest_generator)
  SENSITIVE = []
  include Aws::Structure
end