Class: Aws::DynamoDB::Types::BulkOperationDescription

Inherits:

Struct

Object
Struct
Aws::DynamoDB::Types::BulkOperationDescription

show all

Defined in:: gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb

Overview

Contains detailed information about a bulk operation.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#bulk_operation_arn ⇒ String
The Amazon Resource Name (ARN) of the bulk operation.
#bulk_operation_status ⇒ String
The current status of the bulk operation can be one of the following values:.
#bulk_operation_usage ⇒ Array<Types::BulkOperationUsage>
Usage information for the table and its indexes.
#client_token ⇒ String
The idempotency token associated with the start request.
#end_time ⇒ Time
The time when the operation reached a terminal status.
#failed_item_count ⇒ Integer
The number of processed input items that failed because of parsing or validation errors.
#failure_code ⇒ String
A code that identifies why the bulk operation failed or was cancelled.
#failure_message ⇒ String
A message that describes why the bulk operation failed or was cancelled.
#input_s3_configuration ⇒ Types::InputS3Configuration
The Amazon S3 input configuration associated with the bulk operation.
#max_write_request_units ⇒ Integer
The maximum write request unit rate configured for the bulk operation.
#output_s3_configuration ⇒ Types::OutputS3Configuration
The Amazon S3 output configuration associated with the bulk operation.
#performance_tier ⇒ String
The performance tier selected for the bulk operation.
#processed_input_bytes ⇒ Integer
The number of bytes that DynamoDB has read from the Amazon S3 input objects.
#processed_item_count ⇒ Integer
The number of input items that DynamoDB has processed.
#start_time ⇒ Time
The time when DynamoDB accepted the start request.
#table_details ⇒ Array<Types::BulkOperationTableDetail>
A list containing identifying information for the table targeted by the bulk operation.
#total_input_bytes ⇒ Integer
The total size, in bytes, of the Amazon S3 input objects.

Instance Attribute Details

#bulk_operation_arn ⇒ `String`

The Amazon Resource Name (ARN) of the bulk operation.

Returns:

(String)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#bulk_operation_status ⇒ `String`

The current status of the bulk operation can be one of the following values:

IN_PROGRESS: DynamoDB is processing the input.
COMPLETED: The bulk operation finished without parsing or validation errors. Condition-check failures do not cause the operation to complete with errors.
COMPLETED_WITH_ERRORS: The bulk operation finished, but DynamoDB couldn't process at least one input item because of a parsing or validation error. When you enable ERROR output, DynamoDB writes the details to the configured Amazon S3 output location.
CANCELLING: DynamoDB accepted a cancellation request and is stopping the operation.
CANCELLED: DynamoDB stopped the operation after a cancellation request.
FAILED: The bulk operation failed. DynamoDB might write some items before the operation reaches this status. See FailureCode and FailureMessage for details.

Returns:

(String)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#bulk_operation_usage ⇒ `Array<Types::BulkOperationUsage>`

Usage information for the table and its indexes.

Returns:

(Array<Types::BulkOperationUsage>)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ `String`

The idempotency token associated with the start request.

Returns:

(String)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ `Time`

The time when the operation reached a terminal status. DynamoDB omits this value while the operation remains in progress.

Returns:

(Time)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#failed_item_count ⇒ `Integer`

The number of processed input items that failed because of parsing or validation errors. This count is included in ProcessedItemCount. Condition-check failures do not increase this count.

Returns:

(Integer)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#failure_code ⇒ `String`

A code that identifies why the bulk operation failed or was cancelled. DynamoDB returns this value only when BulkOperationStatus is FAILED or CANCELLED.

Returns:

(String)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#failure_message ⇒ `String`

A message that describes why the bulk operation failed or was cancelled. DynamoDB returns this value only when BulkOperationStatus is FAILED or CANCELLED.

Returns:

(String)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#input_s3_configuration ⇒ `Types::InputS3Configuration`

The Amazon S3 input configuration associated with the bulk operation.

Returns:

(Types::InputS3Configuration)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#max_write_request_units ⇒ `Integer`

The maximum write request unit rate configured for the bulk operation.

Returns:

(Integer)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#output_s3_configuration ⇒ `Types::OutputS3Configuration`

The Amazon S3 output configuration associated with the bulk operation.

Returns:

(Types::OutputS3Configuration)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#performance_tier ⇒ `String`

The performance tier selected for the bulk operation. Valid values are STANDARD and ACCELERATED. If the start request omitted this value, DynamoDB uses STANDARD.

Returns:

(String)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#processed_input_bytes ⇒ `Integer`

The number of bytes that DynamoDB has read from the Amazon S3 input objects.

Returns:

(Integer)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#processed_item_count ⇒ `Integer`

The number of input items that DynamoDB has processed. This count includes successful writes, parsing or validation failures, and condition-check failures.

Returns:

(Integer)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ `Time`

The time when DynamoDB accepted the start request.

Returns:

(Time)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#table_details ⇒ `Array<Types::BulkOperationTableDetail>`

A list containing identifying information for the table targeted by the bulk operation.

Returns:

(Array<Types::BulkOperationTableDetail>)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

#total_input_bytes ⇒ `Integer`

The total size, in bytes, of the Amazon S3 input objects. DynamoDB omits this value until the initial input-size calculation completes.

Returns:

(Integer)

# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1334

class BulkOperationDescription < Struct.new(
  :bulk_operation_arn,
  :bulk_operation_status,
  :table_details,
  :client_token,
  :input_s3_configuration,
  :output_s3_configuration,
  :start_time,
  :end_time,
  :processed_item_count,
  :processed_input_bytes,
  :total_input_bytes,
  :bulk_operation_usage,
  :failed_item_count,
  :failure_code,
  :failure_message,
  :max_write_request_units,
  :performance_tier)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::DynamoDB::Types::BulkOperationDescription

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#bulk_operation_arn ⇒ String

#bulk_operation_status ⇒ String

#bulk_operation_usage ⇒ Array<Types::BulkOperationUsage>

#client_token ⇒ String

#end_time ⇒ Time

#failed_item_count ⇒ Integer

#failure_code ⇒ String

#failure_message ⇒ String

#input_s3_configuration ⇒ Types::InputS3Configuration

#max_write_request_units ⇒ Integer

#output_s3_configuration ⇒ Types::OutputS3Configuration

#performance_tier ⇒ String

#processed_input_bytes ⇒ Integer

#processed_item_count ⇒ Integer

#start_time ⇒ Time

#table_details ⇒ Array<Types::BulkOperationTableDetail>

#total_input_bytes ⇒ Integer

#bulk_operation_arn ⇒ `String`

#bulk_operation_status ⇒ `String`

#bulk_operation_usage ⇒ `Array<Types::BulkOperationUsage>`

#client_token ⇒ `String`

#end_time ⇒ `Time`

#failed_item_count ⇒ `Integer`

#failure_code ⇒ `String`

#failure_message ⇒ `String`

#input_s3_configuration ⇒ `Types::InputS3Configuration`

#max_write_request_units ⇒ `Integer`

#output_s3_configuration ⇒ `Types::OutputS3Configuration`

#performance_tier ⇒ `String`

#processed_input_bytes ⇒ `Integer`

#processed_item_count ⇒ `Integer`

#start_time ⇒ `Time`

#table_details ⇒ `Array<Types::BulkOperationTableDetail>`

#total_input_bytes ⇒ `Integer`