RedshiftServerless / Client / create_namespace

create_namespace#

RedshiftServerless.Client.create_namespace(**kwargs)#

Creates a namespace in Amazon Redshift Serverless.

See also: AWS API Documentation

Request Syntax

response = client.create_namespace(
    adminUserPassword='string',
    adminUsername='string',
    dbName='string',
    defaultIamRoleArn='string',
    iamRoles=[
        'string',
    ],
    kmsKeyId='string',
    logExports=[
        'useractivitylog'|'userlog'|'connectionlog',
    ],
    namespaceName='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters:
  • adminUserPassword (string) – The password of the administrator for the first database created in the namespace.

  • adminUsername (string) – The username of the administrator for the first database created in the namespace.

  • 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 userlog, connectionlog, and useractivitylog.

    • (string) –

  • namespaceName (string) –

    [REQUIRED]

    The name of the namespace.

  • tags (list) –

    A list of tag instances.

    • (dict) –

      A map of key-value pairs.

      • key (string) – [REQUIRED]

        The key to use in the tag.

      • value (string) – [REQUIRED]

        The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    'namespace': {
        '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 created namespace object.

      • 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

  • RedshiftServerless.Client.exceptions.InternalServerException

  • RedshiftServerless.Client.exceptions.ConflictException

  • RedshiftServerless.Client.exceptions.ValidationException

  • RedshiftServerless.Client.exceptions.TooManyTagsException