LicenseManagerLinuxSubscriptions ******************************** Client ====== class LicenseManagerLinuxSubscriptions.Client A low-level client representing AWS License Manager Linux Subscriptions With License Manager, you can discover and track your commercial Linux subscriptions on running Amazon EC2 instances. import boto3 client = boto3.client('license-manager-linux-subscriptions') These are the available methods: * can_paginate * close * deregister_subscription_provider * get_paginator * get_registered_subscription_provider * get_service_settings * get_waiter * list_linux_subscription_instances * list_linux_subscriptions * list_registered_subscription_providers * list_tags_for_resource * register_subscription_provider * tag_resource * untag_resource * update_service_settings Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListLinuxSubscriptionInstances * ListLinuxSubscriptions * ListRegisteredSubscriptionProviders LicenseManagerLinuxSubscriptions / Paginator / ListRegisteredSubscriptionProviders ListRegisteredSubscriptionProviders *********************************** class LicenseManagerLinuxSubscriptions.Paginator.ListRegisteredSubscriptionProviders paginator = client.get_paginator('list_registered_subscription_providers') paginate(**kwargs) Creates an iterator that will paginate through responses from " LicenseManagerLinuxSubscriptions.Client.list_registered_subscri ption_providers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( SubscriptionProviderSources=[ 'RedHat', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **SubscriptionProviderSources** (*list*) -- To filter your results, specify which subscription providers to return in the list. * *(string) --* * **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** { 'RegisteredSubscriptionProviders': [ { 'LastSuccessfulDataRetrievalTime': 'string', 'SecretArn': 'string', 'SubscriptionProviderArn': 'string', 'SubscriptionProviderSource': 'RedHat', 'SubscriptionProviderStatus': 'ACTIVE'|'INVALID'|'PENDING', 'SubscriptionProviderStatusMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **RegisteredSubscriptionProviders** *(list) --* The list of BYOL registration resources that fit the criteria you specified in the request. * *(dict) --* A third-party provider for operating system (OS) platform software and license subscriptions, such as Red Hat. When you register a third-party Linux subscription provider, License Manager can get subscription data from the registered provider. * **LastSuccessfulDataRetrievalTime** *(string) --* The timestamp from the last time that License Manager accessed third-party subscription data for your account from your registered Linux subscription provider. * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the Secrets Manager secret that stores your registered Linux subscription provider access token. For RHEL account subscriptions, this is the offline token. * **SubscriptionProviderArn** *(string) --* The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered. * **SubscriptionProviderSource** *(string) --* A supported third-party Linux subscription provider. License Manager currently supports Red Hat subscriptions. * **SubscriptionProviderStatus** *(string) --* Indicates the status of your registered Linux subscription provider access token from the last time License Manager retrieved subscription data. For RHEL account subscriptions, this is the status of the offline token. * **SubscriptionProviderStatusMessage** *(string) --* A detailed message that's associated with your BYOL subscription provider token status. LicenseManagerLinuxSubscriptions / Paginator / ListLinuxSubscriptionInstances ListLinuxSubscriptionInstances ****************************** class LicenseManagerLinuxSubscriptions.Paginator.ListLinuxSubscriptionInstances paginator = client.get_paginator('list_linux_subscription_instances') paginate(**kwargs) Creates an iterator that will paginate through responses from " LicenseManagerLinuxSubscriptions.Client.list_linux_subscription _instances()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Filters=[ { 'Name': 'string', 'Operator': 'Equal'|'NotEqual'|'Contains', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Filters** (*list*) -- An array of structures that you can use to filter the results by your specified criteria. For example, you can specify "Region" in the "Name", with the "contains" operator to list all subscriptions that match a partial string in the "Value", such as "us-west". For each filter, you can specify one of the following values for the "Name" key to streamline results: * "AccountID" * "AmiID" * "DualSubscription" * "InstanceID" * "InstanceType" * "ProductCode" * "Region" * "Status" * "UsageOperation" For each filter, you can use one of the following "Operator" values to define the behavior of the filter: * "contains" * "equals" * "Notequal" * *(dict) --* A filter object 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. * **Name** *(string) --* The type of name to filter by. * **Operator** *(string) --* An operator for filtering results. * **Values** *(list) --* One or more values for the name to filter by. * *(string) --* * **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** { 'Instances': [ { 'AccountID': 'string', 'AmiId': 'string', 'DualSubscription': 'string', 'InstanceID': 'string', 'InstanceType': 'string', 'LastUpdatedTime': 'string', 'OsVersion': 'string', 'ProductCode': [ 'string', ], 'Region': 'string', 'RegisteredWithSubscriptionProvider': 'string', 'Status': 'string', 'SubscriptionName': 'string', 'SubscriptionProviderCreateTime': 'string', 'SubscriptionProviderUpdateTime': 'string', 'UsageOperation': 'string' }, ], } **Response Structure** * *(dict) --* * **Instances** *(list) --* An array that contains instance objects. * *(dict) --* Details discovered information about a running instance using Linux subscriptions. * **AccountID** *(string) --* The account ID which owns the instance. * **AmiId** *(string) --* The AMI ID used to launch the instance. * **DualSubscription** *(string) --* Indicates that you have two different license subscriptions for the same software on your instance. * **InstanceID** *(string) --* The instance ID of the resource. * **InstanceType** *(string) --* The instance type of the resource. * **LastUpdatedTime** *(string) --* The time in which the last discovery updated the instance details. * **OsVersion** *(string) --* The operating system software version that runs on your instance. * **ProductCode** *(list) --* The product code for the instance. For more information, see Usage operation values in the *License Manager User Guide* . * *(string) --* * **Region** *(string) --* The Region the instance is running in. * **RegisteredWithSubscriptionProvider** *(string) --* Indicates that your instance uses a BYOL license subscription from a third-party Linux subscription provider that you've registered with License Manager. * **Status** *(string) --* The status of the instance. * **SubscriptionName** *(string) --* The name of the license subscription that the instance uses. * **SubscriptionProviderCreateTime** *(string) --* The timestamp when you registered the third-party Linux subscription provider for the subscription that the instance uses. * **SubscriptionProviderUpdateTime** *(string) --* The timestamp from the last time that the instance synced with the registered third-party Linux subscription provider. * **UsageOperation** *(string) --* The usage operation of the instance. For more information, see For more information, see Usage operation values in the *License Manager User Guide*. LicenseManagerLinuxSubscriptions / Paginator / ListLinuxSubscriptions ListLinuxSubscriptions ********************** class LicenseManagerLinuxSubscriptions.Paginator.ListLinuxSubscriptions paginator = client.get_paginator('list_linux_subscriptions') paginate(**kwargs) Creates an iterator that will paginate through responses from " LicenseManagerLinuxSubscriptions.Client.list_linux_subscription s()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Filters=[ { 'Name': 'string', 'Operator': 'Equal'|'NotEqual'|'Contains', 'Values': [ '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. For example, you can filter by the name of "Subscription" with an optional operator to see subscriptions that match, partially match, or don't match a certain subscription's name. The valid names for this filter are: * "Subscription" The valid Operators for this filter are: * "contains" * "equals" * "Notequal" * *(dict) --* A filter object 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. * **Name** *(string) --* The type of name to filter by. * **Operator** *(string) --* An operator for filtering results. * **Values** *(list) --* One or more values for the name to filter by. * *(string) --* * **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** { 'Subscriptions': [ { 'InstanceCount': 123, 'Name': 'string', 'Type': 'string' }, ] } **Response Structure** * *(dict) --* * **Subscriptions** *(list) --* An array that contains subscription objects. * *(dict) --* An object which details a discovered Linux subscription. * **InstanceCount** *(integer) --* The total amount of running instances using this subscription. * **Name** *(string) --* The name of the subscription. * **Type** *(string) --* The type of subscription. The type can be subscription-included with Amazon EC2, Bring Your Own Subscription model (BYOS), or from the Amazon Web Services Marketplace. Certain subscriptions may use licensing from the Amazon Web Services Marketplace as well as OS licensing from Amazon EC2 or BYOS. LicenseManagerLinuxSubscriptions / Client / list_linux_subscriptions list_linux_subscriptions ************************ LicenseManagerLinuxSubscriptions.Client.list_linux_subscriptions(**kwargs) Lists the Linux subscriptions that have been discovered. If you have linked your organization, the returned results will include data aggregated across your accounts in Organizations. See also: AWS API Documentation **Request Syntax** response = client.list_linux_subscriptions( Filters=[ { 'Name': 'string', 'Operator': 'Equal'|'NotEqual'|'Contains', 'Values': [ '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. For example, you can filter by the name of "Subscription" with an optional operator to see subscriptions that match, partially match, or don't match a certain subscription's name. The valid names for this filter are: * "Subscription" The valid Operators for this filter are: * "contains" * "equals" * "Notequal" * *(dict) --* A filter object 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. * **Name** *(string) --* The type of name to filter by. * **Operator** *(string) --* An operator for filtering results. * **Values** *(list) --* One or more values for the name to filter by. * *(string) --* * **MaxResults** (*integer*) -- The maximum items to return in a request. * **NextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Subscriptions': [ { 'InstanceCount': 123, 'Name': 'string', 'Type': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. * **Subscriptions** *(list) --* An array that contains subscription objects. * *(dict) --* An object which details a discovered Linux subscription. * **InstanceCount** *(integer) --* The total amount of running instances using this subscription. * **Name** *(string) --* The name of the subscription. * **Type** *(string) --* The type of subscription. The type can be subscription- included with Amazon EC2, Bring Your Own Subscription model (BYOS), or from the Amazon Web Services Marketplace. Certain subscriptions may use licensing from the Amazon Web Services Marketplace as well as OS licensing from Amazon EC2 or BYOS. **Exceptions** * "LicenseManagerLinuxSubscriptions.Client.exceptions.InternalServ erException" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ThrottlingEx ception" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ValidationEx ception" LicenseManagerLinuxSubscriptions / Client / get_paginator get_paginator ************* LicenseManagerLinuxSubscriptions.Client.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: "botocore.paginate.Paginator" Returns: A paginator object. LicenseManagerLinuxSubscriptions / Client / can_paginate can_paginate ************ LicenseManagerLinuxSubscriptions.Client.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. LicenseManagerLinuxSubscriptions / Client / deregister_subscription_provider deregister_subscription_provider ******************************** LicenseManagerLinuxSubscriptions.Client.deregister_subscription_provider(**kwargs) Remove a third-party subscription provider from the Bring Your Own License (BYOL) subscriptions registered to your account. See also: AWS API Documentation **Request Syntax** response = client.deregister_subscription_provider( SubscriptionProviderArn='string' ) Parameters: **SubscriptionProviderArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the subscription provider resource to deregister. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LicenseManagerLinuxSubscriptions.Client.exceptions.InternalServ erException" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ResourceNotF oundException" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ThrottlingEx ception" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ValidationEx ception" LicenseManagerLinuxSubscriptions / Client / list_tags_for_resource list_tags_for_resource ********************** LicenseManagerLinuxSubscriptions.Client.list_tags_for_resource(**kwargs) List the metadata tags that are assigned to the specified Amazon Web Services resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource for which to list metadata tags. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* The metadata tags for the requested resource. * *(string) --* * *(string) --* **Exceptions** * "LicenseManagerLinuxSubscriptions.Client.exceptions.InternalServ erException" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ResourceNotF oundException" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ValidationEx ception" LicenseManagerLinuxSubscriptions / Client / untag_resource untag_resource ************** LicenseManagerLinuxSubscriptions.Client.untag_resource(**kwargs) Remove one or more metadata tag from the specified Amazon Web Services resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon Web Services resource to remove the metadata tags from. * **tagKeys** (*list*) -- **[REQUIRED]** A list of metadata tag keys to remove from the requested resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LicenseManagerLinuxSubscriptions.Client.exceptions.InternalServ erException" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ResourceNotF oundException" LicenseManagerLinuxSubscriptions / Client / get_waiter get_waiter ********** LicenseManagerLinuxSubscriptions.Client.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" LicenseManagerLinuxSubscriptions / Client / list_linux_subscription_instances list_linux_subscription_instances ********************************* LicenseManagerLinuxSubscriptions.Client.list_linux_subscription_instances(**kwargs) Lists the running Amazon EC2 instances that were discovered with commercial Linux subscriptions. See also: AWS API Documentation **Request Syntax** response = client.list_linux_subscription_instances( Filters=[ { 'Name': 'string', 'Operator': 'Equal'|'NotEqual'|'Contains', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string' ) Parameters: * **Filters** (*list*) -- An array of structures that you can use to filter the results by your specified criteria. For example, you can specify "Region" in the "Name", with the "contains" operator to list all subscriptions that match a partial string in the "Value", such as "us-west". For each filter, you can specify one of the following values for the "Name" key to streamline results: * "AccountID" * "AmiID" * "DualSubscription" * "InstanceID" * "InstanceType" * "ProductCode" * "Region" * "Status" * "UsageOperation" For each filter, you can use one of the following "Operator" values to define the behavior of the filter: * "contains" * "equals" * "Notequal" * *(dict) --* A filter object 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. * **Name** *(string) --* The type of name to filter by. * **Operator** *(string) --* An operator for filtering results. * **Values** *(list) --* One or more values for the name to filter by. * *(string) --* * **MaxResults** (*integer*) -- The maximum items to return in a request. * **NextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. Return type: dict Returns: **Response Syntax** { 'Instances': [ { 'AccountID': 'string', 'AmiId': 'string', 'DualSubscription': 'string', 'InstanceID': 'string', 'InstanceType': 'string', 'LastUpdatedTime': 'string', 'OsVersion': 'string', 'ProductCode': [ 'string', ], 'Region': 'string', 'RegisteredWithSubscriptionProvider': 'string', 'Status': 'string', 'SubscriptionName': 'string', 'SubscriptionProviderCreateTime': 'string', 'SubscriptionProviderUpdateTime': 'string', 'UsageOperation': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Instances** *(list) --* An array that contains instance objects. * *(dict) --* Details discovered information about a running instance using Linux subscriptions. * **AccountID** *(string) --* The account ID which owns the instance. * **AmiId** *(string) --* The AMI ID used to launch the instance. * **DualSubscription** *(string) --* Indicates that you have two different license subscriptions for the same software on your instance. * **InstanceID** *(string) --* The instance ID of the resource. * **InstanceType** *(string) --* The instance type of the resource. * **LastUpdatedTime** *(string) --* The time in which the last discovery updated the instance details. * **OsVersion** *(string) --* The operating system software version that runs on your instance. * **ProductCode** *(list) --* The product code for the instance. For more information, see Usage operation values in the *License Manager User Guide* . * *(string) --* * **Region** *(string) --* The Region the instance is running in. * **RegisteredWithSubscriptionProvider** *(string) --* Indicates that your instance uses a BYOL license subscription from a third-party Linux subscription provider that you've registered with License Manager. * **Status** *(string) --* The status of the instance. * **SubscriptionName** *(string) --* The name of the license subscription that the instance uses. * **SubscriptionProviderCreateTime** *(string) --* The timestamp when you registered the third-party Linux subscription provider for the subscription that the instance uses. * **SubscriptionProviderUpdateTime** *(string) --* The timestamp from the last time that the instance synced with the registered third-party Linux subscription provider. * **UsageOperation** *(string) --* The usage operation of the instance. For more information, see For more information, see Usage operation values in the *License Manager User Guide*. * **NextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. **Exceptions** * "LicenseManagerLinuxSubscriptions.Client.exceptions.InternalServ erException" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ThrottlingEx ception" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ValidationEx ception" LicenseManagerLinuxSubscriptions / Client / get_registered_subscription_provider get_registered_subscription_provider ************************************ LicenseManagerLinuxSubscriptions.Client.get_registered_subscription_provider(**kwargs) Get details for a Bring Your Own License (BYOL) subscription that's registered to your account. See also: AWS API Documentation **Request Syntax** response = client.get_registered_subscription_provider( SubscriptionProviderArn='string' ) Parameters: **SubscriptionProviderArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the BYOL registration resource to get details for. Return type: dict Returns: **Response Syntax** { 'LastSuccessfulDataRetrievalTime': 'string', 'SecretArn': 'string', 'SubscriptionProviderArn': 'string', 'SubscriptionProviderSource': 'RedHat', 'SubscriptionProviderStatus': 'ACTIVE'|'INVALID'|'PENDING', 'SubscriptionProviderStatusMessage': 'string' } **Response Structure** * *(dict) --* * **LastSuccessfulDataRetrievalTime** *(string) --* The timestamp from the last time License Manager retrieved subscription details from your registered third-party Linux subscription provider. * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the third-party access secret stored in Secrets Manager for the BYOL registration resource specified in the request. * **SubscriptionProviderArn** *(string) --* The Amazon Resource Name (ARN) for the BYOL registration resource specified in the request. * **SubscriptionProviderSource** *(string) --* The subscription provider for the BYOL registration resource specified in the request. * **SubscriptionProviderStatus** *(string) --* The status of the Linux subscription provider access token from the last successful subscription data request. * **SubscriptionProviderStatusMessage** *(string) --* The detailed message from your subscription provider token status. **Exceptions** * "LicenseManagerLinuxSubscriptions.Client.exceptions.InternalServ erException" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ResourceNotF oundException" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ThrottlingEx ception" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ValidationEx ception" LicenseManagerLinuxSubscriptions / Client / register_subscription_provider register_subscription_provider ****************************** LicenseManagerLinuxSubscriptions.Client.register_subscription_provider(**kwargs) Register the supported third-party subscription provider for your Bring Your Own License (BYOL) subscription. See also: AWS API Documentation **Request Syntax** response = client.register_subscription_provider( SecretArn='string', SubscriptionProviderSource='RedHat', Tags={ 'string': 'string' } ) Parameters: * **SecretArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the secret where you've stored your subscription provider's access token. For RHEL subscriptions managed through the Red Hat Subscription Manager (RHSM), the secret contains your Red Hat Offline token. * **SubscriptionProviderSource** (*string*) -- **[REQUIRED]** The supported Linux subscription provider to register. * **Tags** (*dict*) -- The metadata tags to assign to your registered Linux subscription provider resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'SubscriptionProviderArn': 'string', 'SubscriptionProviderSource': 'RedHat', 'SubscriptionProviderStatus': 'ACTIVE'|'INVALID'|'PENDING' } **Response Structure** * *(dict) --* * **SubscriptionProviderArn** *(string) --* The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered. * **SubscriptionProviderSource** *(string) --* The Linux subscription provider that you registered. * **SubscriptionProviderStatus** *(string) --* Indicates the status of the registration action for the Linux subscription provider that you requested. **Exceptions** * "LicenseManagerLinuxSubscriptions.Client.exceptions.InternalServ erException" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ThrottlingEx ception" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ValidationEx ception" LicenseManagerLinuxSubscriptions / Client / update_service_settings update_service_settings *********************** LicenseManagerLinuxSubscriptions.Client.update_service_settings(**kwargs) Updates the service settings for Linux subscriptions. See also: AWS API Documentation **Request Syntax** response = client.update_service_settings( AllowUpdate=True|False, LinuxSubscriptionsDiscovery='Enabled'|'Disabled', LinuxSubscriptionsDiscoverySettings={ 'OrganizationIntegration': 'Enabled'|'Disabled', 'SourceRegions': [ 'string', ] } ) Parameters: * **AllowUpdate** (*boolean*) -- Describes if updates are allowed to the service settings for Linux subscriptions. If you allow updates, you can aggregate Linux subscription data in more than one home Region. * **LinuxSubscriptionsDiscovery** (*string*) -- **[REQUIRED]** Describes if the discovery of Linux subscriptions is enabled. * **LinuxSubscriptionsDiscoverySettings** (*dict*) -- **[REQUIRED]** The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from. * **OrganizationIntegration** *(string) --* **[REQUIRED]** Details if you have enabled resource discovery across your accounts in Organizations. * **SourceRegions** *(list) --* **[REQUIRED]** The Regions in which to discover data for Linux subscriptions. * *(string) --* Return type: dict Returns: **Response Syntax** { 'HomeRegions': [ 'string', ], 'LinuxSubscriptionsDiscovery': 'Enabled'|'Disabled', 'LinuxSubscriptionsDiscoverySettings': { 'OrganizationIntegration': 'Enabled'|'Disabled', 'SourceRegions': [ 'string', ] }, 'Status': 'InProgress'|'Completed'|'Successful'|'Failed', 'StatusMessage': { 'string': 'string' } } **Response Structure** * *(dict) --* * **HomeRegions** *(list) --* The Region in which License Manager displays the aggregated data for Linux subscriptions. * *(string) --* * **LinuxSubscriptionsDiscovery** *(string) --* Lists if discovery has been enabled for Linux subscriptions. * **LinuxSubscriptionsDiscoverySettings** *(dict) --* The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from. * **OrganizationIntegration** *(string) --* Details if you have enabled resource discovery across your accounts in Organizations. * **SourceRegions** *(list) --* The Regions in which to discover data for Linux subscriptions. * *(string) --* * **Status** *(string) --* Indicates the status of Linux subscriptions settings being applied. * **StatusMessage** *(dict) --* A message which details the Linux subscriptions service settings current status. * *(string) --* * *(string) --* **Exceptions** * "LicenseManagerLinuxSubscriptions.Client.exceptions.InternalServ erException" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ThrottlingEx ception" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ValidationEx ception" LicenseManagerLinuxSubscriptions / Client / close close ***** LicenseManagerLinuxSubscriptions.Client.close() Closes underlying endpoint connections. LicenseManagerLinuxSubscriptions / Client / get_service_settings get_service_settings ******************** LicenseManagerLinuxSubscriptions.Client.get_service_settings() Lists the Linux subscriptions service settings for your account. See also: AWS API Documentation **Request Syntax** response = client.get_service_settings() Return type: dict Returns: **Response Syntax** { 'HomeRegions': [ 'string', ], 'LinuxSubscriptionsDiscovery': 'Enabled'|'Disabled', 'LinuxSubscriptionsDiscoverySettings': { 'OrganizationIntegration': 'Enabled'|'Disabled', 'SourceRegions': [ 'string', ] }, 'Status': 'InProgress'|'Completed'|'Successful'|'Failed', 'StatusMessage': { 'string': 'string' } } **Response Structure** * *(dict) --* * **HomeRegions** *(list) --* The Region in which License Manager displays the aggregated data for Linux subscriptions. * *(string) --* * **LinuxSubscriptionsDiscovery** *(string) --* Lists if discovery has been enabled for Linux subscriptions. * **LinuxSubscriptionsDiscoverySettings** *(dict) --* Lists the settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from. * **OrganizationIntegration** *(string) --* Details if you have enabled resource discovery across your accounts in Organizations. * **SourceRegions** *(list) --* The Regions in which to discover data for Linux subscriptions. * *(string) --* * **Status** *(string) --* Indicates the status of Linux subscriptions settings being applied. * **StatusMessage** *(dict) --* A message which details the Linux subscriptions service settings current status. * *(string) --* * *(string) --* **Exceptions** * "LicenseManagerLinuxSubscriptions.Client.exceptions.InternalServ erException" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ThrottlingEx ception" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ValidationEx ception" LicenseManagerLinuxSubscriptions / Client / list_registered_subscription_providers list_registered_subscription_providers ************************************** LicenseManagerLinuxSubscriptions.Client.list_registered_subscription_providers(**kwargs) List Bring Your Own License (BYOL) subscription registration resources for your account. See also: AWS API Documentation **Request Syntax** response = client.list_registered_subscription_providers( MaxResults=123, NextToken='string', SubscriptionProviderSources=[ 'RedHat', ] ) Parameters: * **MaxResults** (*integer*) -- The maximum items to return in a request. * **NextToken** (*string*) -- A token to specify where to start paginating. This is the nextToken from a previously truncated response. * **SubscriptionProviderSources** (*list*) -- To filter your results, specify which subscription providers to return in the list. * *(string) --* Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'RegisteredSubscriptionProviders': [ { 'LastSuccessfulDataRetrievalTime': 'string', 'SecretArn': 'string', 'SubscriptionProviderArn': 'string', 'SubscriptionProviderSource': 'RedHat', 'SubscriptionProviderStatus': 'ACTIVE'|'INVALID'|'PENDING', 'SubscriptionProviderStatusMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects. * **RegisteredSubscriptionProviders** *(list) --* The list of BYOL registration resources that fit the criteria you specified in the request. * *(dict) --* A third-party provider for operating system (OS) platform software and license subscriptions, such as Red Hat. When you register a third-party Linux subscription provider, License Manager can get subscription data from the registered provider. * **LastSuccessfulDataRetrievalTime** *(string) --* The timestamp from the last time that License Manager accessed third-party subscription data for your account from your registered Linux subscription provider. * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the Secrets Manager secret that stores your registered Linux subscription provider access token. For RHEL account subscriptions, this is the offline token. * **SubscriptionProviderArn** *(string) --* The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered. * **SubscriptionProviderSource** *(string) --* A supported third-party Linux subscription provider. License Manager currently supports Red Hat subscriptions. * **SubscriptionProviderStatus** *(string) --* Indicates the status of your registered Linux subscription provider access token from the last time License Manager retrieved subscription data. For RHEL account subscriptions, this is the status of the offline token. * **SubscriptionProviderStatusMessage** *(string) --* A detailed message that's associated with your BYOL subscription provider token status. **Exceptions** * "LicenseManagerLinuxSubscriptions.Client.exceptions.InternalServ erException" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ThrottlingEx ception" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ValidationEx ception" LicenseManagerLinuxSubscriptions / Client / tag_resource tag_resource ************ LicenseManagerLinuxSubscriptions.Client.tag_resource(**kwargs) Add metadata tags to the specified Amazon Web Services resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon Web Services resource to which to add the specified metadata tags. * **tags** (*dict*) -- **[REQUIRED]** The metadata tags to assign to the Amazon Web Services resource. Tags are formatted as key value pairs. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LicenseManagerLinuxSubscriptions.Client.exceptions.InternalServ erException" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ResourceNotF oundException" * "LicenseManagerLinuxSubscriptions.Client.exceptions.ValidationEx ception"