create_user_access_logging_settings

WorkSpacesWeb.Client.create_user_access_logging_settings(**kwargs)

Creates a user access logging settings resource that can be associated with a web portal.

See also: AWS API Documentation

Request Syntax

response = client.create_user_access_logging_settings(
    clientToken='string',
    kinesisStreamArn='string',
    tags=[
        {
            'Key': 'string',
            'Value': '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 returns 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) --

  [REQUIRED]

  The ARN of the Kinesis stream.

• tags (list) --

  The tags to add to the user settings resource. A tag is a key-value pair.

  • (dict) --

    The tag.

    • Key (string) -- [REQUIRED]

      The key of the tag.

    • Value (string) -- [REQUIRED]

      The value of the tag

Return type

dict

Returns

Response Syntax

{
    'userAccessLoggingSettingsArn': 'string'
}

Response Structure

• (dict) --

  • userAccessLoggingSettingsArn (string) --

    The ARN of the user access logging settings.

Exceptions

• WorkSpacesWeb.Client.exceptions.InternalServerException
• WorkSpacesWeb.Client.exceptions.AccessDeniedException
• WorkSpacesWeb.Client.exceptions.ThrottlingException
• WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException
• WorkSpacesWeb.Client.exceptions.ValidationException
• WorkSpacesWeb.Client.exceptions.ConflictException