AWS API Changes

2021/09/22 - AWS License Manager - 3 new api methods

Changes AWS License Manager now allows customers to change their Windows Server or SQL license types from Bring-Your-Own-License (BYOL) to License Included or vice-versa (using the customer's media).

GetLicenseConversionTask (new)

Link ¶

Gets information about the specified license type conversion task.

See also: AWS API Documentation

Request Syntax

client.get_license_conversion_task(
    LicenseConversionTaskId='string'
)

type LicenseConversionTaskId

string

param LicenseConversionTaskId

[REQUIRED]

ID of the license type conversion task to retrieve information on.

rtype

dict

returns

Response Syntax

{
    'LicenseConversionTaskId': 'string',
    'ResourceArn': 'string',
    'SourceLicenseContext': {
        'UsageOperation': 'string'
    },
    'DestinationLicenseContext': {
        'UsageOperation': 'string'
    },
    'StatusMessage': 'string',
    'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
    'StartTime': datetime(2015, 1, 1),
    'LicenseConversionTime': datetime(2015, 1, 1),
    'EndTime': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- LicenseConversionTaskId (string) --
  
  ID of the license type conversion task.
- ResourceArn (string) --
  
  Amazon Resource Names (ARN) of the resources the license conversion task is associated with.
- SourceLicenseContext (dict) --
  
  Information about the license type converted from.
  - UsageOperation (string) --
    
    The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform
- DestinationLicenseContext (dict) --
  
  Information about the license type converted to.
  - UsageOperation (string) --
    
    The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform
- StatusMessage (string) --
  
  The status message for the conversion task.
- Status (string) --
  
  Status of the license type conversion task.
- StartTime (datetime) --
  
  Time at which the license type conversion task was started .
- LicenseConversionTime (datetime) --
  
  Amount of time to complete the license type conversion.
- EndTime (datetime) --
  
  Time at which the license type conversion task was completed.

ListLicenseConversionTasks (new)

Link ¶

Lists the license type conversion tasks for your account.

See also: AWS API Documentation

Request Syntax

client.list_license_conversion_tasks(
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

type NextToken

string

param NextToken

Token for the next set of results.

type MaxResults

integer

param MaxResults

Maximum number of results to return in a single call.

type Filters

list

param Filters

Filters to scope the results. Valid filters are ResourceArns and Status .

(dict) --

A filter name and value pair 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, such as tags, attributes, or IDs.
- Name (string) --
  
  Name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  Filter values. Filter values are case-sensitive.
  - (string) --

rtype

dict

returns

Response Syntax

{
    'LicenseConversionTasks': [
        {
            'LicenseConversionTaskId': 'string',
            'ResourceArn': 'string',
            'SourceLicenseContext': {
                'UsageOperation': 'string'
            },
            'DestinationLicenseContext': {
                'UsageOperation': 'string'
            },
            'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
            'StatusMessage': 'string',
            'StartTime': datetime(2015, 1, 1),
            'LicenseConversionTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- LicenseConversionTasks (list) --
  
  Information about the license configuration tasks for your account.
  - (dict) --
    
    Information about a license type conversion task.
    - LicenseConversionTaskId (string) --
      
      The ID of the license type conversion task.
    - ResourceArn (string) --
      
      The Amazon Resource Name (ARN) of the resource associated with the license type conversion task.
    - SourceLicenseContext (dict) --
      
      Information about the license type this conversion task converted from.
      - UsageOperation (string) --
        
        The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform
    - DestinationLicenseContext (dict) --
      
      Information about the license type this conversion task converted to.
      - UsageOperation (string) --
        
        The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform
    - Status (string) --
      
      The status of the conversion task.
    - StatusMessage (string) --
      
      The status message for the conversion task.
    - StartTime (datetime) --
      
      The time the conversion task was started at.
    - LicenseConversionTime (datetime) --
      
      The time the usage operation value of the resource was changed.
    - EndTime (datetime) --
      
      The time the conversion task was completed.
- NextToken (string) --
  
  Token for the next set of results.

CreateLicenseConversionTaskForResource (new)

Link ¶

Creates a new license conversion task.

See also: AWS API Documentation

Request Syntax

client.create_license_conversion_task_for_resource(
    ResourceArn='string',
    SourceLicenseContext={
        'UsageOperation': 'string'
    },
    DestinationLicenseContext={
        'UsageOperation': 'string'
    }
)

type ResourceArn

string

param ResourceArn

[REQUIRED]

Amazon Resource Name (ARN) of the resource you are converting the license type for.

type SourceLicenseContext

dict

param SourceLicenseContext

[REQUIRED]

Information that identifies the license type you are converting from. For the structure of the source license, see Convert a license type using the AWS CLI in the License Manager User Guide .

UsageOperation (string) --

The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform

type DestinationLicenseContext

dict

param DestinationLicenseContext

[REQUIRED]

Information that identifies the license type you are converting to. For the structure of the destination license, see Convert a license type using the AWS CLI in the License Manager User Guide .

UsageOperation (string) --

The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform

rtype

dict

returns

Response Syntax

{
    'LicenseConversionTaskId': 'string'
}

Response Structure

(dict) --
- LicenseConversionTaskId (string) --
  
  The ID of the created license type conversion task.