Documentation ¶
Overview ¶
Package qldb provides the client and types for making API requests to QLDB.
The control plane for Amazon QLDB ¶
See https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02 for more information on this service.
See qldb package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/qldb/
Using the Client ¶
To use QLDB with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the QLDB client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/qldb/#New
Index ¶
- Constants
- type Client
- func (c *Client) CreateLedgerRequest(input *CreateLedgerInput) CreateLedgerRequest
- func (c *Client) DeleteLedgerRequest(input *DeleteLedgerInput) DeleteLedgerRequest
- func (c *Client) DescribeJournalS3ExportRequest(input *DescribeJournalS3ExportInput) DescribeJournalS3ExportRequest
- func (c *Client) DescribeLedgerRequest(input *DescribeLedgerInput) DescribeLedgerRequest
- func (c *Client) ExportJournalToS3Request(input *ExportJournalToS3Input) ExportJournalToS3Request
- func (c *Client) GetBlockRequest(input *GetBlockInput) GetBlockRequest
- func (c *Client) GetDigestRequest(input *GetDigestInput) GetDigestRequest
- func (c *Client) GetRevisionRequest(input *GetRevisionInput) GetRevisionRequest
- func (c *Client) ListJournalS3ExportsForLedgerRequest(input *ListJournalS3ExportsForLedgerInput) ListJournalS3ExportsForLedgerRequest
- func (c *Client) ListJournalS3ExportsRequest(input *ListJournalS3ExportsInput) ListJournalS3ExportsRequest
- func (c *Client) ListLedgersRequest(input *ListLedgersInput) ListLedgersRequest
- func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
- func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
- func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
- func (c *Client) UpdateLedgerRequest(input *UpdateLedgerInput) UpdateLedgerRequest
- type CreateLedgerInput
- type CreateLedgerOutput
- type CreateLedgerRequest
- type CreateLedgerResponse
- type DeleteLedgerInput
- type DeleteLedgerOutput
- type DeleteLedgerRequest
- type DeleteLedgerResponse
- type DescribeJournalS3ExportInput
- type DescribeJournalS3ExportOutput
- type DescribeJournalS3ExportRequest
- type DescribeJournalS3ExportResponse
- type DescribeLedgerInput
- type DescribeLedgerOutput
- type DescribeLedgerRequest
- type DescribeLedgerResponse
- type ExportJournalToS3Input
- type ExportJournalToS3Output
- type ExportJournalToS3Request
- type ExportJournalToS3Response
- type ExportStatus
- type GetBlockInput
- type GetBlockOutput
- type GetBlockRequest
- type GetBlockResponse
- type GetDigestInput
- type GetDigestOutput
- type GetDigestRequest
- type GetDigestResponse
- type GetRevisionInput
- type GetRevisionOutput
- type GetRevisionRequest
- type GetRevisionResponse
- type JournalS3ExportDescription
- type LedgerState
- type LedgerSummary
- type ListJournalS3ExportsForLedgerInput
- type ListJournalS3ExportsForLedgerOutput
- type ListJournalS3ExportsForLedgerPaginator
- type ListJournalS3ExportsForLedgerRequest
- type ListJournalS3ExportsForLedgerResponse
- type ListJournalS3ExportsInput
- type ListJournalS3ExportsOutput
- type ListJournalS3ExportsPaginator
- type ListJournalS3ExportsRequest
- type ListJournalS3ExportsResponse
- type ListLedgersInput
- type ListLedgersOutput
- type ListLedgersPaginator
- type ListLedgersRequest
- type ListLedgersResponse
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTagsForResourceRequest
- type ListTagsForResourceResponse
- type PermissionsMode
- type S3EncryptionConfiguration
- type S3ExportConfiguration
- type S3ObjectEncryptionType
- type TagResourceInput
- type TagResourceOutput
- type TagResourceRequest
- type TagResourceResponse
- type UntagResourceInput
- type UntagResourceOutput
- type UntagResourceRequest
- type UntagResourceResponse
- type UpdateLedgerInput
- type UpdateLedgerOutput
- type UpdateLedgerRequest
- type UpdateLedgerResponse
- type ValueHolder
Constants ¶
const ( ServiceName = "QLDB" // Service's name ServiceID = "QLDB" // Service's identifier EndpointsID = "qldb" // Service's Endpoint identifier )
const ( // ErrCodeInvalidParameterException for service response error code // "InvalidParameterException". // // One or more parameters in the request aren't valid. ErrCodeInvalidParameterException = "InvalidParameterException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // // You have reached the limit on the maximum number of resources allowed. ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeResourceAlreadyExistsException for service response error code // "ResourceAlreadyExistsException". // // The specified resource already exists. ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException" // ErrCodeResourceInUseException for service response error code // "ResourceInUseException". // // The specified resource can't be modified at this time. ErrCodeResourceInUseException = "ResourceInUseException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // The specified resource doesn't exist. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeResourcePreconditionNotMetException for service response error code // "ResourcePreconditionNotMetException". // // The operation failed because a condition wasn't satisfied in advance. ErrCodeResourcePreconditionNotMetException = "ResourcePreconditionNotMetException" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
Client provides the API operation methods for making requests to QLDB. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := qldb.New(myConfig)
func (*Client) CreateLedgerRequest ¶
func (c *Client) CreateLedgerRequest(input *CreateLedgerInput) CreateLedgerRequest
CreateLedgerRequest returns a request value for making API operation for Amazon QLDB.
Creates a new ledger in your AWS account.
// Example sending a request using CreateLedgerRequest. req := client.CreateLedgerRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CreateLedger
func (*Client) DeleteLedgerRequest ¶
func (c *Client) DeleteLedgerRequest(input *DeleteLedgerInput) DeleteLedgerRequest
DeleteLedgerRequest returns a request value for making API operation for Amazon QLDB.
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 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.
// Example sending a request using DeleteLedgerRequest. req := client.DeleteLedgerRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DeleteLedger
func (*Client) DescribeJournalS3ExportRequest ¶
func (c *Client) DescribeJournalS3ExportRequest(input *DescribeJournalS3ExportInput) DescribeJournalS3ExportRequest
DescribeJournalS3ExportRequest returns a request value for making API operation for Amazon QLDB.
Returns 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.
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.
// Example sending a request using DescribeJournalS3ExportRequest. req := client.DescribeJournalS3ExportRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalS3Export
func (*Client) DescribeLedgerRequest ¶
func (c *Client) DescribeLedgerRequest(input *DescribeLedgerInput) DescribeLedgerRequest
DescribeLedgerRequest returns a request value for making API operation for Amazon QLDB.
Returns information about a ledger, including its state and when it was created.
// Example sending a request using DescribeLedgerRequest. req := client.DescribeLedgerRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeLedger
func (*Client) ExportJournalToS3Request ¶
func (c *Client) ExportJournalToS3Request(input *ExportJournalToS3Input) ExportJournalToS3Request
ExportJournalToS3Request returns a request value for making API operation for Amazon QLDB.
Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion 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.
// Example sending a request using ExportJournalToS3Request. req := client.ExportJournalToS3Request(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ExportJournalToS3
func (*Client) GetBlockRequest ¶
func (c *Client) GetBlockRequest(input *GetBlockInput) GetBlockRequest
GetBlockRequest returns a request value for making API operation for Amazon QLDB.
Returns a journal block object at a specified address in a ledger. Also returns a proof of the specified block for verification if DigestTipAddress is provided.
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.
// Example sending a request using GetBlockRequest. req := client.GetBlockRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetBlock
func (*Client) GetDigestRequest ¶
func (c *Client) GetDigestRequest(input *GetDigestInput) GetDigestRequest
GetDigestRequest returns a request value for making API operation for Amazon QLDB.
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.
// Example sending a request using GetDigestRequest. req := client.GetDigestRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetDigest
func (*Client) GetRevisionRequest ¶
func (c *Client) GetRevisionRequest(input *GetRevisionInput) GetRevisionRequest
GetRevisionRequest returns a request value for making API operation for Amazon QLDB.
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.
// Example sending a request using GetRevisionRequest. req := client.GetRevisionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetRevision
func (*Client) ListJournalS3ExportsForLedgerRequest ¶
func (c *Client) ListJournalS3ExportsForLedgerRequest(input *ListJournalS3ExportsForLedgerInput) ListJournalS3ExportsForLedgerRequest
ListJournalS3ExportsForLedgerRequest returns a request value for making API operation for Amazon QLDB.
Returns an array of journal export job descriptions 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.
// Example sending a request using ListJournalS3ExportsForLedgerRequest. req := client.ListJournalS3ExportsForLedgerRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalS3ExportsForLedger
func (*Client) ListJournalS3ExportsRequest ¶
func (c *Client) ListJournalS3ExportsRequest(input *ListJournalS3ExportsInput) ListJournalS3ExportsRequest
ListJournalS3ExportsRequest returns a request value for making API operation for Amazon QLDB.
Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS 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.
// Example sending a request using ListJournalS3ExportsRequest. req := client.ListJournalS3ExportsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalS3Exports
func (*Client) ListLedgersRequest ¶
func (c *Client) ListLedgersRequest(input *ListLedgersInput) ListLedgersRequest
ListLedgersRequest returns a request value for making API operation for Amazon QLDB.
Returns an array of ledger summaries that are associated with the current AWS account and Region.
This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times.
// Example sending a request using ListLedgersRequest. req := client.ListLedgersRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListLedgers
func (*Client) ListTagsForResourceRequest ¶
func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
ListTagsForResourceRequest returns a request value for making API operation for Amazon QLDB.
Returns all tags for a specified Amazon QLDB resource.
// Example sending a request using ListTagsForResourceRequest. req := client.ListTagsForResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListTagsForResource
func (*Client) TagResourceRequest ¶
func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
TagResourceRequest returns a request value for making API operation for Amazon QLDB.
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.
// Example sending a request using TagResourceRequest. req := client.TagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/TagResource
func (*Client) UntagResourceRequest ¶
func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
UntagResourceRequest returns a request value for making API operation for Amazon QLDB.
Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
// Example sending a request using UntagResourceRequest. req := client.UntagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UntagResource
func (*Client) UpdateLedgerRequest ¶
func (c *Client) UpdateLedgerRequest(input *UpdateLedgerInput) UpdateLedgerRequest
UpdateLedgerRequest returns a request value for making API operation for Amazon QLDB.
Updates properties on a ledger.
// Example sending a request using UpdateLedgerRequest. req := client.UpdateLedgerRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedger
type CreateLedgerInput ¶
type CreateLedgerInput struct { // 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. DeletionProtection *bool `type:"boolean"` // 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. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // The permissions mode to assign to the ledger that you want to create. // // PermissionsMode is a required field PermissionsMode PermissionsMode `type:"string" required:"true" enum:"true"` // 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. Tags map[string]string `type:"map"` // contains filtered or unexported fields }
func (CreateLedgerInput) MarshalFields ¶
func (s CreateLedgerInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateLedgerInput) String ¶
func (s CreateLedgerInput) String() string
String returns the string representation
func (*CreateLedgerInput) Validate ¶
func (s *CreateLedgerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateLedgerOutput ¶
type CreateLedgerOutput struct { // The Amazon Resource Name (ARN) for the ledger. Arn *string `min:"20" type:"string"` // The date and time, in epoch time format, when the ledger was created. (Epoch // time format is the number of seconds elapsed since 12:00:00 AM January 1, // 1970 UTC.) CreationDateTime *time.Time `type:"timestamp"` // 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. DeletionProtection *bool `type:"boolean"` // The name of the ledger. Name *string `min:"1" type:"string"` // The current status of the ledger. State LedgerState `type:"string" enum:"true"` // contains filtered or unexported fields }
func (CreateLedgerOutput) MarshalFields ¶
func (s CreateLedgerOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateLedgerOutput) String ¶
func (s CreateLedgerOutput) String() string
String returns the string representation
type CreateLedgerRequest ¶
type CreateLedgerRequest struct { *aws.Request Input *CreateLedgerInput Copy func(*CreateLedgerInput) CreateLedgerRequest }
CreateLedgerRequest is the request type for the CreateLedger API operation.
func (CreateLedgerRequest) Send ¶
func (r CreateLedgerRequest) Send(ctx context.Context) (*CreateLedgerResponse, error)
Send marshals and sends the CreateLedger API request.
type CreateLedgerResponse ¶
type CreateLedgerResponse struct { *CreateLedgerOutput // contains filtered or unexported fields }
CreateLedgerResponse is the response type for the CreateLedger API operation.
func (*CreateLedgerResponse) SDKResponseMetdata ¶
func (r *CreateLedgerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateLedger request.
type DeleteLedgerInput ¶
type DeleteLedgerInput struct { // The name of the ledger that you want to delete. // // Name is a required field Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteLedgerInput) MarshalFields ¶
func (s DeleteLedgerInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteLedgerInput) String ¶
func (s DeleteLedgerInput) String() string
String returns the string representation
func (*DeleteLedgerInput) Validate ¶
func (s *DeleteLedgerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteLedgerOutput ¶
type DeleteLedgerOutput struct {
// contains filtered or unexported fields
}
func (DeleteLedgerOutput) MarshalFields ¶
func (s DeleteLedgerOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteLedgerOutput) String ¶
func (s DeleteLedgerOutput) String() string
String returns the string representation
type DeleteLedgerRequest ¶
type DeleteLedgerRequest struct { *aws.Request Input *DeleteLedgerInput Copy func(*DeleteLedgerInput) DeleteLedgerRequest }
DeleteLedgerRequest is the request type for the DeleteLedger API operation.
func (DeleteLedgerRequest) Send ¶
func (r DeleteLedgerRequest) Send(ctx context.Context) (*DeleteLedgerResponse, error)
Send marshals and sends the DeleteLedger API request.
type DeleteLedgerResponse ¶
type DeleteLedgerResponse struct { *DeleteLedgerOutput // contains filtered or unexported fields }
DeleteLedgerResponse is the response type for the DeleteLedger API operation.
func (*DeleteLedgerResponse) SDKResponseMetdata ¶
func (r *DeleteLedgerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteLedger request.
type DescribeJournalS3ExportInput ¶
type DescribeJournalS3ExportInput struct { // The unique ID of the journal export job that you want to describe. // // ExportId is a required field ExportId *string `location:"uri" locationName:"exportId" min:"22" type:"string" required:"true"` // The name of the ledger. // // Name is a required field Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeJournalS3ExportInput) MarshalFields ¶
func (s DescribeJournalS3ExportInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DescribeJournalS3ExportInput) String ¶
func (s DescribeJournalS3ExportInput) String() string
String returns the string representation
func (*DescribeJournalS3ExportInput) Validate ¶
func (s *DescribeJournalS3ExportInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeJournalS3ExportOutput ¶
type DescribeJournalS3ExportOutput struct { // Information about the journal export job returned by a DescribeJournalS3Export // request. // // ExportDescription is a required field ExportDescription *JournalS3ExportDescription `type:"structure" required:"true"` // contains filtered or unexported fields }
func (DescribeJournalS3ExportOutput) MarshalFields ¶
func (s DescribeJournalS3ExportOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DescribeJournalS3ExportOutput) String ¶
func (s DescribeJournalS3ExportOutput) String() string
String returns the string representation
type DescribeJournalS3ExportRequest ¶
type DescribeJournalS3ExportRequest struct { *aws.Request Input *DescribeJournalS3ExportInput Copy func(*DescribeJournalS3ExportInput) DescribeJournalS3ExportRequest }
DescribeJournalS3ExportRequest is the request type for the DescribeJournalS3Export API operation.
func (DescribeJournalS3ExportRequest) Send ¶
func (r DescribeJournalS3ExportRequest) Send(ctx context.Context) (*DescribeJournalS3ExportResponse, error)
Send marshals and sends the DescribeJournalS3Export API request.
type DescribeJournalS3ExportResponse ¶
type DescribeJournalS3ExportResponse struct { *DescribeJournalS3ExportOutput // contains filtered or unexported fields }
DescribeJournalS3ExportResponse is the response type for the DescribeJournalS3Export API operation.
func (*DescribeJournalS3ExportResponse) SDKResponseMetdata ¶
func (r *DescribeJournalS3ExportResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeJournalS3Export request.
type DescribeLedgerInput ¶
type DescribeLedgerInput struct { // The name of the ledger that you want to describe. // // Name is a required field Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeLedgerInput) MarshalFields ¶
func (s DescribeLedgerInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DescribeLedgerInput) String ¶
func (s DescribeLedgerInput) String() string
String returns the string representation
func (*DescribeLedgerInput) Validate ¶
func (s *DescribeLedgerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeLedgerOutput ¶
type DescribeLedgerOutput struct { // The Amazon Resource Name (ARN) for the ledger. Arn *string `min:"20" type:"string"` // The date and time, in epoch time format, when the ledger was created. (Epoch // time format is the number of seconds elapsed since 12:00:00 AM January 1, // 1970 UTC.) CreationDateTime *time.Time `type:"timestamp"` // 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. DeletionProtection *bool `type:"boolean"` // The name of the ledger. Name *string `min:"1" type:"string"` // The current status of the ledger. State LedgerState `type:"string" enum:"true"` // contains filtered or unexported fields }
func (DescribeLedgerOutput) MarshalFields ¶
func (s DescribeLedgerOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DescribeLedgerOutput) String ¶
func (s DescribeLedgerOutput) String() string
String returns the string representation
type DescribeLedgerRequest ¶
type DescribeLedgerRequest struct { *aws.Request Input *DescribeLedgerInput Copy func(*DescribeLedgerInput) DescribeLedgerRequest }
DescribeLedgerRequest is the request type for the DescribeLedger API operation.
func (DescribeLedgerRequest) Send ¶
func (r DescribeLedgerRequest) Send(ctx context.Context) (*DescribeLedgerResponse, error)
Send marshals and sends the DescribeLedger API request.
type DescribeLedgerResponse ¶
type DescribeLedgerResponse struct { *DescribeLedgerOutput // contains filtered or unexported fields }
DescribeLedgerResponse is the response type for the DescribeLedger API operation.
func (*DescribeLedgerResponse) SDKResponseMetdata ¶
func (r *DescribeLedgerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeLedger request.
type ExportJournalToS3Input ¶
type ExportJournalToS3Input struct { // 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. // // ExclusiveEndTime is a required field ExclusiveEndTime *time.Time `type:"timestamp" required:"true"` // 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. // // InclusiveStartTime is a required field InclusiveStartTime *time.Time `type:"timestamp" required:"true"` // The name of the ledger. // // Name is a required field Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` // 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. // // RoleArn is a required field RoleArn *string `min:"20" type:"string" required:"true"` // The configuration settings of the Amazon S3 bucket destination for your export // request. // // S3ExportConfiguration is a required field S3ExportConfiguration *S3ExportConfiguration `type:"structure" required:"true"` // contains filtered or unexported fields }
func (ExportJournalToS3Input) MarshalFields ¶
func (s ExportJournalToS3Input) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ExportJournalToS3Input) String ¶
func (s ExportJournalToS3Input) String() string
String returns the string representation
func (*ExportJournalToS3Input) Validate ¶
func (s *ExportJournalToS3Input) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ExportJournalToS3Output ¶
type ExportJournalToS3Output struct { // The unique ID that QLDB assigns to each journal export job. // // To describe your export request and check the status of the job, you can // use ExportId to call DescribeJournalS3Export. // // ExportId is a required field ExportId *string `min:"22" type:"string" required:"true"` // contains filtered or unexported fields }
func (ExportJournalToS3Output) MarshalFields ¶
func (s ExportJournalToS3Output) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ExportJournalToS3Output) String ¶
func (s ExportJournalToS3Output) String() string
String returns the string representation
type ExportJournalToS3Request ¶
type ExportJournalToS3Request struct { *aws.Request Input *ExportJournalToS3Input Copy func(*ExportJournalToS3Input) ExportJournalToS3Request }
ExportJournalToS3Request is the request type for the ExportJournalToS3 API operation.
func (ExportJournalToS3Request) Send ¶
func (r ExportJournalToS3Request) Send(ctx context.Context) (*ExportJournalToS3Response, error)
Send marshals and sends the ExportJournalToS3 API request.
type ExportJournalToS3Response ¶
type ExportJournalToS3Response struct { *ExportJournalToS3Output // contains filtered or unexported fields }
ExportJournalToS3Response is the response type for the ExportJournalToS3 API operation.
func (*ExportJournalToS3Response) SDKResponseMetdata ¶
func (r *ExportJournalToS3Response) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ExportJournalToS3 request.
type ExportStatus ¶
type ExportStatus string
const ( ExportStatusInProgress ExportStatus = "IN_PROGRESS" ExportStatusCompleted ExportStatus = "COMPLETED" ExportStatusCancelled ExportStatus = "CANCELLED" )
Enum values for ExportStatus
func (ExportStatus) MarshalValue ¶
func (enum ExportStatus) MarshalValue() (string, error)
func (ExportStatus) MarshalValueBuf ¶
func (enum ExportStatus) MarshalValueBuf(b []byte) ([]byte, error)
type GetBlockInput ¶
type GetBlockInput struct { // The location of the block that you want to request. An address is an Amazon // Ion structure that has two fields: strandId and sequenceNo. // // For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14} // // BlockAddress is a required field BlockAddress *ValueHolder `type:"structure" required:"true" sensitive:"true"` // The latest block location covered by the digest for which to request a proof. // An address is an Amazon Ion structure that has two fields: strandId and sequenceNo. // // For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49} DigestTipAddress *ValueHolder `type:"structure" sensitive:"true"` // The name of the ledger. // // Name is a required field Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetBlockInput) MarshalFields ¶
func (s GetBlockInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetBlockInput) String ¶
func (s GetBlockInput) String() string
String returns the string representation
func (*GetBlockInput) Validate ¶
func (s *GetBlockInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetBlockOutput ¶
type GetBlockOutput struct { // The block data object in Amazon Ion format. // // Block is a required field Block *ValueHolder `type:"structure" required:"true" sensitive:"true"` // The proof object in Amazon Ion format returned by a GetBlock request. A proof // contains the list of hash values required to recalculate the specified digest // using a Merkle tree, starting with the specified block. Proof *ValueHolder `type:"structure" sensitive:"true"` // contains filtered or unexported fields }
func (GetBlockOutput) MarshalFields ¶
func (s GetBlockOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetBlockOutput) String ¶
func (s GetBlockOutput) String() string
String returns the string representation
type GetBlockRequest ¶
type GetBlockRequest struct { *aws.Request Input *GetBlockInput Copy func(*GetBlockInput) GetBlockRequest }
GetBlockRequest is the request type for the GetBlock API operation.
func (GetBlockRequest) Send ¶
func (r GetBlockRequest) Send(ctx context.Context) (*GetBlockResponse, error)
Send marshals and sends the GetBlock API request.
type GetBlockResponse ¶
type GetBlockResponse struct { *GetBlockOutput // contains filtered or unexported fields }
GetBlockResponse is the response type for the GetBlock API operation.
func (*GetBlockResponse) SDKResponseMetdata ¶
func (r *GetBlockResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetBlock request.
type GetDigestInput ¶
type GetDigestInput struct { // The name of the ledger. // // Name is a required field Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetDigestInput) MarshalFields ¶
func (s GetDigestInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDigestInput) String ¶
func (s GetDigestInput) String() string
String returns the string representation
func (*GetDigestInput) Validate ¶
func (s *GetDigestInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDigestOutput ¶
type GetDigestOutput struct { // The 256-bit hash value representing the digest returned by a GetDigest request. // // Digest is automatically base64 encoded/decoded by the SDK. // // Digest is a required field Digest []byte `min:"32" type:"blob" required:"true"` // The latest block location covered by the digest that you requested. An address // is an Amazon Ion structure that has two fields: strandId and sequenceNo. // // DigestTipAddress is a required field DigestTipAddress *ValueHolder `type:"structure" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (GetDigestOutput) MarshalFields ¶
func (s GetDigestOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDigestOutput) String ¶
func (s GetDigestOutput) String() string
String returns the string representation
type GetDigestRequest ¶
type GetDigestRequest struct { *aws.Request Input *GetDigestInput Copy func(*GetDigestInput) GetDigestRequest }
GetDigestRequest is the request type for the GetDigest API operation.
func (GetDigestRequest) Send ¶
func (r GetDigestRequest) Send(ctx context.Context) (*GetDigestResponse, error)
Send marshals and sends the GetDigest API request.
type GetDigestResponse ¶
type GetDigestResponse struct { *GetDigestOutput // contains filtered or unexported fields }
GetDigestResponse is the response type for the GetDigest API operation.
func (*GetDigestResponse) SDKResponseMetdata ¶
func (r *GetDigestResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetDigest request.
type GetRevisionInput ¶
type GetRevisionInput struct { // The block location of the document revision to be verified. An address is // an Amazon Ion structure that has two fields: strandId and sequenceNo. // // For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14} // // BlockAddress is a required field BlockAddress *ValueHolder `type:"structure" required:"true" sensitive:"true"` // The latest block location covered by the digest for which to request a proof. // An address is an Amazon Ion structure that has two fields: strandId and sequenceNo. // // For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49} DigestTipAddress *ValueHolder `type:"structure" sensitive:"true"` // The unique ID of the document to be verified. // // DocumentId is a required field DocumentId *string `min:"22" type:"string" required:"true"` // The name of the ledger. // // Name is a required field Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetRevisionInput) MarshalFields ¶
func (s GetRevisionInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetRevisionInput) String ¶
func (s GetRevisionInput) String() string
String returns the string representation
func (*GetRevisionInput) Validate ¶
func (s *GetRevisionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetRevisionOutput ¶
type GetRevisionOutput struct { // The proof object in Amazon Ion format returned by a GetRevision request. // A proof contains the list of hash values that are required to recalculate // the specified digest using a Merkle tree, starting with the specified document // revision. Proof *ValueHolder `type:"structure" sensitive:"true"` // The document revision data object in Amazon Ion format. // // Revision is a required field Revision *ValueHolder `type:"structure" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (GetRevisionOutput) MarshalFields ¶
func (s GetRevisionOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetRevisionOutput) String ¶
func (s GetRevisionOutput) String() string
String returns the string representation
type GetRevisionRequest ¶
type GetRevisionRequest struct { *aws.Request Input *GetRevisionInput Copy func(*GetRevisionInput) GetRevisionRequest }
GetRevisionRequest is the request type for the GetRevision API operation.
func (GetRevisionRequest) Send ¶
func (r GetRevisionRequest) Send(ctx context.Context) (*GetRevisionResponse, error)
Send marshals and sends the GetRevision API request.
type GetRevisionResponse ¶
type GetRevisionResponse struct { *GetRevisionOutput // contains filtered or unexported fields }
GetRevisionResponse is the response type for the GetRevision API operation.
func (*GetRevisionResponse) SDKResponseMetdata ¶
func (r *GetRevisionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetRevision request.
type JournalS3ExportDescription ¶
type JournalS3ExportDescription struct { // The exclusive end date and time for the range of journal contents that are // specified in the original export request. // // ExclusiveEndTime is a required field ExclusiveEndTime *time.Time `type:"timestamp" required:"true"` // The date and time, in epoch time format, when the export job was created. // (Epoch time format is the number of seconds elapsed since 12:00:00 AM January // 1, 1970 UTC.) // // ExportCreationTime is a required field ExportCreationTime *time.Time `type:"timestamp" required:"true"` // The unique ID of the journal export job. // // ExportId is a required field ExportId *string `min:"22" type:"string" required:"true"` // The inclusive start date and time for the range of journal contents that // are specified in the original export request. // // InclusiveStartTime is a required field InclusiveStartTime *time.Time `type:"timestamp" required:"true"` // The name of the ledger. // // LedgerName is a required field LedgerName *string `min:"1" type:"string" required:"true"` // 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. // // RoleArn is a required field RoleArn *string `min:"20" type:"string" required:"true"` // The Amazon Simple Storage Service (Amazon S3) bucket location in which a // journal export job writes the journal contents. // // S3ExportConfiguration is a required field S3ExportConfiguration *S3ExportConfiguration `type:"structure" required:"true"` // The current state of the journal export job. // // Status is a required field Status ExportStatus `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
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.
func (JournalS3ExportDescription) MarshalFields ¶
func (s JournalS3ExportDescription) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (JournalS3ExportDescription) String ¶
func (s JournalS3ExportDescription) String() string
String returns the string representation
type LedgerState ¶
type LedgerState string
const ( LedgerStateCreating LedgerState = "CREATING" LedgerStateActive LedgerState = "ACTIVE" LedgerStateDeleting LedgerState = "DELETING" LedgerStateDeleted LedgerState = "DELETED" )
Enum values for LedgerState
func (LedgerState) MarshalValue ¶
func (enum LedgerState) MarshalValue() (string, error)
func (LedgerState) MarshalValueBuf ¶
func (enum LedgerState) MarshalValueBuf(b []byte) ([]byte, error)
type LedgerSummary ¶
type LedgerSummary struct { // The date and time, in epoch time format, when the ledger was created. (Epoch // time format is the number of seconds elapsed since 12:00:00 AM January 1, // 1970 UTC.) CreationDateTime *time.Time `type:"timestamp"` // The name of the ledger. Name *string `min:"1" type:"string"` // The current status of the ledger. State LedgerState `type:"string" enum:"true"` // contains filtered or unexported fields }
Information about a ledger, including its name, state, and when it was created.
func (LedgerSummary) MarshalFields ¶
func (s LedgerSummary) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (LedgerSummary) String ¶
func (s LedgerSummary) String() string
String returns the string representation
type ListJournalS3ExportsForLedgerInput ¶
type ListJournalS3ExportsForLedgerInput struct { // The maximum number of results to return in a single ListJournalS3ExportsForLedger // request. (The actual number of results returned might be fewer.) MaxResults *int64 `location:"querystring" locationName:"max_results" min:"1" type:"integer"` // The name of the ledger. // // Name is a required field Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` // A pagination token, indicating that you want to retrieve the next page of // results. If you received a value for NextToken in the response from a previous // ListJournalS3ExportsForLedger call, then you should use that value as input // here. NextToken *string `location:"querystring" locationName:"next_token" min:"4" type:"string"` // contains filtered or unexported fields }
func (ListJournalS3ExportsForLedgerInput) MarshalFields ¶
func (s ListJournalS3ExportsForLedgerInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListJournalS3ExportsForLedgerInput) String ¶
func (s ListJournalS3ExportsForLedgerInput) String() string
String returns the string representation
func (*ListJournalS3ExportsForLedgerInput) Validate ¶
func (s *ListJournalS3ExportsForLedgerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListJournalS3ExportsForLedgerOutput ¶
type ListJournalS3ExportsForLedgerOutput struct { // The array of journal export job descriptions that are associated with the // specified ledger. JournalS3Exports []JournalS3ExportDescription `type:"list"` // * If NextToken is empty, then the last page of results has been processed // and there are no more results to be retrieved. // // * If NextToken is not empty, then there are more results available. To // retrieve the next page of results, use the value of NextToken in a subsequent // ListJournalS3ExportsForLedger call. NextToken *string `min:"4" type:"string"` // contains filtered or unexported fields }
func (ListJournalS3ExportsForLedgerOutput) MarshalFields ¶
func (s ListJournalS3ExportsForLedgerOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListJournalS3ExportsForLedgerOutput) String ¶
func (s ListJournalS3ExportsForLedgerOutput) String() string
String returns the string representation
type ListJournalS3ExportsForLedgerPaginator ¶
ListJournalS3ExportsForLedgerPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListJournalS3ExportsForLedgerPaginator ¶
func NewListJournalS3ExportsForLedgerPaginator(req ListJournalS3ExportsForLedgerRequest) ListJournalS3ExportsForLedgerPaginator
NewListJournalS3ExportsForLedgerRequestPaginator returns a paginator for ListJournalS3ExportsForLedger. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListJournalS3ExportsForLedgerRequest(input) p := qldb.NewListJournalS3ExportsForLedgerRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListJournalS3ExportsForLedgerPaginator) CurrentPage ¶
func (p *ListJournalS3ExportsForLedgerPaginator) CurrentPage() *ListJournalS3ExportsForLedgerOutput
type ListJournalS3ExportsForLedgerRequest ¶
type ListJournalS3ExportsForLedgerRequest struct { *aws.Request Input *ListJournalS3ExportsForLedgerInput Copy func(*ListJournalS3ExportsForLedgerInput) ListJournalS3ExportsForLedgerRequest }
ListJournalS3ExportsForLedgerRequest is the request type for the ListJournalS3ExportsForLedger API operation.
func (ListJournalS3ExportsForLedgerRequest) Send ¶
func (r ListJournalS3ExportsForLedgerRequest) Send(ctx context.Context) (*ListJournalS3ExportsForLedgerResponse, error)
Send marshals and sends the ListJournalS3ExportsForLedger API request.
type ListJournalS3ExportsForLedgerResponse ¶
type ListJournalS3ExportsForLedgerResponse struct { *ListJournalS3ExportsForLedgerOutput // contains filtered or unexported fields }
ListJournalS3ExportsForLedgerResponse is the response type for the ListJournalS3ExportsForLedger API operation.
func (*ListJournalS3ExportsForLedgerResponse) SDKResponseMetdata ¶
func (r *ListJournalS3ExportsForLedgerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListJournalS3ExportsForLedger request.
type ListJournalS3ExportsInput ¶
type ListJournalS3ExportsInput struct { // The maximum number of results to return in a single ListJournalS3Exports // request. (The actual number of results returned might be fewer.) MaxResults *int64 `location:"querystring" locationName:"max_results" min:"1" type:"integer"` // A pagination token, indicating that you want to retrieve the next page of // results. If you received a value for NextToken in the response from a previous // ListJournalS3Exports call, then you should use that value as input here. NextToken *string `location:"querystring" locationName:"next_token" min:"4" type:"string"` // contains filtered or unexported fields }
func (ListJournalS3ExportsInput) MarshalFields ¶
func (s ListJournalS3ExportsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListJournalS3ExportsInput) String ¶
func (s ListJournalS3ExportsInput) String() string
String returns the string representation
func (*ListJournalS3ExportsInput) Validate ¶
func (s *ListJournalS3ExportsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListJournalS3ExportsOutput ¶
type ListJournalS3ExportsOutput struct { // The array of journal export job descriptions for all ledgers that are associated // with the current AWS account and Region. JournalS3Exports []JournalS3ExportDescription `type:"list"` // * If NextToken is empty, then the last page of results has been processed // and there are no more results to be retrieved. // // * If NextToken is not empty, then there are more results available. To // retrieve the next page of results, use the value of NextToken in a subsequent // ListJournalS3Exports call. NextToken *string `min:"4" type:"string"` // contains filtered or unexported fields }
func (ListJournalS3ExportsOutput) MarshalFields ¶
func (s ListJournalS3ExportsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListJournalS3ExportsOutput) String ¶
func (s ListJournalS3ExportsOutput) String() string
String returns the string representation
type ListJournalS3ExportsPaginator ¶
ListJournalS3ExportsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListJournalS3ExportsPaginator ¶
func NewListJournalS3ExportsPaginator(req ListJournalS3ExportsRequest) ListJournalS3ExportsPaginator
NewListJournalS3ExportsRequestPaginator returns a paginator for ListJournalS3Exports. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListJournalS3ExportsRequest(input) p := qldb.NewListJournalS3ExportsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListJournalS3ExportsPaginator) CurrentPage ¶
func (p *ListJournalS3ExportsPaginator) CurrentPage() *ListJournalS3ExportsOutput
type ListJournalS3ExportsRequest ¶
type ListJournalS3ExportsRequest struct { *aws.Request Input *ListJournalS3ExportsInput Copy func(*ListJournalS3ExportsInput) ListJournalS3ExportsRequest }
ListJournalS3ExportsRequest is the request type for the ListJournalS3Exports API operation.
func (ListJournalS3ExportsRequest) Send ¶
func (r ListJournalS3ExportsRequest) Send(ctx context.Context) (*ListJournalS3ExportsResponse, error)
Send marshals and sends the ListJournalS3Exports API request.
type ListJournalS3ExportsResponse ¶
type ListJournalS3ExportsResponse struct { *ListJournalS3ExportsOutput // contains filtered or unexported fields }
ListJournalS3ExportsResponse is the response type for the ListJournalS3Exports API operation.
func (*ListJournalS3ExportsResponse) SDKResponseMetdata ¶
func (r *ListJournalS3ExportsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListJournalS3Exports request.
type ListLedgersInput ¶
type ListLedgersInput struct { // The maximum number of results to return in a single ListLedgers request. // (The actual number of results returned might be fewer.) MaxResults *int64 `location:"querystring" locationName:"max_results" min:"1" type:"integer"` // A pagination token, indicating that you want to retrieve the next page of // results. If you received a value for NextToken in the response from a previous // ListLedgers call, then you should use that value as input here. NextToken *string `location:"querystring" locationName:"next_token" min:"4" type:"string"` // contains filtered or unexported fields }
func (ListLedgersInput) MarshalFields ¶
func (s ListLedgersInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListLedgersInput) String ¶
func (s ListLedgersInput) String() string
String returns the string representation
func (*ListLedgersInput) Validate ¶
func (s *ListLedgersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListLedgersOutput ¶
type ListLedgersOutput struct { // The array of ledger summaries that are associated with the current AWS account // and Region. Ledgers []LedgerSummary `type:"list"` // A pagination token, indicating whether there are more results available: // // * If NextToken is empty, then the last page of results has been processed // and there are no more results to be retrieved. // // * If NextToken is not empty, then there are more results available. To // retrieve the next page of results, use the value of NextToken in a subsequent // ListLedgers call. NextToken *string `min:"4" type:"string"` // contains filtered or unexported fields }
func (ListLedgersOutput) MarshalFields ¶
func (s ListLedgersOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListLedgersOutput) String ¶
func (s ListLedgersOutput) String() string
String returns the string representation
type ListLedgersPaginator ¶
ListLedgersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListLedgersPaginator ¶
func NewListLedgersPaginator(req ListLedgersRequest) ListLedgersPaginator
NewListLedgersRequestPaginator returns a paginator for ListLedgers. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListLedgersRequest(input) p := qldb.NewListLedgersRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListLedgersPaginator) CurrentPage ¶
func (p *ListLedgersPaginator) CurrentPage() *ListLedgersOutput
type ListLedgersRequest ¶
type ListLedgersRequest struct { *aws.Request Input *ListLedgersInput Copy func(*ListLedgersInput) ListLedgersRequest }
ListLedgersRequest is the request type for the ListLedgers API operation.
func (ListLedgersRequest) Send ¶
func (r ListLedgersRequest) Send(ctx context.Context) (*ListLedgersResponse, error)
Send marshals and sends the ListLedgers API request.
type ListLedgersResponse ¶
type ListLedgersResponse struct { *ListLedgersOutput // contains filtered or unexported fields }
ListLedgersResponse is the response type for the ListLedgers API operation.
func (*ListLedgersResponse) SDKResponseMetdata ¶
func (r *ListLedgersResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListLedgers request.
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) for which you want to list the tags. For example: // // arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListTagsForResourceInput) MarshalFields ¶
func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListTagsForResourceInput) String ¶
func (s ListTagsForResourceInput) String() string
String returns the string representation
func (*ListTagsForResourceInput) Validate ¶
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The tags that are currently associated with the specified Amazon QLDB resource. Tags map[string]string `type:"map"` // contains filtered or unexported fields }
func (ListTagsForResourceOutput) MarshalFields ¶
func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListTagsForResourceOutput) String ¶
func (s ListTagsForResourceOutput) String() string
String returns the string representation
type ListTagsForResourceRequest ¶
type ListTagsForResourceRequest struct { *aws.Request Input *ListTagsForResourceInput Copy func(*ListTagsForResourceInput) ListTagsForResourceRequest }
ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.
func (ListTagsForResourceRequest) Send ¶
func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)
Send marshals and sends the ListTagsForResource API request.
type ListTagsForResourceResponse ¶
type ListTagsForResourceResponse struct { *ListTagsForResourceOutput // contains filtered or unexported fields }
ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.
func (*ListTagsForResourceResponse) SDKResponseMetdata ¶
func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListTagsForResource request.
type PermissionsMode ¶
type PermissionsMode string
const (
PermissionsModeAllowAll PermissionsMode = "ALLOW_ALL"
)
Enum values for PermissionsMode
func (PermissionsMode) MarshalValue ¶
func (enum PermissionsMode) MarshalValue() (string, error)
func (PermissionsMode) MarshalValueBuf ¶
func (enum PermissionsMode) MarshalValueBuf(b []byte) ([]byte, error)
type S3EncryptionConfiguration ¶
type S3EncryptionConfiguration struct { // The Amazon Resource Name (ARN) for a customer master key (CMK) in AWS Key // Management Service (AWS KMS). // // You must provide a KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType. // // KmsKeyArn is not required if you specify SSE_S3 as the ObjectEncryptionType. KmsKeyArn *string `min:"20" type:"string"` // The Amazon S3 object encryption type. // // To learn more about server-side encryption options in Amazon S3, see Protecting // Data Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) // in the Amazon S3 Developer Guide. // // ObjectEncryptionType is a required field ObjectEncryptionType S3ObjectEncryptionType `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
The encryption settings that are used by a journal export job to write data in an Amazon Simple Storage Service (Amazon S3) bucket.
func (S3EncryptionConfiguration) MarshalFields ¶
func (s S3EncryptionConfiguration) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (S3EncryptionConfiguration) String ¶
func (s S3EncryptionConfiguration) String() string
String returns the string representation
func (*S3EncryptionConfiguration) Validate ¶
func (s *S3EncryptionConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type S3ExportConfiguration ¶
type S3ExportConfiguration struct { // The Amazon S3 bucket name in which a journal export job writes the journal // contents. // // The bucket name must comply with the Amazon S3 bucket naming conventions. // For more information, see Bucket Restrictions and Limitations (https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html) // in the Amazon S3 Developer Guide. // // Bucket is a required field Bucket *string `min:"3" type:"string" required:"true"` // The encryption settings that are used by a journal export job to write data // in an Amazon S3 bucket. // // EncryptionConfiguration is a required field EncryptionConfiguration *S3EncryptionConfiguration `type:"structure" required:"true"` // The prefix for the Amazon S3 bucket in which a journal export job writes // the journal contents. // // The prefix must comply with Amazon S3 key naming rules and restrictions. // For more information, see Object Key and Metadata (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html) // in the Amazon S3 Developer Guide. // // The following are examples of valid Prefix values: // // * JournalExports-ForMyLedger/Testing/ // // * JournalExports // // * My:Tests/ // // Prefix is a required field Prefix *string `type:"string" required:"true"` // contains filtered or unexported fields }
The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.
func (S3ExportConfiguration) MarshalFields ¶
func (s S3ExportConfiguration) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (S3ExportConfiguration) String ¶
func (s S3ExportConfiguration) String() string
String returns the string representation
func (*S3ExportConfiguration) Validate ¶
func (s *S3ExportConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type S3ObjectEncryptionType ¶
type S3ObjectEncryptionType string
const ( S3ObjectEncryptionTypeSseKms S3ObjectEncryptionType = "SSE_KMS" S3ObjectEncryptionTypeSseS3 S3ObjectEncryptionType = "SSE_S3" S3ObjectEncryptionTypeNoEncryption S3ObjectEncryptionType = "NO_ENCRYPTION" )
Enum values for S3ObjectEncryptionType
func (S3ObjectEncryptionType) MarshalValue ¶
func (enum S3ObjectEncryptionType) MarshalValue() (string, error)
func (S3ObjectEncryptionType) MarshalValueBuf ¶
func (enum S3ObjectEncryptionType) MarshalValueBuf(b []byte) ([]byte, error)
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) to which you want to add the tags. For example: // // arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` // 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. // // Tags is a required field Tags map[string]string `type:"map" required:"true"` // contains filtered or unexported fields }
func (TagResourceInput) MarshalFields ¶
func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (TagResourceInput) String ¶
func (s TagResourceInput) String() string
String returns the string representation
func (*TagResourceInput) Validate ¶
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (TagResourceOutput) MarshalFields ¶
func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (TagResourceOutput) String ¶
func (s TagResourceOutput) String() string
String returns the string representation
type TagResourceRequest ¶
type TagResourceRequest struct { *aws.Request Input *TagResourceInput Copy func(*TagResourceInput) TagResourceRequest }
TagResourceRequest is the request type for the TagResource API operation.
func (TagResourceRequest) Send ¶
func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)
Send marshals and sends the TagResource API request.
type TagResourceResponse ¶
type TagResourceResponse struct { *TagResourceOutput // contains filtered or unexported fields }
TagResourceResponse is the response type for the TagResource API operation.
func (*TagResourceResponse) SDKResponseMetdata ¶
func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the TagResource request.
type UntagResourceInput ¶
type UntagResourceInput struct { // The Amazon Resource Name (ARN) from which you want to remove the tags. For // example: // // arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` // The list of tag keys that you want to remove. // // TagKeys is a required field TagKeys []string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"` // contains filtered or unexported fields }
func (UntagResourceInput) MarshalFields ¶
func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UntagResourceInput) String ¶
func (s UntagResourceInput) String() string
String returns the string representation
func (*UntagResourceInput) Validate ¶
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (UntagResourceOutput) MarshalFields ¶
func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UntagResourceOutput) String ¶
func (s UntagResourceOutput) String() string
String returns the string representation
type UntagResourceRequest ¶
type UntagResourceRequest struct { *aws.Request Input *UntagResourceInput Copy func(*UntagResourceInput) UntagResourceRequest }
UntagResourceRequest is the request type for the UntagResource API operation.
func (UntagResourceRequest) Send ¶
func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)
Send marshals and sends the UntagResource API request.
type UntagResourceResponse ¶
type UntagResourceResponse struct { *UntagResourceOutput // contains filtered or unexported fields }
UntagResourceResponse is the response type for the UntagResource API operation.
func (*UntagResourceResponse) SDKResponseMetdata ¶
func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UntagResource request.
type UpdateLedgerInput ¶
type UpdateLedgerInput struct { // 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. DeletionProtection *bool `type:"boolean"` // The name of the ledger. // // Name is a required field Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (UpdateLedgerInput) MarshalFields ¶
func (s UpdateLedgerInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateLedgerInput) String ¶
func (s UpdateLedgerInput) String() string
String returns the string representation
func (*UpdateLedgerInput) Validate ¶
func (s *UpdateLedgerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateLedgerOutput ¶
type UpdateLedgerOutput struct { // The Amazon Resource Name (ARN) for the ledger. Arn *string `min:"20" type:"string"` // The date and time, in epoch time format, when the ledger was created. (Epoch // time format is the number of seconds elapsed since 12:00:00 AM January 1, // 1970 UTC.) CreationDateTime *time.Time `type:"timestamp"` // 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. DeletionProtection *bool `type:"boolean"` // The name of the ledger. Name *string `min:"1" type:"string"` // The current status of the ledger. State LedgerState `type:"string" enum:"true"` // contains filtered or unexported fields }
func (UpdateLedgerOutput) MarshalFields ¶
func (s UpdateLedgerOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateLedgerOutput) String ¶
func (s UpdateLedgerOutput) String() string
String returns the string representation
type UpdateLedgerRequest ¶
type UpdateLedgerRequest struct { *aws.Request Input *UpdateLedgerInput Copy func(*UpdateLedgerInput) UpdateLedgerRequest }
UpdateLedgerRequest is the request type for the UpdateLedger API operation.
func (UpdateLedgerRequest) Send ¶
func (r UpdateLedgerRequest) Send(ctx context.Context) (*UpdateLedgerResponse, error)
Send marshals and sends the UpdateLedger API request.
type UpdateLedgerResponse ¶
type UpdateLedgerResponse struct { *UpdateLedgerOutput // contains filtered or unexported fields }
UpdateLedgerResponse is the response type for the UpdateLedger API operation.
func (*UpdateLedgerResponse) SDKResponseMetdata ¶
func (r *UpdateLedgerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateLedger request.
type ValueHolder ¶
type ValueHolder struct { // An Amazon Ion plaintext value contained in a ValueHolder structure. IonText *string `min:"1" type:"string" sensitive:"true"` // contains filtered or unexported fields }
A structure that can contain an Amazon Ion value in multiple encoding formats.
func (ValueHolder) MarshalFields ¶
func (s ValueHolder) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ValueHolder) String ¶
func (s ValueHolder) String() string
String returns the string representation
func (*ValueHolder) Validate ¶
func (s *ValueHolder) Validate() error
Validate inspects the fields of the type to determine if they are valid.
Source Files ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_CreateLedger.go
- api_op_DeleteLedger.go
- api_op_DescribeJournalS3Export.go
- api_op_DescribeLedger.go
- api_op_ExportJournalToS3.go
- api_op_GetBlock.go
- api_op_GetDigest.go
- api_op_GetRevision.go
- api_op_ListJournalS3Exports.go
- api_op_ListJournalS3ExportsForLedger.go
- api_op_ListLedgers.go
- api_op_ListTagsForResource.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateLedger.go
- api_types.go