LicenseManagerUserSubscriptions / Paginator / ListLicenseServerEndpoints

ListLicenseServerEndpoints

class LicenseManagerUserSubscriptions.Paginator.ListLicenseServerEndpoints

paginator = client.get_paginator('list_license_server_endpoints')

paginate(**kwargs)

Creates an iterator that will paginate through responses from LicenseManagerUserSubscriptions.Client.list_license_server_endpoints().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Attribute': 'string',
            'Operation': 'string',
            'Value': 'string'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous 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'
        },
    ],

}

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.