Keyspaces / Client / list_types

list_types#

Keyspaces.Client.list_types(**kwargs)#

The ListTypes operation returns a list of types for a specified keyspace.

To read keyspace metadata using ListTypes, the IAM principal needs Select action permissions for the system keyspace. To configure the required permissions, see Permissions to view a UDT in the Amazon Keyspaces Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_types(
    nextToken='string',
    maxResults=123,
    keyspaceName='string'
)
Parameters:

  • nextToken (string) – The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

  • maxResults (integer) – The total number of types to return in the output. If the total number of types available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

  • keyspaceName (string) –

    [REQUIRED]

    The name of the keyspace that contains the listed types.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'types': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

    • types (list) –

      The list of types contained in the specified keyspace.

      • (string) –

Exceptions

  • Keyspaces.Client.exceptions.ValidationException

  • Keyspaces.Client.exceptions.ServiceQuotaExceededException

  • Keyspaces.Client.exceptions.InternalServerException

  • Keyspaces.Client.exceptions.AccessDeniedException

  • Keyspaces.Client.exceptions.ResourceNotFoundException