LicenseManagerUserSubscriptions / Client / list_identity_providers

list_identity_providers#

LicenseManagerUserSubscriptions.Client.list_identity_providers(**kwargs)#

Lists the identity providers for user-based subscriptions.

See also: AWS API Documentation

Request Syntax

response = client.list_identity_providers(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – Maximum number of results to return in a single call.

  • NextToken (string) – Token for the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityProviderSummaries': [
        {
            'FailureMessage': 'string',
            'IdentityProvider': {
                'ActiveDirectoryIdentityProvider': {
                    'DirectoryId': 'string'
                }
            },
            'Product': 'string',
            'Settings': {
                'SecurityGroupId': 'string',
                'Subnets': [
                    'string',
                ]
            },
            'Status': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • IdentityProviderSummaries (list) –

      Metadata that describes the list identity providers operation.

      • (dict) –

        Describes an identity provider.

        • FailureMessage (string) –

          The failure message associated with an identity provider.

        • IdentityProvider (dict) –

          An object that specifies details for the identity provider.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: ActiveDirectoryIdentityProvider. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • ActiveDirectoryIdentityProvider (dict) –

            An object that details an Active Directory identity provider.

            • DirectoryId (string) –

              The directory ID for an Active Directory identity provider.

        • Product (string) –

          The name of the user-based subscription product.

        • Settings (dict) –

          An object that details the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.

          • SecurityGroupId (string) –

            A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.

          • Subnets (list) –

            The subnets defined for the registered identity provider.

            • (string) –

        • Status (string) –

          The status of an identity provider.

    • NextToken (string) –

      Token for the next set of results.

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