Class: Aws::RDSDataService::Types::BatchExecuteStatementRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb

Overview

Note:

When making an API call, you may pass BatchExecuteStatementRequest data as a hash:

{
  database: "DbName",
  parameter_sets: [
    [
      {
        name: "ParameterName",
        type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
        value: {
          array_value: {
            array_values: [
              {
                # recursive ArrayValue
              },
            ],
            boolean_values: [false],
            double_values: [1.0],
            long_values: [1],
            string_values: ["String"],
          },
          blob_value: "data",
          boolean_value: false,
          double_value: 1.0,
          is_null: false,
          long_value: 1,
          string_value: "String",
        },
      },
    ],
  ],
  resource_arn: "Arn", # required
  schema: "DbName",
  secret_arn: "Arn", # required
  sql: "SqlStatement", # required
  transaction_id: "Id",
}

The request parameters represent the input of a SQL statement over an array of data.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#databaseString

The name of the database.

Returns:

  • (String)


164
165
166
167
168
169
170
171
172
173
174
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 164

class BatchExecuteStatementRequest < Struct.new(
  :database,
  :parameter_sets,
  :resource_arn,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_setsArray<Array<Types::SqlParameter>>

The parameter set for the batch operation.

The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options:

  • Specify one or more empty parameter sets.

  • Use the ExecuteStatement operation instead of the BatchExecuteStatement operation.

Array parameters are not supported.

Returns:



164
165
166
167
168
169
170
171
172
173
174
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 164

class BatchExecuteStatementRequest < Struct.new(
  :database,
  :parameter_sets,
  :resource_arn,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arnString

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

Returns:

  • (String)


164
165
166
167
168
169
170
171
172
173
174
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 164

class BatchExecuteStatementRequest < Struct.new(
  :database,
  :parameter_sets,
  :resource_arn,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#schemaString

The name of the database schema.

Returns:

  • (String)


164
165
166
167
168
169
170
171
172
173
174
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 164

class BatchExecuteStatementRequest < Struct.new(
  :database,
  :parameter_sets,
  :resource_arn,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arnString

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

Returns:

  • (String)


164
165
166
167
168
169
170
171
172
173
174
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 164

class BatchExecuteStatementRequest < Struct.new(
  :database,
  :parameter_sets,
  :resource_arn,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#sqlString

The SQL statement to run.

Returns:

  • (String)


164
165
166
167
168
169
170
171
172
173
174
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 164

class BatchExecuteStatementRequest < Struct.new(
  :database,
  :parameter_sets,
  :resource_arn,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#transaction_idString

The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.

If the SQL statement is not part of a transaction, don't set this parameter.

Returns:

  • (String)


164
165
166
167
168
169
170
171
172
173
174
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 164

class BatchExecuteStatementRequest < Struct.new(
  :database,
  :parameter_sets,
  :resource_arn,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end