Class: Aws::Athena::Types::UpdateDataCatalogInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-athena/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

New or modified text that describes the data catalog.

Returns:

  • (String)


4817
4818
4819
4820
4821
4822
4823
4824
# File 'lib/aws-sdk-athena/types.rb', line 4817

class UpdateDataCatalogInput < Struct.new(
  :name,
  :type,
  :description,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


4817
4818
4819
4820
4821
4822
4823
4824
# File 'lib/aws-sdk-athena/types.rb', line 4817

class UpdateDataCatalogInput < Struct.new(
  :name,
  :type,
  :description,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#parametersHash<String,String>

Specifies the Lambda function or functions to use for updating 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 `

Returns:

  • (Hash<String,String>)


4817
4818
4819
4820
4821
4822
4823
4824
# File 'lib/aws-sdk-athena/types.rb', line 4817

class UpdateDataCatalogInput < Struct.new(
  :name,
  :type,
  :description,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

Specifies the type of data catalog to update. Specify ‘LAMBDA` for a federated catalog, `HIVE` for an external hive metastore, or `GLUE` for an Glue Data Catalog.

Returns:

  • (String)


4817
4818
4819
4820
4821
4822
4823
4824
# File 'lib/aws-sdk-athena/types.rb', line 4817

class UpdateDataCatalogInput < Struct.new(
  :name,
  :type,
  :description,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end