Redshift / Paginator / DescribeHsmConfigurations

DescribeHsmConfigurations

class Redshift.Paginator.DescribeHsmConfigurations

paginator = client.get_paginator('describe_hsm_configurations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Redshift.Client.describe_hsm_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    HsmConfigurationIdentifier='string',
    TagKeys=[
        'string',
    ],
    TagValues=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• HsmConfigurationIdentifier (string) – The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your Amazon Web Services account.

• TagKeys (list) –

  A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them.

  • (string) –

• TagValues (list) –

  A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.

  • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'HsmConfigurations': [
        {
            'HsmConfigurationIdentifier': 'string',
            'Description': 'string',
            'HsmIpAddress': 'string',
            'HsmPartitionName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • HsmConfigurations (list) –

    A list of HsmConfiguration objects.

    • (dict) –

      Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.

      • HsmConfigurationIdentifier (string) –

        The name of the Amazon Redshift HSM configuration.

      • Description (string) –

        A text description of the HSM configuration.

      • HsmIpAddress (string) –

        The IP address that the Amazon Redshift cluster must use to access the HSM.

      • HsmPartitionName (string) –

        The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

      • Tags (list) –

        The list of tags for the HSM configuration.

        • (dict) –

          A tag consisting of a name/value pair for a resource.

          • Key (string) –

            The key, or name, for the resource tag.

          • Value (string) –

            The value for the resource tag.

  • NextToken (string) –

    A token to resume pagination.