Amazon WorkSpaces Web

2025/07/31 - Amazon WorkSpaces Web - 7 new3 updated api methods

Changes  Added ability to log session activity on a portal to an S3 bucket.

CreateSessionLogger (new) Link ¶

Creates a session logger.

See also: AWS API Documentation

Request Syntax

client.create_session_logger(
    eventFilter={
        'all': {}
        ,
        'include': [
            'WebsiteInteract'|'FileDownloadFromSecureBrowserToRemoteDisk'|'FileTransferFromRemoteToLocalDisk'|'FileTransferFromLocalToRemoteDisk'|'FileUploadFromRemoteDiskToSecureBrowser'|'ContentPasteToWebsite'|'ContentTransferFromLocalToRemoteClipboard'|'ContentCopyFromWebsite'|'UrlLoad'|'TabOpen'|'TabClose'|'PrintJobSubmit'|'SessionConnect'|'SessionStart'|'SessionDisconnect'|'SessionEnd',
        ]
    },
    logConfiguration={
        's3': {
            'bucket': 'string',
            'keyPrefix': 'string',
            'bucketOwner': 'string',
            'logFileFormat': 'JSONLines'|'Json',
            'folderStructure': 'Flat'|'NestedByDate'
        }
    },
    displayName='string',
    customerManagedKey='string',
    additionalEncryptionContext={
        'string': 'string'
    },
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    clientToken='string'
)
type eventFilter:

dict

param eventFilter:

[REQUIRED]

The filter that specifies the events to monitor.

  • all (dict) --

    The filter that monitors all of the available events, including any new events emitted in the future.

  • include (list) --

    The filter that monitors only the listed set of events. New events are not auto-monitored.

    • (string) --

type logConfiguration:

dict

param logConfiguration:

[REQUIRED]

The configuration that specifies where logs are delivered.

  • s3 (dict) --

    The configuration for delivering the logs to S3.

    • bucket (string) -- [REQUIRED]

      The S3 bucket name where logs are delivered.

    • keyPrefix (string) --

      The S3 path prefix that determines where log files are stored.

    • bucketOwner (string) --

      The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket.

    • logFileFormat (string) -- [REQUIRED]

      The format of the LogFile that is written to S3.

    • folderStructure (string) -- [REQUIRED]

      The folder structure that defines the organizational structure for log files in S3.

type displayName:

string

param displayName:

The human-readable display name for the session logger resource.

type customerManagedKey:

string

param customerManagedKey:

The custom managed key of the session logger.

type additionalEncryptionContext:

dict

param additionalEncryptionContext:

The additional encryption context of the session logger.

  • (string) --

    • (string) --

type tags:

list

param tags:

The tags to add to the session logger.

  • (dict) --

    The tag.

    • Key (string) -- [REQUIRED]

      The key of the tag.

    • Value (string) -- [REQUIRED]

      The value of the tag

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.

rtype:

dict

returns:

Response Syntax

{
    'sessionLoggerArn': 'string'
}

Response Structure

  • (dict) --

    • sessionLoggerArn (string) --

      The ARN of the session logger.

AssociateSessionLogger (new) Link ¶

Associates a session logger with a portal.

See also: AWS API Documentation

Request Syntax

client.associate_session_logger(
    portalArn='string',
    sessionLoggerArn='string'
)
type portalArn:

string

param portalArn:

[REQUIRED]

The ARN of the portal to associate to the session logger ARN.

type sessionLoggerArn:

string

param sessionLoggerArn:

[REQUIRED]

The ARN of the session logger to associate to the portal ARN.

rtype:

dict

returns:

Response Syntax

{
    'portalArn': 'string',
    'sessionLoggerArn': 'string'
}

Response Structure

  • (dict) --

    • portalArn (string) --

      The ARN of the portal.

    • sessionLoggerArn (string) --

      The ARN of the session logger.

UpdateSessionLogger (new) Link ¶

Updates the details of a session logger.

See also: AWS API Documentation

Request Syntax

client.update_session_logger(
    sessionLoggerArn='string',
    eventFilter={
        'all': {}
        ,
        'include': [
            'WebsiteInteract'|'FileDownloadFromSecureBrowserToRemoteDisk'|'FileTransferFromRemoteToLocalDisk'|'FileTransferFromLocalToRemoteDisk'|'FileUploadFromRemoteDiskToSecureBrowser'|'ContentPasteToWebsite'|'ContentTransferFromLocalToRemoteClipboard'|'ContentCopyFromWebsite'|'UrlLoad'|'TabOpen'|'TabClose'|'PrintJobSubmit'|'SessionConnect'|'SessionStart'|'SessionDisconnect'|'SessionEnd',
        ]
    },
    logConfiguration={
        's3': {
            'bucket': 'string',
            'keyPrefix': 'string',
            'bucketOwner': 'string',
            'logFileFormat': 'JSONLines'|'Json',
            'folderStructure': 'Flat'|'NestedByDate'
        }
    },
    displayName='string'
)
type sessionLoggerArn:

string

param sessionLoggerArn:

[REQUIRED]

The ARN of the session logger to update.

type eventFilter:

dict

param eventFilter:

The updated eventFilter.

  • all (dict) --

    The filter that monitors all of the available events, including any new events emitted in the future.

  • include (list) --

    The filter that monitors only the listed set of events. New events are not auto-monitored.

    • (string) --

type logConfiguration:

dict

param logConfiguration:

The updated logConfiguration.

  • s3 (dict) --

    The configuration for delivering the logs to S3.

    • bucket (string) -- [REQUIRED]

      The S3 bucket name where logs are delivered.

    • keyPrefix (string) --

      The S3 path prefix that determines where log files are stored.

    • bucketOwner (string) --

      The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket.

    • logFileFormat (string) -- [REQUIRED]

      The format of the LogFile that is written to S3.

    • folderStructure (string) -- [REQUIRED]

      The folder structure that defines the organizational structure for log files in S3.

type displayName:

string

param displayName:

The updated display name.

rtype:

dict

returns:

Response Syntax

{
    'sessionLogger': {
        'sessionLoggerArn': 'string',
        'eventFilter': {
            'all': {},
            'include': [
                'WebsiteInteract'|'FileDownloadFromSecureBrowserToRemoteDisk'|'FileTransferFromRemoteToLocalDisk'|'FileTransferFromLocalToRemoteDisk'|'FileUploadFromRemoteDiskToSecureBrowser'|'ContentPasteToWebsite'|'ContentTransferFromLocalToRemoteClipboard'|'ContentCopyFromWebsite'|'UrlLoad'|'TabOpen'|'TabClose'|'PrintJobSubmit'|'SessionConnect'|'SessionStart'|'SessionDisconnect'|'SessionEnd',
            ]
        },
        'logConfiguration': {
            's3': {
                'bucket': 'string',
                'keyPrefix': 'string',
                'bucketOwner': 'string',
                'logFileFormat': 'JSONLines'|'Json',
                'folderStructure': 'Flat'|'NestedByDate'
            }
        },
        'customerManagedKey': 'string',
        'additionalEncryptionContext': {
            'string': 'string'
        },
        'associatedPortalArns': [
            'string',
        ],
        'displayName': 'string',
        'creationDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • sessionLogger (dict) --

      The updated details of the session logger.

      • sessionLoggerArn (string) --

        The ARN of the session logger resource.

      • eventFilter (dict) --

        The filter that specifies which events to monitor.

        • all (dict) --

          The filter that monitors all of the available events, including any new events emitted in the future.

        • include (list) --

          The filter that monitors only the listed set of events. New events are not auto-monitored.

          • (string) --

      • logConfiguration (dict) --

        The configuration that specifies where logs are fowarded.

        • s3 (dict) --

          The configuration for delivering the logs to S3.

          • bucket (string) --

            The S3 bucket name where logs are delivered.

          • keyPrefix (string) --

            The S3 path prefix that determines where log files are stored.

          • bucketOwner (string) --

            The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket.

          • logFileFormat (string) --

            The format of the LogFile that is written to S3.

          • folderStructure (string) --

            The folder structure that defines the organizational structure for log files in S3.

      • customerManagedKey (string) --

        The custom managed key of the session logger.

      • additionalEncryptionContext (dict) --

        The additional encryption context of the session logger.

        • (string) --

          • (string) --

      • associatedPortalArns (list) --

        The associated portal ARN.

        • (string) --

      • displayName (string) --

        The human-readable display name.

      • creationDate (datetime) --

        The date the session logger resource was created.

GetSessionLogger (new) Link ¶

Gets details about a specific session logger resource.

See also: AWS API Documentation

Request Syntax

client.get_session_logger(
    sessionLoggerArn='string'
)
type sessionLoggerArn:

string

param sessionLoggerArn:

[REQUIRED]

The ARN of the session logger.

rtype:

dict

returns:

Response Syntax

{
    'sessionLogger': {
        'sessionLoggerArn': 'string',
        'eventFilter': {
            'all': {},
            'include': [
                'WebsiteInteract'|'FileDownloadFromSecureBrowserToRemoteDisk'|'FileTransferFromRemoteToLocalDisk'|'FileTransferFromLocalToRemoteDisk'|'FileUploadFromRemoteDiskToSecureBrowser'|'ContentPasteToWebsite'|'ContentTransferFromLocalToRemoteClipboard'|'ContentCopyFromWebsite'|'UrlLoad'|'TabOpen'|'TabClose'|'PrintJobSubmit'|'SessionConnect'|'SessionStart'|'SessionDisconnect'|'SessionEnd',
            ]
        },
        'logConfiguration': {
            's3': {
                'bucket': 'string',
                'keyPrefix': 'string',
                'bucketOwner': 'string',
                'logFileFormat': 'JSONLines'|'Json',
                'folderStructure': 'Flat'|'NestedByDate'
            }
        },
        'customerManagedKey': 'string',
        'additionalEncryptionContext': {
            'string': 'string'
        },
        'associatedPortalArns': [
            'string',
        ],
        'displayName': 'string',
        'creationDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • sessionLogger (dict) --

      The session logger details.

      • sessionLoggerArn (string) --

        The ARN of the session logger resource.

      • eventFilter (dict) --

        The filter that specifies which events to monitor.

        • all (dict) --

          The filter that monitors all of the available events, including any new events emitted in the future.

        • include (list) --

          The filter that monitors only the listed set of events. New events are not auto-monitored.

          • (string) --

      • logConfiguration (dict) --

        The configuration that specifies where logs are fowarded.

        • s3 (dict) --

          The configuration for delivering the logs to S3.

          • bucket (string) --

            The S3 bucket name where logs are delivered.

          • keyPrefix (string) --

            The S3 path prefix that determines where log files are stored.

          • bucketOwner (string) --

            The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket.

          • logFileFormat (string) --

            The format of the LogFile that is written to S3.

          • folderStructure (string) --

            The folder structure that defines the organizational structure for log files in S3.

      • customerManagedKey (string) --

        The custom managed key of the session logger.

      • additionalEncryptionContext (dict) --

        The additional encryption context of the session logger.

        • (string) --

          • (string) --

      • associatedPortalArns (list) --

        The associated portal ARN.

        • (string) --

      • displayName (string) --

        The human-readable display name.

      • creationDate (datetime) --

        The date the session logger resource was created.

ListSessionLoggers (new) Link ¶

Lists all available session logger resources.

See also: AWS API Documentation

Request Syntax

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

string

param nextToken:

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

type maxResults:

integer

param maxResults:

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

rtype:

dict

returns:

Response Syntax

{
    'sessionLoggers': [
        {
            'sessionLoggerArn': 'string',
            'logConfiguration': {
                's3': {
                    'bucket': 'string',
                    'keyPrefix': 'string',
                    'bucketOwner': 'string',
                    'logFileFormat': 'JSONLines'|'Json',
                    'folderStructure': 'Flat'|'NestedByDate'
                }
            },
            'displayName': 'string',
            'creationDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • sessionLoggers (list) --

      The list of session loggers, including summaries of their details.

      • (dict) --

        The summary of the session logger resource.

        • sessionLoggerArn (string) --

          The ARN of the session logger resource.

        • logConfiguration (dict) --

          The configuration that specifies where the logs are fowarded.

          • s3 (dict) --

            The configuration for delivering the logs to S3.

            • bucket (string) --

              The S3 bucket name where logs are delivered.

            • keyPrefix (string) --

              The S3 path prefix that determines where log files are stored.

            • bucketOwner (string) --

              The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket.

            • logFileFormat (string) --

              The format of the LogFile that is written to S3.

            • folderStructure (string) --

              The folder structure that defines the organizational structure for log files in S3.

        • displayName (string) --

          The human-readable display name.

        • creationDate (datetime) --

          The date the session logger resource was created.

    • nextToken (string) --

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

DisassociateSessionLogger (new) Link ¶

Disassociates a session logger from a portal.

See also: AWS API Documentation

Request Syntax

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

string

param portalArn:

[REQUIRED]

The ARN of the portal to disassociate from the a session logger.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

DeleteSessionLogger (new) Link ¶

Deletes a session logger resource.

See also: AWS API Documentation

Request Syntax

client.delete_session_logger(
    sessionLoggerArn='string'
)
type sessionLoggerArn:

string

param sessionLoggerArn:

[REQUIRED]

The ARN of the session logger.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

GetPortal (updated) Link ¶
Changes (response) 
{'portal': {'sessionLoggerArn': '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': {
        'portalArn': 'string',
        'rendererType': 'AppStream',
        'browserType': 'Chrome',
        'portalStatus': 'Incomplete'|'Pending'|'Active',
        'portalEndpoint': 'string',
        'displayName': 'string',
        'creationDate': datetime(2015, 1, 1),
        'browserSettingsArn': 'string',
        'dataProtectionSettingsArn': 'string',
        'userSettingsArn': 'string',
        'networkSettingsArn': 'string',
        'sessionLoggerArn': 'string',
        'trustStoreArn': 'string',
        'statusReason': 'string',
        'userAccessLoggingSettingsArn': 'string',
        'authenticationType': 'Standard'|'IAM_Identity_Center',
        'ipAccessSettingsArn': 'string',
        'customerManagedKey': 'string',
        'additionalEncryptionContext': {
            'string': 'string'
        },
        'instanceType': 'standard.regular'|'standard.large'|'standard.xlarge',
        'maxConcurrentSessions': 123
    }
}

Response Structure

  • (dict) --

    • portal (dict) --

      The web portal.

      • portalArn (string) --

        The ARN of the web portal.

      • rendererType (string) --

        The renderer that is used in streaming sessions.

      • browserType (string) --

        The browser that users see when using a streaming session.

      • portalStatus (string) --

        The status of the web portal.

      • portalEndpoint (string) --

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

      • displayName (string) --

        The name of the web portal.

      • creationDate (datetime) --

        The creation date of the web portal.

      • browserSettingsArn (string) --

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

      • dataProtectionSettingsArn (string) --

        The ARN of the data protection settings.

      • userSettingsArn (string) --

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

      • networkSettingsArn (string) --

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

      • sessionLoggerArn (string) --

        The ARN of the session logger that is assocaited with the portal.

      • trustStoreArn (string) --

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

      • statusReason (string) --

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

      • userAccessLoggingSettingsArn (string) --

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

      • authenticationType (string) --

        The type of authentication integration points used when signing into the web portal. Defaults to Standard.

        Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

        IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

      • ipAccessSettingsArn (string) --

        The ARN of the IP access settings.

      • customerManagedKey (string) --

        The customer managed key used to encrypt sensitive information in the portal.

      • additionalEncryptionContext (dict) --

        The additional encryption context of the portal.

        • (string) --

          • (string) --

      • instanceType (string) --

        The type and resources of the underlying instance.

      • maxConcurrentSessions (integer) --

        The maximum number of concurrent sessions for the portal.

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

Retrieves a list or web portals.

See also: AWS API Documentation

Request Syntax

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

string

param nextToken:

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

type maxResults:

integer

param maxResults:

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

rtype:

dict

returns:

Response Syntax

{
    'portals': [
        {
            'portalArn': 'string',
            'rendererType': 'AppStream',
            'browserType': 'Chrome',
            'portalStatus': 'Incomplete'|'Pending'|'Active',
            'portalEndpoint': 'string',
            'displayName': 'string',
            'creationDate': datetime(2015, 1, 1),
            'browserSettingsArn': 'string',
            'dataProtectionSettingsArn': 'string',
            'userSettingsArn': 'string',
            'networkSettingsArn': 'string',
            'sessionLoggerArn': 'string',
            'trustStoreArn': 'string',
            'userAccessLoggingSettingsArn': 'string',
            'authenticationType': 'Standard'|'IAM_Identity_Center',
            'ipAccessSettingsArn': 'string',
            'instanceType': 'standard.regular'|'standard.large'|'standard.xlarge',
            'maxConcurrentSessions': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • portals (list) --

      The portals in the list.

      • (dict) --

        The summary of the portal.

        • portalArn (string) --

          The ARN of the web portal.

        • rendererType (string) --

          The renderer that is used in streaming sessions.

        • browserType (string) --

          The browser type of the web portal.

        • portalStatus (string) --

          The status of the web portal.

        • portalEndpoint (string) --

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

        • displayName (string) --

          The name of the web portal.

        • creationDate (datetime) --

          The creation date of the web portal.

        • browserSettingsArn (string) --

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

        • dataProtectionSettingsArn (string) --

          The ARN of the data protection settings.

        • userSettingsArn (string) --

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

        • networkSettingsArn (string) --

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

        • sessionLoggerArn (string) --

          The ARN of the session logger that is assocaited with the portal.

        • 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.

        • authenticationType (string) --

          The type of authentication integration points used when signing into the web portal. Defaults to Standard.

          Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

          IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

        • ipAccessSettingsArn (string) --

          The ARN of the IP access settings.

        • instanceType (string) --

          The type and resources of the underlying instance.

        • maxConcurrentSessions (integer) --

          The maximum number of concurrent sessions for the portal.

    • nextToken (string) --

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

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

Updates a web portal.

See also: AWS API Documentation

Request Syntax

client.update_portal(
    portalArn='string',
    displayName='string',
    authenticationType='Standard'|'IAM_Identity_Center',
    instanceType='standard.regular'|'standard.large'|'standard.xlarge',
    maxConcurrentSessions=123
)
type portalArn:

string

param portalArn:

[REQUIRED]

The ARN of the web portal.

type displayName:

string

param displayName:

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

type authenticationType:

string

param authenticationType:

The type of authentication integration points used when signing into the web portal. Defaults to Standard.

Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

type instanceType:

string

param instanceType:

The type and resources of the underlying instance.

type maxConcurrentSessions:

integer

param maxConcurrentSessions:

The maximum number of concurrent sessions for the portal.

rtype:

dict

returns:

Response Syntax

{
    'portal': {
        'portalArn': 'string',
        'rendererType': 'AppStream',
        'browserType': 'Chrome',
        'portalStatus': 'Incomplete'|'Pending'|'Active',
        'portalEndpoint': 'string',
        'displayName': 'string',
        'creationDate': datetime(2015, 1, 1),
        'browserSettingsArn': 'string',
        'dataProtectionSettingsArn': 'string',
        'userSettingsArn': 'string',
        'networkSettingsArn': 'string',
        'sessionLoggerArn': 'string',
        'trustStoreArn': 'string',
        'statusReason': 'string',
        'userAccessLoggingSettingsArn': 'string',
        'authenticationType': 'Standard'|'IAM_Identity_Center',
        'ipAccessSettingsArn': 'string',
        'customerManagedKey': 'string',
        'additionalEncryptionContext': {
            'string': 'string'
        },
        'instanceType': 'standard.regular'|'standard.large'|'standard.xlarge',
        'maxConcurrentSessions': 123
    }
}

Response Structure

  • (dict) --

    • portal (dict) --

      The web portal.

      • portalArn (string) --

        The ARN of the web portal.

      • rendererType (string) --

        The renderer that is used in streaming sessions.

      • browserType (string) --

        The browser that users see when using a streaming session.

      • portalStatus (string) --

        The status of the web portal.

      • portalEndpoint (string) --

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

      • displayName (string) --

        The name of the web portal.

      • creationDate (datetime) --

        The creation date of the web portal.

      • browserSettingsArn (string) --

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

      • dataProtectionSettingsArn (string) --

        The ARN of the data protection settings.

      • userSettingsArn (string) --

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

      • networkSettingsArn (string) --

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

      • sessionLoggerArn (string) --

        The ARN of the session logger that is assocaited with the portal.

      • trustStoreArn (string) --

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

      • statusReason (string) --

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

      • userAccessLoggingSettingsArn (string) --

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

      • authenticationType (string) --

        The type of authentication integration points used when signing into the web portal. Defaults to Standard.

        Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

        IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

      • ipAccessSettingsArn (string) --

        The ARN of the IP access settings.

      • customerManagedKey (string) --

        The customer managed key used to encrypt sensitive information in the portal.

      • additionalEncryptionContext (dict) --

        The additional encryption context of the portal.

        • (string) --

          • (string) --

      • instanceType (string) --

        The type and resources of the underlying instance.

      • maxConcurrentSessions (integer) --

        The maximum number of concurrent sessions for the portal.