Bedrock / Client / list_custom_model_deployments

list_custom_model_deployments

Bedrock.Client.list_custom_model_deployments(**kwargs)

Lists custom model deployments in your account. You can filter the results by creation time, name, status, and associated model. Use this operation to manage and monitor your custom model deployments.

We recommend using pagination to ensure that the operation returns quickly and successfully.

The following actions are related to the ListCustomModelDeployments operation:

See also: AWS API Documentation

Request Syntax

response = client.list_custom_model_deployments(
    createdBefore=datetime(2015, 1, 1),
    createdAfter=datetime(2015, 1, 1),
    nameContains='string',
    maxResults=123,
    nextToken='string',
    sortBy='CreationTime',
    sortOrder='Ascending'|'Descending',
    statusEquals='Creating'|'Active'|'Failed',
    modelArnEquals='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.

  • maxResults (integer) – The maximum number of results to return in a single call.

  • nextToken (string) – The token for the next set of results. Use this token to retrieve additional results when the response is truncated.

  • 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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • nextToken (string) –

      The token for the next set of results. This value is null when there are no more results to return.

    • 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.

Exceptions

  • Bedrock.Client.exceptions.AccessDeniedException

  • Bedrock.Client.exceptions.ValidationException

  • Bedrock.Client.exceptions.InternalServerException

  • Bedrock.Client.exceptions.ThrottlingException