Redshift / Client / register_namespace

register_namespace

Redshift.Client.register_namespace(**kwargs)

Registers a cluster or serverless namespace to the Amazon Web Services Glue Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.register_namespace(
    NamespaceIdentifier={
        'ServerlessIdentifier': {
            'NamespaceIdentifier': 'string',
            'WorkgroupIdentifier': 'string'
        },
        'ProvisionedIdentifier': {
            'ClusterIdentifier': 'string'
        }
    },
    ConsumerIdentifiers=[
        'string',
    ]
)

Parameters:

• NamespaceIdentifier (dict) –

  [REQUIRED]

  The unique identifier of the cluster or serverless namespace that you want to register.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: ServerlessIdentifier, ProvisionedIdentifier.

  • ServerlessIdentifier (dict) –

    The identifier for a serverless namespace.

    • NamespaceIdentifier (string) – [REQUIRED]

      The unique identifier for the serverless namespace.

    • WorkgroupIdentifier (string) – [REQUIRED]

      The unique identifier for the workgroup associated with the serverless namespace.

  • ProvisionedIdentifier (dict) –

    The identifier for a provisioned cluster.

    • ClusterIdentifier (string) – [REQUIRED]

      The unique identifier for the provisioned cluster.

• ConsumerIdentifiers (list) –

  [REQUIRED]

  An array containing the ID of the consumer account that you want to register the namespace to.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'Registering'|'Deregistering'
}

Response Structure

• (dict) –

  • Status (string) –

    The registration status of the cluster or serverless namespace.

Exceptions

• Redshift.Client.exceptions.ClusterNotFoundFault

• Redshift.Client.exceptions.InvalidNamespaceFault

• Redshift.Client.exceptions.InvalidClusterStateFault