Skip to content

update_app_instance async

update_app_instance(
    app_instance_arn: ChimeArn,
    name: NonEmptyResourceName,
    metadata: Metadata,
    *,
    config_overrides: Optional[AsyncChimeSDKIdentityClientConfig] = None,
) -> UpdateAppInstanceResponse

Updates AppInstance metadata.

Parameters:

  • app_instance_arn (ChimeArn) –

    The ARN of the AppInstance.

  • name (NonEmptyResourceName) –

    The name that you want to change.

  • metadata (Metadata) –

    The metadata that you want to change.

Raises:

Source code in docs_src/capo_chime_sdk_identity/_services/async_chime_sdk_identity.py
async def update_app_instance(
    self,
    app_instance_arn: "capo_chime_sdk_identity.types.chime_arn.ChimeArn",
    name: "capo_chime_sdk_identity.types.non_empty_resource_name.NonEmptyResourceName",
    metadata: "capo_chime_sdk_identity.types.metadata.Metadata",
    *,
    config_overrides: Optional[AsyncChimeSDKIdentityClientConfig] = None,
) -> "capo_chime_sdk_identity.types.update_app_instance_response.UpdateAppInstanceResponse":
    """<p>Updates <code>AppInstance</code> metadata.</p>

    Args:
        app_instance_arn: <p>The ARN of the <code>AppInstance</code>.</p>
        name: <p>The name that you want to change.</p>
        metadata: <p>The metadata that you want to change.</p>

    Raises:
        capo_chime_sdk_identity.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_identity.errors.conflict_exception.ConflictException: <p>The request could not be processed because of conflict in the current state of the resource.</p>
        capo_chime_sdk_identity.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_identity.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_identity.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_identity.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime_sdk_identity.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime_sdk_identity.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime_sdk_identity.types.update_app_instance_request.UpdateAppInstanceRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime_sdk_identity.types.update_app_instance_response.UpdateAppInstanceResponse"
    ]:
        import capo_chime_sdk_identity._operations.chime_identity_service.update_app_instance

        (
            output,
            http_response,
        ) = await capo_chime_sdk_identity._operations.chime_identity_service.update_app_instance.async_update_app_instance(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime_sdk_identity.types.update_app_instance_request.UpdateAppInstanceRequest",
    ) -> dict[str, Any]:
        import capo_chime_sdk_identity.types.update_app_instance_request

        return capo_chime_sdk_identity.types.update_app_instance_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateAppInstance", redact_input=_redact_input),
    )
    input_: capo_chime_sdk_identity.types.update_app_instance_request.UpdateAppInstanceRequest = {
        "app_instance_arn": app_instance_arn,
        "name": name,
        "metadata": metadata,
    }

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