Amazon WorkSpaces Web

2023/05/31 - Amazon WorkSpaces Web - 7 new 3 updated api methods

Changes  WorkSpaces Web now allows you to control which IP addresses your WorkSpaces Web portal may be accessed from.

AssociateIpAccessSettings (new) Link ¶

Associates an IP access settings resource with a web portal.

See also: AWS API Documentation

Request Syntax

client.associate_ip_access_settings(
    ipAccessSettingsArn='string',
    portalArn='string'
)
type ipAccessSettingsArn

string

param ipAccessSettingsArn

[REQUIRED]

The ARN of the IP access settings.

type portalArn

string

param portalArn

[REQUIRED]

The ARN of the web portal.

rtype

dict

returns

Response Syntax

{
    'ipAccessSettingsArn': 'string',
    'portalArn': 'string'
}

Response Structure

  • (dict) --

    • ipAccessSettingsArn (string) --

      The ARN of the IP access settings resource.

    • portalArn (string) --

      The ARN of the web portal.

CreateIpAccessSettings (new) Link ¶

Creates an IP access settings resource that can be associated with a web portal.

See also: AWS API Documentation

Request Syntax

client.create_ip_access_settings(
    additionalEncryptionContext={
        'string': 'string'
    },
    clientToken='string',
    customerManagedKey='string',
    description='string',
    displayName='string',
    ipRules=[
        {
            'description': 'string',
            'ipRange': 'string'
        },
    ],
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type additionalEncryptionContext

dict

param additionalEncryptionContext

Additional encryption context of the IP access settings.

  • (string) --

    • (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 customerManagedKey

string

param customerManagedKey

The custom managed key of the IP access settings.

type description

string

param description

The description of the IP access settings.

type displayName

string

param displayName

The display name of the IP access settings.

type ipRules

list

param ipRules

[REQUIRED]

The IP rules of the IP access settings.

  • (dict) --

    The IP rules of the IP access settings.

    • description (string) --

      The description of the IP rule.

    • ipRange (string) -- [REQUIRED]

      The IP range of the IP rule.

type tags

list

param tags

The tags to add to the browser 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

{
    'ipAccessSettingsArn': 'string'
}

Response Structure

  • (dict) --

    • ipAccessSettingsArn (string) --

      The ARN of the IP access settings resource.

DeleteIpAccessSettings (new) Link ¶

Deletes IP access settings.

See also: AWS API Documentation

Request Syntax

client.delete_ip_access_settings(
    ipAccessSettingsArn='string'
)
type ipAccessSettingsArn

string

param ipAccessSettingsArn

[REQUIRED]

The ARN of the IP access settings.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

GetIpAccessSettings (new) Link ¶

Gets the IP access settings.

See also: AWS API Documentation

Request Syntax

client.get_ip_access_settings(
    ipAccessSettingsArn='string'
)
type ipAccessSettingsArn

string

param ipAccessSettingsArn

[REQUIRED]

The ARN of the IP access settings.

rtype

dict

returns

Response Syntax

{
    'ipAccessSettings': {
        'associatedPortalArns': [
            'string',
        ],
        'creationDate': datetime(2015, 1, 1),
        'description': 'string',
        'displayName': 'string',
        'ipAccessSettingsArn': 'string',
        'ipRules': [
            {
                'description': 'string',
                'ipRange': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ipAccessSettings (dict) --

      The IP access settings.

      • associatedPortalArns (list) --

        A list of web portal ARNs that this IP access settings resource is associated with.

        • (string) --

      • creationDate (datetime) --

        The creation date timestamp of the IP access settings.

      • description (string) --

        The description of the IP access settings.

      • displayName (string) --

        The display name of the IP access settings.

      • ipAccessSettingsArn (string) --

        The ARN of the IP access settings resource.

      • ipRules (list) --

        The IP rules of the IP access settings.

        • (dict) --

          The IP rules of the IP access settings.

          • description (string) --

            The description of the IP rule.

          • ipRange (string) --

            The IP range of the IP rule.

ListIpAccessSettings (new) Link ¶

Retrieves a list of IP access settings.

See also: AWS API Documentation

Request Syntax

client.list_ip_access_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

{
    'ipAccessSettings': [
        {
            'creationDate': datetime(2015, 1, 1),
            'description': 'string',
            'displayName': 'string',
            'ipAccessSettingsArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • ipAccessSettings (list) --

      The IP access settings.

      • (dict) --

        The summary of IP access settings.

        • creationDate (datetime) --

          The creation date timestamp of the IP access settings.

        • description (string) --

          The description of the IP access settings.

        • displayName (string) --

          The display name of the IP access settings.

        • ipAccessSettingsArn (string) --

          The ARN of IP access settings.

    • nextToken (string) --

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

DisassociateIpAccessSettings (new) Link ¶

Disassociates IP access settings from a web portal.

See also: AWS API Documentation

Request Syntax

client.disassociate_ip_access_settings(
    portalArn='string'
)
type portalArn

string

param portalArn

[REQUIRED]

The ARN of the web portal.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

UpdateIpAccessSettings (new) Link ¶

Updates IP access settings.

See also: AWS API Documentation

Request Syntax

client.update_ip_access_settings(
    clientToken='string',
    description='string',
    displayName='string',
    ipAccessSettingsArn='string',
    ipRules=[
        {
            'description': 'string',
            'ipRange': '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 description

string

param description

The description of the IP access settings.

type displayName

string

param displayName

The display name of the IP access settings.

type ipAccessSettingsArn

string

param ipAccessSettingsArn

[REQUIRED]

The ARN of the IP access settings.

type ipRules

list

param ipRules

The updated IP rules of the IP access settings.

  • (dict) --

    The IP rules of the IP access settings.

    • description (string) --

      The description of the IP rule.

    • ipRange (string) -- [REQUIRED]

      The IP range of the IP rule.

rtype

dict

returns

Response Syntax

{
    'ipAccessSettings': {
        'associatedPortalArns': [
            'string',
        ],
        'creationDate': datetime(2015, 1, 1),
        'description': 'string',
        'displayName': 'string',
        'ipAccessSettingsArn': 'string',
        'ipRules': [
            {
                'description': 'string',
                'ipRange': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ipAccessSettings (dict) --

      The IP access settings.

      • associatedPortalArns (list) --

        A list of web portal ARNs that this IP access settings resource is associated with.

        • (string) --

      • creationDate (datetime) --

        The creation date timestamp of the IP access settings.

      • description (string) --

        The description of the IP access settings.

      • displayName (string) --

        The display name of the IP access settings.

      • ipAccessSettingsArn (string) --

        The ARN of the IP access settings resource.

      • ipRules (list) --

        The IP rules of the IP access settings.

        • (dict) --

          The IP rules of the IP access settings.

          • description (string) --

            The description of the IP rule.

          • ipRange (string) --

            The IP range of the IP rule.

GetPortal (updated) Link ¶
Changes (response) 
{'portal': {'ipAccessSettingsArn': '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': {
        'authenticationType': 'Standard'|'IAM_Identity_Center',
        'browserSettingsArn': 'string',
        'browserType': 'Chrome',
        'creationDate': datetime(2015, 1, 1),
        'displayName': 'string',
        'ipAccessSettingsArn': '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.

      • 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 AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

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

      • ipAccessSettingsArn (string) --

        The ARN of the IP access settings.

      • 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': {'ipAccessSettingsArn': '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': [
        {
            'authenticationType': 'Standard'|'IAM_Identity_Center',
            'browserSettingsArn': 'string',
            'browserType': 'Chrome',
            'creationDate': datetime(2015, 1, 1),
            'displayName': 'string',
            'ipAccessSettingsArn': '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.

        • 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 AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

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

        • ipAccessSettingsArn (string) --

          The ARN of the IP access settings.

        • 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': {'ipAccessSettingsArn': 'string'}}

Updates a web portal.

See also: AWS API Documentation

Request Syntax

client.update_portal(
    authenticationType='Standard'|'IAM_Identity_Center',
    displayName='string',
    portalArn='string'
)
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 AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. 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 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': {
        'authenticationType': 'Standard'|'IAM_Identity_Center',
        'browserSettingsArn': 'string',
        'browserType': 'Chrome',
        'creationDate': datetime(2015, 1, 1),
        'displayName': 'string',
        'ipAccessSettingsArn': '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.

      • 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 AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

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

      • ipAccessSettingsArn (string) --

        The ARN of the IP access settings.

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