WorkSpacesWeb / Client / create_ip_access_settings

create_ip_access_settings#

WorkSpacesWeb.Client.create_ip_access_settings(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • additionalEncryptionContext (dict) –

    Additional encryption context of the IP access settings.

    • (string) –

      • (string) –

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

  • customerManagedKey (string) – The custom managed key of the IP access settings.

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

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

  • ipRules (list) –

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

  • tags (list) –

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

Return type:

dict

Returns:

Response Syntax

{
    'ipAccessSettingsArn': 'string'
}

Response Structure

  • (dict) –

    • ipAccessSettingsArn (string) –

      The ARN of the IP access settings resource.

Exceptions

  • WorkSpacesWeb.Client.exceptions.InternalServerException

  • WorkSpacesWeb.Client.exceptions.AccessDeniedException

  • WorkSpacesWeb.Client.exceptions.ThrottlingException

  • WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException

  • WorkSpacesWeb.Client.exceptions.ValidationException

  • WorkSpacesWeb.Client.exceptions.ConflictException