WorkSpacesWeb / Client / update_data_protection_settings

update_data_protection_settings#

WorkSpacesWeb.Client.update_data_protection_settings(**kwargs)#

Updates data protection settings.

Request Syntax

response = 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'
                }
            },
        ]
    }
)

Parameters:

clientToken (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.
dataProtectionSettingsArn (string) –
[REQUIRED]

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.
inlineRedactionConfiguration (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.

Return type:

dict

Returns:

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.

Exceptions

WorkSpacesWeb.Client.exceptions.InternalServerException
WorkSpacesWeb.Client.exceptions.ResourceNotFoundException
WorkSpacesWeb.Client.exceptions.AccessDeniedException
WorkSpacesWeb.Client.exceptions.ThrottlingException
WorkSpacesWeb.Client.exceptions.ValidationException