BatchGetNamedQuery

$result = $client->batchGetNamedQuery([/* ... */]);
$promise = $client->batchGetNamedQueryAsync([/* ... */]);

Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput to get a list of query execution IDs.

Parameter Syntax

$result = $client->batchGetNamedQuery([
    'NamedQueryIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NamedQueries' => [
        [
            'Database' => '<string>',
            'Description' => '<string>',
            'Name' => '<string>',
            'NamedQueryId' => '<string>',
            'QueryString' => '<string>',
            'WorkGroup' => '<string>',
        ],
        // ...
    ],
    'UnprocessedNamedQueryIds' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'NamedQueryId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

BatchGetPreparedStatement

$result = $client->batchGetPreparedStatement([/* ... */]);
$promise = $client->batchGetPreparedStatementAsync([/* ... */]);

Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed in UnprocessedPreparedStatementNames.

Parameter Syntax

$result = $client->batchGetPreparedStatement([
    'PreparedStatementNames' => ['<string>', ...], // REQUIRED
    'WorkGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PreparedStatements' => [
        [
            'Description' => '<string>',
            'LastModifiedTime' => <DateTime>,
            'QueryStatement' => '<string>',
            'StatementName' => '<string>',
            'WorkGroupName' => '<string>',
        ],
        // ...
    ],
    'UnprocessedPreparedStatementNames' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'StatementName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

BatchGetQueryExecution

$result = $client->batchGetQueryExecution([/* ... */]);
$promise = $client->batchGetQueryExecutionAsync([/* ... */]);

Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.

Parameter Syntax

$result = $client->batchGetQueryExecution([
    'QueryExecutionIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'QueryExecutions' => [
        [
            'EngineVersion' => [
                'EffectiveEngineVersion' => '<string>',
                'SelectedEngineVersion' => '<string>',
            ],
            'ExecutionParameters' => ['<string>', ...],
            'ManagedQueryResultsConfiguration' => [
                'Enabled' => true || false,
                'EncryptionConfiguration' => [
                    'KmsKey' => '<string>',
                ],
            ],
            'Query' => '<string>',
            'QueryExecutionContext' => [
                'Catalog' => '<string>',
                'Database' => '<string>',
            ],
            'QueryExecutionId' => '<string>',
            'QueryResultsS3AccessGrantsConfiguration' => [
                'AuthenticationType' => 'DIRECTORY_IDENTITY',
                'CreateUserLevelPrefix' => true || false,
                'EnableS3AccessGrants' => true || false,
            ],
            'ResultConfiguration' => [
                'AclConfiguration' => [
                    'S3AclOption' => 'BUCKET_OWNER_FULL_CONTROL',
                ],
                'EncryptionConfiguration' => [
                    'EncryptionOption' => 'SSE_S3|SSE_KMS|CSE_KMS',
                    'KmsKey' => '<string>',
                ],
                'ExpectedBucketOwner' => '<string>',
                'OutputLocation' => '<string>',
            ],
            'ResultReuseConfiguration' => [
                'ResultReuseByAgeConfiguration' => [
                    'Enabled' => true || false,
                    'MaxAgeInMinutes' => <integer>,
                ],
            ],
            'StatementType' => 'DDL|DML|UTILITY',
            'Statistics' => [
                'DataManifestLocation' => '<string>',
                'DataScannedInBytes' => <integer>,
                'EngineExecutionTimeInMillis' => <integer>,
                'QueryPlanningTimeInMillis' => <integer>,
                'QueryQueueTimeInMillis' => <integer>,
                'ResultReuseInformation' => [
                    'ReusedPreviousResult' => true || false,
                ],
                'ServicePreProcessingTimeInMillis' => <integer>,
                'ServiceProcessingTimeInMillis' => <integer>,
                'TotalExecutionTimeInMillis' => <integer>,
            ],
            'Status' => [
                'AthenaError' => [
                    'ErrorCategory' => <integer>,
                    'ErrorMessage' => '<string>',
                    'ErrorType' => <integer>,
                    'Retryable' => true || false,
                ],
                'CompletionDateTime' => <DateTime>,
                'State' => 'QUEUED|RUNNING|SUCCEEDED|FAILED|CANCELLED',
                'StateChangeReason' => '<string>',
                'SubmissionDateTime' => <DateTime>,
            ],
            'SubstatementType' => '<string>',
            'WorkGroup' => '<string>',
        ],
        // ...
    ],
    'UnprocessedQueryExecutionIds' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'QueryExecutionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

CancelCapacityReservation

$result = $client->cancelCapacityReservation([/* ... */]);
$promise = $client->cancelCapacityReservationAsync([/* ... */]);

Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.

Parameter Syntax

$result = $client->cancelCapacityReservation([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

CreateCapacityReservation

$result = $client->createCapacityReservation([/* ... */]);
$promise = $client->createCapacityReservationAsync([/* ... */]);

Creates a capacity reservation with the specified name and number of requested data processing units.

Parameter Syntax

$result = $client->createCapacityReservation([
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetDpus' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

CreateDataCatalog

$result = $client->createDataCatalog([/* ... */]);
$promise = $client->createDataCatalogAsync([/* ... */]);

Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.

For a FEDERATED catalog, this API operation creates the following resources.

• CFN Stack Name with a maximum length of 128 characters and prefix athenafederatedcatalog-CATALOG_NAME_SANITIZED with length 23 characters.

• Lambda Function Name with a maximum length of 64 characters and prefix athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23 characters.

• Glue Connection Name with a maximum length of 255 characters and a prefix athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23 characters.

Parameter Syntax

$result = $client->createDataCatalog([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Parameters' => ['<string>', ...],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Type' => 'LAMBDA|GLUE|HIVE|FEDERATED', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DataCatalog' => [
        'ConnectionType' => 'DYNAMODB|MYSQL|POSTGRESQL|REDSHIFT|ORACLE|SYNAPSE|SQLSERVER|DB2|OPENSEARCH|BIGQUERY|GOOGLECLOUDSTORAGE|HBASE|DOCUMENTDB|CMDB|TPCDS|TIMESTREAM|SAPHANA|SNOWFLAKE|DATALAKEGEN2|DB2AS400',
        'Description' => '<string>',
        'Error' => '<string>',
        'Name' => '<string>',
        'Parameters' => ['<string>', ...],
        'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|CREATE_FAILED_CLEANUP_IN_PROGRESS|CREATE_FAILED_CLEANUP_COMPLETE|CREATE_FAILED_CLEANUP_FAILED|DELETE_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED',
        'Type' => 'LAMBDA|GLUE|HIVE|FEDERATED',
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

CreateNamedQuery

$result = $client->createNamedQuery([/* ... */]);
$promise = $client->createNamedQueryAsync([/* ... */]);

Creates a named query in the specified workgroup. Requires that you have access to the workgroup.

Parameter Syntax

$result = $client->createNamedQuery([
    'ClientRequestToken' => '<string>',
    'Database' => '<string>', // REQUIRED
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'QueryString' => '<string>', // REQUIRED
    'WorkGroup' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NamedQueryId' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

CreateNotebook

$result = $client->createNotebook([/* ... */]);
$promise = $client->createNotebookAsync([/* ... */]);

Creates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.

Parameter Syntax

$result = $client->createNotebook([
    'ClientRequestToken' => '<string>',
    'Name' => '<string>', // REQUIRED
    'WorkGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NotebookId' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

TooManyRequestsException:

Indicates that the request was throttled.

CreatePreparedStatement

$result = $client->createPreparedStatement([/* ... */]);
$promise = $client->createPreparedStatementAsync([/* ... */]);

Creates a prepared statement for use with SQL queries in Athena.

Parameter Syntax

$result = $client->createPreparedStatement([
    'Description' => '<string>',
    'QueryStatement' => '<string>', // REQUIRED
    'StatementName' => '<string>', // REQUIRED
    'WorkGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

CreatePresignedNotebookUrl

$result = $client->createPresignedNotebookUrl([/* ... */]);
$promise = $client->createPresignedNotebookUrlAsync([/* ... */]);

Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl must be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see Grant programmatic access.

Parameter Syntax

$result = $client->createPresignedNotebookUrl([
    'SessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AuthToken' => '<string>',
    'AuthTokenExpirationTime' => <integer>,
    'NotebookUrl' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

CreateWorkGroup

$result = $client->createWorkGroup([/* ... */]);
$promise = $client->createWorkGroupAsync([/* ... */]);

Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.

Parameter Syntax

$result = $client->createWorkGroup([
    'Configuration' => [
        'AdditionalConfiguration' => '<string>',
        'BytesScannedCutoffPerQuery' => <integer>,
        'CustomerContentEncryptionConfiguration' => [
            'KmsKey' => '<string>', // REQUIRED
        ],
        'EnableMinimumEncryptionConfiguration' => true || false,
        'EnforceWorkGroupConfiguration' => true || false,
        'EngineVersion' => [
            'EffectiveEngineVersion' => '<string>',
            'SelectedEngineVersion' => '<string>',
        ],
        'ExecutionRole' => '<string>',
        'IdentityCenterConfiguration' => [
            'EnableIdentityCenter' => true || false,
            'IdentityCenterInstanceArn' => '<string>',
        ],
        'ManagedQueryResultsConfiguration' => [
            'Enabled' => true || false, // REQUIRED
            'EncryptionConfiguration' => [
                'KmsKey' => '<string>', // REQUIRED
            ],
        ],
        'PublishCloudWatchMetricsEnabled' => true || false,
        'QueryResultsS3AccessGrantsConfiguration' => [
            'AuthenticationType' => 'DIRECTORY_IDENTITY', // REQUIRED
            'CreateUserLevelPrefix' => true || false,
            'EnableS3AccessGrants' => true || false, // REQUIRED
        ],
        'RequesterPaysEnabled' => true || false,
        'ResultConfiguration' => [
            'AclConfiguration' => [
                'S3AclOption' => 'BUCKET_OWNER_FULL_CONTROL', // REQUIRED
            ],
            'EncryptionConfiguration' => [
                'EncryptionOption' => 'SSE_S3|SSE_KMS|CSE_KMS', // REQUIRED
                'KmsKey' => '<string>',
            ],
            'ExpectedBucketOwner' => '<string>',
            'OutputLocation' => '<string>',
        ],
    ],
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

DeleteCapacityReservation

$result = $client->deleteCapacityReservation([/* ... */]);
$promise = $client->deleteCapacityReservationAsync([/* ... */]);

Deletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by GetCapacityReservation, and deleted reservations do not appear in the output of ListCapacityReservations.

Parameter Syntax

$result = $client->deleteCapacityReservation([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

DeleteDataCatalog

$result = $client->deleteDataCatalog([/* ... */]);
$promise = $client->deleteDataCatalogAsync([/* ... */]);

Deletes a data catalog.

Parameter Syntax

$result = $client->deleteDataCatalog([
    'DeleteCatalogOnly' => true || false,
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DataCatalog' => [
        'ConnectionType' => 'DYNAMODB|MYSQL|POSTGRESQL|REDSHIFT|ORACLE|SYNAPSE|SQLSERVER|DB2|OPENSEARCH|BIGQUERY|GOOGLECLOUDSTORAGE|HBASE|DOCUMENTDB|CMDB|TPCDS|TIMESTREAM|SAPHANA|SNOWFLAKE|DATALAKEGEN2|DB2AS400',
        'Description' => '<string>',
        'Error' => '<string>',
        'Name' => '<string>',
        'Parameters' => ['<string>', ...],
        'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|CREATE_FAILED_CLEANUP_IN_PROGRESS|CREATE_FAILED_CLEANUP_COMPLETE|CREATE_FAILED_CLEANUP_FAILED|DELETE_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED',
        'Type' => 'LAMBDA|GLUE|HIVE|FEDERATED',
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

DeleteNamedQuery

$result = $client->deleteNamedQuery([/* ... */]);
$promise = $client->deleteNamedQueryAsync([/* ... */]);

Deletes the named query if you have access to the workgroup in which the query was saved.

Parameter Syntax

$result = $client->deleteNamedQuery([
    'NamedQueryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

DeleteNotebook

$result = $client->deleteNotebook([/* ... */]);
$promise = $client->deleteNotebookAsync([/* ... */]);

Deletes the specified notebook.

Parameter Syntax

$result = $client->deleteNotebook([
    'NotebookId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

TooManyRequestsException:

Indicates that the request was throttled.

DeletePreparedStatement

$result = $client->deletePreparedStatement([/* ... */]);
$promise = $client->deletePreparedStatementAsync([/* ... */]);

Deletes the prepared statement with the specified name from the specified workgroup.

Parameter Syntax

$result = $client->deletePreparedStatement([
    'StatementName' => '<string>', // REQUIRED
    'WorkGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

DeleteWorkGroup

$result = $client->deleteWorkGroup([/* ... */]);
$promise = $client->deleteWorkGroupAsync([/* ... */]);

Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.

Parameter Syntax

$result = $client->deleteWorkGroup([
    'RecursiveDeleteOption' => true || false,
    'WorkGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ExportNotebook

$result = $client->exportNotebook([/* ... */]);
$promise = $client->exportNotebookAsync([/* ... */]);

Exports the specified notebook and its metadata.

Parameter Syntax

$result = $client->exportNotebook([
    'NotebookId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NotebookMetadata' => [
        'CreationTime' => <DateTime>,
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'NotebookId' => '<string>',
        'Type' => 'IPYNB',
        'WorkGroup' => '<string>',
    ],
    'Payload' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

TooManyRequestsException:

Indicates that the request was throttled.

GetCalculationExecution

$result = $client->getCalculationExecution([/* ... */]);
$promise = $client->getCalculationExecutionAsync([/* ... */]);

Describes a previously submitted calculation execution.

Parameter Syntax

$result = $client->getCalculationExecution([
    'CalculationExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CalculationExecutionId' => '<string>',
    'Description' => '<string>',
    'Result' => [
        'ResultS3Uri' => '<string>',
        'ResultType' => '<string>',
        'StdErrorS3Uri' => '<string>',
        'StdOutS3Uri' => '<string>',
    ],
    'SessionId' => '<string>',
    'Statistics' => [
        'DpuExecutionInMillis' => <integer>,
        'Progress' => '<string>',
    ],
    'Status' => [
        'CompletionDateTime' => <DateTime>,
        'State' => 'CREATING|CREATED|QUEUED|RUNNING|CANCELING|CANCELED|COMPLETED|FAILED',
        'StateChangeReason' => '<string>',
        'SubmissionDateTime' => <DateTime>,
    ],
    'WorkingDirectory' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

GetCalculationExecutionCode

$result = $client->getCalculationExecutionCode([/* ... */]);
$promise = $client->getCalculationExecutionCodeAsync([/* ... */]);

Retrieves the unencrypted code that was executed for the calculation.

Parameter Syntax

$result = $client->getCalculationExecutionCode([
    'CalculationExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CodeBlock' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

GetCalculationExecutionStatus

$result = $client->getCalculationExecutionStatus([/* ... */]);
$promise = $client->getCalculationExecutionStatusAsync([/* ... */]);

Gets the status of a current calculation.

Parameter Syntax

$result = $client->getCalculationExecutionStatus([
    'CalculationExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Statistics' => [
        'DpuExecutionInMillis' => <integer>,
        'Progress' => '<string>',
    ],
    'Status' => [
        'CompletionDateTime' => <DateTime>,
        'State' => 'CREATING|CREATED|QUEUED|RUNNING|CANCELING|CANCELED|COMPLETED|FAILED',
        'StateChangeReason' => '<string>',
        'SubmissionDateTime' => <DateTime>,
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

GetCapacityAssignmentConfiguration

$result = $client->getCapacityAssignmentConfiguration([/* ... */]);
$promise = $client->getCapacityAssignmentConfigurationAsync([/* ... */]);

Gets the capacity assignment configuration for a capacity reservation, if one exists.

Parameter Syntax

$result = $client->getCapacityAssignmentConfiguration([
    'CapacityReservationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CapacityAssignmentConfiguration' => [
        'CapacityAssignments' => [
            [
                'WorkGroupNames' => ['<string>', ...],
            ],
            // ...
        ],
        'CapacityReservationName' => '<string>',
    ],
]

Result Details

Errors

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

GetCapacityReservation

$result = $client->getCapacityReservation([/* ... */]);
$promise = $client->getCapacityReservationAsync([/* ... */]);

Returns information about the capacity reservation with the specified name.

Parameter Syntax

$result = $client->getCapacityReservation([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CapacityReservation' => [
        'AllocatedDpus' => <integer>,
        'CreationTime' => <DateTime>,
        'LastAllocation' => [
            'RequestCompletionTime' => <DateTime>,
            'RequestTime' => <DateTime>,
            'Status' => 'PENDING|SUCCEEDED|FAILED',
            'StatusMessage' => '<string>',
        ],
        'LastSuccessfulAllocationTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'PENDING|ACTIVE|CANCELLING|CANCELLED|FAILED|UPDATE_PENDING',
        'TargetDpus' => <integer>,
    ],
]

Result Details

Errors

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

GetDataCatalog

$result = $client->getDataCatalog([/* ... */]);
$promise = $client->getDataCatalogAsync([/* ... */]);

Returns the specified data catalog.

Parameter Syntax

$result = $client->getDataCatalog([
    'Name' => '<string>', // REQUIRED
    'WorkGroup' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DataCatalog' => [
        'ConnectionType' => 'DYNAMODB|MYSQL|POSTGRESQL|REDSHIFT|ORACLE|SYNAPSE|SQLSERVER|DB2|OPENSEARCH|BIGQUERY|GOOGLECLOUDSTORAGE|HBASE|DOCUMENTDB|CMDB|TPCDS|TIMESTREAM|SAPHANA|SNOWFLAKE|DATALAKEGEN2|DB2AS400',
        'Description' => '<string>',
        'Error' => '<string>',
        'Name' => '<string>',
        'Parameters' => ['<string>', ...],
        'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|CREATE_FAILED_CLEANUP_IN_PROGRESS|CREATE_FAILED_CLEANUP_COMPLETE|CREATE_FAILED_CLEANUP_FAILED|DELETE_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED',
        'Type' => 'LAMBDA|GLUE|HIVE|FEDERATED',
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

GetDatabase

$result = $client->getDatabase([/* ... */]);
$promise = $client->getDatabaseAsync([/* ... */]);

Returns a database object for the specified database and data catalog.

Parameter Syntax

$result = $client->getDatabase([
    'CatalogName' => '<string>', // REQUIRED
    'DatabaseName' => '<string>', // REQUIRED
    'WorkGroup' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Database' => [
        'Description' => '<string>',
        'Name' => '<string>',
        'Parameters' => ['<string>', ...],
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

MetadataException:

An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.

GetNamedQuery

$result = $client->getNamedQuery([/* ... */]);
$promise = $client->getNamedQueryAsync([/* ... */]);

Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.

Parameter Syntax

$result = $client->getNamedQuery([
    'NamedQueryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NamedQuery' => [
        'Database' => '<string>',
        'Description' => '<string>',
        'Name' => '<string>',
        'NamedQueryId' => '<string>',
        'QueryString' => '<string>',
        'WorkGroup' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

GetNotebookMetadata

$result = $client->getNotebookMetadata([/* ... */]);
$promise = $client->getNotebookMetadataAsync([/* ... */]);

Retrieves notebook metadata for the specified notebook ID.

Parameter Syntax

$result = $client->getNotebookMetadata([
    'NotebookId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NotebookMetadata' => [
        'CreationTime' => <DateTime>,
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'NotebookId' => '<string>',
        'Type' => 'IPYNB',
        'WorkGroup' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

TooManyRequestsException:

Indicates that the request was throttled.

GetPreparedStatement

$result = $client->getPreparedStatement([/* ... */]);
$promise = $client->getPreparedStatementAsync([/* ... */]);

Retrieves the prepared statement with the specified name from the specified workgroup.

Parameter Syntax

$result = $client->getPreparedStatement([
    'StatementName' => '<string>', // REQUIRED
    'WorkGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PreparedStatement' => [
        'Description' => '<string>',
        'LastModifiedTime' => <DateTime>,
        'QueryStatement' => '<string>',
        'StatementName' => '<string>',
        'WorkGroupName' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

GetQueryExecution

$result = $client->getQueryExecution([/* ... */]);
$promise = $client->getQueryExecutionAsync([/* ... */]);

Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.

Parameter Syntax

$result = $client->getQueryExecution([
    'QueryExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'QueryExecution' => [
        'EngineVersion' => [
            'EffectiveEngineVersion' => '<string>',
            'SelectedEngineVersion' => '<string>',
        ],
        'ExecutionParameters' => ['<string>', ...],
        'ManagedQueryResultsConfiguration' => [
            'Enabled' => true || false,
            'EncryptionConfiguration' => [
                'KmsKey' => '<string>',
            ],
        ],
        'Query' => '<string>',
        'QueryExecutionContext' => [
            'Catalog' => '<string>',
            'Database' => '<string>',
        ],
        'QueryExecutionId' => '<string>',
        'QueryResultsS3AccessGrantsConfiguration' => [
            'AuthenticationType' => 'DIRECTORY_IDENTITY',
            'CreateUserLevelPrefix' => true || false,
            'EnableS3AccessGrants' => true || false,
        ],
        'ResultConfiguration' => [
            'AclConfiguration' => [
                'S3AclOption' => 'BUCKET_OWNER_FULL_CONTROL',
            ],
            'EncryptionConfiguration' => [
                'EncryptionOption' => 'SSE_S3|SSE_KMS|CSE_KMS',
                'KmsKey' => '<string>',
            ],
            'ExpectedBucketOwner' => '<string>',
            'OutputLocation' => '<string>',
        ],
        'ResultReuseConfiguration' => [
            'ResultReuseByAgeConfiguration' => [
                'Enabled' => true || false,
                'MaxAgeInMinutes' => <integer>,
            ],
        ],
        'StatementType' => 'DDL|DML|UTILITY',
        'Statistics' => [
            'DataManifestLocation' => '<string>',
            'DataScannedInBytes' => <integer>,
            'EngineExecutionTimeInMillis' => <integer>,
            'QueryPlanningTimeInMillis' => <integer>,
            'QueryQueueTimeInMillis' => <integer>,
            'ResultReuseInformation' => [
                'ReusedPreviousResult' => true || false,
            ],
            'ServicePreProcessingTimeInMillis' => <integer>,
            'ServiceProcessingTimeInMillis' => <integer>,
            'TotalExecutionTimeInMillis' => <integer>,
        ],
        'Status' => [
            'AthenaError' => [
                'ErrorCategory' => <integer>,
                'ErrorMessage' => '<string>',
                'ErrorType' => <integer>,
                'Retryable' => true || false,
            ],
            'CompletionDateTime' => <DateTime>,
            'State' => 'QUEUED|RUNNING|SUCCEEDED|FAILED|CANCELLED',
            'StateChangeReason' => '<string>',
            'SubmissionDateTime' => <DateTime>,
        ],
        'SubstatementType' => '<string>',
        'WorkGroup' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

GetQueryResults

$result = $client->getQueryResults([/* ... */]);
$promise = $client->getQueryResultsAsync([/* ... */]);

Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Working with query results, recent queries, and output files in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query.

To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location.

Parameter Syntax

$result = $client->getQueryResults([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'QueryExecutionId' => '<string>', // REQUIRED
    'QueryResultType' => 'DATA_MANIFEST|DATA_ROWS',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ResultSet' => [
        'ResultSetMetadata' => [
            'ColumnInfo' => [
                [
                    'CaseSensitive' => true || false,
                    'CatalogName' => '<string>',
                    'Label' => '<string>',
                    'Name' => '<string>',
                    'Nullable' => 'NOT_NULL|NULLABLE|UNKNOWN',
                    'Precision' => <integer>,
                    'Scale' => <integer>,
                    'SchemaName' => '<string>',
                    'TableName' => '<string>',
                    'Type' => '<string>',
                ],
                // ...
            ],
        ],
        'Rows' => [
            [
                'Data' => [
                    [
                        'VarCharValue' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'UpdateCount' => <integer>,
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

TooManyRequestsException:

Indicates that the request was throttled.

GetQueryRuntimeStatistics

$result = $client->getQueryRuntimeStatistics([/* ... */]);
$promise = $client->getQueryRuntimeStatisticsAsync([/* ... */]);

Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Statistics from the Timeline section of the response object are available as soon as QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. The remaining non-timeline statistics in the response (like stage-level input and output row count and data size) are updated asynchronously and may not be available immediately after a query completes. The non-timeline statistics are also not included when a query has row-level filters defined in Lake Formation.

Parameter Syntax

$result = $client->getQueryRuntimeStatistics([
    'QueryExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'QueryRuntimeStatistics' => [
        'OutputStage' => [
            'ExecutionTime' => <integer>,
            'InputBytes' => <integer>,
            'InputRows' => <integer>,
            'OutputBytes' => <integer>,
            'OutputRows' => <integer>,
            'QueryStagePlan' => [
                'Children' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'Identifier' => '<string>',
                'Name' => '<string>',
                'RemoteSources' => ['<string>', ...],
            ],
            'StageId' => <integer>,
            'State' => '<string>',
            'SubStages' => [
                [...], // RECURSIVE
                // ...
            ],
        ],
        'Rows' => [
            'InputBytes' => <integer>,
            'InputRows' => <integer>,
            'OutputBytes' => <integer>,
            'OutputRows' => <integer>,
        ],
        'Timeline' => [
            'EngineExecutionTimeInMillis' => <integer>,
            'QueryPlanningTimeInMillis' => <integer>,
            'QueryQueueTimeInMillis' => <integer>,
            'ServicePreProcessingTimeInMillis' => <integer>,
            'ServiceProcessingTimeInMillis' => <integer>,
            'TotalExecutionTimeInMillis' => <integer>,
        ],
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

GetSession

$result = $client->getSession([/* ... */]);
$promise = $client->getSessionAsync([/* ... */]);

Gets the full details of a previously created session, including the session status and configuration.

Parameter Syntax

$result = $client->getSession([
    'SessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Description' => '<string>',
    'EngineConfiguration' => [
        'AdditionalConfigs' => ['<string>', ...],
        'CoordinatorDpuSize' => <integer>,
        'DefaultExecutorDpuSize' => <integer>,
        'MaxConcurrentDpus' => <integer>,
        'SparkProperties' => ['<string>', ...],
    ],
    'EngineVersion' => '<string>',
    'NotebookVersion' => '<string>',
    'SessionConfiguration' => [
        'EncryptionConfiguration' => [
            'EncryptionOption' => 'SSE_S3|SSE_KMS|CSE_KMS',
            'KmsKey' => '<string>',
        ],
        'ExecutionRole' => '<string>',
        'IdleTimeoutSeconds' => <integer>,
        'WorkingDirectory' => '<string>',
    ],
    'SessionId' => '<string>',
    'Statistics' => [
        'DpuExecutionInMillis' => <integer>,
    ],
    'Status' => [
        'EndDateTime' => <DateTime>,
        'IdleSinceDateTime' => <DateTime>,
        'LastModifiedDateTime' => <DateTime>,
        'StartDateTime' => <DateTime>,
        'State' => 'CREATING|CREATED|IDLE|BUSY|TERMINATING|TERMINATED|DEGRADED|FAILED',
        'StateChangeReason' => '<string>',
    ],
    'WorkGroup' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

GetSessionStatus

$result = $client->getSessionStatus([/* ... */]);
$promise = $client->getSessionStatusAsync([/* ... */]);

Gets the current status of a session.

Parameter Syntax

$result = $client->getSessionStatus([
    'SessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SessionId' => '<string>',
    'Status' => [
        'EndDateTime' => <DateTime>,
        'IdleSinceDateTime' => <DateTime>,
        'LastModifiedDateTime' => <DateTime>,
        'StartDateTime' => <DateTime>,
        'State' => 'CREATING|CREATED|IDLE|BUSY|TERMINATING|TERMINATED|DEGRADED|FAILED',
        'StateChangeReason' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

GetTableMetadata

$result = $client->getTableMetadata([/* ... */]);
$promise = $client->getTableMetadataAsync([/* ... */]);

Returns table metadata for the specified catalog, database, and table.

Parameter Syntax

$result = $client->getTableMetadata([
    'CatalogName' => '<string>', // REQUIRED
    'DatabaseName' => '<string>', // REQUIRED
    'TableName' => '<string>', // REQUIRED
    'WorkGroup' => '<string>',
]);

Parameter Details

Result Syntax

[
    'TableMetadata' => [
        'Columns' => [
            [
                'Comment' => '<string>',
                'Name' => '<string>',
                'Type' => '<string>',
            ],
            // ...
        ],
        'CreateTime' => <DateTime>,
        'LastAccessTime' => <DateTime>,
        'Name' => '<string>',
        'Parameters' => ['<string>', ...],
        'PartitionKeys' => [
            [
                'Comment' => '<string>',
                'Name' => '<string>',
                'Type' => '<string>',
            ],
            // ...
        ],
        'TableType' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

MetadataException:

An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.

GetWorkGroup

$result = $client->getWorkGroup([/* ... */]);
$promise = $client->getWorkGroupAsync([/* ... */]);

Returns information about the workgroup with the specified name.

Parameter Syntax

$result = $client->getWorkGroup([
    'WorkGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'WorkGroup' => [
        'Configuration' => [
            'AdditionalConfiguration' => '<string>',
            'BytesScannedCutoffPerQuery' => <integer>,
            'CustomerContentEncryptionConfiguration' => [
                'KmsKey' => '<string>',
            ],
            'EnableMinimumEncryptionConfiguration' => true || false,
            'EnforceWorkGroupConfiguration' => true || false,
            'EngineVersion' => [
                'EffectiveEngineVersion' => '<string>',
                'SelectedEngineVersion' => '<string>',
            ],
            'ExecutionRole' => '<string>',
            'IdentityCenterConfiguration' => [
                'EnableIdentityCenter' => true || false,
                'IdentityCenterInstanceArn' => '<string>',
            ],
            'ManagedQueryResultsConfiguration' => [
                'Enabled' => true || false,
                'EncryptionConfiguration' => [
                    'KmsKey' => '<string>',
                ],
            ],
            'PublishCloudWatchMetricsEnabled' => true || false,
            'QueryResultsS3AccessGrantsConfiguration' => [
                'AuthenticationType' => 'DIRECTORY_IDENTITY',
                'CreateUserLevelPrefix' => true || false,
                'EnableS3AccessGrants' => true || false,
            ],
            'RequesterPaysEnabled' => true || false,
            'ResultConfiguration' => [
                'AclConfiguration' => [
                    'S3AclOption' => 'BUCKET_OWNER_FULL_CONTROL',
                ],
                'EncryptionConfiguration' => [
                    'EncryptionOption' => 'SSE_S3|SSE_KMS|CSE_KMS',
                    'KmsKey' => '<string>',
                ],
                'ExpectedBucketOwner' => '<string>',
                'OutputLocation' => '<string>',
            ],
        ],
        'CreationTime' => <DateTime>,
        'Description' => '<string>',
        'IdentityCenterApplicationArn' => '<string>',
        'Name' => '<string>',
        'State' => 'ENABLED|DISABLED',
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ImportNotebook

$result = $client->importNotebook([/* ... */]);
$promise = $client->importNotebookAsync([/* ... */]);

Imports a single ipynb file to a Spark enabled workgroup. To import the notebook, the request must specify a value for either Payload or NoteBookS3LocationUri. If neither is specified or both are specified, an InvalidRequestException occurs. The maximum file size that can be imported is 10 megabytes. If an ipynb file with the same name already exists in the workgroup, throws an error.

Parameter Syntax

$result = $client->importNotebook([
    'ClientRequestToken' => '<string>',
    'Name' => '<string>', // REQUIRED
    'NotebookS3LocationUri' => '<string>',
    'Payload' => '<string>',
    'Type' => 'IPYNB', // REQUIRED
    'WorkGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NotebookId' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

TooManyRequestsException:

Indicates that the request was throttled.

ListApplicationDPUSizes

$result = $client->listApplicationDPUSizes([/* ... */]);
$promise = $client->listApplicationDPUSizesAsync([/* ... */]);

Returns the supported DPU sizes for the supported application runtimes (for example, Athena notebook version 1).

Parameter Syntax

$result = $client->listApplicationDPUSizes([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ApplicationDPUSizes' => [
        [
            'ApplicationRuntimeId' => '<string>',
            'SupportedDPUSizes' => [<integer>, ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

TooManyRequestsException:

Indicates that the request was throttled.

ListCalculationExecutions

$result = $client->listCalculationExecutions([/* ... */]);
$promise = $client->listCalculationExecutionsAsync([/* ... */]);

Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.

Parameter Syntax

$result = $client->listCalculationExecutions([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SessionId' => '<string>', // REQUIRED
    'StateFilter' => 'CREATING|CREATED|QUEUED|RUNNING|CANCELING|CANCELED|COMPLETED|FAILED',
]);

Parameter Details

Result Syntax

[
    'Calculations' => [
        [
            'CalculationExecutionId' => '<string>',
            'Description' => '<string>',
            'Status' => [
                'CompletionDateTime' => <DateTime>,
                'State' => 'CREATING|CREATED|QUEUED|RUNNING|CANCELING|CANCELED|COMPLETED|FAILED',
                'StateChangeReason' => '<string>',
                'SubmissionDateTime' => <DateTime>,
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

ListCapacityReservations

$result = $client->listCapacityReservations([/* ... */]);
$promise = $client->listCapacityReservationsAsync([/* ... */]);

Lists the capacity reservations for the current account.

Parameter Syntax

$result = $client->listCapacityReservations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CapacityReservations' => [
        [
            'AllocatedDpus' => <integer>,
            'CreationTime' => <DateTime>,
            'LastAllocation' => [
                'RequestCompletionTime' => <DateTime>,
                'RequestTime' => <DateTime>,
                'Status' => 'PENDING|SUCCEEDED|FAILED',
                'StatusMessage' => '<string>',
            ],
            'LastSuccessfulAllocationTime' => <DateTime>,
            'Name' => '<string>',
            'Status' => 'PENDING|ACTIVE|CANCELLING|CANCELLED|FAILED|UPDATE_PENDING',
            'TargetDpus' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ListDataCatalogs

$result = $client->listDataCatalogs([/* ... */]);
$promise = $client->listDataCatalogsAsync([/* ... */]);

Lists the data catalogs in the current Amazon Web Services account.

Parameter Syntax

$result = $client->listDataCatalogs([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkGroup' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DataCatalogsSummary' => [
        [
            'CatalogName' => '<string>',
            'ConnectionType' => 'DYNAMODB|MYSQL|POSTGRESQL|REDSHIFT|ORACLE|SYNAPSE|SQLSERVER|DB2|OPENSEARCH|BIGQUERY|GOOGLECLOUDSTORAGE|HBASE|DOCUMENTDB|CMDB|TPCDS|TIMESTREAM|SAPHANA|SNOWFLAKE|DATALAKEGEN2|DB2AS400',
            'Error' => '<string>',
            'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|CREATE_FAILED_CLEANUP_IN_PROGRESS|CREATE_FAILED_CLEANUP_COMPLETE|CREATE_FAILED_CLEANUP_FAILED|DELETE_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED',
            'Type' => 'LAMBDA|GLUE|HIVE|FEDERATED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ListDatabases

$result = $client->listDatabases([/* ... */]);
$promise = $client->listDatabasesAsync([/* ... */]);

Lists the databases in the specified data catalog.

Parameter Syntax

$result = $client->listDatabases([
    'CatalogName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkGroup' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DatabaseList' => [
        [
            'Description' => '<string>',
            'Name' => '<string>',
            'Parameters' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

MetadataException:

An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.

ListEngineVersions

$result = $client->listEngineVersions([/* ... */]);
$promise = $client->listEngineVersionsAsync([/* ... */]);

Returns a list of engine versions that are available to choose from, including the Auto option.

Parameter Syntax

$result = $client->listEngineVersions([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EngineVersions' => [
        [
            'EffectiveEngineVersion' => '<string>',
            'SelectedEngineVersion' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ListExecutors

$result = $client->listExecutors([/* ... */]);
$promise = $client->listExecutorsAsync([/* ... */]);

Lists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.

Parameter Syntax

$result = $client->listExecutors([
    'ExecutorStateFilter' => 'CREATING|CREATED|REGISTERED|TERMINATING|TERMINATED|FAILED',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ExecutorsSummary' => [
        [
            'ExecutorId' => '<string>',
            'ExecutorSize' => <integer>,
            'ExecutorState' => 'CREATING|CREATED|REGISTERED|TERMINATING|TERMINATED|FAILED',
            'ExecutorType' => 'COORDINATOR|GATEWAY|WORKER',
            'StartDateTime' => <integer>,
            'TerminationDateTime' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'SessionId' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

ListNamedQueries

$result = $client->listNamedQueries([/* ... */]);
$promise = $client->listNamedQueriesAsync([/* ... */]);

Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.

Parameter Syntax

$result = $client->listNamedQueries([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkGroup' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NamedQueryIds' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ListNotebookMetadata

$result = $client->listNotebookMetadata([/* ... */]);
$promise = $client->listNotebookMetadataAsync([/* ... */]);

Displays the notebook files for the specified workgroup in paginated format.

Parameter Syntax

$result = $client->listNotebookMetadata([
    'Filters' => [
        'Name' => '<string>',
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'NotebookMetadataList' => [
        [
            'CreationTime' => <DateTime>,
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'NotebookId' => '<string>',
            'Type' => 'IPYNB',
            'WorkGroup' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

TooManyRequestsException:

Indicates that the request was throttled.

ListNotebookSessions

$result = $client->listNotebookSessions([/* ... */]);
$promise = $client->listNotebookSessionsAsync([/* ... */]);

Lists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING, CREATED, IDLE or BUSY. Newer sessions are listed first; older sessions are listed later.

Parameter Syntax

$result = $client->listNotebookSessions([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'NotebookId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'NotebookSessionsList' => [
        [
            'CreationTime' => <DateTime>,
            'SessionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

ListPreparedStatements

$result = $client->listPreparedStatements([/* ... */]);
$promise = $client->listPreparedStatementsAsync([/* ... */]);

Lists the prepared statements in the specified workgroup.

Parameter Syntax

$result = $client->listPreparedStatements([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PreparedStatements' => [
        [
            'LastModifiedTime' => <DateTime>,
            'StatementName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ListQueryExecutions

$result = $client->listQueryExecutions([/* ... */]);
$promise = $client->listQueryExecutionsAsync([/* ... */]);

Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.

Parameter Syntax

$result = $client->listQueryExecutions([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkGroup' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'QueryExecutionIds' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ListSessions

$result = $client->listSessions([/* ... */]);
$promise = $client->listSessionsAsync([/* ... */]);

Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are listed later.

Parameter Syntax

$result = $client->listSessions([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StateFilter' => 'CREATING|CREATED|IDLE|BUSY|TERMINATING|TERMINATED|DEGRADED|FAILED',
    'WorkGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Sessions' => [
        [
            'Description' => '<string>',
            'EngineVersion' => [
                'EffectiveEngineVersion' => '<string>',
                'SelectedEngineVersion' => '<string>',
            ],
            'NotebookVersion' => '<string>',
            'SessionId' => '<string>',
            'Status' => [
                'EndDateTime' => <DateTime>,
                'IdleSinceDateTime' => <DateTime>,
                'LastModifiedDateTime' => <DateTime>,
                'StartDateTime' => <DateTime>,
                'State' => 'CREATING|CREATED|IDLE|BUSY|TERMINATING|TERMINATED|DEGRADED|FAILED',
                'StateChangeReason' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

ListTableMetadata

$result = $client->listTableMetadata([/* ... */]);
$promise = $client->listTableMetadataAsync([/* ... */]);

Lists the metadata for the tables in the specified data catalog database.

Parameter Syntax

$result = $client->listTableMetadata([
    'CatalogName' => '<string>', // REQUIRED
    'DatabaseName' => '<string>', // REQUIRED
    'Expression' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkGroup' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'TableMetadataList' => [
        [
            'Columns' => [
                [
                    'Comment' => '<string>',
                    'Name' => '<string>',
                    'Type' => '<string>',
                ],
                // ...
            ],
            'CreateTime' => <DateTime>,
            'LastAccessTime' => <DateTime>,
            'Name' => '<string>',
            'Parameters' => ['<string>', ...],
            'PartitionKeys' => [
                [
                    'Comment' => '<string>',
                    'Name' => '<string>',
                    'Type' => '<string>',
                ],
                // ...
            ],
            'TableType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

MetadataException:

An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags associated with an Athena resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

ListWorkGroups

$result = $client->listWorkGroups([/* ... */]);
$promise = $client->listWorkGroupsAsync([/* ... */]);

Lists available workgroups for the account.

Parameter Syntax

$result = $client->listWorkGroups([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'WorkGroups' => [
        [
            'CreationTime' => <DateTime>,
            'Description' => '<string>',
            'EngineVersion' => [
                'EffectiveEngineVersion' => '<string>',
                'SelectedEngineVersion' => '<string>',
            ],
            'IdentityCenterApplicationArn' => '<string>',
            'Name' => '<string>',
            'State' => 'ENABLED|DISABLED',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

PutCapacityAssignmentConfiguration

$result = $client->putCapacityAssignmentConfiguration([/* ... */]);
$promise = $client->putCapacityAssignmentConfigurationAsync([/* ... */]);

Puts a new capacity assignment configuration for a specified capacity reservation. If a capacity assignment configuration already exists for the capacity reservation, replaces the existing capacity assignment configuration.

Parameter Syntax

$result = $client->putCapacityAssignmentConfiguration([
    'CapacityAssignments' => [ // REQUIRED
        [
            'WorkGroupNames' => ['<string>', ...],
        ],
        // ...
    ],
    'CapacityReservationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

StartCalculationExecution

$result = $client->startCalculationExecution([/* ... */]);
$promise = $client->startCalculationExecutionAsync([/* ... */]);

Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.

Parameter Syntax

$result = $client->startCalculationExecution([
    'CalculationConfiguration' => [
        'CodeBlock' => '<string>',
    ],
    'ClientRequestToken' => '<string>',
    'CodeBlock' => '<string>',
    'Description' => '<string>',
    'SessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CalculationExecutionId' => '<string>',
    'State' => 'CREATING|CREATED|QUEUED|RUNNING|CANCELING|CANCELED|COMPLETED|FAILED',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

StartQueryExecution

$result = $client->startQueryExecution([/* ... */]);
$promise = $client->startQueryExecutionAsync([/* ... */]);

Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires GetDataCatalog permission to the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Parameter Syntax

$result = $client->startQueryExecution([
    'ClientRequestToken' => '<string>',
    'ExecutionParameters' => ['<string>', ...],
    'QueryExecutionContext' => [
        'Catalog' => '<string>',
        'Database' => '<string>',
    ],
    'QueryString' => '<string>', // REQUIRED
    'ResultConfiguration' => [
        'AclConfiguration' => [
            'S3AclOption' => 'BUCKET_OWNER_FULL_CONTROL', // REQUIRED
        ],
        'EncryptionConfiguration' => [
            'EncryptionOption' => 'SSE_S3|SSE_KMS|CSE_KMS', // REQUIRED
            'KmsKey' => '<string>',
        ],
        'ExpectedBucketOwner' => '<string>',
        'OutputLocation' => '<string>',
    ],
    'ResultReuseConfiguration' => [
        'ResultReuseByAgeConfiguration' => [
            'Enabled' => true || false, // REQUIRED
            'MaxAgeInMinutes' => <integer>,
        ],
    ],
    'WorkGroup' => '<string>',
]);

Parameter Details

Result Syntax

[
    'QueryExecutionId' => '<string>',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

TooManyRequestsException:

Indicates that the request was throttled.

StartSession

$result = $client->startSession([/* ... */]);
$promise = $client->startSessionAsync([/* ... */]);

Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.

Parameter Syntax

$result = $client->startSession([
    'ClientRequestToken' => '<string>',
    'Description' => '<string>',
    'EngineConfiguration' => [ // REQUIRED
        'AdditionalConfigs' => ['<string>', ...],
        'CoordinatorDpuSize' => <integer>,
        'DefaultExecutorDpuSize' => <integer>,
        'MaxConcurrentDpus' => <integer>, // REQUIRED
        'SparkProperties' => ['<string>', ...],
    ],
    'NotebookVersion' => '<string>',
    'SessionIdleTimeoutInMinutes' => <integer>,
    'WorkGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SessionId' => '<string>',
    'State' => 'CREATING|CREATED|IDLE|BUSY|TERMINATING|TERMINATED|DEGRADED|FAILED',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

SessionAlreadyExistsException:

The specified session already exists.

TooManyRequestsException:

Indicates that the request was throttled.

StopCalculationExecution

$result = $client->stopCalculationExecution([/* ... */]);
$promise = $client->stopCalculationExecutionAsync([/* ... */]);

Requests the cancellation of a calculation. A StopCalculationExecution call on a calculation that is already in a terminal state (for example, STOPPED, FAILED, or COMPLETED) succeeds but has no effect.

Parameter Syntax

$result = $client->stopCalculationExecution([
    'CalculationExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'State' => 'CREATING|CREATED|QUEUED|RUNNING|CANCELING|CANCELED|COMPLETED|FAILED',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

StopQueryExecution

$result = $client->stopQueryExecution([/* ... */]);
$promise = $client->stopQueryExecutionAsync([/* ... */]);

Stops a query execution. Requires you to have access to the workgroup in which the query ran.

Parameter Syntax

$result = $client->stopQueryExecution([
    'QueryExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups, data catalogs, or capacity reservations by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

TerminateSession

$result = $client->terminateSession([/* ... */]);
$promise = $client->terminateSessionAsync([/* ... */]);

Terminates an active session. A TerminateSession call on a session that is already inactive (for example, in a FAILED, TERMINATED or TERMINATING state) succeeds but has no effect. Calculations running in the session when TerminateSession is called are forcefully stopped, but may display as FAILED instead of STOPPED.

Parameter Syntax

$result = $client->terminateSession([
    'SessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'State' => 'CREATING|CREATED|IDLE|BUSY|TERMINATING|TERMINATED|DEGRADED|FAILED',
]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from an Athena resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

UpdateCapacityReservation

$result = $client->updateCapacityReservation([/* ... */]);
$promise = $client->updateCapacityReservationAsync([/* ... */]);

Updates the number of requested data processing units for the capacity reservation with the specified name.

Parameter Syntax

$result = $client->updateCapacityReservation([
    'Name' => '<string>', // REQUIRED
    'TargetDpus' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

UpdateDataCatalog

$result = $client->updateDataCatalog([/* ... */]);
$promise = $client->updateDataCatalogAsync([/* ... */]);

Updates the data catalog that has the specified name.

Parameter Syntax

$result = $client->updateDataCatalog([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Parameters' => ['<string>', ...],
    'Type' => 'LAMBDA|GLUE|HIVE|FEDERATED', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

UpdateNamedQuery

$result = $client->updateNamedQuery([/* ... */]);
$promise = $client->updateNamedQueryAsync([/* ... */]);

Updates a NamedQuery object. The database or workgroup cannot be updated.

Parameter Syntax

$result = $client->updateNamedQuery([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'NamedQueryId' => '<string>', // REQUIRED
    'QueryString' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

UpdateNotebook

$result = $client->updateNotebook([/* ... */]);
$promise = $client->updateNotebookAsync([/* ... */]);

Updates the contents of a Spark notebook.

Parameter Syntax

$result = $client->updateNotebook([
    'ClientRequestToken' => '<string>',
    'NotebookId' => '<string>', // REQUIRED
    'Payload' => '<string>', // REQUIRED
    'SessionId' => '<string>',
    'Type' => 'IPYNB', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

TooManyRequestsException:

Indicates that the request was throttled.

UpdateNotebookMetadata

$result = $client->updateNotebookMetadata([/* ... */]);
$promise = $client->updateNotebookMetadataAsync([/* ... */]);

Updates the metadata for a notebook.

Parameter Syntax

$result = $client->updateNotebookMetadata([
    'ClientRequestToken' => '<string>',
    'Name' => '<string>', // REQUIRED
    'NotebookId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

TooManyRequestsException:

Indicates that the request was throttled.

UpdatePreparedStatement

$result = $client->updatePreparedStatement([/* ... */]);
$promise = $client->updatePreparedStatementAsync([/* ... */]);

Updates a prepared statement.

Parameter Syntax

$result = $client->updatePreparedStatement([
    'Description' => '<string>',
    'QueryStatement' => '<string>', // REQUIRED
    'StatementName' => '<string>', // REQUIRED
    'WorkGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException:

A resource, such as a workgroup, was not found.

UpdateWorkGroup

$result = $client->updateWorkGroup([/* ... */]);
$promise = $client->updateWorkGroupAsync([/* ... */]);

Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates can be specified.

Parameter Syntax

$result = $client->updateWorkGroup([
    'ConfigurationUpdates' => [
        'AdditionalConfiguration' => '<string>',
        'BytesScannedCutoffPerQuery' => <integer>,
        'CustomerContentEncryptionConfiguration' => [
            'KmsKey' => '<string>', // REQUIRED
        ],
        'EnableMinimumEncryptionConfiguration' => true || false,
        'EnforceWorkGroupConfiguration' => true || false,
        'EngineVersion' => [
            'EffectiveEngineVersion' => '<string>',
            'SelectedEngineVersion' => '<string>',
        ],
        'ExecutionRole' => '<string>',
        'ManagedQueryResultsConfigurationUpdates' => [
            'Enabled' => true || false,
            'EncryptionConfiguration' => [
                'KmsKey' => '<string>', // REQUIRED
            ],
            'RemoveEncryptionConfiguration' => true || false,
        ],
        'PublishCloudWatchMetricsEnabled' => true || false,
        'QueryResultsS3AccessGrantsConfiguration' => [
            'AuthenticationType' => 'DIRECTORY_IDENTITY', // REQUIRED
            'CreateUserLevelPrefix' => true || false,
            'EnableS3AccessGrants' => true || false, // REQUIRED
        ],
        'RemoveBytesScannedCutoffPerQuery' => true || false,
        'RemoveCustomerContentEncryptionConfiguration' => true || false,
        'RequesterPaysEnabled' => true || false,
        'ResultConfigurationUpdates' => [
            'AclConfiguration' => [
                'S3AclOption' => 'BUCKET_OWNER_FULL_CONTROL', // REQUIRED
            ],
            'EncryptionConfiguration' => [
                'EncryptionOption' => 'SSE_S3|SSE_KMS|CSE_KMS', // REQUIRED
                'KmsKey' => '<string>',
            ],
            'ExpectedBucketOwner' => '<string>',
            'OutputLocation' => '<string>',
            'RemoveAclConfiguration' => true || false,
            'RemoveEncryptionConfiguration' => true || false,
            'RemoveExpectedBucketOwner' => true || false,
            'RemoveOutputLocation' => true || false,
        ],
    ],
    'Description' => '<string>',
    'State' => 'ENABLED|DISABLED',
    'WorkGroup' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException:

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.