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

can_paginate

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

generate_presigned_url

Type annotations and code completion for boto3.client("license-manager").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:
    ...

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

1. See AcceptGrantResponseTypeDef

# accept_grant method usage example with argument unpacking

kwargs: AcceptGrantRequestTypeDef = {  # (1)
    "GrantArn": ...,
}

parent.accept_grant(**kwargs)

1. See AcceptGrantRequestTypeDef

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: CheckInLicenseRequestTypeDef = {  # (1)
    "LicenseConsumptionToken": ...,
}

parent.check_in_license(**kwargs)

1. See CheckInLicenseRequestTypeDef

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

1. See Sequence[EntitlementDataTypeDef]
2. See DigitalSignatureMethodType
3. See Sequence[MetadataTypeDef]
4. See CheckoutBorrowLicenseResponseTypeDef

# checkout_borrow_license method usage example with argument unpacking

kwargs: CheckoutBorrowLicenseRequestTypeDef = {  # (1)
    "LicenseArn": ...,
    "Entitlements": ...,
    "DigitalSignatureMethod": ...,
    "ClientToken": ...,
}

parent.checkout_borrow_license(**kwargs)

1. See CheckoutBorrowLicenseRequestTypeDef

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

1. See CheckoutTypeType
2. See Sequence[EntitlementDataTypeDef]
3. See CheckoutLicenseResponseTypeDef

# checkout_license method usage example with argument unpacking

kwargs: CheckoutLicenseRequestTypeDef = {  # (1)
    "ProductSKU": ...,
    "CheckoutType": ...,
    "KeyFingerprint": ...,
    "Entitlements": ...,
    "ClientToken": ...,
}

parent.checkout_license(**kwargs)

1. See CheckoutLicenseRequestTypeDef

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

1. See Sequence[AllowedOperationType]
2. See CreateGrantResponseTypeDef

# create_grant method usage example with argument unpacking

kwargs: CreateGrantRequestTypeDef = {  # (1)
    "ClientToken": ...,
    "GrantName": ...,
    "LicenseArn": ...,
    "Principals": ...,
    "HomeRegion": ...,
    "AllowedOperations": ...,
}

parent.create_grant(**kwargs)

1. See CreateGrantRequestTypeDef

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

1. See Sequence[AllowedOperationType]
2. See GrantStatusType
3. See OptionsTypeDef
4. See CreateGrantVersionResponseTypeDef

# create_grant_version method usage example with argument unpacking

kwargs: CreateGrantVersionRequestTypeDef = {  # (1)
    "ClientToken": ...,
    "GrantArn": ...,
}

parent.create_grant_version(**kwargs)

1. See CreateGrantVersionRequestTypeDef

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

1. See IssuerTypeDef
2. See DatetimeRangeTypeDef
3. See Sequence[EntitlementTypeDef]
4. See ConsumptionConfigurationTypeDef
5. See Sequence[MetadataTypeDef]
6. See CreateLicenseResponseTypeDef

# create_license method usage example with argument unpacking

kwargs: CreateLicenseRequestTypeDef = {  # (1)
    "LicenseName": ...,
    "ProductName": ...,
    "ProductSKU": ...,
    "Issuer": ...,
    "HomeRegion": ...,
    "Validity": ...,
    "Entitlements": ...,
    "Beneficiary": ...,
    "ConsumptionConfiguration": ...,
    "ClientToken": ...,
}

parent.create_license(**kwargs)

1. See CreateLicenseRequestTypeDef

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[ProductInformationUnionTypeDef] = ...,  # (3)
) -> CreateLicenseConfigurationResponseTypeDef:  # (4)
    ...

1. See LicenseCountingTypeType
2. See Sequence[TagTypeDef]
3. See Sequence[ProductInformationUnionTypeDef]
4. See CreateLicenseConfigurationResponseTypeDef

# create_license_configuration method usage example with argument unpacking

kwargs: CreateLicenseConfigurationRequestTypeDef = {  # (1)
    "Name": ...,
    "LicenseCountingType": ...,
}

parent.create_license_configuration(**kwargs)

1. See CreateLicenseConfigurationRequestTypeDef

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

1. See LicenseConversionContextTypeDef
2. See LicenseConversionContextTypeDef
3. See CreateLicenseConversionTaskForResourceResponseTypeDef

# create_license_conversion_task_for_resource method usage example with argument unpacking

kwargs: CreateLicenseConversionTaskForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "SourceLicenseContext": ...,
    "DestinationLicenseContext": ...,
}

parent.create_license_conversion_task_for_resource(**kwargs)

1. See CreateLicenseConversionTaskForResourceRequestTypeDef

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: ReportContextUnionTypeDef,  # (2)
    ReportFrequency: ReportFrequencyTypeDef,  # (3)
    ClientToken: str,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateLicenseManagerReportGeneratorResponseTypeDef:  # (5)
    ...

1. See Sequence[ReportTypeType]
2. See ReportContextUnionTypeDef
3. See ReportFrequencyTypeDef
4. See Sequence[TagTypeDef]
5. See CreateLicenseManagerReportGeneratorResponseTypeDef

# create_license_manager_report_generator method usage example with argument unpacking

kwargs: CreateLicenseManagerReportGeneratorRequestTypeDef = {  # (1)
    "ReportGeneratorName": ...,
    "Type": ...,
    "ReportContext": ...,
    "ReportFrequency": ...,
    "ClientToken": ...,
}

parent.create_license_manager_report_generator(**kwargs)

1. See CreateLicenseManagerReportGeneratorRequestTypeDef

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. boto3 documentation

# create_license_version method definition

def create_license_version(
    self,
    *,
    LicenseArn: str,
    LicenseName: str,
    ProductName: str,
    Issuer: IssuerTypeDef,  # (1)
    HomeRegion: str,
    Validity: DatetimeRangeTypeDef,  # (2)
    Entitlements: Sequence[EntitlementTypeDef],  # (3)
    ConsumptionConfiguration: ConsumptionConfigurationTypeDef,  # (4)
    Status: LicenseStatusType,  # (5)
    ClientToken: str,
    LicenseMetadata: Sequence[MetadataTypeDef] = ...,  # (6)
    SourceVersion: str = ...,
) -> CreateLicenseVersionResponseTypeDef:  # (7)
    ...

1. See IssuerTypeDef
2. See DatetimeRangeTypeDef
3. See Sequence[EntitlementTypeDef]
4. See ConsumptionConfigurationTypeDef
5. See LicenseStatusType
6. See Sequence[MetadataTypeDef]
7. See CreateLicenseVersionResponseTypeDef

# create_license_version method usage example with argument unpacking

kwargs: CreateLicenseVersionRequestTypeDef = {  # (1)
    "LicenseArn": ...,
    "LicenseName": ...,
    "ProductName": ...,
    "Issuer": ...,
    "HomeRegion": ...,
    "Validity": ...,
    "Entitlements": ...,
    "ConsumptionConfiguration": ...,
    "Status": ...,
    "ClientToken": ...,
}

parent.create_license_version(**kwargs)

1. See CreateLicenseVersionRequestTypeDef

create_token

Creates a long-lived token.

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

# create_token method definition

def create_token(
    self,
    *,
    LicenseArn: str,
    ClientToken: str,
    RoleArns: Sequence[str] = ...,
    ExpirationInDays: int = ...,
    TokenProperties: Sequence[str] = ...,
) -> CreateTokenResponseTypeDef:  # (1)
    ...

1. See CreateTokenResponseTypeDef

# create_token method usage example with argument unpacking

kwargs: CreateTokenRequestTypeDef = {  # (1)
    "LicenseArn": ...,
    "ClientToken": ...,
}

parent.create_token(**kwargs)

1. See CreateTokenRequestTypeDef

delete_grant

Deletes the specified grant.

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

# delete_grant method definition

def delete_grant(
    self,
    *,
    GrantArn: str,
    Version: str,
    StatusReason: str = ...,
) -> DeleteGrantResponseTypeDef:  # (1)
    ...

1. See DeleteGrantResponseTypeDef

# delete_grant method usage example with argument unpacking

kwargs: DeleteGrantRequestTypeDef = {  # (1)
    "GrantArn": ...,
    "Version": ...,
}

parent.delete_grant(**kwargs)

1. See DeleteGrantRequestTypeDef

delete_license

Deletes the specified license.

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

# delete_license method definition

def delete_license(
    self,
    *,
    LicenseArn: str,
    SourceVersion: str,
) -> DeleteLicenseResponseTypeDef:  # (1)
    ...

1. See DeleteLicenseResponseTypeDef

# delete_license method usage example with argument unpacking

kwargs: DeleteLicenseRequestTypeDef = {  # (1)
    "LicenseArn": ...,
    "SourceVersion": ...,
}

parent.delete_license(**kwargs)

1. See DeleteLicenseRequestTypeDef

delete_license_configuration

Deletes the specified license configuration.

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

# delete_license_configuration method definition

def delete_license_configuration(
    self,
    *,
    LicenseConfigurationArn: str,
) -> Dict[str, Any]:
    ...

# delete_license_configuration method usage example with argument unpacking

kwargs: DeleteLicenseConfigurationRequestTypeDef = {  # (1)
    "LicenseConfigurationArn": ...,
}

parent.delete_license_configuration(**kwargs)

1. See DeleteLicenseConfigurationRequestTypeDef

delete_license_manager_report_generator

Deletes the specified report generator.

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

# delete_license_manager_report_generator method definition

def delete_license_manager_report_generator(
    self,
    *,
    LicenseManagerReportGeneratorArn: str,
) -> Dict[str, Any]:
    ...

# delete_license_manager_report_generator method usage example with argument unpacking

kwargs: DeleteLicenseManagerReportGeneratorRequestTypeDef = {  # (1)
    "LicenseManagerReportGeneratorArn": ...,
}

parent.delete_license_manager_report_generator(**kwargs)

1. See DeleteLicenseManagerReportGeneratorRequestTypeDef

delete_token

Deletes the specified token.

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

# delete_token method definition

def delete_token(
    self,
    *,
    TokenId: str,
) -> Dict[str, Any]:
    ...

# delete_token method usage example with argument unpacking

kwargs: DeleteTokenRequestTypeDef = {  # (1)
    "TokenId": ...,
}

parent.delete_token(**kwargs)

1. See DeleteTokenRequestTypeDef

extend_license_consumption

Extends the expiration date for license consumption.

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

# extend_license_consumption method definition

def extend_license_consumption(
    self,
    *,
    LicenseConsumptionToken: str,
    DryRun: bool = ...,
) -> ExtendLicenseConsumptionResponseTypeDef:  # (1)
    ...

1. See ExtendLicenseConsumptionResponseTypeDef

# extend_license_consumption method usage example with argument unpacking

kwargs: ExtendLicenseConsumptionRequestTypeDef = {  # (1)
    "LicenseConsumptionToken": ...,
}

parent.extend_license_consumption(**kwargs)

1. See ExtendLicenseConsumptionRequestTypeDef

get_access_token

Gets a temporary access token to use with AssumeRoleWithWebIdentity.

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

# get_access_token method definition

def get_access_token(
    self,
    *,
    Token: str,
    TokenProperties: Sequence[str] = ...,
) -> GetAccessTokenResponseTypeDef:  # (1)
    ...

1. See GetAccessTokenResponseTypeDef

# get_access_token method usage example with argument unpacking

kwargs: GetAccessTokenRequestTypeDef = {  # (1)
    "Token": ...,
}

parent.get_access_token(**kwargs)

1. See GetAccessTokenRequestTypeDef

get_grant

Gets detailed information about the specified grant.

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

# get_grant method definition

def get_grant(
    self,
    *,
    GrantArn: str,
    Version: str = ...,
) -> GetGrantResponseTypeDef:  # (1)
    ...

1. See GetGrantResponseTypeDef

# get_grant method usage example with argument unpacking

kwargs: GetGrantRequestTypeDef = {  # (1)
    "GrantArn": ...,
}

parent.get_grant(**kwargs)

1. See GetGrantRequestTypeDef

get_license

Gets detailed information about the specified license.

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

# get_license method definition

def get_license(
    self,
    *,
    LicenseArn: str,
    Version: str = ...,
) -> GetLicenseResponseTypeDef:  # (1)
    ...

1. See GetLicenseResponseTypeDef

# get_license method usage example with argument unpacking

kwargs: GetLicenseRequestTypeDef = {  # (1)
    "LicenseArn": ...,
}

parent.get_license(**kwargs)

1. See GetLicenseRequestTypeDef

get_license_configuration

Gets detailed information about the specified license configuration.

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

# get_license_configuration method definition

def get_license_configuration(
    self,
    *,
    LicenseConfigurationArn: str,
) -> GetLicenseConfigurationResponseTypeDef:  # (1)
    ...

1. See GetLicenseConfigurationResponseTypeDef

# get_license_configuration method usage example with argument unpacking

kwargs: GetLicenseConfigurationRequestTypeDef = {  # (1)
    "LicenseConfigurationArn": ...,
}

parent.get_license_configuration(**kwargs)

1. See GetLicenseConfigurationRequestTypeDef

get_license_conversion_task

Gets information about the specified license type conversion task.

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

# get_license_conversion_task method definition

def get_license_conversion_task(
    self,
    *,
    LicenseConversionTaskId: str,
) -> GetLicenseConversionTaskResponseTypeDef:  # (1)
    ...

1. See GetLicenseConversionTaskResponseTypeDef

# get_license_conversion_task method usage example with argument unpacking

kwargs: GetLicenseConversionTaskRequestTypeDef = {  # (1)
    "LicenseConversionTaskId": ...,
}

parent.get_license_conversion_task(**kwargs)

1. See GetLicenseConversionTaskRequestTypeDef

get_license_manager_report_generator

Gets information about the specified report generator.

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

# get_license_manager_report_generator method definition

def get_license_manager_report_generator(
    self,
    *,
    LicenseManagerReportGeneratorArn: str,
) -> GetLicenseManagerReportGeneratorResponseTypeDef:  # (1)
    ...

1. See GetLicenseManagerReportGeneratorResponseTypeDef

# get_license_manager_report_generator method usage example with argument unpacking

kwargs: GetLicenseManagerReportGeneratorRequestTypeDef = {  # (1)
    "LicenseManagerReportGeneratorArn": ...,
}

parent.get_license_manager_report_generator(**kwargs)

1. See GetLicenseManagerReportGeneratorRequestTypeDef

get_license_usage

Gets detailed information about the usage of the specified license.

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

# get_license_usage method definition

def get_license_usage(
    self,
    *,
    LicenseArn: str,
) -> GetLicenseUsageResponseTypeDef:  # (1)
    ...

1. See GetLicenseUsageResponseTypeDef

# get_license_usage method usage example with argument unpacking

kwargs: GetLicenseUsageRequestTypeDef = {  # (1)
    "LicenseArn": ...,
}

parent.get_license_usage(**kwargs)

1. See GetLicenseUsageRequestTypeDef

get_service_settings

Gets the License Manager settings for the current Region.

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

# get_service_settings method definition

def get_service_settings(
    self,
) -> GetServiceSettingsResponseTypeDef:  # (1)
    ...

1. See GetServiceSettingsResponseTypeDef

list_associations_for_license_configuration

Lists the resource associations for the specified license configuration.

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

# list_associations_for_license_configuration method definition

def list_associations_for_license_configuration(
    self,
    *,
    LicenseConfigurationArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAssociationsForLicenseConfigurationResponseTypeDef:  # (1)
    ...

1. See ListAssociationsForLicenseConfigurationResponseTypeDef

# list_associations_for_license_configuration method usage example with argument unpacking

kwargs: ListAssociationsForLicenseConfigurationRequestTypeDef = {  # (1)
    "LicenseConfigurationArn": ...,
}

parent.list_associations_for_license_configuration(**kwargs)

1. See ListAssociationsForLicenseConfigurationRequestTypeDef

list_distributed_grants

Lists the grants distributed for the specified license.

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

# list_distributed_grants method definition

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

1. See Sequence[FilterTypeDef]
2. See ListDistributedGrantsResponseTypeDef

# list_distributed_grants method usage example with argument unpacking

kwargs: ListDistributedGrantsRequestTypeDef = {  # (1)
    "GrantArns": ...,
}

parent.list_distributed_grants(**kwargs)

1. See ListDistributedGrantsRequestTypeDef

list_failures_for_license_configuration_operations

Lists the license configuration operations that failed.

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

# list_failures_for_license_configuration_operations method definition

def list_failures_for_license_configuration_operations(
    self,
    *,
    LicenseConfigurationArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListFailuresForLicenseConfigurationOperationsResponseTypeDef:  # (1)
    ...

1. See ListFailuresForLicenseConfigurationOperationsResponseTypeDef

# list_failures_for_license_configuration_operations method usage example with argument unpacking

kwargs: ListFailuresForLicenseConfigurationOperationsRequestTypeDef = {  # (1)
    "LicenseConfigurationArn": ...,
}

parent.list_failures_for_license_configuration_operations(**kwargs)

1. See ListFailuresForLicenseConfigurationOperationsRequestTypeDef

list_license_configurations

Lists the license configurations for your account.

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

# list_license_configurations method definition

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

1. See Sequence[FilterTypeDef]
2. See ListLicenseConfigurationsResponseTypeDef

# list_license_configurations method usage example with argument unpacking

kwargs: ListLicenseConfigurationsRequestTypeDef = {  # (1)
    "LicenseConfigurationArns": ...,
}

parent.list_license_configurations(**kwargs)

1. See ListLicenseConfigurationsRequestTypeDef

list_license_conversion_tasks

Lists the license type conversion tasks for your account.

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

# list_license_conversion_tasks method definition

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

1. See Sequence[FilterTypeDef]
2. See ListLicenseConversionTasksResponseTypeDef

# list_license_conversion_tasks method usage example with argument unpacking

kwargs: ListLicenseConversionTasksRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_license_conversion_tasks(**kwargs)

1. See ListLicenseConversionTasksRequestTypeDef

list_license_manager_report_generators

Lists the report generators for your account.

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

# list_license_manager_report_generators method definition

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

1. See Sequence[FilterTypeDef]
2. See ListLicenseManagerReportGeneratorsResponseTypeDef

# list_license_manager_report_generators method usage example with argument unpacking

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

parent.list_license_manager_report_generators(**kwargs)

1. See ListLicenseManagerReportGeneratorsRequestTypeDef

list_license_specifications_for_resource

Describes the license configurations for the specified resource.

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

# list_license_specifications_for_resource method definition

def list_license_specifications_for_resource(
    self,
    *,
    ResourceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListLicenseSpecificationsForResourceResponseTypeDef:  # (1)
    ...

1. See ListLicenseSpecificationsForResourceResponseTypeDef

# list_license_specifications_for_resource method usage example with argument unpacking

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

parent.list_license_specifications_for_resource(**kwargs)

1. See ListLicenseSpecificationsForResourceRequestTypeDef

list_license_versions

Lists all versions of the specified license.

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

# list_license_versions method definition

def list_license_versions(
    self,
    *,
    LicenseArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListLicenseVersionsResponseTypeDef:  # (1)
    ...

1. See ListLicenseVersionsResponseTypeDef

# list_license_versions method usage example with argument unpacking

kwargs: ListLicenseVersionsRequestTypeDef = {  # (1)
    "LicenseArn": ...,
}

parent.list_license_versions(**kwargs)

1. See ListLicenseVersionsRequestTypeDef

list_licenses

Lists the licenses for your account.

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

# list_licenses method definition

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

1. See Sequence[FilterTypeDef]
2. See ListLicensesResponseTypeDef

# list_licenses method usage example with argument unpacking

kwargs: ListLicensesRequestTypeDef = {  # (1)
    "LicenseArns": ...,
}

parent.list_licenses(**kwargs)

1. See ListLicensesRequestTypeDef

list_received_grants

Lists grants that are received.

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

# list_received_grants method definition

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

1. See Sequence[FilterTypeDef]
2. See ListReceivedGrantsResponseTypeDef

# list_received_grants method usage example with argument unpacking

kwargs: ListReceivedGrantsRequestTypeDef = {  # (1)
    "GrantArns": ...,
}

parent.list_received_grants(**kwargs)

1. See ListReceivedGrantsRequestTypeDef

list_received_grants_for_organization

Lists the grants received for all accounts in the organization.

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

# list_received_grants_for_organization method definition

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

1. See Sequence[FilterTypeDef]
2. See ListReceivedGrantsForOrganizationResponseTypeDef

# list_received_grants_for_organization method usage example with argument unpacking

kwargs: ListReceivedGrantsForOrganizationRequestTypeDef = {  # (1)
    "LicenseArn": ...,
}

parent.list_received_grants_for_organization(**kwargs)

1. See ListReceivedGrantsForOrganizationRequestTypeDef

list_received_licenses

Lists received licenses.

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

# list_received_licenses method definition

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

1. See Sequence[FilterTypeDef]
2. See ListReceivedLicensesResponseTypeDef

# list_received_licenses method usage example with argument unpacking

kwargs: ListReceivedLicensesRequestTypeDef = {  # (1)
    "LicenseArns": ...,
}

parent.list_received_licenses(**kwargs)

1. See ListReceivedLicensesRequestTypeDef

list_received_licenses_for_organization

Lists the licenses received for all accounts in the organization.

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

# list_received_licenses_for_organization method definition

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

1. See Sequence[FilterTypeDef]
2. See ListReceivedLicensesForOrganizationResponseTypeDef

# list_received_licenses_for_organization method usage example with argument unpacking

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

parent.list_received_licenses_for_organization(**kwargs)

1. See ListReceivedLicensesForOrganizationRequestTypeDef

list_resource_inventory

Lists resources managed using Systems Manager inventory.

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

# list_resource_inventory method definition

def list_resource_inventory(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filters: Sequence[InventoryFilterTypeDef] = ...,  # (1)
) -> ListResourceInventoryResponseTypeDef:  # (2)
    ...

1. See Sequence[InventoryFilterTypeDef]
2. See ListResourceInventoryResponseTypeDef

# list_resource_inventory method usage example with argument unpacking

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

parent.list_resource_inventory(**kwargs)

1. See ListResourceInventoryRequestTypeDef

list_tags_for_resource

Lists the tags for the specified license configuration.

Type annotations and code completion for boto3.client("license-manager").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: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

list_tokens

Lists your tokens.

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

# list_tokens method definition

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

1. See Sequence[FilterTypeDef]
2. See ListTokensResponseTypeDef

# list_tokens method usage example with argument unpacking

kwargs: ListTokensRequestTypeDef = {  # (1)
    "TokenIds": ...,
}

parent.list_tokens(**kwargs)

1. See ListTokensRequestTypeDef

list_usage_for_license_configuration

Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time.

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

# list_usage_for_license_configuration method definition

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

1. See Sequence[FilterTypeDef]
2. See ListUsageForLicenseConfigurationResponseTypeDef

# list_usage_for_license_configuration method usage example with argument unpacking

kwargs: ListUsageForLicenseConfigurationRequestTypeDef = {  # (1)
    "LicenseConfigurationArn": ...,
}

parent.list_usage_for_license_configuration(**kwargs)

1. See ListUsageForLicenseConfigurationRequestTypeDef

reject_grant

Rejects the specified grant.

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

# reject_grant method definition

def reject_grant(
    self,
    *,
    GrantArn: str,
) -> RejectGrantResponseTypeDef:  # (1)
    ...

1. See RejectGrantResponseTypeDef

# reject_grant method usage example with argument unpacking

kwargs: RejectGrantRequestTypeDef = {  # (1)
    "GrantArn": ...,
}

parent.reject_grant(**kwargs)

1. See RejectGrantRequestTypeDef

tag_resource

Adds the specified tags to the specified license configuration.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See Sequence[TagTypeDef]

# tag_resource method usage example with argument unpacking

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes the specified tags from the specified license configuration.

Type annotations and code completion for boto3.client("license-manager").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: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_license_configuration

Modifies the attributes of an existing license configuration.

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

# update_license_configuration method definition

def update_license_configuration(
    self,
    *,
    LicenseConfigurationArn: str,
    LicenseConfigurationStatus: LicenseConfigurationStatusType = ...,  # (1)
    LicenseRules: Sequence[str] = ...,
    LicenseCount: int = ...,
    LicenseCountHardLimit: bool = ...,
    Name: str = ...,
    Description: str = ...,
    ProductInformationList: Sequence[ProductInformationUnionTypeDef] = ...,  # (2)
    DisassociateWhenNotFound: bool = ...,
) -> Dict[str, Any]:
    ...

1. See LicenseConfigurationStatusType
2. See Sequence[ProductInformationUnionTypeDef]

# update_license_configuration method usage example with argument unpacking

kwargs: UpdateLicenseConfigurationRequestTypeDef = {  # (1)
    "LicenseConfigurationArn": ...,
}

parent.update_license_configuration(**kwargs)

1. See UpdateLicenseConfigurationRequestTypeDef

update_license_manager_report_generator

Updates a report generator.

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

# update_license_manager_report_generator method definition

def update_license_manager_report_generator(
    self,
    *,
    LicenseManagerReportGeneratorArn: str,
    ReportGeneratorName: str,
    Type: Sequence[ReportTypeType],  # (1)
    ReportContext: ReportContextUnionTypeDef,  # (2)
    ReportFrequency: ReportFrequencyTypeDef,  # (3)
    ClientToken: str,
    Description: str = ...,
) -> Dict[str, Any]:
    ...

1. See Sequence[ReportTypeType]
2. See ReportContextUnionTypeDef
3. See ReportFrequencyTypeDef

# update_license_manager_report_generator method usage example with argument unpacking

kwargs: UpdateLicenseManagerReportGeneratorRequestTypeDef = {  # (1)
    "LicenseManagerReportGeneratorArn": ...,
    "ReportGeneratorName": ...,
    "Type": ...,
    "ReportContext": ...,
    "ReportFrequency": ...,
    "ClientToken": ...,
}

parent.update_license_manager_report_generator(**kwargs)

1. See UpdateLicenseManagerReportGeneratorRequestTypeDef

update_license_specifications_for_resource

Adds or removes the specified license configurations for the specified Amazon Web Services resource.

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

# update_license_specifications_for_resource method definition

def update_license_specifications_for_resource(
    self,
    *,
    ResourceArn: str,
    AddLicenseSpecifications: Sequence[LicenseSpecificationTypeDef] = ...,  # (1)
    RemoveLicenseSpecifications: Sequence[LicenseSpecificationTypeDef] = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See Sequence[LicenseSpecificationTypeDef]
2. See Sequence[LicenseSpecificationTypeDef]

# update_license_specifications_for_resource method usage example with argument unpacking

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

parent.update_license_specifications_for_resource(**kwargs)

1. See UpdateLicenseSpecificationsForResourceRequestTypeDef

update_service_settings

Updates License Manager settings for the current Region.

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

# update_service_settings method definition

def update_service_settings(
    self,
    *,
    S3BucketArn: str = ...,
    SnsTopicArn: str = ...,
    OrganizationConfiguration: OrganizationConfigurationTypeDef = ...,  # (1)
    EnableCrossAccountsDiscovery: bool = ...,
) -> Dict[str, Any]:
    ...

1. See OrganizationConfigurationTypeDef

# update_service_settings method usage example with argument unpacking

kwargs: UpdateServiceSettingsRequestTypeDef = {  # (1)
    "S3BucketArn": ...,
}

parent.update_service_settings(**kwargs)

1. See UpdateServiceSettingsRequestTypeDef

get_paginator

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

• client.get_paginator("list_associations_for_license_configuration") -> ListAssociationsForLicenseConfigurationPaginator
• client.get_paginator("list_license_configurations") -> ListLicenseConfigurationsPaginator
• client.get_paginator("list_license_specifications_for_resource") -> ListLicenseSpecificationsForResourcePaginator
• client.get_paginator("list_resource_inventory") -> ListResourceInventoryPaginator
• client.get_paginator("list_usage_for_license_configuration") -> ListUsageForLicenseConfigurationPaginator