LicenseManagerClient#
Index > LicenseManager > LicenseManagerClient
Auto-generated documentation for LicenseManager type annotations stubs module mypy-boto3-license-manager.
LicenseManagerClient#
Type annotations and code completion for boto3.client("license-manager")
.
boto3 documentation
# LicenseManagerClient usage example
from boto3.session import Session
from mypy_boto3_license_manager.client import LicenseManagerClient
def get_license-manager_client() -> LicenseManagerClient:
return Session().client("license-manager")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("license-manager").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("license-manager")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.AuthorizationException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.EntitlementNotAllowedException,
client.exceptions.FailedDependencyException,
client.exceptions.FilterLimitExceededException,
client.exceptions.InvalidParameterValueException,
client.exceptions.InvalidResourceStateException,
client.exceptions.LicenseUsageException,
client.exceptions.NoEntitlementsAllowedException,
client.exceptions.RateLimitExceededException,
client.exceptions.RedirectException,
client.exceptions.ResourceLimitExceededException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServerInternalException,
client.exceptions.UnsupportedDigitalSignatureMethodException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_license_manager.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
accept_grant#
Accepts the specified grant.
Type annotations and code completion for boto3.client("license-manager").accept_grant
method.
boto3 documentation
# accept_grant method definition
def accept_grant(
self,
*,
GrantArn: str,
) -> AcceptGrantResponseTypeDef: # (1)
...
# accept_grant method usage example with argument unpacking
kwargs: AcceptGrantRequestRequestTypeDef = { # (1)
"GrantArn": ...,
}
parent.accept_grant(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("license-manager").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
check_in_license#
Checks in the specified license.
Type annotations and code completion for boto3.client("license-manager").check_in_license
method.
boto3 documentation
# check_in_license method definition
def check_in_license(
self,
*,
LicenseConsumptionToken: str,
Beneficiary: str = ...,
) -> Dict[str, Any]:
...
# check_in_license method usage example with argument unpacking
kwargs: CheckInLicenseRequestRequestTypeDef = { # (1)
"LicenseConsumptionToken": ...,
}
parent.check_in_license(**kwargs)
checkout_borrow_license#
Checks out the specified license for offline use.
Type annotations and code completion for boto3.client("license-manager").checkout_borrow_license
method.
boto3 documentation
# checkout_borrow_license method definition
def checkout_borrow_license(
self,
*,
LicenseArn: str,
Entitlements: Sequence[EntitlementDataTypeDef], # (1)
DigitalSignatureMethod: DigitalSignatureMethodType, # (2)
ClientToken: str,
NodeId: str = ...,
CheckoutMetadata: Sequence[MetadataTypeDef] = ..., # (3)
) -> CheckoutBorrowLicenseResponseTypeDef: # (4)
...
- See EntitlementDataTypeDef
- See DigitalSignatureMethodType
- See MetadataTypeDef
- See CheckoutBorrowLicenseResponseTypeDef
# checkout_borrow_license method usage example with argument unpacking
kwargs: CheckoutBorrowLicenseRequestRequestTypeDef = { # (1)
"LicenseArn": ...,
"Entitlements": ...,
"DigitalSignatureMethod": ...,
"ClientToken": ...,
}
parent.checkout_borrow_license(**kwargs)
checkout_license#
Checks out the specified license.
Type annotations and code completion for boto3.client("license-manager").checkout_license
method.
boto3 documentation
# checkout_license method definition
def checkout_license(
self,
*,
ProductSKU: str,
CheckoutType: CheckoutTypeType, # (1)
KeyFingerprint: str,
Entitlements: Sequence[EntitlementDataTypeDef], # (2)
ClientToken: str,
Beneficiary: str = ...,
NodeId: str = ...,
) -> CheckoutLicenseResponseTypeDef: # (3)
...
# checkout_license method usage example with argument unpacking
kwargs: CheckoutLicenseRequestRequestTypeDef = { # (1)
"ProductSKU": ...,
"CheckoutType": ...,
"KeyFingerprint": ...,
"Entitlements": ...,
"ClientToken": ...,
}
parent.checkout_license(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("license-manager").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_grant#
Creates a grant for the specified license.
Type annotations and code completion for boto3.client("license-manager").create_grant
method.
boto3 documentation
# create_grant method definition
def create_grant(
self,
*,
ClientToken: str,
GrantName: str,
LicenseArn: str,
Principals: Sequence[str],
HomeRegion: str,
AllowedOperations: Sequence[AllowedOperationType], # (1)
) -> CreateGrantResponseTypeDef: # (2)
...
# create_grant method usage example with argument unpacking
kwargs: CreateGrantRequestRequestTypeDef = { # (1)
"ClientToken": ...,
"GrantName": ...,
"LicenseArn": ...,
"Principals": ...,
"HomeRegion": ...,
"AllowedOperations": ...,
}
parent.create_grant(**kwargs)
create_grant_version#
Creates a new version of the specified grant.
Type annotations and code completion for boto3.client("license-manager").create_grant_version
method.
boto3 documentation
# create_grant_version method definition
def create_grant_version(
self,
*,
ClientToken: str,
GrantArn: str,
GrantName: str = ...,
AllowedOperations: Sequence[AllowedOperationType] = ..., # (1)
Status: GrantStatusType = ..., # (2)
StatusReason: str = ...,
SourceVersion: str = ...,
Options: OptionsTypeDef = ..., # (3)
) -> CreateGrantVersionResponseTypeDef: # (4)
...
- See AllowedOperationType
- See GrantStatusType
- See OptionsTypeDef
- See CreateGrantVersionResponseTypeDef
# create_grant_version method usage example with argument unpacking
kwargs: CreateGrantVersionRequestRequestTypeDef = { # (1)
"ClientToken": ...,
"GrantArn": ...,
}
parent.create_grant_version(**kwargs)
create_license#
Creates a license.
Type annotations and code completion for boto3.client("license-manager").create_license
method.
boto3 documentation
# create_license method definition
def create_license(
self,
*,
LicenseName: str,
ProductName: str,
ProductSKU: str,
Issuer: IssuerTypeDef, # (1)
HomeRegion: str,
Validity: DatetimeRangeTypeDef, # (2)
Entitlements: Sequence[EntitlementTypeDef], # (3)
Beneficiary: str,
ConsumptionConfiguration: ConsumptionConfigurationTypeDef, # (4)
ClientToken: str,
LicenseMetadata: Sequence[MetadataTypeDef] = ..., # (5)
) -> CreateLicenseResponseTypeDef: # (6)
...
- See IssuerTypeDef
- See DatetimeRangeTypeDef
- See EntitlementTypeDef
- See ConsumptionConfigurationTypeDef
- See MetadataTypeDef
- See CreateLicenseResponseTypeDef
# create_license method usage example with argument unpacking
kwargs: CreateLicenseRequestRequestTypeDef = { # (1)
"LicenseName": ...,
"ProductName": ...,
"ProductSKU": ...,
"Issuer": ...,
"HomeRegion": ...,
"Validity": ...,
"Entitlements": ...,
"Beneficiary": ...,
"ConsumptionConfiguration": ...,
"ClientToken": ...,
}
parent.create_license(**kwargs)
create_license_configuration#
Creates a license configuration.
Type annotations and code completion for boto3.client("license-manager").create_license_configuration
method.
boto3 documentation
# create_license_configuration method definition
def create_license_configuration(
self,
*,
Name: str,
LicenseCountingType: LicenseCountingTypeType, # (1)
Description: str = ...,
LicenseCount: int = ...,
LicenseCountHardLimit: bool = ...,
LicenseRules: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
DisassociateWhenNotFound: bool = ...,
ProductInformationList: Sequence[ProductInformationTypeDef] = ..., # (3)
) -> CreateLicenseConfigurationResponseTypeDef: # (4)
...
- See LicenseCountingTypeType
- See TagTypeDef
- See ProductInformationTypeDef
- See CreateLicenseConfigurationResponseTypeDef
# create_license_configuration method usage example with argument unpacking
kwargs: CreateLicenseConfigurationRequestRequestTypeDef = { # (1)
"Name": ...,
"LicenseCountingType": ...,
}
parent.create_license_configuration(**kwargs)
create_license_conversion_task_for_resource#
Creates a new license conversion task.
Type annotations and code completion for boto3.client("license-manager").create_license_conversion_task_for_resource
method.
boto3 documentation
# create_license_conversion_task_for_resource method definition
def create_license_conversion_task_for_resource(
self,
*,
ResourceArn: str,
SourceLicenseContext: LicenseConversionContextTypeDef, # (1)
DestinationLicenseContext: LicenseConversionContextTypeDef, # (1)
) -> CreateLicenseConversionTaskForResourceResponseTypeDef: # (3)
...
- See LicenseConversionContextTypeDef
- See LicenseConversionContextTypeDef
- See CreateLicenseConversionTaskForResourceResponseTypeDef
# create_license_conversion_task_for_resource method usage example with argument unpacking
kwargs: CreateLicenseConversionTaskForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"SourceLicenseContext": ...,
"DestinationLicenseContext": ...,
}
parent.create_license_conversion_task_for_resource(**kwargs)
create_license_manager_report_generator#
Creates a report generator.
Type annotations and code completion for boto3.client("license-manager").create_license_manager_report_generator
method.
boto3 documentation
# create_license_manager_report_generator method definition
def create_license_manager_report_generator(
self,
*,
ReportGeneratorName: str,
Type: Sequence[ReportTypeType], # (1)
ReportContext: ReportContextTypeDef, # (2)
ReportFrequency: ReportFrequencyTypeDef, # (3)
ClientToken: str,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (4)
) -> CreateLicenseManagerReportGeneratorResponseTypeDef: # (5)
...
- See ReportTypeType
- See ReportContextTypeDef
- See ReportFrequencyTypeDef
- See TagTypeDef
- See CreateLicenseManagerReportGeneratorResponseTypeDef
# create_license_manager_report_generator method usage example with argument unpacking
kwargs: CreateLicenseManagerReportGeneratorRequestRequestTypeDef = { # (1)
"ReportGeneratorName": ...,
"Type": ...,
"ReportContext": ...,
"ReportFrequency": ...,
"ClientToken": ...,
}
parent.create_license_manager_report_generator(**kwargs)
create_license_version#
Creates a new version of the specified license.
Type annotations and code completion for boto3.client("license-manager").create_license_version
method.