Amazon WorkSpaces Web

2022/10/19 - Amazon WorkSpaces Web - 7 new3 updated api methods

Changes  WorkSpaces Web now supports user access logging for recording session start, stop, and URL navigation.

UpdateUserAccessLoggingSettings (new) Link ¶

Updates the user access logging settings.

See also: AWS API Documentation

Request Syntax

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

string

param clientToken:

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.

type kinesisStreamArn:

string

param kinesisStreamArn:

The ARN of the Kinesis stream.

type userAccessLoggingSettingsArn:

string

param userAccessLoggingSettingsArn:

[REQUIRED]

The ARN of the user access logging settings.

rtype:

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.

DeleteUserAccessLoggingSettings (new) Link ¶

Deletes user access logging settings.

See also: AWS API Documentation

Request Syntax

client.delete_user_access_logging_settings(
    userAccessLoggingSettingsArn='string'
)
type userAccessLoggingSettingsArn:

string

param userAccessLoggingSettingsArn:

[REQUIRED]

The ARN of the user access logging settings.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

GetUserAccessLoggingSettings (new) Link ¶

Gets user access logging settings.

See also: AWS API Documentation

Request Syntax

client.get_user_access_logging_settings(
    userAccessLoggingSettingsArn='string'
)
type userAccessLoggingSettingsArn:

string

param userAccessLoggingSettingsArn:

[REQUIRED]

The ARN of the user access logging settings.

rtype:

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.

CreateUserAccessLoggingSettings (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.create_user_access_logging_settings(
    clientToken='string',
    kinesisStreamArn='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type clientToken:

string

param clientToken:

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.

type kinesisStreamArn:

string

param kinesisStreamArn:

[REQUIRED]

The ARN of the Kinesis stream.

type tags:

list

param tags:

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

rtype:

dict

returns:

Response Syntax

{
    'userAccessLoggingSettingsArn': 'string'
}

Response Structure

  • (dict) --

    • userAccessLoggingSettingsArn (string) --

      The ARN of the user access logging settings.

AssociateUserAccessLoggingSettings (new) Link ¶

Associates a user access logging settings resource with a web portal.

See also: AWS API Documentation

Request Syntax

client.associate_user_access_logging_settings(
    portalArn='string',
    userAccessLoggingSettingsArn='string'
)
type portalArn:

string

param portalArn:

[REQUIRED]

The ARN of the web portal.

type userAccessLoggingSettingsArn:

string

param userAccessLoggingSettingsArn:

[REQUIRED]

The ARN of the user access logging settings.

rtype:

dict

returns:

Response Syntax

{
    'portalArn': 'string',
    'userAccessLoggingSettingsArn': 'string'
}

Response Structure

  • (dict) --

    • portalArn (string) --

      The ARN of the web portal.

    • userAccessLoggingSettingsArn (string) --

      The ARN of the user access logging settings.

ListUserAccessLoggingSettings (new) Link ¶

Retrieves a list of user access logging settings.

See also: AWS API Documentation

Request Syntax

client.list_user_access_logging_settings(
    maxResults=123,
    nextToken='string'
)
type maxResults:

integer

param maxResults:

The maximum number of results to be included in the next page.

type nextToken:

string

param nextToken:

The pagination token used to retrieve the next page of results for this operation.

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

    • nextToken (string) --

      The pagination token used to retrieve the next page of results for this operation.

    • userAccessLoggingSettings (list) --

      The user access logging settings.

      • (dict) --

        The summary of user access logging settings.

        • kinesisStreamArn (string) --

          The ARN of the Kinesis stream.

        • userAccessLoggingSettingsArn (string) --

          The ARN of the user access logging settings.

DisassociateUserAccessLoggingSettings (new) Link ¶

Disassociates user access logging settings from a web portal.

See also: AWS API Documentation

Request Syntax

client.disassociate_user_access_logging_settings(
    portalArn='string'
)
type portalArn:

string

param portalArn:

[REQUIRED]

The ARN of the web portal.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

GetPortal (updated) Link ¶
Changes (response) 
{'portal': {'userAccessLoggingSettingsArn': 'string'}}

Gets the web portal.

See also: AWS API Documentation

Request Syntax

client.get_portal(
    portalArn='string'
)
type portalArn:

string

param portalArn:

[REQUIRED]

The ARN of the web portal.

rtype:

dict

returns:

Response Syntax

{
    'portal': {
        'browserSettingsArn': 'string',
        'browserType': 'Chrome',
        'creationDate': datetime(2015, 1, 1),
        'displayName': 'string',
        'networkSettingsArn': 'string',
        'portalArn': 'string',
        'portalEndpoint': 'string',
        'portalStatus': 'Incomplete'|'Pending'|'Active',
        'rendererType': 'AppStream',
        'statusReason': 'string',
        'trustStoreArn': 'string',
        'userAccessLoggingSettingsArn': 'string',
        'userSettingsArn': 'string'
    }
}

Response Structure

  • (dict) --

    • portal (dict) --

      The web portal.

      • browserSettingsArn (string) --

        The ARN of the browser settings that is associated with this web portal.

      • browserType (string) --

        The browser that users see when using a streaming session.

      • creationDate (datetime) --

        The creation date of the web portal.

      • displayName (string) --

        The name of the web portal.

      • networkSettingsArn (string) --

        The ARN of the network settings that is associated with the web portal.

      • portalArn (string) --

        The ARN of the web portal.

      • portalEndpoint (string) --

        The endpoint URL of the web portal that users access in order to start streaming sessions.

      • portalStatus (string) --

        The status of the web portal.

      • rendererType (string) --

        The renderer that is used in streaming sessions.

      • statusReason (string) --

        A message that explains why the web portal is in its current status.

      • trustStoreArn (string) --

        The ARN of the trust store that is associated with the web portal.

      • userAccessLoggingSettingsArn (string) --

        The ARN of the user access logging settings that is associated with the web portal.

      • userSettingsArn (string) --

        The ARN of the user settings that is associated with the web portal.

ListPortals (updated) Link ¶
Changes (response) 
{'portals': {'userAccessLoggingSettingsArn': 'string'}}

Retrieves a list or web portals.

See also: AWS API Documentation

Request Syntax

client.list_portals(
    maxResults=123,
    nextToken='string'
)
type maxResults:

integer

param maxResults:

The maximum number of results to be included in the next page.

type nextToken:

string

param nextToken:

The pagination token used to retrieve the next page of results for this operation.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'portals': [
        {
            'browserSettingsArn': 'string',
            'browserType': 'Chrome',
            'creationDate': datetime(2015, 1, 1),
            'displayName': 'string',
            'networkSettingsArn': 'string',
            'portalArn': 'string',
            'portalEndpoint': 'string',
            'portalStatus': 'Incomplete'|'Pending'|'Active',
            'rendererType': 'AppStream',
            'trustStoreArn': 'string',
            'userAccessLoggingSettingsArn': 'string',
            'userSettingsArn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The pagination token used to retrieve the next page of results for this operation.

    • portals (list) --

      The portals in the list.

      • (dict) --

        The summary of the portal.

        • browserSettingsArn (string) --

          The ARN of the browser settings that is associated with the web portal.

        • browserType (string) --

          The browser type of the web portal.

        • creationDate (datetime) --

          The creation date of the web portal.

        • displayName (string) --

          The name of the web portal.

        • networkSettingsArn (string) --

          The ARN of the network settings that is associated with the web portal.

        • portalArn (string) --

          The ARN of the web portal.

        • portalEndpoint (string) --

          The endpoint URL of the web portal that users access in order to start streaming sessions.

        • portalStatus (string) --

          The status of the web portal.

        • rendererType (string) --

          The renderer that is used in streaming sessions.

        • trustStoreArn (string) --

          The ARN of the trust that is associated with this web portal.

        • userAccessLoggingSettingsArn (string) --

          The ARN of the user access logging settings that is associated with the web portal.

        • userSettingsArn (string) --

          The ARN of the user settings that is associated with the web portal.

UpdatePortal (updated) Link ¶
Changes (response) 
{'portal': {'userAccessLoggingSettingsArn': 'string'}}

Updates a web portal.

See also: AWS API Documentation

Request Syntax

client.update_portal(
    displayName='string',
    portalArn='string'
)
type displayName:

string

param displayName:

The name of the web portal. This is not visible to users who log into the web portal.

type portalArn:

string

param portalArn:

[REQUIRED]

The ARN of the web portal.

rtype:

dict

returns:

Response Syntax

{
    'portal': {
        'browserSettingsArn': 'string',
        'browserType': 'Chrome',
        'creationDate': datetime(2015, 1, 1),
        'displayName': 'string',
        'networkSettingsArn': 'string',
        'portalArn': 'string',
        'portalEndpoint': 'string',
        'portalStatus': 'Incomplete'|'Pending'|'Active',
        'rendererType': 'AppStream',
        'statusReason': 'string',
        'trustStoreArn': 'string',
        'userAccessLoggingSettingsArn': 'string',
        'userSettingsArn': 'string'
    }
}

Response Structure

  • (dict) --

    • portal (dict) --

      The web portal.

      • browserSettingsArn (string) --

        The ARN of the browser settings that is associated with this web portal.

      • browserType (string) --

        The browser that users see when using a streaming session.

      • creationDate (datetime) --

        The creation date of the web portal.

      • displayName (string) --

        The name of the web portal.

      • networkSettingsArn (string) --

        The ARN of the network settings that is associated with the web portal.

      • portalArn (string) --

        The ARN of the web portal.

      • portalEndpoint (string) --

        The endpoint URL of the web portal that users access in order to start streaming sessions.

      • portalStatus (string) --

        The status of the web portal.

      • rendererType (string) --

        The renderer that is used in streaming sessions.

      • statusReason (string) --

        A message that explains why the web portal is in its current status.

      • trustStoreArn (string) --

        The ARN of the trust store that is associated with the web portal.

      • userAccessLoggingSettingsArn (string) --

        The ARN of the user access logging settings that is associated with the web portal.

      • userSettingsArn (string) --

        The ARN of the user settings that is associated with the web portal.