WorkSpacesWeb / Client / create_network_settings

create_network_settings#

WorkSpacesWeb.Client.create_network_settings(**kwargs)#

Creates a network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC.

See also: AWS API Documentation

Request Syntax

response = client.create_network_settings(
    clientToken='string',
    securityGroupIds=[
        'string',
    ],
    subnetIds=[
        'string',
    ],
    tags=[
        {
            'Key': 'string',
            'Value': '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 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.

  • securityGroupIds (list) –

    [REQUIRED]

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

    • (string) –

  • subnetIds (list) –

    [REQUIRED]

    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) –

  • tags (list) –

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

  • vpcId (string) –

    [REQUIRED]

    The VPC that streaming instances will connect to.

Return type:

dict

Returns:

Response Syntax

{
    'networkSettingsArn': 'string'
}

Response Structure

  • (dict) –

    • networkSettingsArn (string) –

      The ARN of the network settings.

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