get_messaging_streaming_configurations ¶

get_messaging_streaming_configurations(
    app_instance_arn: ChimeArn,
    *,
    config_overrides: Optional[ChimeSDKMessagingClientConfig] = None,
) -> GetMessagingStreamingConfigurationsResponse

Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

Parameters:

app_instance_arn (ChimeArn) –

The ARN of the streaming configurations.

Raises:

BadRequestException –

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

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

One or more of the resources in the request does not exist in the system.
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/chime_sdk_messaging.py

def get_messaging_streaming_configurations(
    self,
    app_instance_arn: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn",
    *,
    config_overrides: Optional[ChimeSDKMessagingClientConfig] = None,
) -> "capo_chime_sdk_messaging.types.get_messaging_streaming_configurations_response.GetMessagingStreamingConfigurationsResponse":
    """<p>Retrieves the data streaming configuration for an <code>AppInstance</code>. For more information, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the <i>Amazon Chime SDK Developer Guide</i>.</p>

    Args:
        app_instance_arn: <p>The ARN of the streaming configurations.</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.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_messaging.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system.</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.
    """

    def _handler(
        req: "OperationRequest[capo_chime_sdk_messaging.types.get_messaging_streaming_configurations_request.GetMessagingStreamingConfigurationsRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_messaging.types.get_messaging_streaming_configurations_response.GetMessagingStreamingConfigurationsResponse"
    ]:
        import capo_chime_sdk_messaging._operations.chime_messaging_service.get_messaging_streaming_configurations

        output, http_response = (
            capo_chime_sdk_messaging._operations.chime_messaging_service.get_messaging_streaming_configurations.get_messaging_streaming_configurations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetMessagingStreamingConfigurations")
    )
    input_: capo_chime_sdk_messaging.types.get_messaging_streaming_configurations_request.GetMessagingStreamingConfigurationsRequest = {
        "app_instance_arn": app_instance_arn
    }

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