Returns the specified data catalog.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
get-data-catalog
--name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
--name
(string)
The name of the data catalog to return.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
To return information about a data catalog
The following get-data-catalog
example returns information about the dynamo_db_catalog
data catalog.
aws athena get-data-catalog \
--name dynamo_db_catalog
Output:
{
"DataCatalog": {
"Name": "dynamo_db_catalog",
"Description": "DynamoDB Catalog",
"Type": "LAMBDA",
"Parameters": {
"catalog": "dynamo_db_catalog",
"metadata-function": "arn:aws:lambda:us-west-2:111122223333:function:dynamo_db_lambda",
"record-function": "arn:aws:lambda:us-west-2:111122223333:function:dynamo_db_lambda"
}
}
}
For more information, see Showing Catalog Details: get-data-catalog in the Amazon Athena User Guide.
DataCatalog -> (structure)
The data catalog returned.
Name -> (string)
The name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
Description -> (string)
An optional description of the data catalog.
Type -> (string)
The type of data catalog:
LAMBDA
for a federated catalog,GLUE
for AWS Glue Catalog, orHIVE
for an external hive metastore.Parameters -> (map)
Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type.
For the
HIVE
data catalog type, use the following syntax. Themetadata-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 has no parameters.key -> (string)
value -> (string)