1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package rds
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Cancels an export task in progress that is exporting a snapshot to Amazon S3.
// Any data that has already been written to the S3 bucket isn't removed.
func (c *Client) CancelExportTask(ctx context.Context, params *CancelExportTaskInput, optFns ...func(*Options)) (*CancelExportTaskOutput, error) {
if params == nil {
params = &CancelExportTaskInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CancelExportTask", params, optFns, c.addOperationCancelExportTaskMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CancelExportTaskOutput)
out.ResultMetadata = metadata
return out, nil
}
type CancelExportTaskInput struct {
// The identifier of the snapshot export task to cancel.
//
// This member is required.
ExportTaskIdentifier *string
noSmithyDocumentSerde
}
// Contains the details of a snapshot export to Amazon S3. This data type is used
// as a response element in the DescribeExportTasks action.
type CancelExportTaskOutput struct {
// The data exported from the snapshot. Valid values are the following:
//
// * database
// - Export all the data from a specified database.
//
// * database.table table-name -
// Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS
// for MariaDB, and Aurora MySQL.
//
// * database.schema schema-name - Export a
// database schema of the snapshot. This format is valid only for RDS for
// PostgreSQL and Aurora PostgreSQL.
//
// * database.schema.table table-name - Export a
// table of the database schema. This format is valid only for RDS for PostgreSQL
// and Aurora PostgreSQL.
ExportOnly []string
// A unique identifier for the snapshot export task. This ID isn't an identifier
// for the Amazon S3 bucket where the snapshot is exported to.
ExportTaskIdentifier *string
// The reason the export failed, if it failed.
FailureCause *string
// The name of the IAM role that is used to write to Amazon S3 when exporting a
// snapshot.
IamRoleArn *string
// The key identifier of the Amazon Web Services KMS key that is used to encrypt
// the snapshot when it's exported to Amazon S3. The KMS key identifier is its key
// ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export
// must have encryption and decryption permissions to use this KMS key.
KmsKeyId *string
// The progress of the snapshot export task as a percentage.
PercentProgress int32
// The Amazon S3 bucket that the snapshot is exported to.
S3Bucket *string
// The Amazon S3 bucket prefix that is the file name and path of the exported
// snapshot.
S3Prefix *string
// The time that the snapshot was created.
SnapshotTime *time.Time
// The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
SourceArn *string
// The progress status of the export task.
Status *string
// The time that the snapshot export task completed.
TaskEndTime *time.Time
// The time that the snapshot export task started.
TaskStartTime *time.Time
// The total amount of data exported, in gigabytes.
TotalExtractedDataInGB int32
// A warning about the snapshot export task.
WarningMessage *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCancelExportTaskMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpCancelExportTask{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpCancelExportTask{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpCancelExportTaskValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCancelExportTask(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCancelExportTask(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "rds",
OperationName: "CancelExportTask",
}
}
|