Bedrock / Paginator / ListGuardrails

ListGuardrails

class Bedrock.Paginator.ListGuardrails

paginator = client.get_paginator('list_guardrails')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Bedrock.Client.list_guardrails().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    guardrailIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• guardrailIdentifier (string) – The unique identifier of the guardrail. This can be an ID or the ARN.

• 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

{
    'guardrails': [
        {
            'id': 'string',
            'arn': 'string',
            'status': 'CREATING'|'UPDATING'|'VERSIONING'|'READY'|'FAILED'|'DELETING',
            'name': 'string',
            'description': 'string',
            'version': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'crossRegionDetails': {
                'guardrailProfileId': 'string',
                'guardrailProfileArn': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • guardrails (list) –

    A list of objects, each of which contains details about a guardrail.

    • (dict) –

      Contains details about a guardrail.

      This data type is used in the following API operations:

      • ListGuardrails response body

      • id (string) –

        The unique identifier of the guardrail.

      • arn (string) –

        The ARN of the guardrail.

      • status (string) –

        The status of the guardrail.

      • name (string) –

        The name of the guardrail.

      • description (string) –

        A description of the guardrail.

      • version (string) –

        The version of the guardrail.

      • createdAt (datetime) –

        The date and time at which the guardrail was created.

      • updatedAt (datetime) –

        The date and time at which the guardrail was last updated.

      • crossRegionDetails (dict) –

        Details about the system-defined guardrail profile that you’re using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

        • guardrailProfileId (string) –

          The ID of the guardrail profile that your guardrail is using. Profile availability depends on your current Amazon Web Services Region. For more information, see the Amazon Bedrock User Guide.

        • guardrailProfileArn (string) –

          The Amazon Resource Name (ARN) of the guardrail profile that you’re using with your guardrail.

  • NextToken (string) –

    A token to resume pagination.