WorkSpacesWeb / Client / update_ip_access_settings

update_ip_access_settings

WorkSpacesWeb.Client.update_ip_access_settings(**kwargs)

Updates IP access settings.

See also: AWS API Documentation

Request Syntax

response = client.update_ip_access_settings(
    clientToken='string',
    description='string',
    displayName='string',
    ipAccessSettingsArn='string',
    ipRules=[
        {
            'description': 'string',
            'ipRange': 'string'
        },
    ]
)

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.

• description (string) – The description of the IP access settings.

• displayName (string) – The display name of the IP access settings.

• ipAccessSettingsArn (string) –

  [REQUIRED]

  The ARN of the IP access settings.

• ipRules (list) –

  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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • ipAccessSettings (dict) –

    The IP access settings.

    • additionalEncryptionContext (dict) –

      The additional encryption context of the IP access settings.

      • (string) –

        • (string) –

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

    • customerManagedKey (string) –

      The customer managed key used to encrypt sensitive information in 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.

Exceptions

• WorkSpacesWeb.Client.exceptions.InternalServerException

• WorkSpacesWeb.Client.exceptions.ResourceNotFoundException

• WorkSpacesWeb.Client.exceptions.AccessDeniedException

• WorkSpacesWeb.Client.exceptions.ThrottlingException

• WorkSpacesWeb.Client.exceptions.ValidationException