Class: AWS.Athena

var params = {
  PreparedStatementNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  WorkGroup: 'STRING_VALUE' /* required */
};
athena.batchGetPreparedStatement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • PreparedStatementNames — (Array<String>)

    A list of prepared statement names to return.

  • WorkGroup — (String)

    The name of the workgroup to which the prepared statements belong.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • PreparedStatements — (Array<map>)

      The list of prepared statements returned.

      • StatementName — (String)

        The name of the prepared statement.

      • QueryStatement — (String)

        The query string for the prepared statement.

      • WorkGroupName — (String)

        The name of the workgroup to which the prepared statement belongs.

      • Description — (String)

        The description of the prepared statement.

      • LastModifiedTime — (Date)

        The last modified time of the prepared statement.

    • UnprocessedPreparedStatementNames — (Array<map>)

      A list of one or more prepared statements that were requested but could not be returned.

      • StatementName — (String)

        The name of a prepared statement that could not be returned due to an error.

      • ErrorCode — (String)

        The error code returned when the request for the prepared statement failed.

      • ErrorMessage — (String)

        The error message containing the reason why the prepared statement could not be returned. The following error messages are possible:

        • INVALID_INPUT - The name of the prepared statement that was provided is not valid (for example, the name is too long).

        • STATEMENT_NOT_FOUND - A prepared statement with the name provided could not be found.

        • UNAUTHORIZED - The requester does not have permission to access the workgroup that contains the prepared statement.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  QueryExecutionIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
athena.batchGetQueryExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • QueryExecutionIds — (Array<String>)

    An array of query execution IDs.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • QueryExecutions — (Array<map>)

      Information about a query execution.

      • QueryExecutionId — (String)

        The unique identifier for each query execution.

      • Query — (String)

        The SQL query statements which the query execution ran.

      • StatementType — (String)

        The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, or DESCRIBE TABLE.

        Possible values include:
        • "DDL"
        • "DML"
        • "UTILITY"
      • ResultConfiguration — (map)

        The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.

        • OutputLocation — (String)

          The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

        • EncryptionConfiguration — (map)

          If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

          • EncryptionOption — required — (String)

            Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used.

            If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

            Possible values include:
            • "SSE_S3"
            • "SSE_KMS"
            • "CSE_KMS"
          • KmsKey — (String)

            For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

        • ExpectedBucketOwner — (String)

          The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

          This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

        • AclConfiguration — (map)

          Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

          • S3AclOption — required — (String)

            The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide.

            Possible values include:
            • "BUCKET_OWNER_FULL_CONTROL"
      • ResultReuseConfiguration — (map)

        Specifies the query result reuse behavior that was used for the query.

        • ResultReuseByAgeConfiguration — (map)

          Specifies whether previous query results are reused, and if so, their maximum age.

          • Enabled — required — (Boolean)

            True if previous query results can be reused when the query is run; otherwise, false. The default is false.

          • MaxAgeInMinutes — (Integer)

            Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse. The default is 60.

      • QueryExecutionContext — (map)

        The database in which the query execution occurred.

        • Database — (String)

          The name of the database used in the query execution. The database must exist in the catalog.

        • Catalog — (String)

          The name of the data catalog used in the query execution.

      • Status — (map)

        The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

        • State — (String)

          The state of query execution. QUEUED indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. RUNNING indicates that the query is in execution phase. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution.

          Note: Athena automatically retries your queries in cases of certain transient errors. As a result, you may see the query state transition from RUNNING or FAILED to QUEUED.
          Possible values include:
          • "QUEUED"
          • "RUNNING"
          • "SUCCEEDED"
          • "FAILED"
          • "CANCELLED"
        • StateChangeReason — (String)

          Further detail about the status of the query.

        • SubmissionDateTime — (Date)

          The date and time that the query was submitted.

        • CompletionDateTime — (Date)

          The date and time that the query completed.

        • AthenaError — (map)

          Provides information about an Athena query error.

          • ErrorCategory — (Integer)

            An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.

            1 - System

            2 - User

            3 - Other

          • ErrorType — (Integer)

            An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User Guide.

          • Retryable — (Boolean)

            True if the query might succeed if resubmitted.

          • ErrorMessage — (String)

            Contains a short description of the error that occurred.

      • Statistics — (map)

        Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.

        • EngineExecutionTimeInMillis — (Integer)

          The number of milliseconds that the query took to execute.

        • DataScannedInBytes — (Integer)

          The number of bytes in the data that was queried.

        • DataManifestLocation — (String)

          The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.

        • TotalExecutionTimeInMillis — (Integer)

          The number of milliseconds that Athena took to run the query.

        • QueryQueueTimeInMillis — (Integer)

          The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.

        • ServicePreProcessingTimeInMillis — (Integer)

          The number of milliseconds that Athena took to preprocess the query before submitting the query to the query engine.

        • QueryPlanningTimeInMillis — (Integer)

          The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.

        • ServiceProcessingTimeInMillis — (Integer)

          The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

        • ResultReuseInformation — (map)

          Contains information about whether previous query results were reused for the query.

          • ReusedPreviousResult — required — (Boolean)

            True if a previous query result was reused; false if the result was generated from a new run of the query.

      • WorkGroup — (String)

        The name of the workgroup in which the query ran.

      • EngineVersion — (map)

        The engine version that executed the query.

        • SelectedEngineVersion — (String)

          The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including AUTO. The default is AUTO.

        • EffectiveEngineVersion — (String)

          Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.

      • ExecutionParameters — (Array<String>)

        A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur. The list of parameters is not returned in the response.

      • SubstatementType — (String)

        The kind of query statement that was run.

      • QueryResultsS3AccessGrantsConfiguration — (map)

        Specifies whether Amazon S3 access grants are enabled for query results.

        • EnableS3AccessGrants — required — (Boolean)

          Specifies whether Amazon S3 access grants are enabled for query results.

        • CreateUserLevelPrefix — (Boolean)

          When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.

        • AuthenticationType — required — (String)

          The authentication type used for Amazon S3 access grants. Currently, only DIRECTORY_IDENTITY is supported.

          Possible values include:
          • "DIRECTORY_IDENTITY"
    • UnprocessedQueryExecutionIds — (Array<map>)

      Information about the query executions that failed to run.

      • QueryExecutionId — (String)

        The unique identifier of the query execution.

      • ErrorCode — (String)

        The error code returned when the query execution failed to process, if applicable.

      • ErrorMessage — (String)

        The error message returned when the query execution failed to process, if applicable.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
athena.cancelCapacityReservation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the capacity reservation to cancel.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  TargetDpus: 'NUMBER_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
athena.createCapacityReservation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TargetDpus — (Integer)

    The number of requested data processing units.

  • Name — (String)

    The name of the capacity reservation to create.

  • Tags — (Array<map>)

    The tags for the capacity reservation.

    • Key — (String)

      A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource.

    • Value — (String)

      A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  Type: LAMBDA | GLUE | HIVE, /* required */
  Description: 'STRING_VALUE',
  Parameters: {
    '<KeyString>': 'STRING_VALUE',
    /* '<KeyString>': ... */
  },
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
athena.createDataCatalog(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

  • Type — (String)

    The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

    Possible values include:
    • "LAMBDA"
    • "GLUE"
    • "HIVE"
  • Description — (String)

    A description of the data catalog to be created.

  • Parameters — (map<String>)

    Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.

    • For the HIVE data catalog type, use the following syntax. The metadata-function parameter is required. The sdk-version parameter is optional and defaults to the currently supported version.

      metadata-function=lambda_arn, sdk-version=version_number

    • For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both.

      • If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.

        metadata-function=lambda_arn, record-function=lambda_arn

      • If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.

        function=lambda_arn

    • The GLUE type takes a catalog ID parameter and is required. The catalog_id is the account ID of the Amazon Web Services account to which the Glue Data Catalog belongs.

      catalog-id=catalog_id

      • The GLUE data catalog type also applies to the default AwsDataCatalog that already exists in your account, of which you can have only one and cannot modify.

  • Tags — (Array<map>)

    A list of comma separated tags to add to the data catalog that is created.

    • Key — (String)

      A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource.

    • Value — (String)

      A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Database: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  QueryString: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  WorkGroup: 'STRING_VALUE'
};
athena.createNamedQuery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The query name.

  • Description — (String)

    The query description.

  • Database — (String)

    The database to which the query belongs.

  • QueryString — (String)

    The contents of the query with all query statements.

  • ClientRequestToken — (String)

    A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another CreateNamedQuery 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 Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

    If a token is not provided, the SDK will use a version 4 UUID.
  • WorkGroup — (String)

    The name of the workgroup in which the named query is being created.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NamedQueryId — (String)

      The unique ID of the query.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  WorkGroup: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE'
};
athena.createNotebook(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkGroup — (String)

    The name of the Spark enabled workgroup in which the notebook will be created.

  • Name — (String)

    The name of the ipynb file to be created in the Spark workgroup, without the .ipynb extension.

  • ClientRequestToken — (String)

    A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NotebookId — (String)

      A unique identifier for the notebook.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  QueryStatement: 'STRING_VALUE', /* required */
  StatementName: 'STRING_VALUE', /* required */
  WorkGroup: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE'
};
athena.createPreparedStatement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StatementName — (String)

    The name of the prepared statement.

  • WorkGroup — (String)

    The name of the workgroup to which the prepared statement belongs.

  • QueryStatement — (String)

    The query string for the prepared statement.

  • Description — (String)

    The description of the prepared statement.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  SessionId: 'STRING_VALUE' /* required */
};
athena.createPresignedNotebookUrl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SessionId — (String)

    The session ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NotebookUrl — (String)

      The URL of the notebook. The URL includes the authentication token and notebook file name and points directly to the opened notebook.

    • AuthToken — (String)

      The authentication token for the notebook.

    • AuthTokenExpirationTime — (Integer)

      The UTC epoch time when the authentication token expires.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  Configuration: {
    AdditionalConfiguration: 'STRING_VALUE',
    BytesScannedCutoffPerQuery: 'NUMBER_VALUE',
    CustomerContentEncryptionConfiguration: {
      KmsKey: 'STRING_VALUE' /* required */
    },
    EnableMinimumEncryptionConfiguration: true || false,
    EnforceWorkGroupConfiguration: true || false,
    EngineVersion: {
      EffectiveEngineVersion: 'STRING_VALUE',
      SelectedEngineVersion: 'STRING_VALUE'
    },
    ExecutionRole: 'STRING_VALUE',
    IdentityCenterConfiguration: {
      EnableIdentityCenter: true || false,
      IdentityCenterInstanceArn: 'STRING_VALUE'
    },
    PublishCloudWatchMetricsEnabled: true || false,
    QueryResultsS3AccessGrantsConfiguration: {
      AuthenticationType: DIRECTORY_IDENTITY, /* required */
      EnableS3AccessGrants: true || false, /* required */
      CreateUserLevelPrefix: true || false
    },
    RequesterPaysEnabled: true || false,
    ResultConfiguration: {
      AclConfiguration: {
        S3AclOption: BUCKET_OWNER_FULL_CONTROL /* required */
      },
      EncryptionConfiguration: {
        EncryptionOption: SSE_S3 | SSE_KMS | CSE_KMS, /* required */
        KmsKey: 'STRING_VALUE'
      },
      ExpectedBucketOwner: 'STRING_VALUE',
      OutputLocation: 'STRING_VALUE'
    }
  },
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
athena.createWorkGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The workgroup name.

  • Configuration — (map)

    Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

    • ResultConfiguration — (map)

      The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided.

      • OutputLocation — (String)

        The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

      • EncryptionConfiguration — (map)

        If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

        • EncryptionOption — required — (String)

          Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used.

          If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

          Possible values include:
          • "SSE_S3"
          • "SSE_KMS"
          • "CSE_KMS"
        • KmsKey — (String)

          For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

      • ExpectedBucketOwner — (String)

        The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

        This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

      • AclConfiguration — (map)

        Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

        • S3AclOption — required — (String)

          The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide.

          Possible values include:
          • "BUCKET_OWNER_FULL_CONTROL"
    • EnforceWorkGroupConfiguration — (Boolean)

      If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

    • PublishCloudWatchMetricsEnabled — (Boolean)

      Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

    • BytesScannedCutoffPerQuery — (Integer)

      The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

    • RequesterPaysEnabled — (Boolean)

      If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

    • EngineVersion — (map)

      The engine version that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

      • SelectedEngineVersion — (String)

        The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including AUTO. The default is AUTO.

      • EffectiveEngineVersion — (String)

        Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.

    • AdditionalConfiguration — (String)

      Specifies a user defined JSON string that is passed to the notebook engine.

    • ExecutionRole — (String)

      The ARN of the execution role used to access user resources for Spark sessions and IAM Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and IAM Identity Center enabled workgroups. The property is required for IAM Identity Center enabled workgroups.

    • CustomerContentEncryptionConfiguration — (map)

      Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.

      • KmsKey — required — (String)

        The customer managed KMS key that is used to encrypt the user's data stores in Athena.

    • EnableMinimumEncryptionConfiguration — (Boolean)

      Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries.

      The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

    • IdentityCenterConfiguration — (map)

      Specifies whether the workgroup is IAM Identity Center supported.

      • EnableIdentityCenter — (Boolean)

        Specifies whether the workgroup is IAM Identity Center supported.

      • IdentityCenterInstanceArn — (String)

        The IAM Identity Center instance ARN that the workgroup associates to.

    • QueryResultsS3AccessGrantsConfiguration — (map)

      Specifies whether Amazon S3 access grants are enabled for query results.

      • EnableS3AccessGrants — required — (Boolean)

        Specifies whether Amazon S3 access grants are enabled for query results.

      • CreateUserLevelPrefix — (Boolean)

        When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.

      • AuthenticationType — required — (String)

        The authentication type used for Amazon S3 access grants. Currently, only DIRECTORY_IDENTITY is supported.

        Possible values include:
        • "DIRECTORY_IDENTITY"
  • Description — (String)

    The workgroup description.

  • Tags — (Array<map>)

    A list of comma separated tags to add to the workgroup that is created.

    • Key — (String)

      A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource.

    • Value — (String)

      A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
athena.deleteCapacityReservation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the capacity reservation to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
athena.deleteDataCatalog(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the data catalog to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  NamedQueryId: 'STRING_VALUE' /* required */
};
athena.deleteNamedQuery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NamedQueryId — (String)

    The unique ID of the query to delete.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  NotebookId: 'STRING_VALUE' /* required */
};
athena.deleteNotebook(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NotebookId — (String)

    The ID of the notebook to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  StatementName: 'STRING_VALUE', /* required */
  WorkGroup: 'STRING_VALUE' /* required */
};
athena.deletePreparedStatement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StatementName — (String)

    The name of the prepared statement to delete.

  • WorkGroup — (String)

    The workgroup to which the statement to be deleted belongs.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  WorkGroup: 'STRING_VALUE', /* required */
  RecursiveDeleteOption: true || false
};
athena.deleteWorkGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkGroup — (String)

    The unique name of the workgroup to delete.

  • RecursiveDeleteOption — (Boolean)

    The option to delete the workgroup and its contents even if the workgroup contains any named queries, query executions, or notebooks.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  NotebookId: 'STRING_VALUE' /* required */
};
athena.exportNotebook(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NotebookId — (String)

    The ID of the notebook to export.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NotebookMetadata — (map)

      The notebook metadata, including notebook ID, notebook name, and workgroup name.

      • NotebookId — (String)

        The notebook ID.

      • Name — (String)

        The name of the notebook.

      • WorkGroup — (String)

        The name of the Spark enabled workgroup to which the notebook belongs.

      • CreationTime — (Date)

        The time when the notebook was created.

      • Type — (String)

        The type of notebook. Currently, the only valid type is IPYNB.

        Possible values include:
        • "IPYNB"
      • LastModifiedTime — (Date)

        The time when the notebook was last modified.

    • Payload — (String)

      The content of the exported notebook.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CalculationExecutionId: 'STRING_VALUE' /* required */
};
athena.getCalculationExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • CalculationExecutionId — (String)

    The calculation execution UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CalculationExecutionId — (String)

      The calculation execution UUID.

    • SessionId — (String)

      The session ID that the calculation ran in.

    • Description — (String)

      The description of the calculation execution.

    • WorkingDirectory — (String)

      The Amazon S3 location in which calculation results are stored.

    • Status — (map)

      Contains information about the status of the calculation.

      • SubmissionDateTime — (Date)

        The date and time the calculation was submitted for processing.

      • CompletionDateTime — (Date)

        The date and time the calculation completed processing.

      • State — (String)

        The state of the calculation execution. A description of each state follows.

        CREATING - The calculation is in the process of being created.

        CREATED - The calculation has been created and is ready to run.

        QUEUED - The calculation has been queued for processing.

        RUNNING - The calculation is running.

        CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

        CANCELED - The calculation is no longer running as the result of a cancel request.

        COMPLETED - The calculation has completed without error.

        FAILED - The calculation failed and is no longer running.

        Possible values include:
        • "CREATING"
        • "CREATED"
        • "QUEUED"
        • "RUNNING"
        • "CANCELING"
        • "CANCELED"
        • "COMPLETED"
        • "FAILED"
      • StateChangeReason — (String)

        The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).

    • Statistics — (map)

      Contains information about the data processing unit (DPU) execution time and progress. This field is populated only when statistics are available.

      • DpuExecutionInMillis — (Integer)

        The data processing unit execution time in milliseconds for the calculation.

      • Progress — (String)

        The progress of the calculation.

    • Result — (map)

      Contains result information. This field is populated only if the calculation is completed.

      • StdOutS3Uri — (String)

        The Amazon S3 location of the stdout file for the calculation.

      • StdErrorS3Uri — (String)

        The Amazon S3 location of the stderr error messages file for the calculation.

      • ResultS3Uri — (String)

        The Amazon S3 location of the folder for the calculation results.

      • ResultType — (String)

        The data format of the calculation result.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CalculationExecutionId: 'STRING_VALUE' /* required */
};
athena.getCalculationExecutionCode(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • CalculationExecutionId — (String)

    The calculation execution UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CodeBlock — (String)

      The unencrypted code that was executed for the calculation.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CalculationExecutionId: 'STRING_VALUE' /* required */
};
athena.getCalculationExecutionStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • CalculationExecutionId — (String)

    The calculation execution UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Status — (map)

      Contains information about the calculation execution status.

      • SubmissionDateTime — (Date)

        The date and time the calculation was submitted for processing.

      • CompletionDateTime — (Date)

        The date and time the calculation completed processing.

      • State — (String)

        The state of the calculation execution. A description of each state follows.

        CREATING - The calculation is in the process of being created.

        CREATED - The calculation has been created and is ready to run.

        QUEUED - The calculation has been queued for processing.

        RUNNING - The calculation is running.

        CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

        CANCELED - The calculation is no longer running as the result of a cancel request.

        COMPLETED - The calculation has completed without error.

        FAILED - The calculation failed and is no longer running.

        Possible values include:
        • "CREATING"
        • "CREATED"
        • "QUEUED"
        • "RUNNING"
        • "CANCELING"
        • "CANCELED"
        • "COMPLETED"
        • "FAILED"
      • StateChangeReason — (String)

        The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).

    • Statistics — (map)

      Contains information about the DPU execution time and progress.

      • DpuExecutionInMillis — (Integer)

        The data processing unit execution time in milliseconds for the calculation.

      • Progress — (String)

        The progress of the calculation.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CapacityReservationName: 'STRING_VALUE' /* required */
};
athena.getCapacityAssignmentConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • CapacityReservationName — (String)

    The name of the capacity reservation to retrieve the capacity assignment configuration for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CapacityAssignmentConfiguration — (map)

      The requested capacity assignment configuration for the specified capacity reservation.

      • CapacityReservationName — (String)

        The name of the reservation that the capacity assignment configuration is for.

      • CapacityAssignments — (Array<map>)

        The list of assignments that make up the capacity assignment configuration.

        • WorkGroupNames — (Array<String>)

          The list of workgroup names for the capacity assignment.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
athena.getCapacityReservation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the capacity reservation.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CapacityReservation — (map)

      The requested capacity reservation structure.

      • Name — required — (String)

        The name of the capacity reservation.

      • Status — required — (String)

        The status of the capacity reservation.

        Possible values include:
        • "PENDING"
        • "ACTIVE"
        • "CANCELLING"
        • "CANCELLED"
        • "FAILED"
        • "UPDATE_PENDING"
      • TargetDpus — required — (Integer)

        The number of data processing units requested.

      • AllocatedDpus — required — (Integer)

        The number of data processing units currently allocated.

      • LastAllocation — (map)

        Contains the submission time of a single allocation request for a capacity reservation and the most recent status of the attempted allocation.

        • Status — required — (String)

          The status of the capacity allocation.

          Possible values include:
          • "PENDING"
          • "SUCCEEDED"
          • "FAILED"
        • StatusMessage — (String)

          The status message of the capacity allocation.

        • RequestTime — required — (Date)

          The time when the capacity allocation was requested.

        • RequestCompletionTime — (Date)

          The time when the capacity allocation request was completed.

      • LastSuccessfulAllocationTime — (Date)

        The time of the most recent capacity allocation that succeeded.

      • CreationTime — required — (Date)

        The time in UTC epoch millis when the capacity reservation was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CatalogName: 'STRING_VALUE', /* required */
  DatabaseName: 'STRING_VALUE', /* required */
  WorkGroup: 'STRING_VALUE'
};
athena.getDatabase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • CatalogName — (String)

    The name of the data catalog that contains the database to return.

  • DatabaseName — (String)

    The name of the database to return.

  • WorkGroup — (String)

    The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Database — (map)

      The database returned.

      • Name — required — (String)

        The name of the database.

      • Description — (String)

        An optional description of the database.

      • Parameters — (map<String>)

        A set of custom key/value pairs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  WorkGroup: 'STRING_VALUE'
};
athena.getDataCatalog(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the data catalog to return.

  • WorkGroup — (String)

    The name of the workgroup. Required if making an IAM Identity Center request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DataCatalog — (map)

      The data catalog returned.

      • Name — required — (String)

        The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

      • Description — (String)

        An optional description of the data catalog.

      • Type — required — (String)

        The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

        Possible values include:
        • "LAMBDA"
        • "GLUE"
        • "HIVE"
      • Parameters — (map<String>)

        Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type.

        • For the HIVE data catalog type, use the following syntax. The metadata-function parameter is required. The sdk-version parameter is optional and defaults to the currently supported version.

          metadata-function=lambda_arn, sdk-version=version_number

        • For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both.

          • If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.

            metadata-function=lambda_arn, record-function=lambda_arn

          • If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.

            function=lambda_arn

        • The GLUE type takes a catalog ID parameter and is required. The catalog_id is the account ID of the Amazon Web Services account to which the Glue catalog belongs.

          catalog-id=catalog_id

          • The GLUE data catalog type also applies to the default AwsDataCatalog that already exists in your account, of which you can have only one and cannot modify.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  NamedQueryId: 'STRING_VALUE' /* required */
};
athena.getNamedQuery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NamedQueryId — (String)

    The unique ID of the query. Use ListNamedQueries to get query IDs.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NamedQuery — (map)

      Information about the query.

      • Name — required — (String)

        The query name.

      • Description — (String)

        The query description.

      • Database — required — (String)

        The database to which the query belongs.

      • QueryString — required — (String)

        The SQL statements that make up the query.

      • NamedQueryId — (String)

        The unique identifier of the query.

      • WorkGroup — (String)

        The name of the workgroup that contains the named query.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  NotebookId: 'STRING_VALUE' /* required */
};
athena.getNotebookMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NotebookId — (String)

    The ID of the notebook whose metadata is to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NotebookMetadata — (map)

      The metadata that is returned for the specified notebook ID.

      • NotebookId — (String)

        The notebook ID.

      • Name — (String)

        The name of the notebook.

      • WorkGroup — (String)

        The name of the Spark enabled workgroup to which the notebook belongs.

      • CreationTime — (Date)

        The time when the notebook was created.

      • Type — (String)

        The type of notebook. Currently, the only valid type is IPYNB.

        Possible values include:
        • "IPYNB"
      • LastModifiedTime — (Date)

        The time when the notebook was last modified.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  StatementName: 'STRING_VALUE', /* required */
  WorkGroup: 'STRING_VALUE' /* required */
};
athena.getPreparedStatement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StatementName — (String)

    The name of the prepared statement to retrieve.

  • WorkGroup — (String)

    The workgroup to which the statement to be retrieved belongs.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • PreparedStatement — (map)

      The name of the prepared statement that was retrieved.

      • StatementName — (String)

        The name of the prepared statement.

      • QueryStatement — (String)

        The query string for the prepared statement.

      • WorkGroupName — (String)

        The name of the workgroup to which the prepared statement belongs.

      • Description — (String)

        The description of the prepared statement.

      • LastModifiedTime — (Date)

        The last modified time of the prepared statement.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  QueryExecutionId: 'STRING_VALUE' /* required */
};
athena.getQueryExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • QueryExecutionId — (String)

    The unique ID of the query execution.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • QueryExecution — (map)

      Information about the query execution.

      • QueryExecutionId — (String)

        The unique identifier for each query execution.

      • Query — (String)

        The SQL query statements which the query execution ran.

      • StatementType — (String)

        The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, or DESCRIBE TABLE.

        Possible values include:
        • "DDL"
        • "DML"
        • "UTILITY"
      • ResultConfiguration — (map)

        The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.

        • OutputLocation — (String)

          The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

        • EncryptionConfiguration — (map)

          If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

          • EncryptionOption — required — (String)

            Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used.

            If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

            Possible values include:
            • "SSE_S3"
            • "SSE_KMS"
            • "CSE_KMS"
          • KmsKey — (String)

            For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

        • ExpectedBucketOwner — (String)

          The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

          This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

        • AclConfiguration — (map)

          Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

          • S3AclOption — required — (String)

            The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide.

            Possible values include:
            • "BUCKET_OWNER_FULL_CONTROL"
      • ResultReuseConfiguration — (map)

        Specifies the query result reuse behavior that was used for the query.

        • ResultReuseByAgeConfiguration — (map)

          Specifies whether previous query results are reused, and if so, their maximum age.

          • Enabled — required — (Boolean)

            True if previous query results can be reused when the query is run; otherwise, false. The default is false.

          • MaxAgeInMinutes — (Integer)

            Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse. The default is 60.

      • QueryExecutionContext — (map)

        The database in which the query execution occurred.

        • Database — (String)

          The name of the database used in the query execution. The database must exist in the catalog.

        • Catalog — (String)

          The name of the data catalog used in the query execution.

      • Status — (map)

        The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

        • State — (String)

          The state of query execution. QUEUED indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. RUNNING indicates that the query is in execution phase. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution.

          Note: Athena automatically retries your queries in cases of certain transient errors. As a result, you may see the query state transition from RUNNING or FAILED to QUEUED.
          Possible values include:
          • "QUEUED"
          • "RUNNING"
          • "SUCCEEDED"
          • "FAILED"
          • "CANCELLED"
        • StateChangeReason — (String)

          Further detail about the status of the query.

        • SubmissionDateTime — (Date)

          The date and time that the query was submitted.

        • CompletionDateTime — (Date)

          The date and time that the query completed.

        • AthenaError — (map)

          Provides information about an Athena query error.

          • ErrorCategory — (Integer)

            An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.

            1 - System

            2 - User

            3 - Other

          • ErrorType — (Integer)

            An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User Guide.

          • Retryable — (Boolean)

            True if the query might succeed if resubmitted.

          • ErrorMessage — (String)

            Contains a short description of the error that occurred.

      • Statistics — (map)

        Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.

        • EngineExecutionTimeInMillis — (Integer)

          The number of milliseconds that the query took to execute.

        • DataScannedInBytes — (Integer)

          The number of bytes in the data that was queried.

        • DataManifestLocation — (String)

          The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.

        • TotalExecutionTimeInMillis — (Integer)

          The number of milliseconds that Athena took to run the query.

        • QueryQueueTimeInMillis — (Integer)

          The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.

        • ServicePreProcessingTimeInMillis — (Integer)

          The number of milliseconds that Athena took to preprocess the query before submitting the query to the query engine.

        • QueryPlanningTimeInMillis — (Integer)

          The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.

        • ServiceProcessingTimeInMillis — (Integer)

          The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

        • ResultReuseInformation — (map)

          Contains information about whether previous query results were reused for the query.

          • ReusedPreviousResult — required — (Boolean)

            True if a previous query result was reused; false if the result was generated from a new run of the query.

      • WorkGroup — (String)

        The name of the workgroup in which the query ran.

      • EngineVersion — (map)

        The engine version that executed the query.

        • SelectedEngineVersion — (String)

          The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including AUTO. The default is AUTO.

        • EffectiveEngineVersion — (String)

          Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.

      • ExecutionParameters — (Array<String>)

        A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur. The list of parameters is not returned in the response.

      • SubstatementType — (String)

        The kind of query statement that was run.

      • QueryResultsS3AccessGrantsConfiguration — (map)

        Specifies whether Amazon S3 access grants are enabled for query results.

        • EnableS3AccessGrants — required — (Boolean)

          Specifies whether Amazon S3 access grants are enabled for query results.

        • CreateUserLevelPrefix — (Boolean)

          When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.

        • AuthenticationType — required — (String)

          The authentication type used for Amazon S3 access grants. Currently, only DIRECTORY_IDENTITY is supported.

          Possible values include:
          • "DIRECTORY_IDENTITY"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  QueryExecutionId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
athena.getQueryResults(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • QueryExecutionId — (String)

    The unique ID of the query execution.

  • NextToken — (String)

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

  • MaxResults — (Integer)

    The maximum number of results (rows) to return in this request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • UpdateCount — (Integer)

      The number of rows inserted with a CREATE TABLE AS SELECT statement.

    • ResultSet — (map)

      The results of the query execution.

      • Rows — (Array<map>)

        The rows in the table.

        • Data — (Array<map>)

          The data that populates a row in a query result table.

          • VarCharValue — (String)

            The value of the datum.

      • ResultSetMetadata — (map)

        The metadata that describes the column structure and data types of a table of query results.

        • ColumnInfo — (Array<map>)

          Information about the columns returned in a query result metadata.

          • CatalogName — (String)

            The catalog to which the query results belong.

          • SchemaName — (String)

            The schema name (database name) to which the query results belong.

          • TableName — (String)

            The table name for the query results.

          • Name — required — (String)

            The name of the column.

          • Label — (String)

            A column label.

          • Type — required — (String)

            The data type of the column.

          • Precision — (Integer)

            For DECIMAL data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.

          • Scale — (Integer)

            For DECIMAL data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.

          • Nullable — (String)

            Unsupported constraint. This value always shows as UNKNOWN.

            Possible values include:
            • "NOT_NULL"
            • "NULLABLE"
            • "UNKNOWN"
          • CaseSensitive — (Boolean)

            Indicates whether values in the column are case-sensitive.

    • NextToken — (String)

      A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  QueryExecutionId: 'STRING_VALUE' /* required */
};
athena.getQueryRuntimeStatistics(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • QueryExecutionId — (String)

    The unique ID of the query execution.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • QueryRuntimeStatistics — (map)

      Runtime statistics about the query execution.

      • Timeline — (map)

        Timeline statistics such as query queue time, planning time, execution time, service processing time, and total execution time.

        • QueryQueueTimeInMillis — (Integer)

          The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.

        • ServicePreProcessingTimeInMillis — (Integer)

          The number of milliseconds that Athena spends on preprocessing before it submits the query to the engine.

        • QueryPlanningTimeInMillis — (Integer)

          The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.

        • EngineExecutionTimeInMillis — (Integer)

          The number of milliseconds that the query took to execute.

        • ServiceProcessingTimeInMillis — (Integer)

          The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

        • TotalExecutionTimeInMillis — (Integer)

          The number of milliseconds that Athena took to run the query.

      • Rows — (map)

        Statistics such as input rows and bytes read by the query, rows and bytes output by the query, and the number of rows written by the query.

        • InputRows — (Integer)

          The number of rows read to execute the query.

        • InputBytes — (Integer)

          The number of bytes read to execute the query.

        • OutputBytes — (Integer)

          The number of bytes returned by the query.

        • OutputRows — (Integer)

          The number of rows returned by the query.

      • OutputStage — (map)

        Stage statistics such as input and output rows and bytes, execution time, and stage state. This information also includes substages and the query stage plan.

        • StageId — (Integer)

          The identifier for a stage.

        • State — (String)

          State of the stage after query execution.

        • OutputBytes — (Integer)

          The number of bytes output from the stage after execution.

        • OutputRows — (Integer)

          The number of rows output from the stage after execution.

        • InputBytes — (Integer)

          The number of bytes input into the stage for execution.

        • InputRows — (Integer)

          The number of rows input into the stage for execution.

        • ExecutionTime — (Integer)

          Time taken to execute this stage.

        • QueryStagePlan — (map)

          Stage plan information such as name, identifier, sub plans, and source stages.

          • Name — (String)

            Name of the query stage plan that describes the operation this stage is performing as part of query execution.

          • Identifier — (String)

            Information about the operation this query stage plan node is performing.

          • Children — (Array<map>)

            Stage plan information such as name, identifier, sub plans, and remote sources of child plan nodes/

          • RemoteSources — (Array<String>)

            Source plan node IDs.

        • SubStages — (Array<map>)

          List of sub query stages that form this stage execution plan.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  SessionId: 'STRING_VALUE' /* required */
};
athena.getSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SessionId — (String)

    The session ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • SessionId — (String)

      The session ID.

    • Description — (String)

      The session description.

    • WorkGroup — (String)

      The workgroup to which the session belongs.

    • EngineVersion — (String)

      The engine version used by the session (for example, PySpark engine version 3). You can get a list of engine versions by calling ListEngineVersions.

    • EngineConfiguration — (map)

      Contains engine configuration information like DPU usage.

      • CoordinatorDpuSize — (Integer)

        The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1.

      • MaxConcurrentDpus — required — (Integer)

        The maximum number of DPUs that can run concurrently.

      • DefaultExecutorDpuSize — (Integer)

        The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1.

      • AdditionalConfigs — (map<String>)

        Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.

      • SparkProperties — (map<String>)

        Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.

    • NotebookVersion — (String)

      The notebook version.

    • SessionConfiguration — (map)

      Contains the workgroup configuration information used by the session.

      • ExecutionRole — (String)

        The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

      • WorkingDirectory — (String)

        The Amazon S3 location that stores information for the notebook.

      • IdleTimeoutSeconds — (Integer)

        The idle timeout in seconds for the session.

      • EncryptionConfiguration — (map)

        If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information.

        • EncryptionOption — required — (String)

          Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used.

          If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

          Possible values include:
          • "SSE_S3"
          • "SSE_KMS"
          • "CSE_KMS"
        • KmsKey — (String)

          For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

    • Status — (map)

      Contains information about the status of the session.

      • StartDateTime — (Date)

        The date and time that the session started.

      • LastModifiedDateTime — (Date)

        The most recent date and time that the session was modified.

      • EndDateTime — (Date)

        The date and time that the session ended.

      • IdleSinceDateTime — (Date)

        The date and time starting at which the session became idle. Can be empty if the session is not currently idle.

      • State — (String)

        The state of the session. A description of each state follows.

        CREATING - The session is being started, including acquiring resources.

        CREATED - The session has been started.

        IDLE - The session is able to accept a calculation.

        BUSY - The session is processing another task and is unable to accept a calculation.

        TERMINATING - The session is in the process of shutting down.

        TERMINATED - The session and its resources are no longer running.

        DEGRADED - The session has no healthy coordinators.

        FAILED - Due to a failure, the session and its resources are no longer running.

        Possible values include:
        • "CREATING"
        • "CREATED"
        • "IDLE"
        • "BUSY"
        • "TERMINATING"
        • "TERMINATED"
        • "DEGRADED"
        • "FAILED"
      • StateChangeReason — (String)

        The reason for the session state change (for example, canceled because the session was terminated).

    • Statistics — (map)

      Contains the DPU execution time.

      • DpuExecutionInMillis — (Integer)

        The data processing unit execution time for a session in milliseconds.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  SessionId: 'STRING_VALUE' /* required */
};
athena.getSessionStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SessionId — (String)

    The session ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • SessionId — (String)

      The session ID.

    • Status — (map)

      Contains information about the status of the session.

      • StartDateTime — (Date)

        The date and time that the session started.

      • LastModifiedDateTime — (Date)

        The most recent date and time that the session was modified.

      • EndDateTime — (Date)

        The date and time that the session ended.

      • IdleSinceDateTime — (Date)

        The date and time starting at which the session became idle. Can be empty if the session is not currently idle.

      • State — (String)

        The state of the session. A description of each state follows.

        CREATING - The session is being started, including acquiring resources.

        CREATED - The session has been started.

        IDLE - The session is able to accept a calculation.

        BUSY - The session is processing another task and is unable to accept a calculation.

        TERMINATING - The session is in the process of shutting down.

        TERMINATED - The session and its resources are no longer running.

        DEGRADED - The session has no healthy coordinators.

        FAILED - Due to a failure, the session and its resources are no longer running.

        Possible values include:
        • "CREATING"
        • "CREATED"
        • "IDLE"
        • "BUSY"
        • "TERMINATING"
        • "TERMINATED"
        • "DEGRADED"
        • "FAILED"
      • StateChangeReason — (String)

        The reason for the session state change (for example, canceled because the session was terminated).

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CatalogName: 'STRING_VALUE', /* required */
  DatabaseName: 'STRING_VALUE', /* required */
  TableName: 'STRING_VALUE', /* required */
  WorkGroup: 'STRING_VALUE'
};
athena.getTableMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • CatalogName — (String)

    The name of the data catalog that contains the database and table metadata to return.

  • DatabaseName — (String)

    The name of the database that contains the table metadata to return.

  • TableName — (String)

    The name of the table for which metadata is returned.

  • WorkGroup — (String)

    The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TableMetadata — (map)

      An object that contains table metadata.

      • Name — required — (String)

        The name of the table.

      • CreateTime — (Date)

        The time that the table was created.

      • LastAccessTime — (Date)

        The last time the table was accessed.

      • TableType — (String)

        The type of table. In Athena, only EXTERNAL_TABLE is supported.

      • Columns — (Array<map>)

        A list of the columns in the table.

        • Name — required — (String)

          The name of the column.

        • Type — (String)

          The data type of the column.

        • Comment — (String)

          Optional information about the column.

      • PartitionKeys — (Array<map>)

        A list of the partition keys in the table.

        • Name — required — (String)

          The name of the column.

        • Type — (String)

          The data type of the column.

        • Comment — (String)

          Optional information about the column.

      • Parameters — (map<String>)

        A set of custom key/value pairs for table properties.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  WorkGroup: 'STRING_VALUE' /* required */
};
athena.getWorkGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkGroup — (String)

    The name of the workgroup.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • WorkGroup — (map)

      Information about the workgroup.

      • Name — required — (String)

        The workgroup name.

      • State — (String)

        The state of the workgroup: ENABLED or DISABLED.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • Configuration — (map)

        The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for query and calculation results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

        • ResultConfiguration — (map)

          The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided.

          • OutputLocation — (String)

            The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

          • EncryptionConfiguration — (map)

            If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

            • EncryptionOption — required — (String)

              Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used.

              If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

              Possible values include:
              • "SSE_S3"
              • "SSE_KMS"
              • "CSE_KMS"
            • KmsKey — (String)

              For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

          • ExpectedBucketOwner — (String)

            The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

            This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

          • AclConfiguration — (map)

            Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

            • S3AclOption — required — (String)

              The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide.

              Possible values include:
              • "BUCKET_OWNER_FULL_CONTROL"
        • EnforceWorkGroupConfiguration — (Boolean)

          If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

        • PublishCloudWatchMetricsEnabled — (Boolean)

          Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

        • BytesScannedCutoffPerQuery — (Integer)

          The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

        • RequesterPaysEnabled — (Boolean)

          If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

        • EngineVersion — (map)

          The engine version that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

          • SelectedEngineVersion — (String)

            The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including AUTO. The default is AUTO.

          • EffectiveEngineVersion — (String)

            Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.

        • AdditionalConfiguration — (String)

          Specifies a user defined JSON string that is passed to the notebook engine.

        • ExecutionRole — (String)

          The ARN of the execution role used to access user resources for Spark sessions and IAM Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and IAM Identity Center enabled workgroups. The property is required for IAM Identity Center enabled workgroups.

        • CustomerContentEncryptionConfiguration — (map)

          Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.

          • KmsKey — required — (String)

            The customer managed KMS key that is used to encrypt the user's data stores in Athena.

        • EnableMinimumEncryptionConfiguration — (Boolean)

          Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries.

          The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

        • IdentityCenterConfiguration — (map)

          Specifies whether the workgroup is IAM Identity Center supported.

          • EnableIdentityCenter — (Boolean)

            Specifies whether the workgroup is IAM Identity Center supported.

          • IdentityCenterInstanceArn — (String)

            The IAM Identity Center instance ARN that the workgroup associates to.

        • QueryResultsS3AccessGrantsConfiguration — (map)

          Specifies whether Amazon S3 access grants are enabled for query results.

          • EnableS3AccessGrants — required — (Boolean)

            Specifies whether Amazon S3 access grants are enabled for query results.

          • CreateUserLevelPrefix — (Boolean)

            When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.

          • AuthenticationType — required — (String)

            The authentication type used for Amazon S3 access grants. Currently, only DIRECTORY_IDENTITY is supported.

            Possible values include:
            • "DIRECTORY_IDENTITY"
      • Description — (String)

        The workgroup description.

      • CreationTime — (Date)

        The date and time the workgroup was created.

      • IdentityCenterApplicationArn — (String)

        The ARN of the IAM Identity Center enabled application associated with the workgroup.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  Type: IPYNB, /* required */
  WorkGroup: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  NotebookS3LocationUri: 'STRING_VALUE',
  Payload: 'STRING_VALUE'
};
athena.importNotebook(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkGroup — (String)

    The name of the Spark enabled workgroup to import the notebook to.

  • Name — (String)

    The name of the notebook to import.

  • Payload — (String)

    The notebook content to be imported. The payload must be in ipynb format.

  • Type — (String)

    The notebook content type. Currently, the only valid type is IPYNB.

    Possible values include:
    • "IPYNB"
  • NotebookS3LocationUri — (String)

    A URI that specifies the Amazon S3 location of a notebook file in ipynb format.

  • ClientRequestToken — (String)

    A unique case-sensitive string used to ensure the request to import the notebook is idempotent (executes only once).

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NotebookId — (String)

      The ID assigned to the imported notebook.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
athena.listApplicationDPUSizes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer)

    Specifies the maximum number of results to return.

  • NextToken — (String)

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ApplicationDPUSizes — (Array<map>)

      A list of the supported DPU sizes that the application runtime supports.

      • ApplicationRuntimeId — (String)

        The name of the supported application runtime (for example, Athena notebook version 1).

      • SupportedDPUSizes — (Array<Integer>)

        A list of the supported DPU sizes that the application runtime supports.

    • NextToken — (String)

      A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  SessionId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StateFilter: CREATING | CREATED | QUEUED | RUNNING | CANCELING | CANCELED | COMPLETED | FAILED
};
athena.listCalculationExecutions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SessionId — (String)

    The session ID.

  • StateFilter — (String)

    A filter for a specific calculation execution state. A description of each state follows.

    CREATING - The calculation is in the process of being created.

    CREATED - The calculation has been created and is ready to run.

    QUEUED - The calculation has been queued for processing.

    RUNNING - The calculation is running.

    CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

    CANCELED - The calculation is no longer running as the result of a cancel request.

    COMPLETED - The calculation has completed without error.

    FAILED - The calculation failed and is no longer running.

    Possible values include:
    • "CREATING"
    • "CREATED"
    • "QUEUED"
    • "RUNNING"
    • "CANCELING"
    • "CANCELED"
    • "COMPLETED"
    • "FAILED"
  • MaxResults — (Integer)

    The maximum number of calculation executions to return.

  • NextToken — (String)

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

    • Calculations — (Array<map>)

      A list of CalculationSummary objects.

      • CalculationExecutionId — (String)

        The calculation execution UUID.

      • Description — (String)

        A description of the calculation.

      • Status — (map)

        Contains information about the status of the calculation.

        • SubmissionDateTime — (Date)

          The date and time the calculation was submitted for processing.

        • CompletionDateTime — (Date)

          The date and time the calculation completed processing.

        • State — (String)

          The state of the calculation execution. A description of each state follows.

          CREATING - The calculation is in the process of being created.

          CREATED - The calculation has been created and is ready to run.

          QUEUED - The calculation has been queued for processing.

          RUNNING - The calculation is running.

          CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

          CANCELED - The calculation is no longer running as the result of a cancel request.

          COMPLETED - The calculation has completed without error.

          FAILED - The calculation failed and is no longer running.

          Possible values include:
          • "CREATING"
          • "CREATED"
          • "QUEUED"
          • "RUNNING"
          • "CANCELING"
          • "CANCELED"
          • "COMPLETED"
          • "FAILED"
        • StateChangeReason — (String)

          The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
athena.listCapacityReservations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

  • MaxResults — (Integer)

    Specifies the maximum number of results to return.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

    • CapacityReservations — (Array<map>)

      The capacity reservations for the current account.

      • Name — required — (String)

        The name of the capacity reservation.

      • Status — required — (String)

        The status of the capacity reservation.

        Possible values include:
        • "PENDING"
        • "ACTIVE"
        • "CANCELLING"
        • "CANCELLED"
        • "FAILED"
        • "UPDATE_PENDING"
      • TargetDpus — required — (Integer)

        The number of data processing units requested.

      • AllocatedDpus — required — (Integer)

        The number of data processing units currently allocated.

      • LastAllocation — (map)

        Contains the submission time of a single allocation request for a capacity reservation and the most recent status of the attempted allocation.

        • Status — required — (String)

          The status of the capacity allocation.

          Possible values include:
          • "PENDING"
          • "SUCCEEDED"
          • "FAILED"
        • StatusMessage — (String)

          The status message of the capacity allocation.

        • RequestTime — required — (Date)

          The time when the capacity allocation was requested.

        • RequestCompletionTime — (Date)

          The time when the capacity allocation request was completed.

      • LastSuccessfulAllocationTime — (Date)

        The time of the most recent capacity allocation that succeeded.

      • CreationTime — required — (Date)

        The time in UTC epoch millis when the capacity reservation was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CatalogName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  WorkGroup: 'STRING_VALUE'
};
athena.listDatabases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • CatalogName — (String)

    The name of the data catalog that contains the databases to return.

  • NextToken — (String)

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

  • MaxResults — (Integer)

    Specifies the maximum number of results to return.

  • WorkGroup — (String)

    The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DatabaseList — (Array<map>)

      A list of databases from a data catalog.

      • Name — required — (String)

        The name of the database.

      • Description — (String)

        An optional description of the database.

      • Parameters — (map<String>)

        A set of custom key/value pairs.

    • NextToken — (String)

      A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  WorkGroup: 'STRING_VALUE'
};
athena.listDataCatalogs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

  • MaxResults — (Integer)

    Specifies the maximum number of data catalogs to return.

  • WorkGroup — (String)

    The name of the workgroup. Required if making an IAM Identity Center request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DataCatalogsSummary — (Array<map>)

      A summary list of data catalogs.

      • CatalogName — (String)

        The name of the data catalog. The catalog name is unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

      • Type — (String)

        The data catalog type.

        Possible values include:
        • "LAMBDA"
        • "GLUE"
        • "HIVE"
    • NextToken — (String)

      A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
athena.listEngineVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

  • MaxResults — (Integer)

    The maximum number of engine versions to return in this request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • EngineVersions — (Array<map>)

      A list of engine versions that are available to choose from.

      • SelectedEngineVersion — (String)

        The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including AUTO. The default is AUTO.

      • EffectiveEngineVersion — (String)

        Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.

    • NextToken — (String)

      A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  SessionId: 'STRING_VALUE', /* required */
  ExecutorStateFilter: CREATING | CREATED | REGISTERED | TERMINATING | TERMINATED | FAILED,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
athena.listExecutors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SessionId — (String)

    The session ID.

  • ExecutorStateFilter — (String)

    A filter for a specific executor state. A description of each state follows.

    CREATING - The executor is being started, including acquiring resources.

    CREATED - The executor has been started.

    REGISTERED - The executor has been registered.

    TERMINATING - The executor is in the process of shutting down.

    TERMINATED - The executor is no longer running.

    FAILED - Due to a failure, the executor is no longer running.

    Possible values include:
    • "CREATING"
    • "CREATED"
    • "REGISTERED"
    • "TERMINATING"
    • "TERMINATED"
    • "FAILED"
  • MaxResults — (Integer)

    The maximum number of executors to return.

  • NextToken — (String)

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • SessionId — (String)

      The session ID.

    • NextToken — (String)

      A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

    • ExecutorsSummary — (Array<map>)

      Contains summary information about the executor.

      • ExecutorId — required — (String)

        The UUID of the executor.

      • ExecutorType — (String)

        The type of executor used for the application (COORDINATOR, GATEWAY, or WORKER).

        Possible values include:
        • "COORDINATOR"
        • "GATEWAY"
        • "WORKER"
      • StartDateTime — (Integer)

        The date and time that the executor started.

      • TerminationDateTime — (Integer)

        The date and time that the executor was terminated.

      • ExecutorState — (String)

        The processing state of the executor. A description of each state follows.

        CREATING - The executor is being started, including acquiring resources.

        CREATED - The executor has been started.

        REGISTERED - The executor has been registered.

        TERMINATING - The executor is in the process of shutting down.

        TERMINATED - The executor is no longer running.

        FAILED - Due to a failure, the executor is no longer running.

        Possible values include:
        • "CREATING"
        • "CREATED"
        • "REGISTERED"
        • "TERMINATING"
        • "TERMINATED"
        • "FAILED"
      • ExecutorSize — (Integer)

        The smallest unit of compute that a session can request from Athena. Size is measured in data processing unit (DPU) values, a relative measure of processing power.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  WorkGroup: 'STRING_VALUE'
};
athena.listNamedQueries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

  • MaxResults — (Integer)

    The maximum number of queries to return in this request.

  • WorkGroup — (String)

    The name of the workgroup from which the named queries are being returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NamedQueryIds — (Array<String>)

      The list of unique query IDs.

    • NextToken — (String)

      A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  WorkGroup: 'STRING_VALUE', /* required */
  Filters: {
    Name: 'STRING_VALUE'
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
athena.listNotebookMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filters — (map)

    Search filter string.

    • Name — (String)

      The name of the notebook to search for.

  • NextToken — (String)

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

  • MaxResults — (Integer)

    Specifies the maximum number of results to return.

  • WorkGroup — (String)

    The name of the Spark enabled workgroup to retrieve notebook metadata for.