WorkSpacesWeb / Client / update_user_access_logging_settings

update_user_access_logging_settings#

WorkSpacesWeb.Client.update_user_access_logging_settings(**kwargs)#

Updates the user access logging settings.

See also: AWS API Documentation

Request Syntax

response = client.update_user_access_logging_settings(
    clientToken='string',
    kinesisStreamArn='string',
    userAccessLoggingSettingsArn='string'
)
Parameters:

  • clientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the AWS SDK.

    This field is autopopulated if not provided.

  • kinesisStreamArn (string) – The ARN of the Kinesis stream.

  • userAccessLoggingSettingsArn (string) –

    [REQUIRED]

    The ARN of the user access logging settings.

Return type:

dict

Returns:

Response Syntax

{
    'userAccessLoggingSettings': {
        'associatedPortalArns': [
            'string',
        ],
        'kinesisStreamArn': 'string',
        'userAccessLoggingSettingsArn': 'string'
    }
}

Response Structure

  • (dict) –

    • userAccessLoggingSettings (dict) –

      The user access logging settings.

      • associatedPortalArns (list) –

        A list of web portal ARNs that this user access logging settings is associated with.

        • (string) –

      • kinesisStreamArn (string) –

        The ARN of the Kinesis stream.

      • userAccessLoggingSettingsArn (string) –

        The ARN of the user access logging settings.

Exceptions

  • WorkSpacesWeb.Client.exceptions.InternalServerException

  • WorkSpacesWeb.Client.exceptions.ResourceNotFoundException

  • WorkSpacesWeb.Client.exceptions.AccessDeniedException

  • WorkSpacesWeb.Client.exceptions.ThrottlingException

  • WorkSpacesWeb.Client.exceptions.ValidationException