update_deployment ¶

update_deployment(
    api_id: __string,
    deployment_id: __string,
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    description: Optional[StringWithLengthBetween0And1024] = None,
) -> UpdateDeploymentResponse

Updates a Deployment.

Parameters:

api_id (__string) –

The API identifier.
deployment_id (__string) –

The deployment ID.
description (Optional[StringWithLengthBetween0And1024], default: None ) –

The description for the deployment resource.

Raises:

BadRequestException –

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ConflictException –

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
NotFoundException –

The resource specified in the request was not found. See the message field for more information.
TooManyRequestsException –

A limit has been exceeded. See the accompanying error message for details.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_apigatewayv2/_services/api_gateway_v2.py

def update_deployment(
    self,
    api_id: "capo_apigatewayv2.types.__string.__string",
    deployment_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    description: Optional[
        "capo_apigatewayv2.types.string_with_length_between0_and1024.StringWithLengthBetween0And1024"
    ] = None,
) -> "capo_apigatewayv2.types.update_deployment_response.UpdateDeploymentResponse":
    """<p>Updates a Deployment.</p>

    Args:
        api_id: <p>The API identifier.</p>
        deployment_id: <p>The deployment ID.</p>
        description: <p>The description for the deployment resource.</p>

    Raises:
        capo_apigatewayv2.errors.bad_request_exception.BadRequestException: <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.conflict_exception.ConflictException: <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.not_found_exception.NotFoundException: <p>The resource specified in the request was not found. See the message field for more information.</p>
        capo_apigatewayv2.errors.too_many_requests_exception.TooManyRequestsException: <p>A limit has been exceeded. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_apigatewayv2.types.update_deployment_request.UpdateDeploymentRequest]",
    ) -> OperationResponse[
        "capo_apigatewayv2.types.update_deployment_response.UpdateDeploymentResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.update_deployment

        output, http_response = (
            capo_apigatewayv2._operations.api_gateway_v2.update_deployment.update_deployment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateDeployment")
    )
    input_: capo_apigatewayv2.types.update_deployment_request.UpdateDeploymentRequest = {
        "api_id": api_id,
        "deployment_id": deployment_id,
    }
    if description is not None:
        input_["description"] = description

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