2024/11/20 - Amazon WorkSpaces Web - 7 new3 updated api methods
Changes Added data protection settings with support for inline data redaction.
Gets the data protection settings.
See also: AWS API Documentation
Request Syntax
client.get_data_protection_settings(
dataProtectionSettingsArn='string'
)
string
[REQUIRED]
The ARN of the data protection settings.
dict
Response Syntax
{
'dataProtectionSettings': {
'additionalEncryptionContext': {
'string': 'string'
},
'associatedPortalArns': [
'string',
],
'creationDate': datetime(2015, 1, 1),
'customerManagedKey': 'string',
'dataProtectionSettingsArn': 'string',
'description': 'string',
'displayName': 'string',
'inlineRedactionConfiguration': {
'globalConfidenceLevel': 123,
'globalEnforcedUrls': [
'string',
],
'globalExemptUrls': [
'string',
],
'inlineRedactionPatterns': [
{
'builtInPatternId': 'string',
'confidenceLevel': 123,
'customPattern': {
'keywordRegex': 'string',
'patternDescription': 'string',
'patternName': 'string',
'patternRegex': 'string'
},
'enforcedUrls': [
'string',
],
'exemptUrls': [
'string',
],
'redactionPlaceHolder': {
'redactionPlaceHolderText': 'string',
'redactionPlaceHolderType': 'CustomText'
}
},
]
}
}
}
Response Structure
(dict) --
dataProtectionSettings (dict) --
The data protection settings.
additionalEncryptionContext (dict) --
The additional encryption context of the data protection settings.
(string) --
(string) --
associatedPortalArns (list) --
A list of web portal ARNs that this data protection settings resource is associated with.
(string) --
creationDate (datetime) --
The creation date timestamp of the data protection settings.
customerManagedKey (string) --
The customer managed key used to encrypt sensitive information in the data protection settings.
dataProtectionSettingsArn (string) --
The ARN of the data protection settings resource.
description (string) --
The description of the data protection settings.
displayName (string) --
The display name of the data protection settings.
inlineRedactionConfiguration (dict) --
The inline redaction configuration for the data protection settings.
globalConfidenceLevel (integer) --
The global confidence level for the inline redaction configuration. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This is applied to patterns that do not have a pattern-level confidence level. Defaults to confidence level 2.
globalEnforcedUrls (list) --
The global enforced URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level enforced URL list.
(string) --
globalExemptUrls (list) --
The global exempt URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level exempt URL list.
(string) --
inlineRedactionPatterns (list) --
The inline redaction patterns to be enabled for the inline redaction configuration.
(dict) --
The set of patterns that determine the data types redacted in session.
builtInPatternId (string) --
The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required.
confidenceLevel (integer) --
The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level.
customPattern (dict) --
>The configuration for a custom pattern. Either a customPattern or builtInPatternId is required.
keywordRegex (string) --
The keyword regex for the customer pattern. After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi”
patternDescription (string) --
The pattern description for the customer pattern.
patternName (string) --
The pattern name for the custom pattern.
patternRegex (string) --
The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”.
enforcedUrls (list) --
The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration.
(string) --
exemptUrls (list) --
The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern.
(string) --
redactionPlaceHolder (dict) --
The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.
redactionPlaceHolderText (string) --
The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type.
redactionPlaceHolderType (string) --
The redaction placeholder type that will replace the redacted text in session.
Creates a data protection settings resource that can be associated with a web portal.
See also: AWS API Documentation
Request Syntax
client.create_data_protection_settings(
additionalEncryptionContext={
'string': 'string'
},
clientToken='string',
customerManagedKey='string',
description='string',
displayName='string',
inlineRedactionConfiguration={
'globalConfidenceLevel': 123,
'globalEnforcedUrls': [
'string',
],
'globalExemptUrls': [
'string',
],
'inlineRedactionPatterns': [
{
'builtInPatternId': 'string',
'confidenceLevel': 123,
'customPattern': {
'keywordRegex': 'string',
'patternDescription': 'string',
'patternName': 'string',
'patternRegex': 'string'
},
'enforcedUrls': [
'string',
],
'exemptUrls': [
'string',
],
'redactionPlaceHolder': {
'redactionPlaceHolderText': 'string',
'redactionPlaceHolderType': 'CustomText'
}
},
]
},
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
dict
Additional encryption context of the data protection settings.
(string) --
(string) --
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 Amazon Web Services SDK.
This field is autopopulated if not provided.
string
The custom managed key of the data protection settings.
string
The description of the data protection settings.
string
The display name of the data protection settings.
dict
The inline redaction configuration of the data protection settings that will be applied to all sessions.
globalConfidenceLevel (integer) --
The global confidence level for the inline redaction configuration. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This is applied to patterns that do not have a pattern-level confidence level. Defaults to confidence level 2.
globalEnforcedUrls (list) --
The global enforced URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level enforced URL list.
(string) --
globalExemptUrls (list) --
The global exempt URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level exempt URL list.
(string) --
inlineRedactionPatterns (list) -- [REQUIRED]
The inline redaction patterns to be enabled for the inline redaction configuration.
(dict) --
The set of patterns that determine the data types redacted in session.
builtInPatternId (string) --
The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required.
confidenceLevel (integer) --
The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level.
customPattern (dict) --
>The configuration for a custom pattern. Either a customPattern or builtInPatternId is required.
keywordRegex (string) --
The keyword regex for the customer pattern. After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi”
patternDescription (string) --
The pattern description for the customer pattern.
patternName (string) -- [REQUIRED]
The pattern name for the custom pattern.
patternRegex (string) -- [REQUIRED]
The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”.
enforcedUrls (list) --
The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration.
(string) --
exemptUrls (list) --
The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern.
(string) --
redactionPlaceHolder (dict) -- [REQUIRED]
The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.
redactionPlaceHolderText (string) --
The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type.
redactionPlaceHolderType (string) -- [REQUIRED]
The redaction placeholder type that will replace the redacted text in session.
list
The tags to add to the data protection 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
dict
Response Syntax
{
'dataProtectionSettingsArn': 'string'
}
Response Structure
(dict) --
dataProtectionSettingsArn (string) --
The ARN of the data protection settings resource.
Deletes data protection settings.
See also: AWS API Documentation
Request Syntax
client.delete_data_protection_settings(
dataProtectionSettingsArn='string'
)
string
[REQUIRED]
The ARN of the data protection settings.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a list of data protection settings.
See also: AWS API Documentation
Request Syntax
client.list_data_protection_settings(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to be included in the next page.
string
The pagination token used to retrieve the next page of results for this operation.
dict
Response Syntax
{
'dataProtectionSettings': [
{
'creationDate': datetime(2015, 1, 1),
'dataProtectionSettingsArn': 'string',
'description': 'string',
'displayName': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
dataProtectionSettings (list) --
The data protection settings.
(dict) --
The summary of the data protection settings.
creationDate (datetime) --
The creation date timestamp of the data protection settings.
dataProtectionSettingsArn (string) --
The ARN of the data protection settings.
description (string) --
The description of the data protection settings.
displayName (string) --
The display name of the data protection settings.
nextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
Disassociates data protection settings from a web portal.
See also: AWS API Documentation
Request Syntax
client.disassociate_data_protection_settings(
portalArn='string'
)
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{}
Response Structure
(dict) --
Associates a data protection settings resource with a web portal.
See also: AWS API Documentation
Request Syntax
client.associate_data_protection_settings(
dataProtectionSettingsArn='string',
portalArn='string'
)
string
[REQUIRED]
The ARN of the data protection settings.
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{
'dataProtectionSettingsArn': 'string',
'portalArn': 'string'
}
Response Structure
(dict) --
dataProtectionSettingsArn (string) --
The ARN of the data protection settings resource.
portalArn (string) --
The ARN of the web portal.
Updates data protection settings.
See also: AWS API Documentation
Request Syntax
client.update_data_protection_settings(
clientToken='string',
dataProtectionSettingsArn='string',
description='string',
displayName='string',
inlineRedactionConfiguration={
'globalConfidenceLevel': 123,
'globalEnforcedUrls': [
'string',
],
'globalExemptUrls': [
'string',
],
'inlineRedactionPatterns': [
{
'builtInPatternId': 'string',
'confidenceLevel': 123,
'customPattern': {
'keywordRegex': 'string',
'patternDescription': 'string',
'patternName': 'string',
'patternRegex': 'string'
},
'enforcedUrls': [
'string',
],
'exemptUrls': [
'string',
],
'redactionPlaceHolder': {
'redactionPlaceHolderText': 'string',
'redactionPlaceHolderType': 'CustomText'
}
},
]
}
)
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 return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
This field is autopopulated if not provided.
string
[REQUIRED]
The ARN of the data protection settings.
string
The description of the data protection settings.
string
The display name of the data protection settings.
dict
The inline redaction configuration of the data protection settings that will be applied to all sessions.
globalConfidenceLevel (integer) --
The global confidence level for the inline redaction configuration. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This is applied to patterns that do not have a pattern-level confidence level. Defaults to confidence level 2.
globalEnforcedUrls (list) --
The global enforced URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level enforced URL list.
(string) --
globalExemptUrls (list) --
The global exempt URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level exempt URL list.
(string) --
inlineRedactionPatterns (list) -- [REQUIRED]
The inline redaction patterns to be enabled for the inline redaction configuration.
(dict) --
The set of patterns that determine the data types redacted in session.
builtInPatternId (string) --
The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required.
confidenceLevel (integer) --
The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level.
customPattern (dict) --
>The configuration for a custom pattern. Either a customPattern or builtInPatternId is required.
keywordRegex (string) --
The keyword regex for the customer pattern. After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi”
patternDescription (string) --
The pattern description for the customer pattern.
patternName (string) -- [REQUIRED]
The pattern name for the custom pattern.
patternRegex (string) -- [REQUIRED]
The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”.
enforcedUrls (list) --
The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration.
(string) --
exemptUrls (list) --
The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern.
(string) --
redactionPlaceHolder (dict) -- [REQUIRED]
The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.
redactionPlaceHolderText (string) --
The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type.
redactionPlaceHolderType (string) -- [REQUIRED]
The redaction placeholder type that will replace the redacted text in session.
dict
Response Syntax
{
'dataProtectionSettings': {
'additionalEncryptionContext': {
'string': 'string'
},
'associatedPortalArns': [
'string',
],
'creationDate': datetime(2015, 1, 1),
'customerManagedKey': 'string',
'dataProtectionSettingsArn': 'string',
'description': 'string',
'displayName': 'string',
'inlineRedactionConfiguration': {
'globalConfidenceLevel': 123,
'globalEnforcedUrls': [
'string',
],
'globalExemptUrls': [
'string',
],
'inlineRedactionPatterns': [
{
'builtInPatternId': 'string',
'confidenceLevel': 123,
'customPattern': {
'keywordRegex': 'string',
'patternDescription': 'string',
'patternName': 'string',
'patternRegex': 'string'
},
'enforcedUrls': [
'string',
],
'exemptUrls': [
'string',
],
'redactionPlaceHolder': {
'redactionPlaceHolderText': 'string',
'redactionPlaceHolderType': 'CustomText'
}
},
]
}
}
}
Response Structure
(dict) --
dataProtectionSettings (dict) --
The data protection settings.
additionalEncryptionContext (dict) --
The additional encryption context of the data protection settings.
(string) --
(string) --
associatedPortalArns (list) --
A list of web portal ARNs that this data protection settings resource is associated with.
(string) --
creationDate (datetime) --
The creation date timestamp of the data protection settings.
customerManagedKey (string) --
The customer managed key used to encrypt sensitive information in the data protection settings.
dataProtectionSettingsArn (string) --
The ARN of the data protection settings resource.
description (string) --
The description of the data protection settings.
displayName (string) --
The display name of the data protection settings.
inlineRedactionConfiguration (dict) --
The inline redaction configuration for the data protection settings.
globalConfidenceLevel (integer) --
The global confidence level for the inline redaction configuration. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This is applied to patterns that do not have a pattern-level confidence level. Defaults to confidence level 2.
globalEnforcedUrls (list) --
The global enforced URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level enforced URL list.
(string) --
globalExemptUrls (list) --
The global exempt URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level exempt URL list.
(string) --
inlineRedactionPatterns (list) --
The inline redaction patterns to be enabled for the inline redaction configuration.
(dict) --
The set of patterns that determine the data types redacted in session.
builtInPatternId (string) --
The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required.
confidenceLevel (integer) --
The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level.
customPattern (dict) --
>The configuration for a custom pattern. Either a customPattern or builtInPatternId is required.
keywordRegex (string) --
The keyword regex for the customer pattern. After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi”
patternDescription (string) --
The pattern description for the customer pattern.
patternName (string) --
The pattern name for the custom pattern.
patternRegex (string) --
The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”.
enforcedUrls (list) --
The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration.
(string) --
exemptUrls (list) --
The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern.
(string) --
redactionPlaceHolder (dict) --
The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.
redactionPlaceHolderText (string) --
The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type.
redactionPlaceHolderType (string) --
The redaction placeholder type that will replace the redacted text in session.
{'portal': {'dataProtectionSettingsArn': 'string'}}
Gets the web portal.
See also: AWS API Documentation
Request Syntax
client.get_portal(
portalArn='string'
)
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{
'portal': {
'additionalEncryptionContext': {
'string': 'string'
},
'authenticationType': 'Standard'|'IAM_Identity_Center',
'browserSettingsArn': 'string',
'browserType': 'Chrome',
'creationDate': datetime(2015, 1, 1),
'customerManagedKey': 'string',
'dataProtectionSettingsArn': 'string',
'displayName': 'string',
'instanceType': 'standard.regular'|'standard.large'|'standard.xlarge',
'ipAccessSettingsArn': 'string',
'maxConcurrentSessions': 123,
'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.
additionalEncryptionContext (dict) --
The additional encryption context of the portal.
(string) --
(string) --
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.
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.
customerManagedKey (string) --
The customer managed key used to encrypt sensitive information in the portal.
dataProtectionSettingsArn (string) --
The ARN of the data protection settings.
displayName (string) --
The name of the web portal.
instanceType (string) --
The type and resources of the underlying instance.
ipAccessSettingsArn (string) --
The ARN of the IP access settings.
maxConcurrentSessions (integer) --
The maximum number of concurrent sessions for the 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.
{'portals': {'dataProtectionSettingsArn': 'string'}}
Retrieves a list or web portals.
See also: AWS API Documentation
Request Syntax
client.list_portals(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to be included in the next page.
string
The pagination token used to retrieve the next page of results for this operation.
dict
Response Syntax
{
'nextToken': 'string',
'portals': [
{
'authenticationType': 'Standard'|'IAM_Identity_Center',
'browserSettingsArn': 'string',
'browserType': 'Chrome',
'creationDate': datetime(2015, 1, 1),
'dataProtectionSettingsArn': 'string',
'displayName': 'string',
'instanceType': 'standard.regular'|'standard.large'|'standard.xlarge',
'ipAccessSettingsArn': 'string',
'maxConcurrentSessions': 123,
'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 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.
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.
dataProtectionSettingsArn (string) --
The ARN of the data protection settings.
displayName (string) --
The name of the web portal.
instanceType (string) --
The type and resources of the underlying instance.
ipAccessSettingsArn (string) --
The ARN of the IP access settings.
maxConcurrentSessions (integer) --
The maximum number of concurrent sessions for the 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.
{'portal': {'dataProtectionSettingsArn': 'string'}}
Updates a web portal.
See also: AWS API Documentation
Request Syntax
client.update_portal(
authenticationType='Standard'|'IAM_Identity_Center',
displayName='string',
instanceType='standard.regular'|'standard.large'|'standard.xlarge',
maxConcurrentSessions=123,
portalArn='string'
)
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.
string
The name of the web portal. This is not visible to users who log into the web portal.
string
The type and resources of the underlying instance.
integer
The maximum number of concurrent sessions for the portal.
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{
'portal': {
'additionalEncryptionContext': {
'string': 'string'
},
'authenticationType': 'Standard'|'IAM_Identity_Center',
'browserSettingsArn': 'string',
'browserType': 'Chrome',
'creationDate': datetime(2015, 1, 1),
'customerManagedKey': 'string',
'dataProtectionSettingsArn': 'string',
'displayName': 'string',
'instanceType': 'standard.regular'|'standard.large'|'standard.xlarge',
'ipAccessSettingsArn': 'string',
'maxConcurrentSessions': 123,
'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.
additionalEncryptionContext (dict) --
The additional encryption context of the portal.
(string) --
(string) --
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.
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.
customerManagedKey (string) --
The customer managed key used to encrypt sensitive information in the portal.
dataProtectionSettingsArn (string) --
The ARN of the data protection settings.
displayName (string) --
The name of the web portal.
instanceType (string) --
The type and resources of the underlying instance.
ipAccessSettingsArn (string) --
The ARN of the IP access settings.
maxConcurrentSessions (integer) --
The maximum number of concurrent sessions for the 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.