View a markdown version of this page

Endpoint overrides - Amazon Athena
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Endpoint overrides

Athena endpoint override

The endpointOverride ClientConfiguration class uses this value override the default HTTP endpoint for the Amazon Athena client. For more information, see Amazon Client configuration in the Amazon SDK for C++ Developer Guide.

Connection string name Parameter type Default value Connection string example
EndpointOverride Optional none EndpointOverride=athena.us-west-2.amazonaws.com;

Athena streaming endpoint override

The ClientConfiguration.endpointOverride method uses this value to override the default HTTP endpoint for the Amazon Athena streaming client. For more information, Amazon Client configuration in the Amazon SDK for C++ Developer Guide. The Athena Streaming service is available through port 444.

Connection string name Parameter type Default value Connection string example
StreamingEndpointOverride Optional none StreamingEndpointOverride=athena.us-west-1.amazonaws.com:444;

Amazon STS endpoint override

The ClientConfiguration.endpointOverride method uses this value to override the default HTTP endpoint for the Amazon STS client. For more information, see Amazon Client configuration in the Amazon SDK for C++ Developer Guide.

Connection string name Parameter type Default value Connection string example
StsEndpointOverride Optional none StsEndpointOverride=sts.us-west-1.amazonaws.com;

Lake Formation endpoint override

The ClientConfiguration.endpointOverride method uses this value to override the default HTTP endpoint for the Lake Formation client. For more information, see Amazon Client configuration in the Amazon SDK for C++ Developer Guide.

Connection string name Parameter type Default value Connection string example
LakeFormationEndpointOverride Optional none LakeFormationEndpointOverride=lakeformation.us-west-1.amazonaws.com;

Amazon Glue endpoint override

The ClientConfiguration.endpointOverride method uses this value to override the default HTTP endpoint for the Amazon Glue client that the driver uses for multi-catalog browsing. For more information, see Amazon Client configuration in the Amazon SDK for C++ Developer Guide.

If a call to list Amazon Glue catalogs fails for a reason other than an access-denied or entity-not-found error, such as throttling, catalog functions fail with SQLSTATE HY000 and a message that begins with [AmazonAthena][GlueClientError]. To avoid the Amazon Glue call for the top-level catalog list, set UseSingleCatalogAndSchema=1. For more information, see Use single catalog and schema.

The Windows ODBC Data Source Administrator dialog box has no field for this parameter, and saving a DSN from that dialog box removes the parameter. Set this parameter in your connection string or directly in your DSN.

Connection string name Parameter type Default value Connection string example
GlueEndpointOverride Optional none GlueEndpointOverride=glue.us-west-1.amazonaws.com;

SSO endpoint override

The ClientConfiguration.endpointOverride method uses this value to override the default HTTP endpoint for the SSO client. For more information, see Amazon Client configuration in the Amazon SDK for C++ Developer Guide.

Connection string name Parameter type Default value Connection string example

SSOEndpointOverride

Optional none SSOEndpointOverride=portal.sso.us-east-2.amazonaws.com;

SSO OIDC endpoint override

The ClientConfiguration.endpointOverride method uses this value to override the default HTTP endpoint for the SSO OIDC client. For more information, see Amazon Client configuration in the Amazon SDK for C++ Developer Guide.

Connection string name Parameter type Default value Connection string example

SSOOIDCEndpointOverride

Optional none SSOOIDCEndpointOverride=oidc.us-east-2.amazonaws.com

SSO Admin endpoint override

The ClientConfiguration.endpointOverride method uses this value to override the default HTTP endpoint for SSO Admin client. For more information, see ClientConfiguration.

Connection string name Parameter type Default value Connection string example
SSOAdminEndpointOverride Optional none SSOAdminEndpointOverride=sso.us-east-2.amazonaws.com

S3 endpoint override

The ClientConfiguration.endpointOverride method uses this value to override the default HTTP endpoint for S3 client. The endpoint that the driver will use to download query results when it uses the Amazon S3 fetcher. If this parameter is not specified, the driver uses a default Amazon S3 endpoint. For more information, see ClientConfiguration.

Connection string name Parameter type Default value Connection string example
S3EndpointOverride Optional none S3EndpointOverride=s3.us-east-2.amazonaws.com

SageMaker endpoint override

The ClientConfiguration.endpointOverride method uses this value to override the default HTTP endpoint for the DataZone client. For more information, see ClientConfiguration.

Connection string name Parameter type Default value Connection string example
SageMakerEndpointOverride Optional none SageMakerEndpointOverride=datazone.us-east-1.amazonaws.com