WorkSpacesWeb / Client / get_ip_access_settings

get_ip_access_settings#

WorkSpacesWeb.Client.get_ip_access_settings(**kwargs)#

Gets the IP access settings.

Request Syntax

response = client.get_ip_access_settings(
    ipAccessSettingsArn='string'
)

Parameters:

ipAccessSettingsArn (string) –

[REQUIRED]

The ARN of the IP access settings.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- ipAccessSettings (dict) –
  
  The IP access settings.
  - 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.
  - 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