WorkSpacesWeb / Client / update_network_settings

update_network_settings#

WorkSpacesWeb.Client.update_network_settings(**kwargs)#

Updates network settings.

See also: AWS API Documentation

Request Syntax

response = client.update_network_settings(
    clientToken='string',
    networkSettingsArn='string',
    securityGroupIds=[
        'string',
    ],
    subnetIds=[
        'string',
    ],
    vpcId='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 AWS SDK.

    This field is autopopulated if not provided.

  • networkSettingsArn (string) –

    [REQUIRED]

    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.

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