LicenseManagerUserSubscriptions / Client / list_identity_providers

list_identity_providers¶

LicenseManagerUserSubscriptions.Client.list_identity_providers(**kwargs)¶

Lists the Active Directory identity providers for user-based subscriptions.

Request Syntax

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

Parameters:

MaxResults (integer) – The maximum number of results to return from a single request.
Filters (list) –
You can use the following filters to streamline results:
- Product
- DirectoryId
- (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.
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

{
    'IdentityProviderSummaries': [
        {
            'IdentityProvider': {
                'ActiveDirectoryIdentityProvider': {
                    'DirectoryId': 'string',
                    'ActiveDirectorySettings': {
                        'DomainName': 'string',
                        'DomainIpv4List': [
                            'string',
                        ],
                        'DomainCredentialsProvider': {
                            'SecretsManagerCredentialsProvider': {
                                'SecretId': 'string'
                            }
                        },
                        'DomainNetworkSettings': {
                            'Subnets': [
                                'string',
                            ]
                        }
                    },
                    'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
                    'IsSharedActiveDirectory': True|False
                }
            },
            'Settings': {
                'Subnets': [
                    'string',
                ],
                'SecurityGroupId': 'string'
            },
            'Product': 'string',
            'Status': 'string',
            'IdentityProviderArn': 'string',
            'FailureMessage': 'string',
            'OwnerAccountId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- IdentityProviderSummaries (list) –
  
  An array of IdentityProviderSummary resources that contain details about the Active Directory identity providers that meet the request criteria.
  - (dict) –
    
    Describes an identity provider.
    - IdentityProvider (dict) –
      
      The IdentityProvider resource contains information about an 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) –
        
        The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.
        
        DirectoryId (string) –
        
        The directory ID for an Active Directory identity provider.
        
        ActiveDirectorySettings (dict) –
        
        The ActiveDirectorySettings resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.
        
        DomainName (string) –
        
        The domain name for the Active Directory.
        
        DomainIpv4List (list) –
        
        A list of domain IPv4 addresses that are used for the Active Directory.
        
        (string) –
        
        DomainCredentialsProvider (dict) –
        
        Points to the CredentialsProvider resource that contains information about the credential provider for user administration.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManagerCredentialsProvider. 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'}
        
        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.
        
        DomainNetworkSettings (dict) –
        
        The DomainNetworkSettings resource contains an array of subnets that apply for the Active Directory.
        
        Subnets (list) –
        
        Contains a list of subnets that apply for the Active Directory domain.
        
        (string) –
        
        ActiveDirectoryType (string) –
        
        The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.
        
        IsSharedActiveDirectory (boolean) –
        
        Whether this directory is shared from an Amazon Web Services Managed Active Directory. The default value is false.
    - Settings (dict) –
      
      The Settings resource contains details about the registered identity provider’s product related configuration settings, such as the subnets to provision VPC endpoints.
      - Subnets (list) –
        
        The subnets defined for the registered identity provider.
        
        (string) –
      - 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.
    - Product (string) –
      
      The name of the user-based subscription product.
    - Status (string) –
      
      The status of the identity provider.
    - IdentityProviderArn (string) –
      
      The Amazon Resource Name (ARN) of the identity provider.
    - FailureMessage (string) –
      
      The failure message associated with an identity provider.
    - OwnerAccountId (string) –
      
      The AWS Account ID of the owner of this resource.
- 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

LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaExceededException
LicenseManagerUserSubscriptions.Client.exceptions.ValidationException
LicenseManagerUserSubscriptions.Client.exceptions.ConflictException
LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingException
LicenseManagerUserSubscriptions.Client.exceptions.InternalServerException
LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFoundException
LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedException