LicenseManagerUserSubscriptions

Client

class LicenseManagerUserSubscriptions.Client

A low-level client representing AWS License Manager User Subscriptions

With License Manager, you can create user-based subscriptions to utilize licensed software with a per user subscription fee on Amazon EC2 instances.

client = session.create_client('license-manager-user-subscriptions')

These are the available methods:

associate_user(**kwargs)

Associates the user to an EC2 instance to utilize user-based subscriptions.

Note

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide .

See also: AWS API Documentation

Request Syntax

response = client.associate_user(
    Domain='string',
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    InstanceId='string',
    Username='string'
)
Parameters
  • Domain (string) -- The domain name of the user.
  • IdentityProvider (dict) --

    [REQUIRED]

    The identity provider of the user.

    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.

  • Username (string) --

    [REQUIRED]

    The user name from the identity provider for the user.

Return type

dict

Returns

Response Syntax

{
    'InstanceUserSummary': {
        'AssociationDate': 'string',
        'DisassociationDate': 'string',
        'Domain': 'string',
        'IdentityProvider': {
            'ActiveDirectoryIdentityProvider': {
                'DirectoryId': 'string'
            }
        },
        'InstanceId': 'string',
        'Status': 'string',
        'StatusMessage': 'string',
        'Username': 'string'
    }
}

Response Structure

  • (dict) --

    • InstanceUserSummary (dict) --

      Metadata that describes the associate user operation.

      • 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.

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

deregister_identity_provider(**kwargs)

Deregisters the identity provider from providing user-based subscriptions.

See also: AWS API Documentation

Request Syntax

response = client.deregister_identity_provider(
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    Product='string'
)
Parameters
  • 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.

  • Product (string) --

    [REQUIRED]

    The name of the user-based subscription product.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • IdentityProviderSummary (dict) --

      Metadata that describes the results of an identity provider operation.

      • 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.

Exceptions

disassociate_user(**kwargs)

Disassociates the user from an EC2 instance providing user-based subscriptions.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_user(
    Domain='string',
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    InstanceId='string',
    Username='string'
)
Parameters
  • Domain (string) -- The domain name of the user.
  • 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.

  • Username (string) --

    [REQUIRED]

    The user name from the identity provider for the user.

Return type

dict

Returns

Response Syntax

{
    'InstanceUserSummary': {
        'AssociationDate': 'string',
        'DisassociationDate': 'string',
        'Domain': 'string',
        'IdentityProvider': {
            'ActiveDirectoryIdentityProvider': {
                'DirectoryId': 'string'
            }
        },
        'InstanceId': 'string',
        'Status': 'string',
        'StatusMessage': 'string',
        'Username': 'string'
    }
}

Response Structure

  • (dict) --

    • InstanceUserSummary (dict) --

      Metadata that describes the associate user operation.

      • 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.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
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

list_instances(**kwargs)

Lists the EC2 instances providing user-based subscriptions.

See also: AWS API Documentation

Request Syntax

response = client.list_instances(
    Filters=[
        {
            'Attribute': 'string',
            'Operation': 'string',
            'Value': '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.

  • 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

{
    'InstanceSummaries': [
        {
            'InstanceId': 'string',
            'LastStatusCheckDate': 'string',
            'Products': [
                'string',
            ],
            'Status': 'string',
            'StatusMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • InstanceSummaries (list) --

      Metadata that describes the list instances operation.

      • (dict) --

        Describes an EC2 instance providing user-based subscriptions.

        • InstanceId (string) --

          The ID of the EC2 instance, which provides user-based subscriptions.

        • LastStatusCheckDate (string) --

          The date of the last status check.

        • Products (list) --

          A list of provided user-based subscription products.

          • (string) --
        • Status (string) --

          The status of an EC2 instance resource.

        • StatusMessage (string) --

          The status message for an EC2 instance.

    • NextToken (string) --

      Token for the next set of results.

Exceptions

list_product_subscriptions(**kwargs)

Lists the user-based subscription products available from an identity provider.

See also: AWS API Documentation

Request Syntax

response = client.list_product_subscriptions(
    Filters=[
        {
            'Attribute': 'string',
            'Operation': 'string',
            'Value': 'string'
        },
    ],
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    MaxResults=123,
    NextToken='string',
    Product='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.

  • MaxResults (integer) -- Maximum number of results to return in a single call.
  • NextToken (string) -- Token for the next set of results.
  • Product (string) --

    [REQUIRED]

    The name of the user-based subscription product.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'ProductUserSummaries': [
        {
            'Domain': 'string',
            'IdentityProvider': {
                'ActiveDirectoryIdentityProvider': {
                    'DirectoryId': 'string'
                }
            },
            'Product': 'string',
            'Status': 'string',
            'StatusMessage': 'string',
            'SubscriptionEndDate': 'string',
            'SubscriptionStartDate': 'string',
            'Username': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      Token for the next set of results.

    • ProductUserSummaries (list) --

      Metadata that describes the list product subscriptions operation.

      • (dict) --

        The summary of the user-based subscription products for a user.

        • 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.

        • Product (string) --

          The name of the user-based subscription product.

        • Status (string) --

          The status of a product for a user.

        • StatusMessage (string) --

          The status message for a product for a user.

        • SubscriptionEndDate (string) --

          The end date of a subscription.

        • SubscriptionStartDate (string) --

          The start date of a subscription.

        • Username (string) --

          The user name from the identity provider of the user.

Exceptions

list_user_associations(**kwargs)

Lists user associations for an identity provider.

See also: AWS API Documentation

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

register_identity_provider(**kwargs)

Registers an identity provider for user-based subscriptions.

See also: AWS API Documentation

Request Syntax

response = client.register_identity_provider(
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    Product='string',
    Settings={
        'SecurityGroupId': 'string',
        'Subnets': [
            'string',
        ]
    }
)
Parameters
  • 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.

  • Product (string) --

    [REQUIRED]

    The name of the user-based subscription product.

  • Settings (dict) --

    The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.

    • SecurityGroupId (string) -- [REQUIRED]

      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) -- [REQUIRED]

      The subnets defined for the registered identity provider.

      • (string) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • IdentityProviderSummary (dict) --

      Metadata that describes the results of an identity provider operation.

      • 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.

Exceptions

start_product_subscription(**kwargs)

Starts a product subscription for a user with the specified identity provider.

Note

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide .

See also: AWS API Documentation

Request Syntax

response = client.start_product_subscription(
    Domain='string',
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    Product='string',
    Username='string'
)
Parameters
  • Domain (string) -- The domain name of the user.
  • 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.

  • Product (string) --

    [REQUIRED]

    The name of the user-based subscription product.

  • Username (string) --

    [REQUIRED]

    The user name from the identity provider of the user.

Return type

dict

Returns

Response Syntax

{
    'ProductUserSummary': {
        'Domain': 'string',
        'IdentityProvider': {
            'ActiveDirectoryIdentityProvider': {
                'DirectoryId': 'string'
            }
        },
        'Product': 'string',
        'Status': 'string',
        'StatusMessage': 'string',
        'SubscriptionEndDate': 'string',
        'SubscriptionStartDate': 'string',
        'Username': 'string'
    }
}

Response Structure

  • (dict) --

    • ProductUserSummary (dict) --

      Metadata that describes the start product subscription operation.

      • 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.

      • Product (string) --

        The name of the user-based subscription product.

      • Status (string) --

        The status of a product for a user.

      • StatusMessage (string) --

        The status message for a product for a user.

      • SubscriptionEndDate (string) --

        The end date of a subscription.

      • SubscriptionStartDate (string) --

        The start date of a subscription.

      • Username (string) --

        The user name from the identity provider of the user.

Exceptions

stop_product_subscription(**kwargs)

Stops a product subscription for a user with the specified identity provider.

See also: AWS API Documentation

Request Syntax

response = client.stop_product_subscription(
    Domain='string',
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    Product='string',
    Username='string'
)
Parameters
  • Domain (string) -- The domain name of the user.
  • 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.

  • Product (string) --

    [REQUIRED]

    The name of the user-based subscription product.

  • Username (string) --

    [REQUIRED]

    The user name from the identity provider for the user.

Return type

dict

Returns

Response Syntax

{
    'ProductUserSummary': {
        'Domain': 'string',
        'IdentityProvider': {
            'ActiveDirectoryIdentityProvider': {
                'DirectoryId': 'string'
            }
        },
        'Product': 'string',
        'Status': 'string',
        'StatusMessage': 'string',
        'SubscriptionEndDate': 'string',
        'SubscriptionStartDate': 'string',
        'Username': 'string'
    }
}

Response Structure

  • (dict) --

    • ProductUserSummary (dict) --

      Metadata that describes the start product subscription operation.

      • 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.

      • Product (string) --

        The name of the user-based subscription product.

      • Status (string) --

        The status of a product for a user.

      • StatusMessage (string) --

        The status message for a product for a user.

      • SubscriptionEndDate (string) --

        The end date of a subscription.

      • SubscriptionStartDate (string) --

        The start date of a subscription.

      • Username (string) --

        The user name from the identity provider of the user.

Exceptions

update_identity_provider_settings(**kwargs)

Updates additional product configuration settings for the registered identity provider.

See also: AWS API Documentation

Request Syntax

response = client.update_identity_provider_settings(
    IdentityProvider={
        'ActiveDirectoryIdentityProvider': {
            'DirectoryId': 'string'
        }
    },
    Product='string',
    UpdateSettings={
        'AddSubnets': [
            'string',
        ],
        'RemoveSubnets': [
            'string',
        ],
        'SecurityGroupId': 'string'
    }
)
Parameters
  • IdentityProvider (dict) --

    [REQUIRED]

    Details about an 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.

  • Product (string) --

    [REQUIRED]

    The name of the user-based subscription product.

  • UpdateSettings (dict) --

    [REQUIRED]

    Updates the registered identity provider’s product related configuration settings. You can update any combination of settings in a single operation such as the:

    • Subnets which you want to add to provision VPC endpoints.
    • Subnets which you want to remove the VPC endpoints from.
    • Security group ID which permits traffic to the VPC endpoints.
    • AddSubnets (list) -- [REQUIRED]

      The ID of one or more subnets in which License Manager will create a VPC endpoint for products that require connectivity to activation servers.

      • (string) --
    • RemoveSubnets (list) -- [REQUIRED]

      The ID of one or more subnets to remove.

      • (string) --
    • SecurityGroupId (string) --

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

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • IdentityProviderSummary (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.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class LicenseManagerUserSubscriptions.Client.exceptions.AccessDeniedException

You don't have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You don't have sufficient access to perform this action.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManagerUserSubscriptions.Client.exceptions.ConflictException

The request couldn't be completed because it conflicted with the current state of the resource.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request couldn't be completed because it conflicted with the current state of the resource.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManagerUserSubscriptions.Client.exceptions.InternalServerException

An exception occurred with the service.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An exception occurred with the service.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManagerUserSubscriptions.Client.exceptions.ResourceNotFoundException

The resource couldn't be found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource couldn't be found.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManagerUserSubscriptions.Client.exceptions.ServiceQuotaExceededException

The request failed because a service quota is exceeded.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request failed because a service quota is exceeded.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManagerUserSubscriptions.Client.exceptions.ThrottlingException

The request was denied because of request throttling. Retry the request.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied because of request throttling. Retry the request.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LicenseManagerUserSubscriptions.Client.exceptions.ValidationException

A parameter is not valid.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A parameter is not valid.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class LicenseManagerUserSubscriptions.Paginator.ListIdentityProviders
paginator = client.get_paginator('list_identity_providers')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
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
{
    'IdentityProviderSummaries': [
        {
            'FailureMessage': 'string',
            'IdentityProvider': {
                'ActiveDirectoryIdentityProvider': {
                    'DirectoryId': 'string'
                }
            },
            'Product': 'string',
            'Settings': {
                'SecurityGroupId': 'string',
                'Subnets': [
                    'string',
                ]
            },
            'Status': '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.

class LicenseManagerUserSubscriptions.Paginator.ListInstances
paginator = client.get_paginator('list_instances')
paginate(**kwargs)

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

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) --

    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.

  • 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

{
    'InstanceSummaries': [
        {
            'InstanceId': 'string',
            'LastStatusCheckDate': 'string',
            'Products': [
                'string',
            ],
            'Status': 'string',
            'StatusMessage': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • InstanceSummaries (list) --

      Metadata that describes the list instances operation.

      • (dict) --

        Describes an EC2 instance providing user-based subscriptions.

        • InstanceId (string) --

          The ID of the EC2 instance, which provides user-based subscriptions.

        • LastStatusCheckDate (string) --

          The date of the last status check.

        • Products (list) --

          A list of provided user-based subscription products.

          • (string) --
        • Status (string) --

          The status of an EC2 instance resource.

        • StatusMessage (string) --

          The status message for an EC2 instance.

class LicenseManagerUserSubscriptions.Paginator.ListProductSubscriptions
paginator = client.get_paginator('list_product_subscriptions')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

  • Product (string) --

    [REQUIRED]

    The name of the user-based subscription product.

  • 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

{
    'ProductUserSummaries': [
        {
            'Domain': 'string',
            'IdentityProvider': {
                'ActiveDirectoryIdentityProvider': {
                    'DirectoryId': 'string'
                }
            },
            'Product': 'string',
            'Status': 'string',
            'StatusMessage': 'string',
            'SubscriptionEndDate': 'string',
            'SubscriptionStartDate': 'string',
            'Username': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • ProductUserSummaries (list) --

      Metadata that describes the list product subscriptions operation.

      • (dict) --

        The summary of the user-based subscription products for a user.

        • 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.

        • Product (string) --

          The name of the user-based subscription product.

        • Status (string) --

          The status of a product for a user.

        • StatusMessage (string) --

          The status message for a product for a user.

        • SubscriptionEndDate (string) --

          The end date of a subscription.

        • SubscriptionStartDate (string) --

          The start date of a subscription.

        • Username (string) --

          The user name from the identity provider of the user.

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().

See also: AWS API Documentation

Request Syntax

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

  • 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': {
                    'DirectoryId': 'string'
                }
            },
            'InstanceId': '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 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.