update_virtual_gateway ¶

update_virtual_gateway(
    virtual_gateway_name: ResourceName,
    mesh_name: ResourceName,
    spec: VirtualGatewaySpec,
    *,
    config_overrides: Optional[AppMeshClientConfig] = None,
    client_token: Optional[str] = None,
    mesh_owner: Optional[AccountId] = None,
) -> UpdateVirtualGatewayOutput

Updates an existing virtual gateway in a specified service mesh.

Parameters:

virtual_gateway_name (ResourceName) –

The name of the virtual gateway to update.
mesh_name (ResourceName) –

The name of the service mesh that the virtual gateway resides in.
spec (VirtualGatewaySpec) –

The new virtual gateway specification to apply. This overwrites the existing data.
client_token (Optional[str], default: None ) –

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
mesh_owner (Optional[AccountId], default: None ) –

The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

Raises:

BadRequestException –

The request syntax was malformed. Check your request syntax and try again.
ConflictException –

The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.
ForbiddenException –

You don't have permissions to perform this action.
InternalServerErrorException –

The request processing has failed because of an unknown error, exception, or failure.
LimitExceededException –

You have exceeded a service limit for your account. For more information, see Service Limits in the App Mesh User Guide.
NotFoundException –

The specified resource doesn't exist. Check your request syntax and try again.
ServiceUnavailableException –

The request has failed due to a temporary failure of the service.
TooManyRequestsException –

The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
UnknownServiceError –

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

Source code in docs_src/capo_app_mesh/_services/app_mesh.py

def update_virtual_gateway(
    self,
    virtual_gateway_name: "capo_app_mesh.types.resource_name.ResourceName",
    mesh_name: "capo_app_mesh.types.resource_name.ResourceName",
    spec: "capo_app_mesh.types.virtual_gateway_spec.VirtualGatewaySpec",
    *,
    config_overrides: Optional[AppMeshClientConfig] = None,
    client_token: Optional[str] = None,
    mesh_owner: Optional["capo_app_mesh.types.account_id.AccountId"] = None,
) -> "capo_app_mesh.types.update_virtual_gateway_output.UpdateVirtualGatewayOutput":
    """<p>Updates an existing virtual gateway in a specified service mesh.</p>

    Args:
        virtual_gateway_name: <p>The name of the virtual gateway to update.</p>
        mesh_name: <p>The name of the service mesh that the virtual gateway resides in.</p>
        spec: <p>The new virtual gateway specification to apply. This overwrites the existing data.</p>
        client_token: <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
        mesh_owner: <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>

    Raises:
        capo_app_mesh.errors.bad_request_exception.BadRequestException: <p>The request syntax was malformed. Check your request syntax and try again.</p>
        capo_app_mesh.errors.conflict_exception.ConflictException: <p>The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.</p>
        capo_app_mesh.errors.forbidden_exception.ForbiddenException: <p>You don't have permissions to perform this action.</p>
        capo_app_mesh.errors.internal_server_error_exception.InternalServerErrorException: <p>The request processing has failed because of an unknown error, exception, or failure.</p>
        capo_app_mesh.errors.limit_exceeded_exception.LimitExceededException: <p>You have exceeded a service limit for your account. For more information, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/service-quotas.html">Service Limits</a> in the <i>App Mesh User Guide</i>.</p>
        capo_app_mesh.errors.not_found_exception.NotFoundException: <p>The specified resource doesn't exist. Check your request syntax and try again.</p>
        capo_app_mesh.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed due to a temporary failure of the service.</p>
        capo_app_mesh.errors.too_many_requests_exception.TooManyRequestsException: <p>The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.</p>
        capo_app_mesh.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_app_mesh.types.update_virtual_gateway_input.UpdateVirtualGatewayInput]",
    ) -> OperationResponse[
        "capo_app_mesh.types.update_virtual_gateway_output.UpdateVirtualGatewayOutput"
    ]:
        import capo_app_mesh._operations.app_mesh.update_virtual_gateway

        output, http_response = (
            capo_app_mesh._operations.app_mesh.update_virtual_gateway.update_virtual_gateway(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateVirtualGateway")
    )
    input_: capo_app_mesh.types.update_virtual_gateway_input.UpdateVirtualGatewayInput = {
        "virtual_gateway_name": virtual_gateway_name,
        "mesh_name": mesh_name,
        "spec": spec,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if mesh_owner is not None:
        input_["mesh_owner"] = mesh_owner

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