Bedrock / Paginator / ListCustomModelDeployments

ListCustomModelDeployments

class Bedrock.Paginator.ListCustomModelDeployments

paginator = client.get_paginator('list_custom_model_deployments')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    createdBefore=datetime(2015, 1, 1),
    createdAfter=datetime(2015, 1, 1),
    nameContains='string',
    sortBy='CreationTime',
    sortOrder='Ascending'|'Descending',
    statusEquals='Creating'|'Active'|'Failed',
    modelArnEquals='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• createdBefore (datetime) – Filters deployments created before the specified date and time.

• createdAfter (datetime) – Filters deployments created after the specified date and time.

• nameContains (string) – Filters deployments whose names contain the specified string.

• sortBy (string) – The field to sort the results by. The only supported value is CreationTime.

• sortOrder (string) – The sort order for the results. Valid values are Ascending and Descending. Default is Descending.

• statusEquals (string) – Filters deployments by status. Valid values are CREATING, ACTIVE, and FAILED.

• modelArnEquals (string) – Filters deployments by the Amazon Resource Name (ARN) of the associated custom model.

• 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

{
    'modelDeploymentSummaries': [
        {
            'customModelDeploymentArn': 'string',
            'customModelDeploymentName': 'string',
            'modelArn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'status': 'Creating'|'Active'|'Failed',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'failureMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • modelDeploymentSummaries (list) –

    A list of custom model deployment summaries.

    • (dict) –

      Contains summary information about a custom model deployment, including its ARN, name, status, and associated custom model.

      • customModelDeploymentArn (string) –

        The Amazon Resource Name (ARN) of the custom model deployment.

      • customModelDeploymentName (string) –

        The name of the custom model deployment.

      • modelArn (string) –

        The Amazon Resource Name (ARN) of the custom model associated with this deployment.

      • createdAt (datetime) –

        The date and time when the custom model deployment was created.

      • status (string) –

        The status of the custom model deployment. Possible values are CREATING, ACTIVE, and FAILED.

      • lastUpdatedAt (datetime) –

        The date and time when the custom model deployment was last modified.

      • failureMessage (string) –

        If the deployment status is FAILED, this field contains a message describing the failure reason.

  • NextToken (string) –

    A token to resume pagination.