Skip to content

list_custom_model_deployments

list_custom_model_deployments(
    *,
    config_overrides: Optional[BedrockClientConfig] = None,
    created_before: Optional[Timestamp] = None,
    created_after: Optional[Timestamp] = None,
    name_contains: Optional[ModelDeploymentName] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[PaginationToken] = None,
    sort_by: Optional[SortModelsBy] = None,
    sort_order: Optional[SortOrder] = None,
    status_equals: Optional[CustomModelDeploymentStatus] = None,
    model_arn_equals: Optional[CustomModelArn] = None,
) -> ListCustomModelDeploymentsResponse

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:

Parameters:

  • created_before (Optional[Timestamp], default: None ) –

    Filters deployments created before the specified date and time.

  • created_after (Optional[Timestamp], default: None ) –

    Filters deployments created after the specified date and time.

  • name_contains (Optional[ModelDeploymentName], default: None ) –

    Filters deployments whose names contain the specified string.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return in a single call.

  • next_token (Optional[PaginationToken], default: None ) –

    The token for the next set of results. Use this token to retrieve additional results when the response is truncated.

  • sort_by (Optional[SortModelsBy], default: None ) –

    The field to sort the results by. The only supported value is CreationTime.

  • sort_order (Optional[SortOrder], default: None ) –

    The sort order for the results. Valid values are Ascending and Descending. Default is Descending.

  • status_equals (Optional[CustomModelDeploymentStatus], default: None ) –

    Filters deployments by status. Valid values are CREATING, ACTIVE, and FAILED.

  • model_arn_equals (Optional[CustomModelArn], default: None ) –

    Filters deployments by the Amazon Resource Name (ARN) of the associated custom model.

Raises:

Source code in docs_src/capo_bedrock/_services/bedrock.py
def list_custom_model_deployments(
    self,
    *,
    config_overrides: Optional[BedrockClientConfig] = None,
    created_before: Optional["capo_bedrock.types.timestamp.Timestamp"] = None,
    created_after: Optional["capo_bedrock.types.timestamp.Timestamp"] = None,
    name_contains: Optional[
        "capo_bedrock.types.model_deployment_name.ModelDeploymentName"
    ] = None,
    max_results: Optional["capo_bedrock.types.max_results.MaxResults"] = None,
    next_token: Optional[
        "capo_bedrock.types.pagination_token.PaginationToken"
    ] = None,
    sort_by: Optional["capo_bedrock.types.sort_models_by.SortModelsBy"] = None,
    sort_order: Optional["capo_bedrock.types.sort_order.SortOrder"] = None,
    status_equals: Optional[
        "capo_bedrock.types.custom_model_deployment_status.CustomModelDeploymentStatus"
    ] = None,
    model_arn_equals: Optional[
        "capo_bedrock.types.custom_model_arn.CustomModelArn"
    ] = None,
) -> "capo_bedrock.types.list_custom_model_deployments_response.ListCustomModelDeploymentsResponse":
    """<p>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.</p> <p>We recommend using pagination to ensure that the operation returns quickly and successfully.</p> <p>The following actions are related to the <code>ListCustomModelDeployments</code> operation:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModelDeployment.html">CreateCustomModelDeployment</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModelDeployment.html">GetCustomModelDeployment</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModelDeployment.html">DeleteCustomModelDeployment</a> </p> </li> </ul>

    Args:
        created_before: <p>Filters deployments created before the specified date and time.</p>
        created_after: <p>Filters deployments created after the specified date and time.</p>
        name_contains: <p>Filters deployments whose names contain the specified string. </p>
        max_results: <p>The maximum number of results to return in a single call.</p>
        next_token: <p>The token for the next set of results. Use this token to retrieve additional results when the response is truncated.</p>
        sort_by: <p>The field to sort the results by. The only supported value is <code>CreationTime</code>.</p>
        sort_order: <p>The sort order for the results. Valid values are <code>Ascending</code> and <code>Descending</code>. Default is <code>Descending</code>.</p>
        status_equals: <p>Filters deployments by status. Valid values are <code>CREATING</code>, <code>ACTIVE</code>, and <code>FAILED</code>.</p>
        model_arn_equals: <p>Filters deployments by the Amazon Resource Name (ARN) of the associated custom model.</p>

    Raises:
        capo_bedrock.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
        capo_bedrock.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_bedrock.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_bedrock.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
        capo_bedrock.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock.types.list_custom_model_deployments_request.ListCustomModelDeploymentsRequest]",
    ) -> OperationResponse[
        "capo_bedrock.types.list_custom_model_deployments_response.ListCustomModelDeploymentsResponse"
    ]:
        import capo_bedrock._operations.amazon_bedrock_control_plane_service.list_custom_model_deployments

        output, http_response = (
            capo_bedrock._operations.amazon_bedrock_control_plane_service.list_custom_model_deployments.list_custom_model_deployments(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCustomModelDeployments")
    )
    input_: capo_bedrock.types.list_custom_model_deployments_request.ListCustomModelDeploymentsRequest = {}
    if created_before is not None:
        input_["created_before"] = created_before
    if created_after is not None:
        input_["created_after"] = created_after
    if name_contains is not None:
        input_["name_contains"] = name_contains
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if status_equals is not None:
        input_["status_equals"] = status_equals
    if model_arn_equals is not None:
        input_["model_arn_equals"] = model_arn_equals

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output