create_type ¶

create_type(
    keyspace_name: KeyspaceName,
    type_name: TypeName,
    field_definitions: FieldList,
    *,
    config_overrides: Optional[KeyspacesClientConfig] = None,
) -> CreateTypeResponse

The CreateType operation creates a new user-defined type in the specified keyspace.

To configure the required permissions, see Permissions to create a UDT in the Amazon Keyspaces Developer Guide.

For more information, see User-defined types (UDTs) in the Amazon Keyspaces Developer Guide.

Parameters:

keyspace_name (KeyspaceName) –

The name of the keyspace.
type_name (TypeName) –

The name of the user-defined type.

UDT names must contain 48 characters or less, must begin with an alphabetic character, and can only contain alpha-numeric characters and underscores. Amazon Keyspaces converts upper case characters automatically into lower case characters.

Alternatively, you can declare a UDT name in double quotes. When declaring a UDT name inside double quotes, Amazon Keyspaces preserves upper casing and allows special characters.

You can also use double quotes as part of the name when you create the UDT, but you must escape each double quote character with an additional double quote character.
field_definitions (FieldList) –

The field definitions, consisting of names and types, that define this type.

Raises:

AccessDeniedException –

You don't have sufficient access permissions to perform this action.
ConflictException –

Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
InternalServerException –

Amazon Keyspaces was unable to fully process this request because of an internal server error.
ResourceNotFoundException –

The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be ACTIVE.
ServiceQuotaExceededException –

The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
ValidationException –

The operation failed due to an invalid or malformed request.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_keyspaces/_services/keyspaces.py

def create_type(
    self,
    keyspace_name: "capo_keyspaces.types.keyspace_name.KeyspaceName",
    type_name: "capo_keyspaces.types.type_name.TypeName",
    field_definitions: "capo_keyspaces.types.field_list.FieldList",
    *,
    config_overrides: Optional[KeyspacesClientConfig] = None,
) -> "capo_keyspaces.types.create_type_response.CreateTypeResponse":
    """<p> The <code>CreateType</code> operation creates a new user-defined type in the specified keyspace. </p> <p>To configure the required permissions, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/configure-udt-permissions.html#udt-permissions-create">Permissions to create a UDT</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/udts.html">User-defined types (UDTs)</a> in the <i>Amazon Keyspaces Developer Guide</i>. </p>

    Args:
        keyspace_name: <p> The name of the keyspace. </p>
        type_name: <p> The name of the user-defined type. </p> <p>UDT names must contain 48 characters or less, must begin with an alphabetic character, and can only contain alpha-numeric characters and underscores. Amazon Keyspaces converts upper case characters automatically into lower case characters. </p> <p>Alternatively, you can declare a UDT name in double quotes. When declaring a UDT name inside double quotes, Amazon Keyspaces preserves upper casing and allows special characters.</p> <p>You can also use double quotes as part of the name when you create the UDT, but you must escape each double quote character with an additional double quote character.</p>
        field_definitions: <p> The field definitions, consisting of names and types, that define this type. </p>

    Raises:
        capo_keyspaces.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access permissions to perform this action. </p>
        capo_keyspaces.errors.conflict_exception.ConflictException: <p>Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists. </p>
        capo_keyspaces.errors.internal_server_exception.InternalServerException: <p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>
        capo_keyspaces.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
        capo_keyspaces.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
        capo_keyspaces.errors.validation_exception.ValidationException: <p>The operation failed due to an invalid or malformed request.</p>
        capo_keyspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_keyspaces.types.create_type_request.CreateTypeRequest]",
    ) -> OperationResponse[
        "capo_keyspaces.types.create_type_response.CreateTypeResponse"
    ]:
        import capo_keyspaces._operations.keyspaces_service.create_type

        output, http_response = (
            capo_keyspaces._operations.keyspaces_service.create_type.create_type(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateType")
    )
    input_: capo_keyspaces.types.create_type_request.CreateTypeRequest = {
        "keyspace_name": keyspace_name,
        "type_name": type_name,
        "field_definitions": field_definitions,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output