list_user_associations¶

list_user_associations(**kwargs)¶

Lists user associations for an identity provider.

Request Syntax

response = client.list_user_associations(
    Filters=[
        {
            'Attribute': 'string',
            'Operation': 'string',
            'Value': 'string'
        },
    ],
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    InstanceId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters

Filters (list) --
An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.
- (dict) --
  A filter name and value pair that is used to return more specific results from a describe operation. 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.
IdentityProvider (dict) --
[REQUIRED]

An object that specifies details for the identity provider.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: ActiveDirectoryIdentityProvider.
- ActiveDirectoryIdentityProvider (dict) --
  An object that details an Active Directory identity provider.
  - DirectoryId (string) --
    The directory ID for an Active Directory identity provider.
InstanceId (string) --
[REQUIRED]

The ID of the EC2 instance, which provides user-based subscriptions.
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

{
    'InstanceUserSummaries': [
        {
            'AssociationDate': 'string',
            'DisassociationDate': 'string',
            'Domain': 'string',
            'IdentityProvider': {
                'ActiveDirectoryIdentityProvider': {
                    'DirectoryId': 'string'
                }
            },
            'InstanceId': 'string',
            'Status': 'string',
            'StatusMessage': 'string',
            'Username': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- InstanceUserSummaries (list) --
  
  Metadata that describes the list user association operation.
  - (dict) --
    
    Describes users of an EC2 instance providing user-based subscriptions.
    - AssociationDate (string) --
      
      The date a user was associated with an EC2 instance.
    - DisassociationDate (string) --
      
      The date a user was disassociated from an EC2 instance.
    - Domain (string) --
      
      The domain name of the user.
    - 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.
    - InstanceId (string) --
      
      The ID of the EC2 instance, which provides user-based subscriptions.
    - Status (string) --
      
      The status of a user associated with an EC2 instance.
    - StatusMessage (string) --
      
      The status message for users of an EC2 instance.
    - Username (string) --
      
      The user name from the identity provider for the user.
- 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

Table Of Contents

list_user_associations¶