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 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package redshiftdata
import (
"context"
"fmt"
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"
)
// Runs one or more SQL statements, which can be data manipulation language (DML)
// or data definition language (DDL). Depending on the authorization method, use
// one of the following combinations of request parameters:
// - Secrets Manager - when connecting to a cluster, provide the secret-arn of a
// secret stored in Secrets Manager which has username and password . The
// specified secret contains credentials to connect to the database you specify.
// When you are connecting to a cluster, you also supply the database name, If you
// provide a cluster identifier ( dbClusterIdentifier ), it must match the
// cluster identifier stored in the secret. When you are connecting to a serverless
// workgroup, you also supply the database name.
// - Temporary credentials - when connecting to your data warehouse, choose one
// of the following options:
// - When connecting to a serverless workgroup, specify the workgroup name and
// database name. The database user name is derived from the IAM identity. For
// example, arn:iam::123456789012:user:foo has the database user name IAM:foo .
// Also, permission to call the redshift-serverless:GetCredentials operation is
// required.
// - When connecting to a cluster as an IAM identity, specify the cluster
// identifier and the database name. The database user name is derived from the IAM
// identity. For example, arn:iam::123456789012:user:foo has the database user
// name IAM:foo . Also, permission to call the
// redshift:GetClusterCredentialsWithIAM operation is required.
// - When connecting to a cluster as a database user, specify the cluster
// identifier, the database name, and the database user name. Also, permission to
// call the redshift:GetClusterCredentials operation is required.
//
// For more information about the Amazon Redshift Data API and CLI usage examples,
// see Using the Amazon Redshift Data API (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html)
// in the Amazon Redshift Management Guide.
func (c *Client) BatchExecuteStatement(ctx context.Context, params *BatchExecuteStatementInput, optFns ...func(*Options)) (*BatchExecuteStatementOutput, error) {
if params == nil {
params = &BatchExecuteStatementInput{}
}
result, metadata, err := c.invokeOperation(ctx, "BatchExecuteStatement", params, optFns, c.addOperationBatchExecuteStatementMiddlewares)
if err != nil {
return nil, err
}
out := result.(*BatchExecuteStatementOutput)
out.ResultMetadata = metadata
return out, nil
}
type BatchExecuteStatementInput struct {
// The name of the database. This parameter is required when authenticating using
// either Secrets Manager or temporary credentials.
//
// This member is required.
Database *string
// One or more SQL statements to run. The SQL statements are run as a single
// transaction. They run serially in the order of the array. Subsequent SQL
// statements don't start until the previous statement in the array completes. If
// any SQL statement fails, then because they are run as one transaction, all work
// is rolled back.
//
// This member is required.
Sqls []string
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request.
ClientToken *string
// The cluster identifier. This parameter is required when connecting to a cluster
// and authenticating using either Secrets Manager or temporary credentials.
ClusterIdentifier *string
// The database user name. This parameter is required when connecting to a cluster
// as a database user and authenticating using temporary credentials.
DbUser *string
// The name or ARN of the secret that enables access to the database. This
// parameter is required when authenticating using Secrets Manager.
SecretArn *string
// The name of the SQL statements. You can name the SQL statements when you create
// them to identify the query.
StatementName *string
// A value that indicates whether to send an event to the Amazon EventBridge event
// bus after the SQL statements run.
WithEvent *bool
// The serverless workgroup name or Amazon Resource Name (ARN). This parameter is
// required when connecting to a serverless workgroup and authenticating using
// either Secrets Manager or temporary credentials.
WorkgroupName *string
noSmithyDocumentSerde
}
type BatchExecuteStatementOutput struct {
// The cluster identifier. This element is not returned when connecting to a
// serverless workgroup.
ClusterIdentifier *string
// The date and time (UTC) the statement was created.
CreatedAt *time.Time
// The name of the database.
Database *string
// The database user name.
DbUser *string
// The identifier of the SQL statement whose results are to be fetched. This value
// is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
// This identifier is returned by BatchExecuteStatment .
Id *string
// The name or ARN of the secret that enables access to the database.
SecretArn *string
// The serverless workgroup name or Amazon Resource Name (ARN). This element is
// not returned when connecting to a provisioned cluster.
WorkgroupName *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationBatchExecuteStatementMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpBatchExecuteStatement{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpBatchExecuteStatement{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "BatchExecuteStatement"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); 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 = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addIdempotencyToken_opBatchExecuteStatementMiddleware(stack, options); err != nil {
return err
}
if err = addOpBatchExecuteStatementValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opBatchExecuteStatement(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); 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
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
type idempotencyToken_initializeOpBatchExecuteStatement struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpBatchExecuteStatement) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpBatchExecuteStatement) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (
out middleware.InitializeOutput, metadata middleware.Metadata, err error,
) {
if m.tokenProvider == nil {
return next.HandleInitialize(ctx, in)
}
input, ok := in.Parameters.(*BatchExecuteStatementInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *BatchExecuteStatementInput ")
}
if input.ClientToken == nil {
t, err := m.tokenProvider.GetIdempotencyToken()
if err != nil {
return out, metadata, err
}
input.ClientToken = &t
}
return next.HandleInitialize(ctx, in)
}
func addIdempotencyToken_opBatchExecuteStatementMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpBatchExecuteStatement{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opBatchExecuteStatement(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "BatchExecuteStatement",
}
}
|