5.0.0 • Published 3 years ago

@datafire/amazonaws_qldb v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
3 years ago

@datafire/amazonaws_qldb

Client library for Amazon QLDB

Installation and Usage

npm install --save @datafire/amazonaws_qldb
let amazonaws_qldb = require('@datafire/amazonaws_qldb').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

The control plane for Amazon QLDB

Actions

ListJournalS3Exports

amazonaws_qldb.ListJournalS3Exports({}, context)

Input

  • input object
    • maxResults integer
    • nextToken string
    • MaxResults string
    • NextToken string

Output

ListLedgers

amazonaws_qldb.ListLedgers({}, context)

Input

  • input object
    • maxResults integer
    • nextToken string
    • MaxResults string
    • NextToken string

Output

CreateLedger

amazonaws_qldb.CreateLedger({
  "Name": "",
  "PermissionsMode": ""
}, context)

Input

  • input object
    • DeletionProtection boolean: The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default. If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.
    • Name required string: The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region. Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.
    • PermissionsMode required string (values: ALLOW_ALL): The permissions mode to assign to the ledger that you want to create.
    • Tags object: The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Output

DeleteLedger

amazonaws_qldb.DeleteLedger({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

Output schema unknown

DescribeLedger

amazonaws_qldb.DescribeLedger({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

UpdateLedger

amazonaws_qldb.UpdateLedger({
  "name": ""
}, context)

Input

  • input object
    • name required string
    • DeletionProtection boolean: The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default. If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

Output

GetBlock

amazonaws_qldb.GetBlock({
  "name": "",
  "BlockAddress": {}
}, context)

Input

  • input object
    • name required string
    • BlockAddress required object: A structure that can contain a value in multiple encoding formats.
      • IonText
    • DigestTipAddress object: A structure that can contain a value in multiple encoding formats.
      • IonText

Output

GetDigest

amazonaws_qldb.GetDigest({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

ListJournalKinesisStreamsForLedger

amazonaws_qldb.ListJournalKinesisStreamsForLedger({
  "name": ""
}, context)

Input

  • input object
    • name required string
    • maxResults integer
    • nextToken string
    • MaxResults string
    • NextToken string

Output

StreamJournalToKinesis

amazonaws_qldb.StreamJournalToKinesis({
  "name": "",
  "RoleArn": "",
  "InclusiveStartTime": "",
  "KinesisConfiguration": {},
  "StreamName": ""
}, context)

Input

  • input object
    • name required string
    • ExclusiveEndTime string: The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it. The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
    • InclusiveStartTime required string: The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime. If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime.
    • KinesisConfiguration required object: The configuration settings of the Amazon Kinesis Data Streams destination for your Amazon QLDB journal stream.
      • AggregationEnabled
      • StreamArn
    • RoleArn required string: 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.
    • StreamName required string: The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream. Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.
    • Tags object: The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Output

CancelJournalKinesisStream

amazonaws_qldb.CancelJournalKinesisStream({
  "name": "",
  "streamId": ""
}, context)

Input

  • input object
    • name required string
    • streamId required string

Output

DescribeJournalKinesisStream

amazonaws_qldb.DescribeJournalKinesisStream({
  "name": "",
  "streamId": ""
}, context)

Input

  • input object
    • name required string
    • streamId required string

Output

ListJournalS3ExportsForLedger

amazonaws_qldb.ListJournalS3ExportsForLedger({
  "name": ""
}, context)

Input

  • input object
    • name required string
    • maxResults integer
    • nextToken string
    • MaxResults string
    • NextToken string

Output

ExportJournalToS3

amazonaws_qldb.ExportJournalToS3({
  "name": "",
  "InclusiveStartTime": "",
  "ExclusiveEndTime": "",
  "S3ExportConfiguration": {},
  "RoleArn": ""
}, context)

Input

  • input object
    • name required string
    • ExclusiveEndTime required string: The exclusive end date and time for the range of journal contents that you want to export. The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z The ExclusiveEndTime must be less than or equal to the current UTC date and time.
    • InclusiveStartTime required string: The inclusive start date and time for the range of journal contents that you want to export. The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z The InclusiveStartTime must be before ExclusiveEndTime. If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.
    • RoleArn required string: The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following: Write objects into your Amazon Simple Storage Service (Amazon S3) bucket. (Optional) Use your customer master key (CMK) in AWS Key Management Service (AWS KMS) for server-side encryption of your exported data.
    • S3ExportConfiguration required object: The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.
      • Bucket
      • EncryptionConfiguration
        • KmsKeyArn
        • ObjectEncryptionType required
      • Prefix

Output

DescribeJournalS3Export

amazonaws_qldb.DescribeJournalS3Export({
  "name": "",
  "exportId": ""
}, context)

Input

  • input object
    • name required string
    • exportId required string

Output

GetRevision

amazonaws_qldb.GetRevision({
  "name": "",
  "BlockAddress": {},
  "DocumentId": ""
}, context)

Input

  • input object
    • name required string
    • BlockAddress required object: A structure that can contain a value in multiple encoding formats.
      • IonText
    • DigestTipAddress object: A structure that can contain a value in multiple encoding formats.
      • IonText
    • DocumentId required string: The unique ID of the document to be verified.

Output

ListTagsForResource

amazonaws_qldb.ListTagsForResource({
  "resourceArn": ""
}, context)

Input

  • input object
    • resourceArn required string

Output

TagResource

amazonaws_qldb.TagResource({
  "resourceArn": "",
  "Tags": {}
}, context)

Input

  • input object
    • resourceArn required string
    • Tags required object: The key-value pairs to add as tags to the specified QLDB resource. Tag keys are case sensitive. If you specify a key that already exists for the resource, your request fails and returns an error. Tag values are case sensitive and can be null.

Output

UntagResource

amazonaws_qldb.UntagResource({
  "resourceArn": "",
  "tagKeys": []
}, context)

Input

  • input object
    • resourceArn required string
    • tagKeys required array

Output

Definitions

Arn

  • Arn string

Boolean

  • Boolean boolean

CancelJournalKinesisStreamRequest

  • CancelJournalKinesisStreamRequest object

CancelJournalKinesisStreamResponse

  • CancelJournalKinesisStreamResponse object
    • StreamId

CreateLedgerRequest

  • CreateLedgerRequest object
    • DeletionProtection
    • Name required
    • PermissionsMode required
    • Tags

CreateLedgerResponse

  • CreateLedgerResponse object
    • Arn
    • CreationDateTime
    • DeletionProtection
    • Name
    • State

DeleteLedgerRequest

  • DeleteLedgerRequest object

DeletionProtection

  • DeletionProtection boolean

DescribeJournalKinesisStreamRequest

  • DescribeJournalKinesisStreamRequest object

DescribeJournalKinesisStreamResponse

  • DescribeJournalKinesisStreamResponse object
    • Stream
      • Arn
      • CreationTime
      • ErrorCause
      • ExclusiveEndTime
      • InclusiveStartTime
      • KinesisConfiguration required
        • AggregationEnabled
        • StreamArn required
      • LedgerName required
      • RoleArn required
      • Status required
      • StreamId required
      • StreamName required

DescribeJournalS3ExportRequest

  • DescribeJournalS3ExportRequest object

DescribeJournalS3ExportResponse

  • DescribeJournalS3ExportResponse object
    • ExportDescription required
      • ExclusiveEndTime required
      • ExportCreationTime required
      • ExportId required
      • InclusiveStartTime required
      • LedgerName required
      • RoleArn required
      • S3ExportConfiguration required S3ExportConfiguration
      • Status required

DescribeLedgerRequest

  • DescribeLedgerRequest object

DescribeLedgerResponse

  • DescribeLedgerResponse object
    • Arn
    • CreationDateTime
    • DeletionProtection
    • Name
    • State

Digest

  • Digest string

ErrorCause

  • ErrorCause string (values: KINESIS_STREAM_NOT_FOUND, IAM_PERMISSION_REVOKED)

ExportJournalToS3Request

  • ExportJournalToS3Request object
    • ExclusiveEndTime required
    • InclusiveStartTime required
    • RoleArn required
    • S3ExportConfiguration required
      • Bucket required
      • EncryptionConfiguration required
        • KmsKeyArn
        • ObjectEncryptionType required
      • Prefix required

ExportJournalToS3Response

  • ExportJournalToS3Response object
    • ExportId required

ExportStatus

  • ExportStatus string (values: IN_PROGRESS, COMPLETED, CANCELLED)

GetBlockRequest

  • GetBlockRequest object
    • BlockAddress required
      • IonText
    • DigestTipAddress
      • IonText

GetBlockResponse

  • GetBlockResponse object
    • Block required
      • IonText
    • Proof
      • IonText

GetDigestRequest

  • GetDigestRequest object

GetDigestResponse

  • GetDigestResponse object
    • Digest required
    • DigestTipAddress required
      • IonText

GetRevisionRequest

  • GetRevisionRequest object
    • BlockAddress required
      • IonText
    • DigestTipAddress
      • IonText
    • DocumentId required

GetRevisionResponse

  • GetRevisionResponse object
    • Proof
      • IonText
    • Revision required
      • IonText

InvalidParameterException

IonText

  • IonText string

JournalKinesisStreamDescription

  • JournalKinesisStreamDescription object: The information about an Amazon QLDB journal stream, including the Amazon Resource Name (ARN), stream name, creation time, current status, and the parameters of your original stream creation request.
    • Arn
    • CreationTime
    • ErrorCause
    • ExclusiveEndTime
    • InclusiveStartTime
    • KinesisConfiguration required
      • AggregationEnabled
      • StreamArn required
    • LedgerName required
    • RoleArn required
    • Status required
    • StreamId required
    • StreamName required

JournalKinesisStreamDescriptionList

JournalS3ExportDescription

  • JournalS3ExportDescription object: The information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.
    • ExclusiveEndTime required
    • ExportCreationTime required
    • ExportId required
    • InclusiveStartTime required
    • LedgerName required
    • RoleArn required
    • S3ExportConfiguration required S3ExportConfiguration
    • Status required

JournalS3ExportList

KinesisConfiguration

  • KinesisConfiguration object: The configuration settings of the Amazon Kinesis Data Streams destination for your Amazon QLDB journal stream.
    • AggregationEnabled
    • StreamArn required

LedgerList

LedgerName

  • LedgerName string

LedgerState

  • LedgerState string (values: CREATING, ACTIVE, DELETING, DELETED)

LedgerSummary

  • LedgerSummary object: Information about a ledger, including its name, state, and when it was created.
    • CreationDateTime
    • Name
    • State

LimitExceededException

ListJournalKinesisStreamsForLedgerRequest

  • ListJournalKinesisStreamsForLedgerRequest object

ListJournalKinesisStreamsForLedgerResponse

ListJournalS3ExportsForLedgerRequest

  • ListJournalS3ExportsForLedgerRequest object

ListJournalS3ExportsForLedgerResponse

ListJournalS3ExportsRequest

  • ListJournalS3ExportsRequest object

ListJournalS3ExportsResponse

ListLedgersRequest

  • ListLedgersRequest object

ListLedgersResponse

ListTagsForResourceRequest

  • ListTagsForResourceRequest object

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • Tags

MaxResults

  • MaxResults integer

NextToken

  • NextToken string

PermissionsMode

  • PermissionsMode string (values: ALLOW_ALL)

ResourceAlreadyExistsException

ResourceInUseException

ResourceNotFoundException

ResourcePreconditionNotMetException

S3Bucket

  • S3Bucket string

S3EncryptionConfiguration

  • S3EncryptionConfiguration object: The encryption settings that are used by a journal export job to write data in an Amazon Simple Storage Service (Amazon S3) bucket.
    • KmsKeyArn
    • ObjectEncryptionType required

S3ExportConfiguration

  • S3ExportConfiguration object: The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.
    • Bucket required
    • EncryptionConfiguration required
      • KmsKeyArn
      • ObjectEncryptionType required
    • Prefix required

S3ObjectEncryptionType

  • S3ObjectEncryptionType string (values: SSE_KMS, SSE_S3, NO_ENCRYPTION)

S3Prefix

  • S3Prefix string

StreamJournalToKinesisRequest

  • StreamJournalToKinesisRequest object
    • ExclusiveEndTime
    • InclusiveStartTime required
    • KinesisConfiguration required
      • AggregationEnabled
      • StreamArn required
    • RoleArn required
    • StreamName required
    • Tags

StreamJournalToKinesisResponse

  • StreamJournalToKinesisResponse object
    • StreamId

StreamName

  • StreamName string

StreamStatus

  • StreamStatus string (values: ACTIVE, COMPLETED, CANCELED, FAILED, IMPAIRED)

TagKey

  • TagKey string

TagKeyList

TagResourceRequest

  • TagResourceRequest object
    • Tags required

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

Tags

  • Tags object

Timestamp

  • Timestamp string

UniqueId

  • UniqueId string

UntagResourceRequest

  • UntagResourceRequest object

UntagResourceResponse

  • UntagResourceResponse object

UpdateLedgerRequest

  • UpdateLedgerRequest object
    • DeletionProtection

UpdateLedgerResponse

  • UpdateLedgerResponse object
    • Arn
    • CreationDateTime
    • DeletionProtection
    • Name
    • State

ValueHolder

  • ValueHolder object: A structure that can contain a value in multiple encoding formats.
    • IonText
datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

3 years ago