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

Inherits:

Struct

• Object
• Struct
• Aws::S3Control::Types::CreateJobRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3control/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_id ⇒ String

  The Amazon Web Services account ID that creates the job.

• #client_request_token ⇒ String

  An idempotency token to ensure that you don’t accidentally submit the same request twice.

• #confirmation_required ⇒ Boolean

  Indicates whether confirmation is required before Amazon S3 runs the job.

• #description ⇒ String

  A description for this job.

• #manifest ⇒ Types::JobManifest

  Configuration parameters for the manifest.

• #manifest_generator ⇒ Types::JobManifestGenerator

  The attribute container for the ManifestGenerator details.

• #operation ⇒ Types::JobOperation

  The action that you want this job to perform on every object listed in the manifest.

• #priority ⇒ Integer

  The numerical priority for this job.

• #report ⇒ Types::JobReport

  Configuration parameters for the optional job-completion report.

• #role_arn ⇒ String

  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.

• #tags ⇒ Array<Types::S3Tag>

  A set of tags to associate with the S3 Batch Operations job.

Instance Attribute Details

#account_id ⇒ String

The Amazon Web Services account ID that creates the job.

Returns:

• (String)

# File 'lib/aws-sdk-s3control/types.rb', line 1228

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_token ⇒ String

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)

# File 'lib/aws-sdk-s3control/types.rb', line 1228

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_required ⇒ Boolean

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)

# File 'lib/aws-sdk-s3control/types.rb', line 1228

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

#description ⇒ String

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)

# File 'lib/aws-sdk-s3control/types.rb', line 1228

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 ⇒ Types::JobManifest

Configuration parameters for the manifest.

Returns:

• (Types::JobManifest)

# File 'lib/aws-sdk-s3control/types.rb', line 1228

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_generator ⇒ Types::JobManifestGenerator

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

Returns:

• (Types::JobManifestGenerator)

# File 'lib/aws-sdk-s3control/types.rb', line 1228

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

#operation ⇒ Types::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*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-actions.html

Returns:

• (Types::JobOperation)

# File 'lib/aws-sdk-s3control/types.rb', line 1228

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

#priority ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-s3control/types.rb', line 1228

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

#report ⇒ Types::JobReport

Configuration parameters for the optional job-completion report.

Returns:

• (Types::JobReport)

# File 'lib/aws-sdk-s3control/types.rb', line 1228

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_arn ⇒ String

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)

# File 'lib/aws-sdk-s3control/types.rb', line 1228

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

#tags ⇒ Array<Types::S3Tag>

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

Returns:

• (Array<Types::S3Tag>)

# File 'lib/aws-sdk-s3control/types.rb', line 1228

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