create_deployment ¶

def create_deployment(
    self,
    api_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    description: Optional[
        "capo_apigatewayv2.types.string_with_length_between0_and1024.StringWithLengthBetween0And1024"
    ] = None,
    stage_name: Optional[
        "capo_apigatewayv2.types.string_with_length_between1_and128.StringWithLengthBetween1And128"
    ] = None,
) -> "capo_apigatewayv2.types.create_deployment_response.CreateDeploymentResponse":
    """<p>Creates a Deployment for an API.</p>

    Args:
        api_id: <p>The API identifier.</p>
        description: <p>The description for the deployment resource.</p>
        stage_name: <p>The name of the Stage resource for the Deployment resource to create.</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.create_deployment_request.CreateDeploymentRequest]",
    ) -> OperationResponse[
        "capo_apigatewayv2.types.create_deployment_response.CreateDeploymentResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.create_deployment

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateDeployment")
    )
    input_: capo_apigatewayv2.types.create_deployment_request.CreateDeploymentRequest = {
        "api_id": api_id
    }
    if description is not None:
        input_["description"] = description
    if stage_name is not None:
        input_["stage_name"] = stage_name

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