/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Athena::StartQueryExecution

NAME

Paws::Athena::StartQueryExecution - Arguments for method StartQueryExecution on Paws::Athena

DESCRIPTION

This class represents the parameters used for calling the method StartQueryExecution on the Amazon Athena service. Use the attributes of this class as arguments to method StartQueryExecution.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartQueryExecution.

SYNOPSIS

my $athena = Paws->service('Athena');
my $StartQueryExecutionOutput = $athena->StartQueryExecution(
  QueryString           => 'MyQueryString',
  ClientRequestToken    => 'MyIdempotencyToken',    # OPTIONAL
  QueryExecutionContext => {
    Catalog  => 'MyCatalogNameString',    # min: 1, max: 256; OPTIONAL
    Database => 'MyDatabaseString',       # min: 1, max: 255; OPTIONAL
  },    # OPTIONAL
  ResultConfiguration => {
    EncryptionConfiguration => {
      EncryptionOption => 'SSE_S3',      # values: SSE_S3, SSE_KMS, CSE_KMS
      KmsKey           => 'MyString',    # OPTIONAL
    },    # OPTIONAL
    OutputLocation => 'MyString',    # OPTIONAL
  },    # OPTIONAL
  WorkGroup => 'MyWorkGroupName',    # OPTIONAL
);

# Results:
my $QueryExecutionId = $StartQueryExecutionOutput->QueryExecutionId;

# Returns a L<Paws::Athena::StartQueryExecutionOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/athena/StartQueryExecution

ATTRIBUTES

ClientRequestToken => Str

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.

QueryExecutionContext => Paws::Athena::QueryExecutionContext

The database within which the query executes.

REQUIRED QueryString => Str

The SQL query statements to be executed.

ResultConfiguration => Paws::Athena::ResultConfiguration

Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

WorkGroup => Str

The name of the workgroup in which the query is being started.

SEE ALSO

This class forms part of Paws, documenting arguments for method StartQueryExecution in Paws::Athena

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues