update_channel `async` ¶

update_channel(
    channel_arn: ChimeArn,
    chime_bearer: ChimeArn,
    *,
    config_overrides: Optional[AsyncChimeSDKMessagingClientConfig] = None,
    name: Optional[NonEmptyResourceName] = None,
    mode: Optional[ChannelMode] = None,
    metadata: Optional[Metadata] = None,
) -> UpdateChannelResponse

Update a channel's attributes.

Restriction: You can't change a channel's privacy.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Parameters:

channel_arn (ChimeArn) –

The ARN of the channel.
name (Optional[NonEmptyResourceName], default: None ) –

The name of the channel.
mode (Optional[ChannelMode], default: None ) –

The mode of the update request.
metadata (Optional[Metadata], default: None ) –

The metadata for the update request.
chime_bearer (ChimeArn) –

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Raises:

BadRequestException –

The input parameters don't match the service's restrictions.
ConflictException –

The request could not be processed because of conflict in the current state of the resource.
ForbiddenException –

The client is permanently forbidden from making the request.
ServiceFailureException –

The service encountered an unexpected error.
ServiceUnavailableException –

The service is currently unavailable.
ThrottledClientException –

The client exceeded its request rate limit.
UnauthorizedClientException –

The client is not currently authorized to make the request.
UnknownServiceError –

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

Source code in docs_src/capo_chime_sdk_messaging/_services/async_chime_sdk_messaging.py

async def update_channel(
    self,
    channel_arn: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn",
    chime_bearer: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn",
    *,
    config_overrides: Optional[AsyncChimeSDKMessagingClientConfig] = None,
    name: Optional[
        "capo_chime_sdk_messaging.types.non_empty_resource_name.NonEmptyResourceName"
    ] = None,
    mode: Optional[
        "capo_chime_sdk_messaging.types.channel_mode.ChannelMode"
    ] = None,
    metadata: Optional["capo_chime_sdk_messaging.types.metadata.Metadata"] = None,
) -> "capo_chime_sdk_messaging.types.update_channel_response.UpdateChannelResponse":
    """<p>Update a channel's attributes.</p> <p> <b>Restriction</b>: You can't change a channel's privacy. </p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header.</p> </note>

    Args:
        channel_arn: <p>The ARN of the channel.</p>
        name: <p>The name of the channel.</p>
        mode: <p>The mode of the update request.</p>
        metadata: <p>The metadata for the update request.</p>
        chime_bearer: <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.</p>

    Raises:
        capo_chime_sdk_messaging.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_messaging.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_messaging.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_messaging.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_messaging.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_messaging.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime_sdk_messaging.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime_sdk_messaging.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime_sdk_messaging.types.update_channel_request.UpdateChannelRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime_sdk_messaging.types.update_channel_response.UpdateChannelResponse"
    ]:
        import capo_chime_sdk_messaging._operations.chime_messaging_service.update_channel

        (
            output,
            http_response,
        ) = await capo_chime_sdk_messaging._operations.chime_messaging_service.update_channel.async_update_channel(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime_sdk_messaging.types.update_channel_request.UpdateChannelRequest",
    ) -> dict[str, Any]:
        import capo_chime_sdk_messaging.types.update_channel_request

        return (
            capo_chime_sdk_messaging.types.update_channel_request.redact_sensitive(
                input_
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateChannel", redact_input=_redact_input),
    )
    input_: capo_chime_sdk_messaging.types.update_channel_request.UpdateChannelRequest = {
        "channel_arn": channel_arn,
        "chime_bearer": chime_bearer,
    }
    if name is not None:
        input_["name"] = name
    if mode is not None:
        input_["mode"] = mode
    if metadata is not None:
        input_["metadata"] = metadata

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

update_channel async ¶

update_channel `async` ¶