/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the qldb-2019-01-02.normal.json service model.
*/
using System;
using System.Runtime.ExceptionServices;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using System.Net;
using Amazon.QLDB.Model;
using Amazon.QLDB.Model.Internal.MarshallTransformations;
using Amazon.QLDB.Internal;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Internal.Auth;
using Amazon.Runtime.Internal.Transform;
namespace Amazon.QLDB
{
///
/// Implementation for accessing QLDB
///
/// The resource management API for Amazon QLDB
///
public partial class AmazonQLDBClient : AmazonServiceClient, IAmazonQLDB
{
private static IServiceMetadata serviceMetadata = new AmazonQLDBMetadata();
private IQLDBPaginatorFactory _paginators;
///
/// Paginators for the service
///
public IQLDBPaginatorFactory Paginators
{
get
{
if (this._paginators == null)
{
this._paginators = new QLDBPaginatorFactory(this);
}
return this._paginators;
}
}
#region Constructors
///
/// Constructs AmazonQLDBClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
public AmazonQLDBClient()
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonQLDBConfig()) { }
///
/// Constructs AmazonQLDBClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The region to connect.
public AmazonQLDBClient(RegionEndpoint region)
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonQLDBConfig{RegionEndpoint = region}) { }
///
/// Constructs AmazonQLDBClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The AmazonQLDBClient Configuration Object
public AmazonQLDBClient(AmazonQLDBConfig config)
: base(FallbackCredentialsFactory.GetCredentials(config), config){}
///
/// Constructs AmazonQLDBClient with AWS Credentials
///
/// AWS Credentials
public AmazonQLDBClient(AWSCredentials credentials)
: this(credentials, new AmazonQLDBConfig())
{
}
///
/// Constructs AmazonQLDBClient with AWS Credentials
///
/// AWS Credentials
/// The region to connect.
public AmazonQLDBClient(AWSCredentials credentials, RegionEndpoint region)
: this(credentials, new AmazonQLDBConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonQLDBClient with AWS Credentials and an
/// AmazonQLDBClient Configuration object.
///
/// AWS Credentials
/// The AmazonQLDBClient Configuration Object
public AmazonQLDBClient(AWSCredentials credentials, AmazonQLDBConfig clientConfig)
: base(credentials, clientConfig)
{
}
///
/// Constructs AmazonQLDBClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
public AmazonQLDBClient(string awsAccessKeyId, string awsSecretAccessKey)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonQLDBConfig())
{
}
///
/// Constructs AmazonQLDBClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The region to connect.
public AmazonQLDBClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonQLDBConfig() {RegionEndpoint=region})
{
}
///
/// Constructs AmazonQLDBClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonQLDBClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The AmazonQLDBClient Configuration Object
public AmazonQLDBClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonQLDBConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, clientConfig)
{
}
///
/// Constructs AmazonQLDBClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
public AmazonQLDBClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonQLDBConfig())
{
}
///
/// Constructs AmazonQLDBClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The region to connect.
public AmazonQLDBClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonQLDBConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonQLDBClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonQLDBClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The AmazonQLDBClient Configuration Object
public AmazonQLDBClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonQLDBConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, clientConfig)
{
}
#endregion
#region Overrides
///
/// Creates the signer for the service.
///
protected override AbstractAWSSigner CreateSigner()
{
return new AWS4Signer();
}
///
/// Customize the pipeline
///
///
protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)
{
pipeline.RemoveHandler();
pipeline.AddHandlerAfter(new AmazonQLDBEndpointResolver());
}
///
/// Capture metadata for the service.
///
protected override IServiceMetadata ServiceMetadata
{
get
{
return serviceMetadata;
}
}
#endregion
#region Dispose
///
/// Disposes the service client.
///
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
}
#endregion
#region CancelJournalKinesisStream
///
/// Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current
/// status must be ACTIVE.
///
///
///
/// You can't restart a stream after you cancel it. Canceled QLDB stream resources are
/// subject to a 7-day retention period, so they are automatically deleted after this
/// limit expires.
///
///
/// Container for the necessary parameters to execute the CancelJournalKinesisStream service method.
///
/// The response from the CancelJournalKinesisStream service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for CancelJournalKinesisStream Operation
public virtual CancelJournalKinesisStreamResponse CancelJournalKinesisStream(CancelJournalKinesisStreamRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CancelJournalKinesisStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = CancelJournalKinesisStreamResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current
/// status must be ACTIVE.
///
///
///
/// You can't restart a stream after you cancel it. Canceled QLDB stream resources are
/// subject to a 7-day retention period, so they are automatically deleted after this
/// limit expires.
///
///
/// Container for the necessary parameters to execute the CancelJournalKinesisStream service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CancelJournalKinesisStream service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for CancelJournalKinesisStream Operation
public virtual Task CancelJournalKinesisStreamAsync(CancelJournalKinesisStreamRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CancelJournalKinesisStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = CancelJournalKinesisStreamResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CreateLedger
///
/// Creates a new ledger in your Amazon Web Services account in the current Region.
///
/// Container for the necessary parameters to execute the CreateLedger service method.
///
/// The response from the CreateLedger service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// You have reached the limit on the maximum number of resources allowed.
///
///
/// The specified resource already exists.
///
///
/// The specified resource can't be modified at this time.
///
/// REST API Reference for CreateLedger Operation
public virtual CreateLedgerResponse CreateLedger(CreateLedgerRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateLedgerRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateLedgerResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates a new ledger in your Amazon Web Services account in the current Region.
///
/// Container for the necessary parameters to execute the CreateLedger service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateLedger service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// You have reached the limit on the maximum number of resources allowed.
///
///
/// The specified resource already exists.
///
///
/// The specified resource can't be modified at this time.
///
/// REST API Reference for CreateLedger Operation
public virtual Task CreateLedgerAsync(CreateLedgerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateLedgerRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateLedgerResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteLedger
///
/// Deletes a ledger and all of its contents. This action is irreversible.
///
///
///
/// If deletion protection is enabled, you must first disable it before you can delete
/// the ledger. You can disable it by calling the UpdateLedger operation
/// to set this parameter to false.
///
///
/// Container for the necessary parameters to execute the DeleteLedger service method.
///
/// The response from the DeleteLedger service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource can't be modified at this time.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for DeleteLedger Operation
public virtual DeleteLedgerResponse DeleteLedger(DeleteLedgerRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteLedgerRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteLedgerResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes a ledger and all of its contents. This action is irreversible.
///
///
///
/// If deletion protection is enabled, you must first disable it before you can delete
/// the ledger. You can disable it by calling the UpdateLedger operation
/// to set this parameter to false.
///
///
/// Container for the necessary parameters to execute the DeleteLedger service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteLedger service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource can't be modified at this time.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for DeleteLedger Operation
public virtual Task DeleteLedgerAsync(DeleteLedgerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteLedgerRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteLedgerResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeJournalKinesisStream
///
/// Returns detailed information about a given Amazon QLDB journal stream. The output
/// includes the Amazon Resource Name (ARN), stream name, current status, creation time,
/// and the parameters of the original stream creation request.
///
///
///
/// This action does not return any expired journal streams. For more information, see
/// Expiration
/// for terminal streams in the Amazon QLDB Developer Guide.
///
///
/// Container for the necessary parameters to execute the DescribeJournalKinesisStream service method.
///
/// The response from the DescribeJournalKinesisStream service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for DescribeJournalKinesisStream Operation
public virtual DescribeJournalKinesisStreamResponse DescribeJournalKinesisStream(DescribeJournalKinesisStreamRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeJournalKinesisStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeJournalKinesisStreamResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns detailed information about a given Amazon QLDB journal stream. The output
/// includes the Amazon Resource Name (ARN), stream name, current status, creation time,
/// and the parameters of the original stream creation request.
///
///
///
/// This action does not return any expired journal streams. For more information, see
/// Expiration
/// for terminal streams in the Amazon QLDB Developer Guide.
///
///
/// Container for the necessary parameters to execute the DescribeJournalKinesisStream service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeJournalKinesisStream service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for DescribeJournalKinesisStream Operation
public virtual Task DescribeJournalKinesisStreamAsync(DescribeJournalKinesisStreamRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeJournalKinesisStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeJournalKinesisStreamResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeJournalS3Export
///
/// Returns information about a journal export job, including the ledger name, export
/// ID, creation time, current status, and the parameters of the original export creation
/// request.
///
///
///
/// This action does not return any expired export jobs. For more information, see Export
/// job expiration in the Amazon QLDB Developer Guide.
///
///
///
/// If the export job with the given ExportId doesn't exist, then throws
/// ResourceNotFoundException.
///
///
///
/// If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.
///
///
/// Container for the necessary parameters to execute the DescribeJournalS3Export service method.
///
/// The response from the DescribeJournalS3Export service method, as returned by QLDB.
///
/// The specified resource doesn't exist.
///
/// REST API Reference for DescribeJournalS3Export Operation
public virtual DescribeJournalS3ExportResponse DescribeJournalS3Export(DescribeJournalS3ExportRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeJournalS3ExportRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeJournalS3ExportResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns information about a journal export job, including the ledger name, export
/// ID, creation time, current status, and the parameters of the original export creation
/// request.
///
///
///
/// This action does not return any expired export jobs. For more information, see Export
/// job expiration in the Amazon QLDB Developer Guide.
///
///
///
/// If the export job with the given ExportId doesn't exist, then throws
/// ResourceNotFoundException.
///
///
///
/// If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.
///
///
/// Container for the necessary parameters to execute the DescribeJournalS3Export service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeJournalS3Export service method, as returned by QLDB.
///
/// The specified resource doesn't exist.
///
/// REST API Reference for DescribeJournalS3Export Operation
public virtual Task DescribeJournalS3ExportAsync(DescribeJournalS3ExportRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeJournalS3ExportRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeJournalS3ExportResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeLedger
///
/// Returns information about a ledger, including its state, permissions mode, encryption
/// at rest settings, and when it was created.
///
/// Container for the necessary parameters to execute the DescribeLedger service method.
///
/// The response from the DescribeLedger service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
/// REST API Reference for DescribeLedger Operation
public virtual DescribeLedgerResponse DescribeLedger(DescribeLedgerRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeLedgerRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeLedgerResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns information about a ledger, including its state, permissions mode, encryption
/// at rest settings, and when it was created.
///
/// Container for the necessary parameters to execute the DescribeLedger service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeLedger service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
/// REST API Reference for DescribeLedger Operation
public virtual Task DescribeLedgerAsync(DescribeLedgerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeLedgerRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeLedgerResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ExportJournalToS3
///
/// Exports journal contents within a date and time range from a ledger into a specified
/// Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the
/// data objects in either the text or binary representation of Amazon Ion format, or
/// in JSON Lines text format.
///
///
///
/// If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.
///
///
///
/// If the ledger with the given Name is in CREATING status,
/// then throws ResourcePreconditionNotMetException.
///
///
///
/// You can initiate up to two concurrent journal export requests for each ledger. Beyond
/// this limit, journal export requests throw LimitExceededException.
///
///
/// Container for the necessary parameters to execute the ExportJournalToS3 service method.
///
/// The response from the ExportJournalToS3 service method, as returned by QLDB.
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for ExportJournalToS3 Operation
public virtual ExportJournalToS3Response ExportJournalToS3(ExportJournalToS3Request request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ExportJournalToS3RequestMarshaller.Instance;
options.ResponseUnmarshaller = ExportJournalToS3ResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Exports journal contents within a date and time range from a ledger into a specified
/// Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the
/// data objects in either the text or binary representation of Amazon Ion format, or
/// in JSON Lines text format.
///
///
///
/// If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.
///
///
///
/// If the ledger with the given Name is in CREATING status,
/// then throws ResourcePreconditionNotMetException.
///
///
///
/// You can initiate up to two concurrent journal export requests for each ledger. Beyond
/// this limit, journal export requests throw LimitExceededException.
///
///
/// Container for the necessary parameters to execute the ExportJournalToS3 service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ExportJournalToS3 service method, as returned by QLDB.
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for ExportJournalToS3 Operation
public virtual Task ExportJournalToS3Async(ExportJournalToS3Request request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ExportJournalToS3RequestMarshaller.Instance;
options.ResponseUnmarshaller = ExportJournalToS3ResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBlock
///
/// Returns a block object at a specified address in a journal. Also returns a proof of
/// the specified block for verification if DigestTipAddress is provided.
///
///
///
/// For information about the data contents in a block, see Journal
/// contents in the Amazon QLDB Developer Guide.
///
///
///
/// If the specified ledger doesn't exist or is in DELETING status, then
/// throws ResourceNotFoundException.
///
///
///
/// If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException.
///
///
///
/// If no block exists with the specified address, then throws InvalidParameterException.
///
///
/// Container for the necessary parameters to execute the GetBlock service method.
///
/// The response from the GetBlock service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for GetBlock Operation
public virtual GetBlockResponse GetBlock(GetBlockRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBlockRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBlockResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns a block object at a specified address in a journal. Also returns a proof of
/// the specified block for verification if DigestTipAddress is provided.
///
///
///
/// For information about the data contents in a block, see Journal
/// contents in the Amazon QLDB Developer Guide.
///
///
///
/// If the specified ledger doesn't exist or is in DELETING status, then
/// throws ResourceNotFoundException.
///
///
///
/// If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException.
///
///
///
/// If no block exists with the specified address, then throws InvalidParameterException.
///
///
/// Container for the necessary parameters to execute the GetBlock service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBlock service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for GetBlock Operation
public virtual Task GetBlockAsync(GetBlockRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBlockRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBlockResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetDigest
///
/// Returns the digest of a ledger at the latest committed block in the journal. The response
/// includes a 256-bit hash value and a block address.
///
/// Container for the necessary parameters to execute the GetDigest service method.
///
/// The response from the GetDigest service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for GetDigest Operation
public virtual GetDigestResponse GetDigest(GetDigestRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetDigestRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetDigestResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the digest of a ledger at the latest committed block in the journal. The response
/// includes a 256-bit hash value and a block address.
///
/// Container for the necessary parameters to execute the GetDigest service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetDigest service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for GetDigest Operation
public virtual Task GetDigestAsync(GetDigestRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetDigestRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetDigestResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetRevision
///
/// Returns a revision data object for a specified document ID and block address. Also
/// returns a proof of the specified revision for verification if DigestTipAddress
/// is provided.
///
/// Container for the necessary parameters to execute the GetRevision service method.
///
/// The response from the GetRevision service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for GetRevision Operation
public virtual GetRevisionResponse GetRevision(GetRevisionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetRevisionRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetRevisionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns a revision data object for a specified document ID and block address. Also
/// returns a proof of the specified revision for verification if DigestTipAddress
/// is provided.
///
/// Container for the necessary parameters to execute the GetRevision service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetRevision service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for GetRevision Operation
public virtual Task GetRevisionAsync(GetRevisionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetRevisionRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetRevisionResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListJournalKinesisStreamsForLedger
///
/// Returns all Amazon QLDB journal streams for a given ledger.
///
///
///
/// This action does not return any expired journal streams. For more information, see
/// Expiration
/// for terminal streams in the Amazon QLDB Developer Guide.
///
///
///
/// This action returns a maximum of MaxResults items. It is paginated so
/// that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger
/// multiple times.
///
///
/// Container for the necessary parameters to execute the ListJournalKinesisStreamsForLedger service method.
///
/// The response from the ListJournalKinesisStreamsForLedger service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for ListJournalKinesisStreamsForLedger Operation
public virtual ListJournalKinesisStreamsForLedgerResponse ListJournalKinesisStreamsForLedger(ListJournalKinesisStreamsForLedgerRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListJournalKinesisStreamsForLedgerRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListJournalKinesisStreamsForLedgerResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns all Amazon QLDB journal streams for a given ledger.
///
///
///
/// This action does not return any expired journal streams. For more information, see
/// Expiration
/// for terminal streams in the Amazon QLDB Developer Guide.
///
///
///
/// This action returns a maximum of MaxResults items. It is paginated so
/// that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger
/// multiple times.
///
///
/// Container for the necessary parameters to execute the ListJournalKinesisStreamsForLedger service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListJournalKinesisStreamsForLedger service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for ListJournalKinesisStreamsForLedger Operation
public virtual Task ListJournalKinesisStreamsForLedgerAsync(ListJournalKinesisStreamsForLedgerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListJournalKinesisStreamsForLedgerRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListJournalKinesisStreamsForLedgerResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListJournalS3Exports
///
/// Returns all journal export jobs for all ledgers that are associated with the current
/// Amazon Web Services account and Region.
///
///
///
/// This action returns a maximum of MaxResults items, and is paginated so
/// that you can retrieve all the items by calling ListJournalS3Exports multiple
/// times.
///
///
///
/// This action does not return any expired export jobs. For more information, see Export
/// job expiration in the Amazon QLDB Developer Guide.
///
///
/// Container for the necessary parameters to execute the ListJournalS3Exports service method.
///
/// The response from the ListJournalS3Exports service method, as returned by QLDB.
/// REST API Reference for ListJournalS3Exports Operation
public virtual ListJournalS3ExportsResponse ListJournalS3Exports(ListJournalS3ExportsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListJournalS3ExportsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListJournalS3ExportsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns all journal export jobs for all ledgers that are associated with the current
/// Amazon Web Services account and Region.
///
///
///
/// This action returns a maximum of MaxResults items, and is paginated so
/// that you can retrieve all the items by calling ListJournalS3Exports multiple
/// times.
///
///
///
/// This action does not return any expired export jobs. For more information, see Export
/// job expiration in the Amazon QLDB Developer Guide.
///
///
/// Container for the necessary parameters to execute the ListJournalS3Exports service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListJournalS3Exports service method, as returned by QLDB.
/// REST API Reference for ListJournalS3Exports Operation
public virtual Task ListJournalS3ExportsAsync(ListJournalS3ExportsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListJournalS3ExportsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListJournalS3ExportsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListJournalS3ExportsForLedger
///
/// Returns all journal export jobs for a specified ledger.
///
///
///
/// This action returns a maximum of MaxResults items, and is paginated so
/// that you can retrieve all the items by calling ListJournalS3ExportsForLedger
/// multiple times.
///
///
///
/// This action does not return any expired export jobs. For more information, see Export
/// job expiration in the Amazon QLDB Developer Guide.
///
///
/// Container for the necessary parameters to execute the ListJournalS3ExportsForLedger service method.
///
/// The response from the ListJournalS3ExportsForLedger service method, as returned by QLDB.
/// REST API Reference for ListJournalS3ExportsForLedger Operation
public virtual ListJournalS3ExportsForLedgerResponse ListJournalS3ExportsForLedger(ListJournalS3ExportsForLedgerRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListJournalS3ExportsForLedgerRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListJournalS3ExportsForLedgerResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns all journal export jobs for a specified ledger.
///
///
///
/// This action returns a maximum of MaxResults items, and is paginated so
/// that you can retrieve all the items by calling ListJournalS3ExportsForLedger
/// multiple times.
///
///
///
/// This action does not return any expired export jobs. For more information, see Export
/// job expiration in the Amazon QLDB Developer Guide.
///
///
/// Container for the necessary parameters to execute the ListJournalS3ExportsForLedger service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListJournalS3ExportsForLedger service method, as returned by QLDB.
/// REST API Reference for ListJournalS3ExportsForLedger Operation
public virtual Task ListJournalS3ExportsForLedgerAsync(ListJournalS3ExportsForLedgerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListJournalS3ExportsForLedgerRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListJournalS3ExportsForLedgerResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListLedgers
///
/// Returns all ledgers that are associated with the current Amazon Web Services account
/// and Region.
///
///
///
/// This action returns a maximum of MaxResults items and is paginated so
/// that you can retrieve all the items by calling ListLedgers multiple times.
///
///
/// Container for the necessary parameters to execute the ListLedgers service method.
///
/// The response from the ListLedgers service method, as returned by QLDB.
/// REST API Reference for ListLedgers Operation
public virtual ListLedgersResponse ListLedgers(ListLedgersRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListLedgersRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListLedgersResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns all ledgers that are associated with the current Amazon Web Services account
/// and Region.
///
///
///
/// This action returns a maximum of MaxResults items and is paginated so
/// that you can retrieve all the items by calling ListLedgers multiple times.
///
///
/// Container for the necessary parameters to execute the ListLedgers service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListLedgers service method, as returned by QLDB.
/// REST API Reference for ListLedgers Operation
public virtual Task ListLedgersAsync(ListLedgersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListLedgersRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListLedgersResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListTagsForResource
///
/// Returns all tags for a specified Amazon QLDB resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
/// REST API Reference for ListTagsForResource Operation
public virtual ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns all tags for a specified Amazon QLDB resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
/// REST API Reference for ListTagsForResource Operation
public virtual Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region StreamJournalToKinesis
///
/// Creates a journal stream for a given Amazon QLDB ledger. The stream captures every
/// document revision that is committed to the ledger's journal and delivers the data
/// to a specified Amazon Kinesis Data Streams resource.
///
/// Container for the necessary parameters to execute the StreamJournalToKinesis service method.
///
/// The response from the StreamJournalToKinesis service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for StreamJournalToKinesis Operation
public virtual StreamJournalToKinesisResponse StreamJournalToKinesis(StreamJournalToKinesisRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = StreamJournalToKinesisRequestMarshaller.Instance;
options.ResponseUnmarshaller = StreamJournalToKinesisResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates a journal stream for a given Amazon QLDB ledger. The stream captures every
/// document revision that is committed to the ledger's journal and delivers the data
/// to a specified Amazon Kinesis Data Streams resource.
///
/// Container for the necessary parameters to execute the StreamJournalToKinesis service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StreamJournalToKinesis service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
///
/// The operation failed because a condition wasn't satisfied in advance.
///
/// REST API Reference for StreamJournalToKinesis Operation
public virtual Task StreamJournalToKinesisAsync(StreamJournalToKinesisRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = StreamJournalToKinesisRequestMarshaller.Instance;
options.ResponseUnmarshaller = StreamJournalToKinesisResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region TagResource
///
/// Adds one or more tags to a specified Amazon QLDB resource.
///
///
///
/// A resource can have up to 50 tags. If you try to create more than 50 tags for a resource,
/// your request fails and returns an error.
///
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
/// REST API Reference for TagResource Operation
public virtual TagResourceResponse TagResource(TagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Adds one or more tags to a specified Amazon QLDB resource.
///
///
///
/// A resource can have up to 50 tags. If you try to create more than 50 tags for a resource,
/// your request fails and returns an error.
///
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
/// REST API Reference for TagResource Operation
public virtual Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region UntagResource
///
/// Removes one or more tags from a specified Amazon QLDB resource. You can specify up
/// to 50 tag keys to remove.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
/// REST API Reference for UntagResource Operation
public virtual UntagResourceResponse UntagResource(UntagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Removes one or more tags from a specified Amazon QLDB resource. You can specify up
/// to 50 tag keys to remove.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
/// REST API Reference for UntagResource Operation
public virtual Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region UpdateLedger
///
/// Updates properties on a ledger.
///
/// Container for the necessary parameters to execute the UpdateLedger service method.
///
/// The response from the UpdateLedger service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
/// REST API Reference for UpdateLedger Operation
public virtual UpdateLedgerResponse UpdateLedger(UpdateLedgerRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateLedgerRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateLedgerResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Updates properties on a ledger.
///
/// Container for the necessary parameters to execute the UpdateLedger service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateLedger service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
/// REST API Reference for UpdateLedger Operation
public virtual Task UpdateLedgerAsync(UpdateLedgerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateLedgerRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateLedgerResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region UpdateLedgerPermissionsMode
///
/// Updates the permissions mode of a ledger.
///
///
///
/// Before you switch to the STANDARD permissions mode, you must first create
/// all required IAM policies and table tags to avoid disruption to your users. To learn
/// more, see Migrating
/// to the standard permissions mode in the Amazon QLDB Developer Guide.
///
///
///
/// Container for the necessary parameters to execute the UpdateLedgerPermissionsMode service method.
///
/// The response from the UpdateLedgerPermissionsMode service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
/// REST API Reference for UpdateLedgerPermissionsMode Operation
public virtual UpdateLedgerPermissionsModeResponse UpdateLedgerPermissionsMode(UpdateLedgerPermissionsModeRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateLedgerPermissionsModeRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateLedgerPermissionsModeResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Updates the permissions mode of a ledger.
///
///
///
/// Before you switch to the STANDARD permissions mode, you must first create
/// all required IAM policies and table tags to avoid disruption to your users. To learn
/// more, see Migrating
/// to the standard permissions mode in the Amazon QLDB Developer Guide.
///
///
///
/// Container for the necessary parameters to execute the UpdateLedgerPermissionsMode service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateLedgerPermissionsMode service method, as returned by QLDB.
///
/// One or more parameters in the request aren't valid.
///
///
/// The specified resource doesn't exist.
///
/// REST API Reference for UpdateLedgerPermissionsMode Operation
public virtual Task UpdateLedgerPermissionsModeAsync(UpdateLedgerPermissionsModeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateLedgerPermissionsModeRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateLedgerPermissionsModeResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
}
}