Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateNetworkSettings

Updates network settings.

Request Syntax


PATCH /networkSettings/networkSettingsArn+ HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "securityGroupIds": [ "string" ],
   "subnetIds": [ "string" ],
   "vpcId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

networkSettingsArn

The ARN of the network settings.

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

securityGroupIds

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[\w+\-]+$

Required: No

subnetIds

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.

Type: Array of strings

Array Members: Minimum number of 2 items. Maximum number of 3 items.

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^subnet-([0-9a-f]{8}|[0-9a-f]{17})$

Required: No

vpcId

The VPC that streaming instances will connect to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^vpc-[0-9a-z]*$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

networkSettings

The network settings.

Type: NetworkSettings object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access is denied.

HTTP Status Code: 403

InternalServerException

There is an internal server error.

HTTP Status Code: 500

ResourceNotFoundException

The resource cannot be found.

HTTP Status Code: 404

ThrottlingException

There is a throttling error.

HTTP Status Code: 429

ValidationException

There is a validation error.

HTTP Status Code: 400