LicenseManagerUserSubscriptions / Client / list_license_server_endpoints

list_license_server_endpoints#

LicenseManagerUserSubscriptions.Client.list_license_server_endpoints(**kwargs)#

List the Remote Desktop Services (RDS) License Server endpoints

See also: AWS API Documentation

Request Syntax

response = client.list_license_server_endpoints(
    Filters=[
        {
            'Attribute': 'string',
            'Operation': 'string',
            'Value': 'string'
        },
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • Filters (list) –

    You can use the following filters to streamline results:

    • IdentityProviderArn

    • (dict) –

      A filter name and value pair that is used to return more specific results from a describe or list operation. You can use filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

      • Attribute (string) –

        The name of an attribute to use as a filter.

      • Operation (string) –

        The type of search (For example, eq, geq, leq)

      • Value (string) –

        Value of the filter.

  • MaxResults (integer) – The maximum number of results to return from a single request.

  • NextToken (string) – A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Return type:

dict

Returns:

Response Syntax

{
    'LicenseServerEndpoints': [
        {
            'CreationTime': datetime(2015, 1, 1),
            'IdentityProviderArn': 'string',
            'LicenseServerEndpointArn': 'string',
            'LicenseServerEndpointId': 'string',
            'LicenseServerEndpointProvisioningStatus': 'PROVISIONING'|'PROVISIONING_FAILED'|'PROVISIONED'|'DELETING'|'DELETION_FAILED'|'DELETED',
            'LicenseServers': [
                {
                    'HealthStatus': 'HEALTHY'|'UNHEALTHY'|'NOT_APPLICABLE',
                    'Ipv4Address': 'string',
                    'ProvisioningStatus': 'PROVISIONING'|'PROVISIONING_FAILED'|'PROVISIONED'|'DELETING'|'DELETION_FAILED'|'DELETED'
                },
            ],
            'ServerEndpoint': {
                'Endpoint': 'string'
            },
            'ServerType': 'RDS_SAL',
            'StatusMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • LicenseServerEndpoints (list) –

      An array of LicenseServerEndpoint resources that contain detailed information about the RDS License Servers that meet the request criteria.

      • (dict) –

        Contains details about a network endpoint for a Remote Desktop Services (RDS) license server.

        • CreationTime (datetime) –

          The timestamp when License Manager created the license server endpoint.

        • IdentityProviderArn (string) –

          The Amazon Resource Name (ARN) of the identity provider that’s associated with the RDS license server endpoint.

        • LicenseServerEndpointArn (string) –

          The ARN of the ServerEndpoint resource for the RDS license server.

        • LicenseServerEndpointId (string) –

          The ID of the license server endpoint.

        • LicenseServerEndpointProvisioningStatus (string) –

          The current state of the provisioning process for the RDS license server endpoint

        • LicenseServers (list) –

          An array of LicenseServer resources that represent the license servers that are accessed through this endpoint.

          • (dict) –

            Information about a Remote Desktop Services (RDS) license server.

            • HealthStatus (string) –

              The health status of the RDS license server.

            • Ipv4Address (string) –

              A list of domain IPv4 addresses that are used for the RDS license server.

            • ProvisioningStatus (string) –

              The current state of the provisioning process for the RDS license server.

        • ServerEndpoint (dict) –

          The ServerEndpoint resource contains the network address of the RDS license server endpoint.

          • Endpoint (string) –

            The network address of the endpoint.

        • ServerType (string) –

          The type of license server.

        • StatusMessage (string) –

          The message associated with the provisioning status, if there is one.

    • NextToken (string) –

      The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

Exceptions