RedshiftServerless / Client / get_namespace

get_namespace#

RedshiftServerless.Client.get_namespace(**kwargs)#

Returns information about a namespace in Amazon Redshift Serverless.

See also: AWS API Documentation

Request Syntax

response = client.get_namespace(
    namespaceName='string'
)
Parameters:

namespaceName (string) –

[REQUIRED]

The name of the namespace to retrieve information for.

Return type:

dict

Returns:

Response Syntax

{
    'namespace': {
        'adminPasswordSecretArn': 'string',
        'adminPasswordSecretKmsKeyId': 'string',
        'adminUsername': 'string',
        'creationDate': datetime(2015, 1, 1),
        'dbName': 'string',
        'defaultIamRoleArn': 'string',
        'iamRoles': [
            'string',
        ],
        'kmsKeyId': 'string',
        'logExports': [
            'useractivitylog'|'userlog'|'connectionlog',
        ],
        'namespaceArn': 'string',
        'namespaceId': 'string',
        'namespaceName': 'string',
        'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
    }
}

Response Structure

  • (dict) –

    • namespace (dict) –

      The returned namespace object.

      • adminPasswordSecretArn (string) –

        The Amazon Resource Name (ARN) for the namespace’s admin user credentials secret.

      • adminPasswordSecretKmsKeyId (string) –

        The ID of the Key Management Service (KMS) key used to encrypt and store the namespace’s admin credentials secret.

      • adminUsername (string) –

        The username of the administrator for the first database created in the namespace.

      • creationDate (datetime) –

        The date of when the namespace was created.

      • dbName (string) –

        The name of the first database created in the namespace.

      • defaultIamRoleArn (string) –

        The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

      • iamRoles (list) –

        A list of IAM roles to associate with the namespace.

        • (string) –

      • kmsKeyId (string) –

        The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

      • logExports (list) –

        The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

        • (string) –

      • namespaceArn (string) –

        The Amazon Resource Name (ARN) associated with a namespace.

      • namespaceId (string) –

        The unique identifier of a namespace.

      • namespaceName (string) –

        The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

      • status (string) –

        The status of the namespace.

Exceptions