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 = ...,
    Tags: Mapping[str, 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:
    ...

create_license_server_endpoint

Creates a network endpoint for the Remote Desktop Services (RDS) license server.

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

# create_license_server_endpoint method definition

def create_license_server_endpoint(
    self,
    *,
    IdentityProviderArn: str,
    LicenseServerSettings: LicenseServerSettingsTypeDef,  # (1)
    Tags: Mapping[str, str] = ...,
) -> CreateLicenseServerEndpointResponseTypeDef:  # (2)
    ...

1. See LicenseServerSettingsTypeDef
2. See CreateLicenseServerEndpointResponseTypeDef

# create_license_server_endpoint method usage example with argument unpacking

kwargs: CreateLicenseServerEndpointRequestRequestTypeDef = {  # (1)
    "IdentityProviderArn": ...,
    "LicenseServerSettings": ...,
}

parent.create_license_server_endpoint(**kwargs)

1. See CreateLicenseServerEndpointRequestRequestTypeDef

delete_license_server_endpoint

Deletes a LicenseServerEndpoint resource.

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

# delete_license_server_endpoint method definition

def delete_license_server_endpoint(
    self,
    *,
    LicenseServerEndpointArn: str,
    ServerType: ServerTypeType,  # (1)
) -> DeleteLicenseServerEndpointResponseTypeDef:  # (2)
    ...

1. See ServerTypeType
2. See DeleteLicenseServerEndpointResponseTypeDef

# delete_license_server_endpoint method usage example with argument unpacking

kwargs: DeleteLicenseServerEndpointRequestRequestTypeDef = {  # (1)
    "LicenseServerEndpointArn": ...,
    "ServerType": ...,
}

parent.delete_license_server_endpoint(**kwargs)

1. See DeleteLicenseServerEndpointRequestRequestTypeDef

deregister_identity_provider

Deregisters the Active Directory identity provider from License Manager 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)
    IdentityProviderArn: str = ...,
    Product: str = ...,
) -> DeregisterIdentityProviderResponseTypeDef:  # (2)
    ...

1. See IdentityProviderTypeDef
2. See DeregisterIdentityProviderResponseTypeDef

# deregister_identity_provider method usage example with argument unpacking

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

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,
    *,
    Domain: str = ...,
    IdentityProvider: IdentityProviderTypeDef = ...,  # (1)
    InstanceId: str = ...,
    InstanceUserArn: str = ...,
    Username: str = ...,
) -> DisassociateUserResponseTypeDef:  # (2)
    ...

1. See IdentityProviderTypeDef
2. See DisassociateUserResponseTypeDef

# disassociate_user method usage example with argument unpacking

kwargs: DisassociateUserRequestRequestTypeDef = {  # (1)
    "Domain": ...,
}

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 Active Directory 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,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListIdentityProvidersResponseTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListIdentityProvidersResponseTypeDef

# list_identity_providers method usage example with argument unpacking

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

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_license_server_endpoints

List the Remote Desktop Services (RDS) License Server endpoints See also: AWS API Documentation.

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

# list_license_server_endpoints method definition

def list_license_server_endpoints(
    self,
    *,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListLicenseServerEndpointsResponseTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListLicenseServerEndpointsResponseTypeDef

# list_license_server_endpoints method usage example with argument unpacking

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

parent.list_license_server_endpoints(**kwargs)

1. See ListLicenseServerEndpointsRequestRequestTypeDef

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)
    Filters: Sequence[FilterTypeDef] = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
    Product: 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": ...,
}

parent.list_product_subscriptions(**kwargs)

1. See ListProductSubscriptionsRequestRequestTypeDef

list_tags_for_resource

Returns the list of tags for the specified resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

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: SettingsTypeDef = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> RegisterIdentityProviderResponseTypeDef:  # (3)
    ...

1. See IdentityProviderTypeDef
2. See SettingsTypeDef
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 = ...,
    Tags: Mapping[str, 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 StartProductSubscriptionRequestRequestTypeDef

stop_product_subscription

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

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

# stop_product_subscription method definition

def stop_product_subscription(
    self,
    *,
    Domain: str = ...,
    IdentityProvider: IdentityProviderTypeDef = ...,  # (1)
    Product: str = ...,
    ProductUserArn: str = ...,
    Username: str = ...,
) -> StopProductSubscriptionResponseTypeDef:  # (2)
    ...

1. See IdentityProviderTypeDef
2. See StopProductSubscriptionResponseTypeDef

# stop_product_subscription method usage example with argument unpacking

kwargs: StopProductSubscriptionRequestRequestTypeDef = {  # (1)
    "Domain": ...,
}

parent.stop_product_subscription(**kwargs)

1. See StopProductSubscriptionRequestRequestTypeDef

tag_resource

Adds tags to a resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes tags from a resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_identity_provider_settings

Updates additional product configuration settings for the registered identity provider.

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

# update_identity_provider_settings method definition

def update_identity_provider_settings(
    self,
    *,
    UpdateSettings: UpdateSettingsTypeDef,  # (1)
    IdentityProvider: IdentityProviderTypeDef = ...,  # (2)
    IdentityProviderArn: str = ...,
    Product: str = ...,
) -> UpdateIdentityProviderSettingsResponseTypeDef:  # (3)
    ...

1. See UpdateSettingsTypeDef
2. See IdentityProviderTypeDef
3. See UpdateIdentityProviderSettingsResponseTypeDef

# update_identity_provider_settings method usage example with argument unpacking

kwargs: UpdateIdentityProviderSettingsRequestRequestTypeDef = {  # (1)
    "UpdateSettings": ...,
}

parent.update_identity_provider_settings(**kwargs)

1. See UpdateIdentityProviderSettingsRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("license-manager-user-subscriptions").get_paginator method with overloads.

• client.get_paginator("list_identity_providers") -> ListIdentityProvidersPaginator
• client.get_paginator("list_instances") -> ListInstancesPaginator
• client.get_paginator("list_license_server_endpoints") -> ListLicenseServerEndpointsPaginator
• client.get_paginator("list_product_subscriptions") -> ListProductSubscriptionsPaginator
• client.get_paginator("list_user_associations") -> ListUserAssociationsPaginator