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

Class: Aws::Kinesis::Types::PutRecordsResultEntry

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

Overview

Represents the result of an individual record from a PutRecords request. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to the stream includes ErrorCode and ErrorMessage in the result.

Instance Attribute Summary collapse

Instance Attribute Details

#error_codeString

The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

Returns:

  • (String)


925
926
927
928
929
930
931
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 925

class PutRecordsResultEntry < Struct.new(
  :sequence_number,
  :shard_id,
  :error_code,
  :error_message)
  include Aws::Structure
end

#error_messageString

The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".

Returns:

  • (String)


925
926
927
928
929
930
931
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 925

class PutRecordsResultEntry < Struct.new(
  :sequence_number,
  :shard_id,
  :error_code,
  :error_message)
  include Aws::Structure
end

#sequence_numberString

The sequence number for an individual record result.

Returns:

  • (String)


925
926
927
928
929
930
931
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 925

class PutRecordsResultEntry < Struct.new(
  :sequence_number,
  :shard_id,
  :error_code,
  :error_message)
  include Aws::Structure
end

#shard_idString

The shard ID for an individual record result.

Returns:

  • (String)


925
926
927
928
929
930
931
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 925

class PutRecordsResultEntry < Struct.new(
  :sequence_number,
  :shard_id,
  :error_code,
  :error_message)
  include Aws::Structure
end