Aws::Athena::Model::CreateDataCatalogRequest Class Reference

#include <CreateDataCatalogRequest.h>

Inheritance diagram for Aws::Athena::Model::CreateDataCatalogRequest:

Public Member Functions
	CreateDataCatalogRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetName () const
bool	NameHasBeenSet () const
void	SetName (const Aws::String &value)
void	SetName (Aws::String &&value)
void	SetName (const char *value)
CreateDataCatalogRequest &	WithName (const Aws::String &value)
CreateDataCatalogRequest &	WithName (Aws::String &&value)
CreateDataCatalogRequest &	WithName (const char *value)
const DataCatalogType &	GetType () const
bool	TypeHasBeenSet () const
void	SetType (const DataCatalogType &value)
void	SetType (DataCatalogType &&value)
CreateDataCatalogRequest &	WithType (const DataCatalogType &value)
CreateDataCatalogRequest &	WithType (DataCatalogType &&value)
const Aws::String &	GetDescription () const
bool	DescriptionHasBeenSet () const
void	SetDescription (const Aws::String &value)
void	SetDescription (Aws::String &&value)
void	SetDescription (const char *value)
CreateDataCatalogRequest &	WithDescription (const Aws::String &value)
CreateDataCatalogRequest &	WithDescription (Aws::String &&value)
CreateDataCatalogRequest &	WithDescription (const char *value)
const Aws::Map< Aws::String, Aws::String > &	GetParameters () const
bool	ParametersHasBeenSet () const
void	SetParameters (const Aws::Map< Aws::String, Aws::String > &value)
void	SetParameters (Aws::Map< Aws::String, Aws::String > &&value)
CreateDataCatalogRequest &	WithParameters (const Aws::Map< Aws::String, Aws::String > &value)
CreateDataCatalogRequest &	WithParameters (Aws::Map< Aws::String, Aws::String > &&value)
CreateDataCatalogRequest &	AddParameters (const Aws::String &key, const Aws::String &value)
CreateDataCatalogRequest &	AddParameters (Aws::String &&key, const Aws::String &value)
CreateDataCatalogRequest &	AddParameters (const Aws::String &key, Aws::String &&value)
CreateDataCatalogRequest &	AddParameters (Aws::String &&key, Aws::String &&value)
CreateDataCatalogRequest &	AddParameters (const char *key, Aws::String &&value)
CreateDataCatalogRequest &	AddParameters (Aws::String &&key, const char *value)
CreateDataCatalogRequest &	AddParameters (const char *key, const char *value)
const Aws::Vector< Tag > &	GetTags () const
bool	TagsHasBeenSet () const
void	SetTags (const Aws::Vector< Tag > &value)
void	SetTags (Aws::Vector< Tag > &&value)
CreateDataCatalogRequest &	WithTags (const Aws::Vector< Tag > &value)
CreateDataCatalogRequest &	WithTags (Aws::Vector< Tag > &&value)
CreateDataCatalogRequest &	AddTags (const Tag &value)
CreateDataCatalogRequest &	AddTags (Tag &&value)
Public Member Functions inherited from Aws::Athena::AthenaRequest
virtual	~AthenaRequest ()
void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
Aws::Http::HeaderValueCollection	GetHeaders () const override
Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()
virtual	~AmazonSerializableWebServiceRequest ()
std::shared_ptr< Aws::IOStream >	GetBody () const override
Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()
virtual	~AmazonWebServiceRequest ()=default
virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const
virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const
virtual bool	IsStreaming () const
virtual bool	IsEventStreamRequest () const
virtual bool	SignBody () const
virtual bool	IsChunked () const
virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)
virtual const RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () const
void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)
virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)
virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () const
virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Definition at line 25 of file CreateDataCatalogRequest.h.

Constructor & Destructor Documentation

CreateDataCatalogRequest()

Aws::Athena::Model::CreateDataCatalogRequest::CreateDataCatalogRequest

(

)

Member Function Documentation

AddParameters() [1/7]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::AddParameters ( Aws::String &&  key, Aws::String &&  value  )

inline

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

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

  metadata-function=lambda_arn, sdk-version=version_number

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

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

    metadata-function=lambda_arn, record-function=lambda_arn

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

    function=lambda_arn

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

  catalog-id=catalog_id

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

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

Definition at line 480 of file CreateDataCatalogRequest.h.

AddParameters() [2/7]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::AddParameters ( Aws::String &&  key, const Aws::String &  value  )

inline

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

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

  metadata-function=lambda_arn, sdk-version=version_number

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

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

    metadata-function=lambda_arn, record-function=lambda_arn

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

    function=lambda_arn

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

  catalog-id=catalog_id

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

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

Definition at line 420 of file CreateDataCatalogRequest.h.

AddParameters() [3/7]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::AddParameters ( Aws::String &&  key, const char *  value  )

inline

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

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

  metadata-function=lambda_arn, sdk-version=version_number

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

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

    metadata-function=lambda_arn, record-function=lambda_arn

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

    function=lambda_arn

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

  catalog-id=catalog_id

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

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

Definition at line 540 of file CreateDataCatalogRequest.h.

AddParameters() [4/7]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::AddParameters ( const Aws::String &  key, Aws::String &&  value  )

inline

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

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

  metadata-function=lambda_arn, sdk-version=version_number

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

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

    metadata-function=lambda_arn, record-function=lambda_arn

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

    function=lambda_arn

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

  catalog-id=catalog_id

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

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

Definition at line 450 of file CreateDataCatalogRequest.h.

AddParameters() [5/7]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::AddParameters ( const Aws::String &  key, const Aws::String &  value  )

inline

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

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

  metadata-function=lambda_arn, sdk-version=version_number

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

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

    metadata-function=lambda_arn, record-function=lambda_arn

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

    function=lambda_arn

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

  catalog-id=catalog_id

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

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

Definition at line 390 of file CreateDataCatalogRequest.h.

AddParameters() [6/7]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::AddParameters ( const char *  key, Aws::String &&  value  )

inline

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

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

  metadata-function=lambda_arn, sdk-version=version_number

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

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

    metadata-function=lambda_arn, record-function=lambda_arn

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

    function=lambda_arn

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

  catalog-id=catalog_id

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

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

Definition at line 510 of file CreateDataCatalogRequest.h.

AddParameters() [7/7]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::AddParameters ( const char *  key, const char *  value  )

inline

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

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

  metadata-function=lambda_arn, sdk-version=version_number

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

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

    metadata-function=lambda_arn, record-function=lambda_arn

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

    function=lambda_arn

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

  catalog-id=catalog_id

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

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

Definition at line 570 of file CreateDataCatalogRequest.h.

AddTags() [1/2]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::AddTags ( const Tag &  value )

inline

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

Definition at line 613 of file CreateDataCatalogRequest.h.

AddTags() [2/2]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::AddTags ( Tag &&  value )

inline

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

Definition at line 619 of file CreateDataCatalogRequest.h.

DescriptionHasBeenSet()

bool Aws::Athena::Model::CreateDataCatalogRequest::DescriptionHasBeenSet ( ) const

inline

A description of the data catalog to be created.

Definition at line 149 of file CreateDataCatalogRequest.h.

GetDescription()

const Aws::String& Aws::Athena::Model::CreateDataCatalogRequest::GetDescription ( ) const

inline

A description of the data catalog to be created.

Definition at line 144 of file CreateDataCatalogRequest.h.

GetName()

const Aws::String& Aws::Athena::Model::CreateDataCatalogRequest::GetName ( ) const

inline

The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 46 of file CreateDataCatalogRequest.h.

GetParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::Athena::Model::CreateDataCatalogRequest::GetParameters ( ) const

inline

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

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

  metadata-function=lambda_arn, sdk-version=version_number

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

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

    metadata-function=lambda_arn, record-function=lambda_arn

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

    function=lambda_arn

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

  catalog-id=catalog_id

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

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

Definition at line 210 of file CreateDataCatalogRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Athena::Model::CreateDataCatalogRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::Athena::AthenaRequest.

GetServiceRequestName()

virtual const char* Aws::Athena::Model::CreateDataCatalogRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CreateDataCatalogRequest.h.

GetTags()

const Aws::Vector<Tag>& Aws::Athena::Model::CreateDataCatalogRequest::GetTags ( ) const

inline

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

Definition at line 577 of file CreateDataCatalogRequest.h.

GetType()

const DataCatalogType& Aws::Athena::Model::CreateDataCatalogRequest::GetType ( ) const

inline

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

Definition at line 103 of file CreateDataCatalogRequest.h.

NameHasBeenSet()

bool Aws::Athena::Model::CreateDataCatalogRequest::NameHasBeenSet ( ) const

inline

The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 53 of file CreateDataCatalogRequest.h.

ParametersHasBeenSet()

bool Aws::Athena::Model::CreateDataCatalogRequest::ParametersHasBeenSet ( ) const

inline

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

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

  metadata-function=lambda_arn, sdk-version=version_number

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

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

    metadata-function=lambda_arn, record-function=lambda_arn

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

    function=lambda_arn

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

  catalog-id=catalog_id

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

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

Definition at line 240 of file CreateDataCatalogRequest.h.

SerializePayload()

Aws::String Aws::Athena::Model::CreateDataCatalogRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetDescription() [1/3]

void Aws::Athena::Model::CreateDataCatalogRequest::SetDescription ( Aws::String &&  value )

inline

A description of the data catalog to be created.

Definition at line 159 of file CreateDataCatalogRequest.h.

SetDescription() [2/3]

void Aws::Athena::Model::CreateDataCatalogRequest::SetDescription ( const Aws::String &  value )

inline

A description of the data catalog to be created.

Definition at line 154 of file CreateDataCatalogRequest.h.

SetDescription() [3/3]

void Aws::Athena::Model::CreateDataCatalogRequest::SetDescription ( const char *  value )

inline

A description of the data catalog to be created.

Definition at line 164 of file CreateDataCatalogRequest.h.

SetName() [1/3]

void Aws::Athena::Model::CreateDataCatalogRequest::SetName ( Aws::String &&  value )

inline

The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 67 of file CreateDataCatalogRequest.h.

SetName() [2/3]

void Aws::Athena::Model::CreateDataCatalogRequest::SetName ( const Aws::String &  value )

inline

The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 60 of file CreateDataCatalogRequest.h.

SetName() [3/3]

void Aws::Athena::Model::CreateDataCatalogRequest::SetName ( const char *  value )

inline

The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 74 of file CreateDataCatalogRequest.h.

SetParameters() [1/2]

void Aws::Athena::Model::CreateDataCatalogRequest::SetParameters ( Aws::Map< Aws::String, Aws::String > &&  value )

inline

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

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

  metadata-function=lambda_arn, sdk-version=version_number

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

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

    metadata-function=lambda_arn, record-function=lambda_arn

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

    function=lambda_arn

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

  catalog-id=catalog_id

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

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

Definition at line 300 of file CreateDataCatalogRequest.h.

SetParameters() [2/2]

void Aws::Athena::Model::CreateDataCatalogRequest::SetParameters ( const Aws::Map< Aws::String, Aws::String > &  value )

inline

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

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

  metadata-function=lambda_arn, sdk-version=version_number

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

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

    metadata-function=lambda_arn, record-function=lambda_arn

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

    function=lambda_arn

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

  catalog-id=catalog_id

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

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

Definition at line 270 of file CreateDataCatalogRequest.h.

SetTags() [1/2]

void Aws::Athena::Model::CreateDataCatalogRequest::SetTags ( Aws::Vector< Tag > &&  value )

inline

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

Definition at line 595 of file CreateDataCatalogRequest.h.

SetTags() [2/2]

void Aws::Athena::Model::CreateDataCatalogRequest::SetTags ( const Aws::Vector< Tag > &  value )

inline

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

Definition at line 589 of file CreateDataCatalogRequest.h.

SetType() [1/2]

void Aws::Athena::Model::CreateDataCatalogRequest::SetType ( const DataCatalogType &  value )

inline

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

Definition at line 117 of file CreateDataCatalogRequest.h.

SetType() [2/2]

void Aws::Athena::Model::CreateDataCatalogRequest::SetType ( DataCatalogType &&  value )

inline

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

Definition at line 124 of file CreateDataCatalogRequest.h.

TagsHasBeenSet()

bool Aws::Athena::Model::CreateDataCatalogRequest::TagsHasBeenSet ( ) const

inline

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

Definition at line 583 of file CreateDataCatalogRequest.h.

TypeHasBeenSet()

bool Aws::Athena::Model::CreateDataCatalogRequest::TypeHasBeenSet ( ) const

inline

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

Definition at line 110 of file CreateDataCatalogRequest.h.

WithDescription() [1/3]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::WithDescription ( Aws::String &&  value )

inline

A description of the data catalog to be created.

Definition at line 174 of file CreateDataCatalogRequest.h.

WithDescription() [2/3]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::WithDescription ( const Aws::String &  value )

inline

A description of the data catalog to be created.

Definition at line 169 of file CreateDataCatalogRequest.h.

WithDescription() [3/3]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::WithDescription ( const char *  value )

inline

A description of the data catalog to be created.

Definition at line 179 of file CreateDataCatalogRequest.h.

WithName() [1/3]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::WithName ( Aws::String &&  value )

inline

The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 88 of file CreateDataCatalogRequest.h.

WithName() [2/3]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::WithName ( const Aws::String &  value )

inline

The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 81 of file CreateDataCatalogRequest.h.

WithName() [3/3]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::WithName ( const char *  value )

inline

The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 95 of file CreateDataCatalogRequest.h.

WithParameters() [1/2]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::WithParameters ( Aws::Map< Aws::String, Aws::String > &&  value )

inline

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

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

  metadata-function=lambda_arn, sdk-version=version_number

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

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

    metadata-function=lambda_arn, record-function=lambda_arn

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

    function=lambda_arn

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

  catalog-id=catalog_id

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

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

Definition at line 360 of file CreateDataCatalogRequest.h.

WithParameters() [2/2]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::WithParameters ( const Aws::Map< Aws::String, Aws::String > &  value )

inline

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

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

  metadata-function=lambda_arn, sdk-version=version_number

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

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

    metadata-function=lambda_arn, record-function=lambda_arn

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

    function=lambda_arn

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

  catalog-id=catalog_id

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

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

Definition at line 330 of file CreateDataCatalogRequest.h.

WithTags() [1/2]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::WithTags ( Aws::Vector< Tag > &&  value )

inline

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

Definition at line 607 of file CreateDataCatalogRequest.h.

WithTags() [2/2]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::WithTags ( const Aws::Vector< Tag > &  value )

inline

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

Definition at line 601 of file CreateDataCatalogRequest.h.

WithType() [1/2]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::WithType ( const DataCatalogType &  value )

inline

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

Definition at line 131 of file CreateDataCatalogRequest.h.

WithType() [2/2]

CreateDataCatalogRequest& Aws::Athena::Model::CreateDataCatalogRequest::WithType ( DataCatalogType &&  value )

inline

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

Definition at line 138 of file CreateDataCatalogRequest.h.

---

The documentation for this class was generated from the following file:

• aws-cpp-sdk-athena/include/aws/athena/model/CreateDataCatalogRequest.h