RedshiftServerless / Client / list_namespaces

list_namespaces

RedshiftServerless.Client.list_namespaces(**kwargs)

Returns information about a list of specified namespaces.

See also: AWS API Documentation

Request Syntax

response = client.list_namespaces(
    maxResults=123,
    nextToken='string'
)

Parameters:

• maxResults (integer) – An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

• nextToken (string) – If your initial ListNamespaces operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.

Return type:

dict

Returns:

Response Syntax

{
    'namespaces': [
        {
            'adminPasswordSecretArn': 'string',
            'adminPasswordSecretKmsKeyId': 'string',
            'adminUsername': 'string',
            'catalogArn': 'string',
            'creationDate': datetime(2015, 1, 1),
            'dbName': 'string',
            'defaultIamRoleArn': 'string',
            'iamRoles': [
                'string',
            ],
            'kmsKeyId': 'string',
            'lakehouseRegistrationStatus': 'string',
            'logExports': [
                'useractivitylog'|'userlog'|'connectionlog',
            ],
            'namespaceArn': 'string',
            'namespaceId': 'string',
            'namespaceName': 'string',
            's3TablePublishStatus': {
                'enabledAll': True|False,
                'lastIngestionTimes': {
                    'string': 'string'
                },
                's3TableGranularity': 'namespace'|'account',
                's3TableNamespace': 'string',
                's3Tables': [
                    'string',
                ]
            },
            'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • namespaces (list) –

    The list of returned namespaces.

    • (dict) –

      A collection of database objects and users.

      • 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.

      • catalogArn (string) –

        The Amazon Resource Name (ARN) of the Glue Data Catalog associated with the namespace enabled with Amazon Redshift federated permissions.

      • 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.

      • lakehouseRegistrationStatus (string) –

        The status of the lakehouse registration for the namespace. Indicates whether the namespace is successfully registered with Amazon Redshift federated permissions.

      • 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.

      • s3TablePublishStatus (dict) –

        The current Amazon S3 Tables log-publishing status for the namespace. Not returned when S3 Tables publishing has never been configured for the namespace.

        • enabledAll (boolean) –

          true when the namespace is enrolled in every current and future system table rather than an explicit list of tables.

        • lastIngestionTimes (dict) –

          A map of system table name to the time that table last received data, as an ISO-8601 timestamp. A table that has not yet been ingested is absent from the map. Use it to judge data freshness.

          • (string) –

            • (string) –

        • s3TableGranularity (string) –

          The scope currently in effect. Values are namespace or account.

        • s3TableNamespace (string) –

          The identifier of the namespace in the S3 table bucket that holds the published tables.

        • s3Tables (list) –

          The system tables currently being published.

          • (string) –

            A system-table view name to publish to S3 Tables (e.g. “sys_query_history”), or the keyword “all” to publish every current and future system table.

      • status (string) –

        The status of the namespace.

  • nextToken (string) –

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Exceptions

• RedshiftServerless.Client.exceptions.InternalServerException

• RedshiftServerless.Client.exceptions.ValidationException