LicenseManagerUserSubscriptions / Paginator / ListUserAssociations

ListUserAssociations#

class LicenseManagerUserSubscriptions.Paginator.ListUserAssociations#

paginator = client.get_paginator('list_user_associations')

paginate(**kwargs)#

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

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Attribute': 'string',
            'Operation': 'string',
            'Value': 'string'
        },
    ],
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'ActiveDirectorySettings': {
                'DomainCredentialsProvider': {
                    'SecretsManagerCredentialsProvider': {
                        'SecretId': 'string'
                    }
                },
                'DomainIpv4List': [
                    'string',
                ],
                'DomainName': 'string',
                'DomainNetworkSettings': {
                    'Subnets': [
                        'string',
                    ]
                }
            },
            'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
            'DirectoryId': 'string'
        }
    },
    InstanceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

Filters (list) –
You can use the following filters to streamline results:
- Status
- Username
- Domain
- (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.
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) –
  
  The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific 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.
    - 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 can be set: SecretsManagerCredentialsProvider.
      - 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.
    - DomainIpv4List (list) –
      
      A list of domain IPv4 addresses that are used for the Active Directory.
      - (string) –
    - DomainName (string) –
      
      The domain name for the Active Directory.
    - DomainNetworkSettings (dict) –
      
      The DomainNetworkSettings resource contains an array of subnets that apply for the Active Directory.
      - Subnets (list) – [REQUIRED]
        
        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.
  - 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.
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

{
    'InstanceUserSummaries': [
        {
            'AssociationDate': 'string',
            'DisassociationDate': 'string',
            'Domain': 'string',
            'IdentityProvider': {
                'ActiveDirectoryIdentityProvider': {
                    'ActiveDirectorySettings': {
                        'DomainCredentialsProvider': {
                            'SecretsManagerCredentialsProvider': {
                                'SecretId': 'string'
                            }
                        },
                        'DomainIpv4List': [
                            'string',
                        ],
                        'DomainName': 'string',
                        'DomainNetworkSettings': {
                            'Subnets': [
                                'string',
                            ]
                        }
                    },
                    'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
                    'DirectoryId': 'string'
                }
            },
            'InstanceId': 'string',
            'InstanceUserArn': 'string',
            'Status': 'string',
            'StatusMessage': 'string',
            'Username': '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 Active Directory that contains the user information for the product subscription.
    - IdentityProvider (dict) –
      
      The IdentityProvider resource specifies details about 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) –
        
        The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific 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.
        
        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.
        
        DomainIpv4List (list) –
        
        A list of domain IPv4 addresses that are used for the Active Directory.
        
        (string) –
        
        DomainName (string) –
        
        The domain name for the Active Directory.
        
        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.
        
        DirectoryId (string) –
        
        The directory ID for an Active Directory identity provider.
    - InstanceId (string) –
      
      The ID of the EC2 instance that provides user-based subscriptions.
    - InstanceUserArn (string) –
      
      The Amazon Resource Name (ARN) that identifies the instance user.
    - 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.