set_log_delivery_configuration `async` ¶

set_log_delivery_configuration(
    user_pool_id: UserPoolIdType,
    log_configurations: LogConfigurationListType,
    *,
    config_overrides: Optional[AsyncCognitoIdentityProviderClientConfig] = None,
) -> SetLogDeliveryConfigurationResponse

Sets up or modifies the logging configuration of a user pool. User pools can export user notification logs and, when threat protection is active, user-activity logs. For more information, see Exporting user pool logs.

Parameters:

user_pool_id (UserPoolIdType) –

The ID of the user pool where you want to configure logging.
log_configurations (LogConfigurationListType) –

A collection of the logging configurations for a user pool.

Raises:

FeatureUnavailableInTierException –
This exception is thrown when a feature that you attempted to use or configure isn't included in your user pool's current feature plan. This can occur when:
- You configure a feature that your feature plan doesn't support.
- You make a request that uses a feature that requires a higher feature plan.
To resolve this issue, upgrade your user pool to a feature plan that includes the feature.
InternalErrorException –

This exception is thrown when Amazon Cognito encounters an internal error.
InvalidParameterException –

This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException –

This exception is thrown when a user isn't authorized.
ResourceNotFoundException –

This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException –

This exception is thrown when the user has made too many requests for a given operation.
UnknownServiceError –

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

Source code in docs_src/capo_cognito_identity_provider/_services/async_cognito_identity_provider.py

async def set_log_delivery_configuration(
    self,
    user_pool_id: "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType",
    log_configurations: "capo_cognito_identity_provider.types.log_configuration_list_type.LogConfigurationListType",
    *,
    config_overrides: Optional[AsyncCognitoIdentityProviderClientConfig] = None,
) -> "capo_cognito_identity_provider.types.set_log_delivery_configuration_response.SetLogDeliveryConfigurationResponse":
    """<p>Sets up or modifies the logging configuration of a user pool. User pools can export user notification logs and, when threat protection is active, user-activity logs. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html">Exporting user pool logs</a>.</p>

    Args:
        user_pool_id: <p>The ID of the user pool where you want to configure logging.</p>
        log_configurations: <p>A collection of the logging configurations for a user pool.</p>

    Raises:
        capo_cognito_identity_provider.errors.feature_unavailable_in_tier_exception.FeatureUnavailableInTierException: <p>This exception is thrown when a feature that you attempted to use or configure isn't included in your user pool's current feature plan. This can occur when:</p> <ul> <li> <p>You configure a feature that your feature plan doesn't support.</p> </li> <li> <p>You make a request that uses a feature that requires a higher feature plan.</p> </li> </ul> <p>To resolve this issue, upgrade your user pool to a feature plan that includes the feature.</p>
        capo_cognito_identity_provider.errors.internal_error_exception.InternalErrorException: <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
        capo_cognito_identity_provider.errors.invalid_parameter_exception.InvalidParameterException: <p>This exception is thrown when the Amazon Cognito service encounters an invalid parameter.</p>
        capo_cognito_identity_provider.errors.not_authorized_exception.NotAuthorizedException: <p>This exception is thrown when a user isn't authorized.</p>
        capo_cognito_identity_provider.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when the Amazon Cognito service can't find the requested resource.</p>
        capo_cognito_identity_provider.errors.too_many_requests_exception.TooManyRequestsException: <p>This exception is thrown when the user has made too many requests for a given operation.</p>
        capo_cognito_identity_provider.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cognito_identity_provider.types.set_log_delivery_configuration_request.SetLogDeliveryConfigurationRequest]",
    ) -> AsyncOperationResponse[
        "capo_cognito_identity_provider.types.set_log_delivery_configuration_response.SetLogDeliveryConfigurationResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.set_log_delivery_configuration

        (
            output,
            http_response,
        ) = await capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.set_log_delivery_configuration.async_set_log_delivery_configuration(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SetLogDeliveryConfiguration")
    )
    input_: capo_cognito_identity_provider.types.set_log_delivery_configuration_request.SetLogDeliveryConfigurationRequest = {
        "user_pool_id": user_pool_id,
        "log_configurations": log_configurations,
    }

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

set_log_delivery_configuration async ¶

set_log_delivery_configuration `async` ¶