update_instance `async` ¶

update_instance(
    instance_id: UUID,
    *,
    config_overrides: Optional[AsyncSupplyChainClientConfig] = None,
    instance_name: Optional[InstanceName] = None,
    instance_description: Optional[InstanceDescription] = None,
) -> UpdateInstanceResponse

Enables you to programmatically update an Amazon Web Services Supply Chain instance description by providing all the relevant information such as account ID, instance ID and so on without using the AWS console.

Parameters:

instance_id (UUID) –

The AWS Supply Chain instance identifier.
instance_name (Optional[InstanceName], default: None ) –

The AWS Supply Chain instance name.
instance_description (Optional[InstanceDescription], default: None ) –

The AWS Supply Chain instance description.

Raises:

AccessDeniedException –

You do not have the required privileges to perform this action.
ConflictException –

Updating or deleting a resource can cause an inconsistent state.
InternalServerException –

Unexpected error during processing of request.
ResourceNotFoundException –

Request references a resource which does not exist.
ServiceQuotaExceededException –

Request would cause a service quota to be exceeded.
ThrottlingException –

Request was denied due to request throttling.
ValidationException –

The input does not satisfy the constraints specified by an AWS service.
UnknownServiceError –

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

Examples:

Successful UpdateInstance request

>>> await client.update_instance(instance_id='9e193580-7cc5-45f7-9609-c43ba0ada793', instance_name='updated example instance name', instance_description='updated example instance description')

Source code in docs_src/capo_supplychain/_services/async_supply_chain.py

async def update_instance(
    self,
    instance_id: "capo_supplychain.types.uuid.UUID",
    *,
    config_overrides: Optional[AsyncSupplyChainClientConfig] = None,
    instance_name: Optional[
        "capo_supplychain.types.instance_name.InstanceName"
    ] = None,
    instance_description: Optional[
        "capo_supplychain.types.instance_description.InstanceDescription"
    ] = None,
) -> "capo_supplychain.types.update_instance_response.UpdateInstanceResponse":
    """<p>Enables you to programmatically update an Amazon Web Services Supply Chain instance description by providing all the relevant information such as account ID, instance ID and so on without using the AWS console.</p>

    Args:
        instance_id: <p>The AWS Supply Chain instance identifier.</p>
        instance_name: <p>The AWS Supply Chain instance name.</p>
        instance_description: <p>The AWS Supply Chain instance description.</p>

    Raises:
        capo_supplychain.errors.access_denied_exception.AccessDeniedException: <p>You do not have the required privileges to perform this action.</p>
        capo_supplychain.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_supplychain.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_supplychain.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_supplychain.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Request would cause a service quota to be exceeded.</p>
        capo_supplychain.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_supplychain.errors.validation_exception.ValidationException: <p>The input does not satisfy the constraints specified by an AWS service.</p>
        capo_supplychain.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Successful UpdateInstance request

        >>> await client.update_instance(instance_id='9e193580-7cc5-45f7-9609-c43ba0ada793', instance_name='updated example instance name', instance_description='updated example instance description')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_supplychain.types.update_instance_request.UpdateInstanceRequest]",
    ) -> AsyncOperationResponse[
        "capo_supplychain.types.update_instance_response.UpdateInstanceResponse"
    ]:
        import capo_supplychain._operations.galaxy_public_api_gateway.update_instance

        (
            output,
            http_response,
        ) = await capo_supplychain._operations.galaxy_public_api_gateway.update_instance.async_update_instance(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateInstance")
    )
    input_: capo_supplychain.types.update_instance_request.UpdateInstanceRequest = {
        "instance_id": instance_id
    }
    if instance_name is not None:
        input_["instance_name"] = instance_name
    if instance_description is not None:
        input_["instance_description"] = instance_description

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

update_instance async ¶

update_instance `async` ¶