WorkSpacesWeb / Client / list_ip_access_settings

list_ip_access_settings#

WorkSpacesWeb.Client.list_ip_access_settings(**kwargs)#

Retrieves a list of IP access settings.

Request Syntax

response = client.list_ip_access_settings(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – The maximum number of results to be included in the next page.
nextToken (string) – The pagination token used to retrieve the next page of results for this operation.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- ipAccessSettings (list) –
  
  The IP access settings.
  - (dict) –
    
    The summary of IP access settings.
    - 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 IP access settings.
- nextToken (string) –
  
  The pagination token used to retrieve the next page of results for this operation.

Exceptions

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