WorkSpacesWeb / Client / get_network_settings

get_network_settings#

WorkSpacesWeb.Client.get_network_settings(**kwargs)#

Gets the network settings.

See also: AWS API Documentation

Request Syntax

response = client.get_network_settings(
    networkSettingsArn='string'
)
Parameters:

networkSettingsArn (string) –

[REQUIRED]

The ARN of the network settings.

Return type:

dict

Returns:

Response Syntax

{
    'networkSettings': {
        'associatedPortalArns': [
            'string',
        ],
        'networkSettingsArn': 'string',
        'securityGroupIds': [
            'string',
        ],
        'subnetIds': [
            'string',
        ],
        'vpcId': 'string'
    }
}

Response Structure

  • (dict) –

    • networkSettings (dict) –

      The network settings.

      • associatedPortalArns (list) –

        A list of web portal ARNs that this network settings is associated with.

        • (string) –

      • networkSettingsArn (string) –

        The ARN of the network settings.

      • securityGroupIds (list) –

        One or more security groups used to control access from streaming instances to your VPC.

        • (string) –

      • subnetIds (list) –

        The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

        • (string) –

      • vpcId (string) –

        The VPC that streaming instances will connect to.

Exceptions

  • WorkSpacesWeb.Client.exceptions.InternalServerException

  • WorkSpacesWeb.Client.exceptions.ResourceNotFoundException

  • WorkSpacesWeb.Client.exceptions.AccessDeniedException

  • WorkSpacesWeb.Client.exceptions.ThrottlingException

  • WorkSpacesWeb.Client.exceptions.ValidationException