Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RedshiftData.BatchExecuteStatement

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Synopsis

Creating a Request

data BatchExecuteStatement Source #

See: newBatchExecuteStatement smart constructor.

Constructors

BatchExecuteStatement'

Fields

dbUser :: Maybe Text
The database user name. This parameter is required when authenticating using temporary credentials.
statementName :: Maybe Text
The name of the SQL statements. You can name the SQL statements when you create them to identify the query.
secretArn :: Maybe Text
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
withEvent :: Maybe Bool
A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.
clusterIdentifier :: Text
The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
database :: Text
The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
sqls :: NonEmpty Text
One or more SQL statements to run.

Instances

Instances details

Eq BatchExecuteStatement Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Methods (==) :: BatchExecuteStatement -> BatchExecuteStatement -> Bool # (/=) :: BatchExecuteStatement -> BatchExecuteStatement -> Bool #
Read BatchExecuteStatement Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Methods readsPrec :: Int -> ReadS BatchExecuteStatement # readList :: ReadS [BatchExecuteStatement] # readPrec :: ReadPrec BatchExecuteStatement # readListPrec :: ReadPrec [BatchExecuteStatement] #
Show BatchExecuteStatement Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Methods showsPrec :: Int -> BatchExecuteStatement -> ShowS # show :: BatchExecuteStatement -> String # showList :: [BatchExecuteStatement] -> ShowS #
Generic BatchExecuteStatement Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Associated Types type Rep BatchExecuteStatement :: Type -> Type # Methods from :: BatchExecuteStatement -> Rep BatchExecuteStatement x # to :: Rep BatchExecuteStatement x -> BatchExecuteStatement #
NFData BatchExecuteStatement Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Methods rnf :: BatchExecuteStatement -> () #
Hashable BatchExecuteStatement Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Methods hashWithSalt :: Int -> BatchExecuteStatement -> Int # hash :: BatchExecuteStatement -> Int #
ToJSON BatchExecuteStatement Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Methods toJSON :: BatchExecuteStatement -> Value # toEncoding :: BatchExecuteStatement -> Encoding # toJSONList :: [BatchExecuteStatement] -> Value # toEncodingList :: [BatchExecuteStatement] -> Encoding #
AWSRequest BatchExecuteStatement Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Associated Types type AWSResponse BatchExecuteStatement # Methods request :: BatchExecuteStatement -> Request BatchExecuteStatement # response :: MonadResource m => Logger -> Service -> Proxy BatchExecuteStatement -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BatchExecuteStatement))) #
ToHeaders BatchExecuteStatement Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Methods toHeaders :: BatchExecuteStatement -> [Header] #
ToPath BatchExecuteStatement Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Methods toPath :: BatchExecuteStatement -> ByteString #
ToQuery BatchExecuteStatement Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Methods toQuery :: BatchExecuteStatement -> QueryString #
type Rep BatchExecuteStatement Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement type Rep BatchExecuteStatement = D1 ('MetaData "BatchExecuteStatement" "Amazonka.RedshiftData.BatchExecuteStatement" "libZSservicesZSamazonka-redshift-dataZSamazonka-redshift-data" 'False) (C1 ('MetaCons "BatchExecuteStatement'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "statementName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "withEvent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "database") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "sqls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))))
type AWSResponse BatchExecuteStatement Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement type AWSResponse BatchExecuteStatement = BatchExecuteStatementResponse

newBatchExecuteStatement Source #

Arguments

:: Text	`$sel:clusterIdentifier:BatchExecuteStatement'`
-> Text	`$sel:database:BatchExecuteStatement'`
-> NonEmpty Text	`$sel:sqls:BatchExecuteStatement'`
-> BatchExecuteStatement

Create a value of BatchExecuteStatement with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbUser:BatchExecuteStatement', batchExecuteStatement_dbUser - The database user name. This parameter is required when authenticating using temporary credentials.

$sel:statementName:BatchExecuteStatement', batchExecuteStatement_statementName - The name of the SQL statements. You can name the SQL statements when you create them to identify the query.

$sel:secretArn:BatchExecuteStatement', batchExecuteStatement_secretArn - The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

$sel:withEvent:BatchExecuteStatement', batchExecuteStatement_withEvent - A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.

$sel:clusterIdentifier:BatchExecuteStatement', batchExecuteStatement_clusterIdentifier - The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

$sel:database:BatchExecuteStatement', batchExecuteStatement_database - The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

$sel:sqls:BatchExecuteStatement', batchExecuteStatement_sqls - One or more SQL statements to run.

Request Lenses

batchExecuteStatement_dbUser :: Lens' BatchExecuteStatement (Maybe Text) Source #

The database user name. This parameter is required when authenticating using temporary credentials.

batchExecuteStatement_statementName :: Lens' BatchExecuteStatement (Maybe Text) Source #

The name of the SQL statements. You can name the SQL statements when you create them to identify the query.

batchExecuteStatement_secretArn :: Lens' BatchExecuteStatement (Maybe Text) Source #

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

batchExecuteStatement_withEvent :: Lens' BatchExecuteStatement (Maybe Bool) Source #

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.

batchExecuteStatement_clusterIdentifier :: Lens' BatchExecuteStatement Text Source #

The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

batchExecuteStatement_database :: Lens' BatchExecuteStatement Text Source #

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

batchExecuteStatement_sqls :: Lens' BatchExecuteStatement (NonEmpty Text) Source #

One or more SQL statements to run.

Destructuring the Response

data BatchExecuteStatementResponse Source #

See: newBatchExecuteStatementResponse smart constructor.

Constructors

BatchExecuteStatementResponse'

Fields

dbUser :: Maybe Text
The database user name.
database :: Maybe Text
The name of the database.
createdAt :: Maybe POSIX
The date and time (UTC) the statement was created.
clusterIdentifier :: Maybe Text
The cluster identifier.
id :: Maybe Text
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.
secretArn :: Maybe Text
The name or ARN of the secret that enables access to the database.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq BatchExecuteStatementResponse Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Methods (==) :: BatchExecuteStatementResponse -> BatchExecuteStatementResponse -> Bool # (/=) :: BatchExecuteStatementResponse -> BatchExecuteStatementResponse -> Bool #
Read BatchExecuteStatementResponse Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Methods readsPrec :: Int -> ReadS BatchExecuteStatementResponse # readList :: ReadS [BatchExecuteStatementResponse] # readPrec :: ReadPrec BatchExecuteStatementResponse # readListPrec :: ReadPrec [BatchExecuteStatementResponse] #
Show BatchExecuteStatementResponse Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Methods showsPrec :: Int -> BatchExecuteStatementResponse -> ShowS # show :: BatchExecuteStatementResponse -> String # showList :: [BatchExecuteStatementResponse] -> ShowS #
Generic BatchExecuteStatementResponse Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Associated Types type Rep BatchExecuteStatementResponse :: Type -> Type # Methods from :: BatchExecuteStatementResponse -> Rep BatchExecuteStatementResponse x # to :: Rep BatchExecuteStatementResponse x -> BatchExecuteStatementResponse #
NFData BatchExecuteStatementResponse Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement Methods rnf :: BatchExecuteStatementResponse -> () #
type Rep BatchExecuteStatementResponse Source #
Instance details Defined in Amazonka.RedshiftData.BatchExecuteStatement type Rep BatchExecuteStatementResponse = D1 ('MetaData "BatchExecuteStatementResponse" "Amazonka.RedshiftData.BatchExecuteStatement" "libZSservicesZSamazonka-redshift-dataZSamazonka-redshift-data" 'False) (C1 ('MetaCons "BatchExecuteStatementResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "database") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newBatchExecuteStatementResponse Source #

Arguments

:: Int	`$sel:httpStatus:BatchExecuteStatementResponse'`
-> BatchExecuteStatementResponse

Create a value of BatchExecuteStatementResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbUser:BatchExecuteStatement', batchExecuteStatementResponse_dbUser - The database user name.

$sel:database:BatchExecuteStatement', batchExecuteStatementResponse_database - The name of the database.

$sel:createdAt:BatchExecuteStatementResponse', batchExecuteStatementResponse_createdAt - The date and time (UTC) the statement was created.

$sel:clusterIdentifier:BatchExecuteStatement', batchExecuteStatementResponse_clusterIdentifier - The cluster identifier.

$sel:id:BatchExecuteStatementResponse', batchExecuteStatementResponse_id - 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.

$sel:secretArn:BatchExecuteStatement', batchExecuteStatementResponse_secretArn - The name or ARN of the secret that enables access to the database.

$sel:httpStatus:BatchExecuteStatementResponse', batchExecuteStatementResponse_httpStatus - The response's http status code.

Response Lenses

batchExecuteStatementResponse_dbUser :: Lens' BatchExecuteStatementResponse (Maybe Text) Source #

The database user name.

batchExecuteStatementResponse_database :: Lens' BatchExecuteStatementResponse (Maybe Text) Source #

The name of the database.

batchExecuteStatementResponse_createdAt :: Lens' BatchExecuteStatementResponse (Maybe UTCTime) Source #

The date and time (UTC) the statement was created.

batchExecuteStatementResponse_clusterIdentifier :: Lens' BatchExecuteStatementResponse (Maybe Text) Source #

The cluster identifier.

batchExecuteStatementResponse_id :: Lens' BatchExecuteStatementResponse (Maybe Text) Source #

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.

batchExecuteStatementResponse_secretArn :: Lens' BatchExecuteStatementResponse (Maybe Text) Source #

The name or ARN of the secret that enables access to the database.

batchExecuteStatementResponse_httpStatus :: Lens' BatchExecuteStatementResponse Int Source #

The response's http status code.