Skip to content

LicenseManagerUserSubscriptionsClient#

Index > LicenseManagerUserSubscriptions > LicenseManagerUserSubscriptionsClient

Auto-generated documentation for LicenseManagerUserSubscriptions type annotations stubs module mypy-boto3-license-manager-user-subscriptions.

LicenseManagerUserSubscriptionsClient#

Type annotations and code completion for boto3.client("license-manager-user-subscriptions"). boto3 documentation

# LicenseManagerUserSubscriptionsClient usage example

from boto3.session import Session
from mypy_boto3_license_manager_user_subscriptions.client import LicenseManagerUserSubscriptionsClient

def get_license-manager-user-subscriptions_client() -> LicenseManagerUserSubscriptionsClient:
    return Session().client("license-manager-user-subscriptions")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("license-manager-user-subscriptions").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("license-manager-user-subscriptions")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_license_manager_user_subscriptions.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

associate_user#

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

Type annotations and code completion for boto3.client("license-manager-user-subscriptions").associate_user method. boto3 documentation

# associate_user method definition

def associate_user(
    self,
    *,
    IdentityProvider: IdentityProviderTypeDef,  # (1)
    InstanceId: str,
    Username: str,
    Domain: str = ...,
) -> AssociateUserResponseTypeDef:  # (2)
    ...
  1. See IdentityProviderTypeDef
  2. See AssociateUserResponseTypeDef
# associate_user method usage example with argument unpacking

kwargs: AssociateUserRequestRequestTypeDef = {  # (1)
    "IdentityProvider": ...,
    "InstanceId": ...,
    "Username": ...,
}

parent.associate_user(**kwargs)
  1. See AssociateUserRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("license-manager-user-subscriptions").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("license-manager-user-subscriptions").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

deregister_identity_provider#

Deregisters the identity provider from providing user-based subscriptions.

Type annotations and code completion for boto3.client("license-manager-user-subscriptions").deregister_identity_provider method. boto3 documentation

# deregister_identity_provider method definition

def deregister_identity_provider(
    self,
    *,
    IdentityProvider: IdentityProviderTypeDef,  # (1)
    Product: str,
) -> DeregisterIdentityProviderResponseTypeDef:  # (2)
    ...
  1. See IdentityProviderTypeDef
  2. See DeregisterIdentityProviderResponseTypeDef
# deregister_identity_provider method usage example with argument unpacking

kwargs: DeregisterIdentityProviderRequestRequestTypeDef = {  # (1)
    "IdentityProvider": ...,
    "Product": ...,
}

parent.deregister_identity_provider(**kwargs)
  1. See DeregisterIdentityProviderRequestRequestTypeDef

disassociate_user#

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

Type annotations and code completion for boto3.client("license-manager-user-subscriptions").disassociate_user method. boto3 documentation

# disassociate_user method definition

def disassociate_user(
    self,
    *,
    IdentityProvider: IdentityProviderTypeDef,  # (1)
    InstanceId: str,
    Username: str,
    Domain: str = ...,
) -> DisassociateUserResponseTypeDef:  # (2)
    ...
  1. See IdentityProviderTypeDef
  2. See DisassociateUserResponseTypeDef
# disassociate_user method usage example with argument unpacking

kwargs: DisassociateUserRequestRequestTypeDef = {  # (1)
    "IdentityProvider": ...,
    "InstanceId": ...,
    "Username": ...,
}

parent.disassociate_user(**kwargs)
  1. See DisassociateUserRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("license-manager-user-subscriptions").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_identity_providers#

Lists the identity providers for user-based subscriptions.

Type annotations and code completion for boto3.client("license-manager-user-subscriptions").list_identity_providers method. boto3 documentation

# list_identity_providers method definition

def list_identity_providers(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListIdentityProvidersResponseTypeDef:  # (1)
    ...
  1. See ListIdentityProvidersResponseTypeDef
# list_identity_providers method usage example with argument unpacking

kwargs: ListIdentityProvidersRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_identity_providers(**kwargs)
  1. See ListIdentityProvidersRequestRequestTypeDef

list_instances#

Lists the EC2 instances providing user-based subscriptions.

Type annotations and code completion for boto3.client("license-manager-user-subscriptions").list_instances method. boto3 documentation

# list_instances method definition

def list_instances(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInstancesResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See ListInstancesResponseTypeDef
# list_instances method usage example with argument unpacking

kwargs: ListInstancesRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_instances(**kwargs)
  1. See ListInstancesRequestRequestTypeDef

list_product_subscriptions#

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

Type annotations and code completion for boto3.client("license-manager-user-subscriptions").list_product_subscriptions method. boto3 documentation

# list_product_subscriptions method definition

def list_product_subscriptions(
    self,
    *,
    IdentityProvider: IdentityProviderTypeDef,  # (1)
    Product: str,
    Filters: Sequence[FilterTypeDef] = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListProductSubscriptionsResponseTypeDef:  # (3)
    ...
  1. See IdentityProviderTypeDef
  2. See FilterTypeDef
  3. See ListProductSubscriptionsResponseTypeDef
# list_product_subscriptions method usage example with argument unpacking

kwargs: ListProductSubscriptionsRequestRequestTypeDef = {  # (1)
    "IdentityProvider": ...,
    "Product": ...,
}

parent.list_product_subscriptions(**kwargs)
  1. See ListProductSubscriptionsRequestRequestTypeDef

list_user_associations#

Lists user associations for an identity provider.

Type annotations and code completion for boto3.client("license-manager-user-subscriptions").list_user_associations method. boto3 documentation

# list_user_associations method definition

def list_user_associations(
    self,
    *,
    IdentityProvider: IdentityProviderTypeDef,  # (1)
    InstanceId: str,
    Filters: Sequence[FilterTypeDef] = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListUserAssociationsResponseTypeDef:  # (3)
    ...
  1. See IdentityProviderTypeDef
  2. See FilterTypeDef
  3. See ListUserAssociationsResponseTypeDef
# list_user_associations method usage example with argument unpacking

kwargs: ListUserAssociationsRequestRequestTypeDef = {  # (1)
    "IdentityProvider": ...,
    "InstanceId": ...,
}

parent.list_user_associations(**kwargs)
  1. See ListUserAssociationsRequestRequestTypeDef

register_identity_provider#

Registers an identity provider for user-based subscriptions.

Type annotations and code completion for boto3.client("license-manager-user-subscriptions").register_identity_provider method. boto3 documentation

# register_identity_provider method definition

def register_identity_provider(
    self,
    *,
    IdentityProvider: IdentityProviderTypeDef,  # (1)
    Product: str,
    Settings: Union[SettingsTypeDef, SettingsExtraOutputTypeDef] = ...,  # (2)
) -> RegisterIdentityProviderResponseTypeDef:  # (3)
    ...
  1. See IdentityProviderTypeDef
  2. See SettingsTypeDef SettingsExtraOutputTypeDef
  3. See RegisterIdentityProviderResponseTypeDef
# register_identity_provider method usage example with argument unpacking

kwargs: RegisterIdentityProviderRequestRequestTypeDef = {  # (1)
    "IdentityProvider": ...,
    "Product": ...,
}

parent.register_identity_provider(**kwargs)
  1. See RegisterIdentityProviderRequestRequestTypeDef

start_product_subscription#

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

Type annotations and code completion for boto3.client("license-manager-user-subscriptions").start_product_subscription method. boto3 documentation

# start_product_subscription method definition

def start_product_subscription(
    self,
    *,
    IdentityProvider: IdentityProviderTypeDef,  # (1)
    Product: str,
    Username: str,
    Domain: str = ...,
) -> StartProductSubscriptionResponseTypeDef:  # (2)
    ...
  1. See IdentityProviderTypeDef
  2. See StartProductSubscriptionResponseTypeDef
# start_product_subscription method usage example with argument unpacking

kwargs: StartProductSubscriptionRequestRequestTypeDef = {  # (1)
    "IdentityProvider": ...,
    "Product": ...,
    "Username": ...,
}

parent.start_product_subscription(**kwargs)
  1. See