Skip to content

get_app_instance_retention_settings async

get_app_instance_retention_settings(
    app_instance_arn: ChimeArn,
    *,
    config_overrides: Optional[AsyncChimeSDKIdentityClientConfig] = None,
) -> GetAppInstanceRetentionSettingsResponse

Gets the retention settings for an AppInstance.

Parameters:

  • app_instance_arn (ChimeArn) –

    The ARN of the AppInstance.

Raises:

Source code in docs_src/capo_chime_sdk_identity/_services/async_chime_sdk_identity.py
async def get_app_instance_retention_settings(
    self,
    app_instance_arn: "capo_chime_sdk_identity.types.chime_arn.ChimeArn",
    *,
    config_overrides: Optional[AsyncChimeSDKIdentityClientConfig] = None,
) -> "capo_chime_sdk_identity.types.get_app_instance_retention_settings_response.GetAppInstanceRetentionSettingsResponse":
    """<p>Gets the retention settings for an <code>AppInstance</code>.</p>

    Args:
        app_instance_arn: <p>The ARN of the <code>AppInstance</code>.</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.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.get_app_instance_retention_settings_request.GetAppInstanceRetentionSettingsRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime_sdk_identity.types.get_app_instance_retention_settings_response.GetAppInstanceRetentionSettingsResponse"
    ]:
        import capo_chime_sdk_identity._operations.chime_identity_service.get_app_instance_retention_settings

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAppInstanceRetentionSettings")
    )
    input_: capo_chime_sdk_identity.types.get_app_instance_retention_settings_request.GetAppInstanceRetentionSettingsRequest = {
        "app_instance_arn": app_instance_arn
    }

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