JournalKinesisStreamDescription
Information about an Amazon QLDB journal stream, including the Amazon Resource Name (ARN), stream name, creation time, current status, and the parameters of the original stream creation request.
Contents
- KinesisConfiguration
-
The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
Type: KinesisConfiguration object
Required: Yes
- LedgerName
-
The name of the ledger.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$Required: Yes
- RoleArn
-
The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1600.
Required: Yes
- Status
-
The current state of the QLDB journal stream.
Type: String
Valid Values:
ACTIVE | COMPLETED | CANCELED | FAILED | IMPAIREDRequired: Yes
- StreamId
-
The UUID (represented in Base62-encoded text) of the QLDB journal stream.
Type: String
Length Constraints: Fixed length of 22.
Pattern:
^[A-Za-z-0-9]+$Required: Yes
- StreamName
-
The user-defined name of the QLDB journal stream.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$Required: Yes
- Arn
-
The Amazon Resource Name (ARN) of the QLDB journal stream.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1600.
Required: No
- CreationTime
-
The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
Type: Timestamp
Required: No
- ErrorCause
-
The error message that describes the reason that a stream has a status of
IMPAIREDorFAILED. This is not applicable to streams that have other status values.Type: String
Valid Values:
KINESIS_STREAM_NOT_FOUND | IAM_PERMISSION_REVOKEDRequired: No
- ExclusiveEndTime
-
The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.
Type: Timestamp
Required: No
- InclusiveStartTime
-
The inclusive start date and time from which to start streaming journal data.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
