update_api ¶

def update_api(
    self,
    api_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    api_key_selection_expression: Optional[
        "capo_apigatewayv2.types.selection_expression.SelectionExpression"
    ] = None,
    cors_configuration: Optional["capo_apigatewayv2.types.cors.Cors"] = None,
    credentials_arn: Optional["capo_apigatewayv2.types.arn.Arn"] = None,
    description: Optional[
        "capo_apigatewayv2.types.string_with_length_between0_and1024.StringWithLengthBetween0And1024"
    ] = None,
    disable_schema_validation: Optional[
        "capo_apigatewayv2.types.__boolean.__boolean"
    ] = None,
    disable_execute_api_endpoint: Optional[
        "capo_apigatewayv2.types.__boolean.__boolean"
    ] = None,
    ip_address_type: Optional[
        "capo_apigatewayv2.types.ip_address_type.IpAddressType"
    ] = None,
    name: Optional[
        "capo_apigatewayv2.types.string_with_length_between1_and128.StringWithLengthBetween1And128"
    ] = None,
    route_key: Optional[
        "capo_apigatewayv2.types.selection_key.SelectionKey"
    ] = None,
    route_selection_expression: Optional[
        "capo_apigatewayv2.types.selection_expression.SelectionExpression"
    ] = None,
    target: Optional[
        "capo_apigatewayv2.types.uri_with_length_between1_and2048.UriWithLengthBetween1And2048"
    ] = None,
    version: Optional[
        "capo_apigatewayv2.types.string_with_length_between1_and64.StringWithLengthBetween1And64"
    ] = None,
) -> "capo_apigatewayv2.types.update_api_response.UpdateApiResponse":
    """<p>Updates an Api resource.</p>

    Args:
        api_id: <p>The API identifier.</p>
        api_key_selection_expression: <p>An API key selection expression. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</p>
        cors_configuration: <p>A CORS configuration. Supported only for HTTP APIs.</p>
        credentials_arn: <p>This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.</p>
        description: <p>The description of the API.</p>
        disable_schema_validation: <p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>
        disable_execute_api_endpoint: <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
        ip_address_type: <p>The IP address types that can invoke your API or domain name.</p>
        name: <p>The name of the API.</p>
        route_key: <p>This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.</p>
        route_selection_expression: <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
        target: <p>This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.</p>
        version: <p>A version identifier for the API.</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_api_request.UpdateApiRequest]",
    ) -> OperationResponse[
        "capo_apigatewayv2.types.update_api_response.UpdateApiResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.update_api

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateApi")
    )
    input_: capo_apigatewayv2.types.update_api_request.UpdateApiRequest = {
        "api_id": api_id
    }
    if api_key_selection_expression is not None:
        input_["api_key_selection_expression"] = api_key_selection_expression
    if cors_configuration is not None:
        input_["cors_configuration"] = cors_configuration
    if credentials_arn is not None:
        input_["credentials_arn"] = credentials_arn
    if description is not None:
        input_["description"] = description
    if disable_schema_validation is not None:
        input_["disable_schema_validation"] = disable_schema_validation
    if disable_execute_api_endpoint is not None:
        input_["disable_execute_api_endpoint"] = disable_execute_api_endpoint
    if ip_address_type is not None:
        input_["ip_address_type"] = ip_address_type
    if name is not None:
        input_["name"] = name
    if route_key is not None:
        input_["route_key"] = route_key
    if route_selection_expression is not None:
        input_["route_selection_expression"] = route_selection_expression
    if target is not None:
        input_["target"] = target
    if version is not None:
        input_["version"] = version

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