AWS API Changes

2023/01/09 - Amazon WorkSpaces Web - 4 updated api methods

Changes This release adds support for a new portal authentication type: AWS IAM Identity Center (successor to AWS Single Sign-On).

CreatePortal (updated)

Link ¶
Changes (request)

{'authenticationType': 'Standard | IAM_Identity_Center'}

Creates a web portal.

See also: AWS API Documentation

Request Syntax

client.create_portal(
    additionalEncryptionContext={
        'string': 'string'
    },
    authenticationType='Standard'|'IAM_Identity_Center',
    clientToken='string',
    customerManagedKey='string',
    displayName='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type additionalEncryptionContext:

dict

param additionalEncryptionContext:

The additional encryption context of the portal.

(string) --
- (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 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 customer managed key 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 tags:

list

param tags:

The tags to add to the web portal. 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

{
    'portalArn': 'string',
    'portalEndpoint': 'string'
}

Response Structure

(dict) --
- 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.

GetPortal (updated)

Link ¶
Changes (response)

{'portal': {'authenticationType': 'Standard | IAM_Identity_Center'}}

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',
        '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.
  - 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': {'authenticationType': 'Standard | IAM_Identity_Center'}}

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',
            '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.
    - 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 (request, response)
Request

{'authenticationType': 'Standard | IAM_Identity_Center'}

Response

{'portal': {'authenticationType': 'Standard | IAM_Identity_Center'}}

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.

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',
        '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.
  - 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.