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

CreateLicenseServerEndpoint

Creates a network endpoint for the Remote Desktop Services (RDS) license server.

Request Syntax


POST /license-server/CreateLicenseServerEndpoint HTTP/1.1
Content-type: application/json

{
   "IdentityProviderArn": "string",
   "LicenseServerSettings": { 
      "ServerSettings": { ... },
      "ServerType": "string"
   },
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

IdentityProviderArn

The Amazon Resource Name (ARN) that identifies the IdentityProvider resource that contains details about a registered identity provider. In the case of Active Directory, that can be a self-managed Active Directory or an AWS Managed Active Directory that contains user identity details.

Type: String

Pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-zA-Z0-9-\.]{1,510}/[a-zA-Z0-9-\.]{1,510}$

Required: Yes

LicenseServerSettings

The LicenseServerSettings resource to create for the endpoint. The settings include the type of license server and the AWS Secrets Manager secret that enables administrators to add or remove users associated with the license server.

Type: LicenseServerSettings object

Required: Yes

Tags

The tags that apply for the license server endpoint.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "IdentityProviderArn": "string",
   "LicenseServerEndpointArn": "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.

IdentityProviderArn

The Amazon Resource Name (ARN) of the identity provider specified in the request.

Type: String

Pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-zA-Z0-9-\.]{1,510}/[a-zA-Z0-9-\.]{1,510}$

LicenseServerEndpointArn

The ARN of the LicenseServerEndpoint resource.

Type: String

Pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-zA-Z0-9-\.]{1,510}/[a-zA-Z0-9-\.]{1,510}$

Errors

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

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 400

ConflictException

The request couldn't be completed because it conflicted with the current state of the resource.

HTTP Status Code: 500

InternalServerException

An exception occurred with the service.

HTTP Status Code: 500

ResourceNotFoundException

The resource couldn't be found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request failed because a service quota is exceeded.

HTTP Status Code: 400

ThrottlingException

The request was denied because of request throttling. Retry the request.

HTTP Status Code: 400

ValidationException

A parameter is not valid.

HTTP Status Code: 400