LicenseManagerUserSubscriptions / Client / create_license_server_endpoint

create_license_server_endpoint

LicenseManagerUserSubscriptions.Client.create_license_server_endpoint(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_license_server_endpoint(
    IdentityProviderArn='string',
    LicenseServerSettings={
        'ServerSettings': {
            'RdsSalSettings': {
                'RdsSalCredentialsProvider': {
                    'SecretsManagerCredentialsProvider': {
                        'SecretId': 'string'
                    }
                }
            }
        },
        'ServerType': 'RDS_SAL'
    },
    Tags={
        'string': 'string'
    }
)

Parameters:

• IdentityProviderArn (string) –

  [REQUIRED]

  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 Amazon Web Services Managed Active Directory that contains user identity details.

• LicenseServerSettings (dict) –

  [REQUIRED]

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

  • ServerSettings (dict) – [REQUIRED]

    The ServerSettings resource contains the settings for your server.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: RdsSalSettings.

    • RdsSalSettings (dict) –

      The RdsSalSettings resource contains settings to configure a specific Remote Desktop Services (RDS) license server.

      • RdsSalCredentialsProvider (dict) – [REQUIRED]

        The CredentialsProvider resource contains a reference to the credentials provider that’s used for RDS license server user administration.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManagerCredentialsProvider.

        • SecretsManagerCredentialsProvider (dict) –

          Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.

          • SecretId (string) –

            The ID of the Secrets Manager secret that contains credentials.

  • ServerType (string) – [REQUIRED]

    The type of license server.

• Tags (dict) –

  The tags that apply for the license server endpoint.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'IdentityProviderArn': 'string',
    'LicenseServerEndpointArn': 'string'
}

Response Structure

• (dict) –

  • IdentityProviderArn (string) –

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

  • LicenseServerEndpointArn (string) –

    The ARN of the LicenseServerEndpoint resource.

Exceptions

• LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaExceededException

• LicenseManagerUserSubscriptions.Client.exceptions.ConflictException

• LicenseManagerUserSubscriptions.Client.exceptions.ValidationException

• LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingException

• LicenseManagerUserSubscriptions.Client.exceptions.InternalServerException

• LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFoundException

• LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedException