Amazon License Manager License Manager Subscription API

The License Manager Subscription API from Amazon License Manager — 6 operation(s) for license manager subscription.

GitHub OpenAPI

Operations 8

POST /subscription/DeregisterSubscriptionProvider Deregister Subscription Provider #
POST /subscription/GetRegisteredSubscriptionProvider Get Registered Subscription Provider #
POST /subscription/GetServiceSettings Get Service Settings #
POST /subscription/ListLinuxSubscriptionInstances List Linux Subscription Instances #
POST /subscription/ListLinuxSubscriptions List Linux Subscriptions #
POST /subscription/ListRegisteredSubscriptionProviders List Registered Subscription Providers #
POST /subscription/RegisterSubscriptionProvider Register Subscription Provider #
POST /subscription/UpdateServiceSettings Update Service Settings #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-license-manager:amazon-license-manager-subscription-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-license-manager-subscription-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS License Manager Subscription API
  version: '2018-08-01'
  description: Generated from AWS's published Smithy model for AWS License Manager. 8 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://license-manager-linux-subscriptions.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /subscription/DeregisterSubscriptionProvider:
    post:
      operationId: DeregisterSubscriptionProvider
      summary: Deregister Subscription Provider
      description: Remove a third-party subscription provider from the Bring Your Own License (BYOL) subscriptions registered
        to your account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeregisterSubscriptionProviderResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ResourceNotFoundException; ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerLinuxSubscriptionsResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeregisterSubscriptionProviderRequest'
      tags:
      - Subscription
  /subscription/GetRegisteredSubscriptionProvider:
    post:
      operationId: GetRegisteredSubscriptionProvider
      summary: Get Registered Subscription Provider
      description: Get details for a Bring Your Own License (BYOL) subscription that's registered to your account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRegisteredSubscriptionProviderResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ResourceNotFoundException; ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerLinuxSubscriptionsResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetRegisteredSubscriptionProviderRequest'
      tags:
      - Subscription
  /subscription/GetServiceSettings:
    post:
      operationId: GetServiceSettings
      summary: Get Service Settings
      description: Lists the Linux subscriptions service settings for your account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerLinuxSubscriptionsGetServiceSettingsResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetServiceSettingsRequest'
      tags:
      - Subscription
  /subscription/ListLinuxSubscriptionInstances:
    post:
      operationId: ListLinuxSubscriptionInstances
      summary: List Linux Subscription Instances
      description: Lists the running Amazon EC2 instances that were discovered with commercial Linux subscriptions.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLinuxSubscriptionInstancesResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListLinuxSubscriptionInstancesRequest'
      tags:
      - Subscription
  /subscription/ListLinuxSubscriptions:
    post:
      operationId: ListLinuxSubscriptions
      summary: List Linux Subscriptions
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLinuxSubscriptionsResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListLinuxSubscriptionsRequest'
      tags:
      - Subscription
  /subscription/ListRegisteredSubscriptionProviders:
    post:
      operationId: ListRegisteredSubscriptionProviders
      summary: List Registered Subscription Providers
      description: List Bring Your Own License (BYOL) subscription registration resources for your account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRegisteredSubscriptionProvidersResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListRegisteredSubscriptionProvidersRequest'
      tags:
      - Subscription
  /subscription/RegisterSubscriptionProvider:
    post:
      operationId: RegisterSubscriptionProvider
      summary: Register Subscription Provider
      description: Register the supported third-party subscription provider for your Bring Your Own License (BYOL) subscription.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterSubscriptionProviderResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterSubscriptionProviderRequest'
      tags:
      - Subscription
  /subscription/UpdateServiceSettings:
    post:
      operationId: UpdateServiceSettings
      summary: Update Service Settings
      description: Updates the service settings for Linux subscriptions.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseManagerLinuxSubscriptionsUpdateServiceSettingsResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LicenseManagerLinuxSubscriptionsUpdateServiceSettingsRequest'
      tags:
      - Subscription
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: license-manager-linux-subscriptions
  schemas:
    DeregisterSubscriptionProviderRequest:
      type: object
      properties:
        SubscriptionProviderArn:
          type: string
          description: The Amazon Resource Name (ARN) of the subscription provider resource to deregister.
      required:
      - SubscriptionProviderArn
    DeregisterSubscriptionProviderResponse:
      type: object
      properties: {}
    GetRegisteredSubscriptionProviderRequest:
      type: object
      properties:
        SubscriptionProviderArn:
          type: string
          description: The Amazon Resource Name (ARN) of the BYOL registration resource to get details for.
      required:
      - SubscriptionProviderArn
    GetRegisteredSubscriptionProviderResponse:
      type: object
      properties:
        SubscriptionProviderArn:
          type: string
          description: The Amazon Resource Name (ARN) for the BYOL registration resource specified in the request.
        SubscriptionProviderSource:
          type: string
          description: The subscription provider for the BYOL registration resource specified in the request.
        SecretArn:
          type: string
          description: The Amazon Resource Name (ARN) of the third-party access secret stored in Secrets Manager for the BYOL
            registration resource specified in the request.
        SubscriptionProviderStatus:
          type: string
          description: The status of the Linux subscription provider access token from the last successful subscription data
            request.
        SubscriptionProviderStatusMessage:
          type: string
          description: The detailed message from your subscription provider token status.
        LastSuccessfulDataRetrievalTime:
          type: string
          description: The timestamp from the last time License Manager retrieved subscription details from your registered
            third-party Linux subscription provider.
    GetServiceSettingsRequest:
      type: object
      properties: {}
    Instance:
      type: object
      properties:
        AmiId:
          type: string
          description: The AMI ID used to launch the instance.
        InstanceID:
          type: string
          description: The instance ID of the resource.
        InstanceType:
          type: string
          description: The instance type of the resource.
        AccountID:
          type: string
          description: The account ID which owns the instance.
        Status:
          type: string
          description: The status of the instance.
        Region:
          type: string
          description: The Region the instance is running in.
        UsageOperation:
          type: string
          description: The usage operation of the instance. For more information, see For more information, see Usage operation
            values in the License Manager User Guide.
        ProductCode:
          type: array
          items:
            type: string
          description: The product code for the instance. For more information, see Usage operation values in the License
            Manager User Guide .
        LastUpdatedTime:
          type: string
          description: The time in which the last discovery updated the instance details.
        SubscriptionName:
          type: string
          description: The name of the license subscription that the instance uses.
        OsVersion:
          type: string
          description: The operating system software version that runs on your instance.
        SubscriptionProviderCreateTime:
          type: string
          description: The timestamp when you registered the third-party Linux subscription provider for the subscription
            that the instance uses.
        SubscriptionProviderUpdateTime:
          type: string
          description: The timestamp from the last time that the instance synced with the registered third-party Linux subscription
            provider.
        DualSubscription:
          type: string
          description: Indicates that you have two different license subscriptions for the same software on your instance.
        RegisteredWithSubscriptionProvider:
          type: string
          description: Indicates that your instance uses a BYOL license subscription from a third-party Linux subscription
            provider that you've registered with License Manager.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    LicenseManagerLinuxSubscriptionsFilter:
      type: object
      properties:
        Name:
          type: string
          description: The type of name to filter by.
        Values:
          type: array
          items:
            type: string
          description: One or more values for the name to filter by.
        Operator:
          type: string
          description: An operator for filtering results.
    LicenseManagerLinuxSubscriptionsGetServiceSettingsResponse:
      type: object
      properties:
        LinuxSubscriptionsDiscovery:
          type: string
          description: Lists if discovery has been enabled for Linux subscriptions.
        LinuxSubscriptionsDiscoverySettings:
          $ref: '#/components/schemas/LinuxSubscriptionsDiscoverySettings'
        Status:
          type: string
          description: Indicates the status of Linux subscriptions settings being applied.
        StatusMessage:
          type: object
          additionalProperties:
            type: string
          description: A message which details the Linux subscriptions service settings current status.
        HomeRegions:
          type: array
          items:
            type: string
          description: The Region in which License Manager displays the aggregated data for Linux subscriptions.
    LicenseManagerLinuxSubscriptionsResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    LicenseManagerLinuxSubscriptionsUpdateServiceSettingsRequest:
      type: object
      properties:
        LinuxSubscriptionsDiscovery:
          type: string
          description: Describes if the discovery of Linux subscriptions is enabled.
        LinuxSubscriptionsDiscoverySettings:
          $ref: '#/components/schemas/LinuxSubscriptionsDiscoverySettings'
        AllowUpdate:
          type: boolean
          description: 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.
      required:
      - LinuxSubscriptionsDiscovery
      - LinuxSubscriptionsDiscoverySettings
    LicenseManagerLinuxSubscriptionsUpdateServiceSettingsResponse:
      type: object
      properties:
        LinuxSubscriptionsDiscovery:
          type: string
          description: Lists if discovery has been enabled for Linux subscriptions.
        LinuxSubscriptionsDiscoverySettings:
          $ref: '#/components/schemas/LinuxSubscriptionsDiscoverySettings'
        Status:
          type: string
          description: Indicates the status of Linux subscriptions settings being applied.
        StatusMessage:
          type: object
          additionalProperties:
            type: string
          description: A message which details the Linux subscriptions service settings current status.
        HomeRegions:
          type: array
          items:
            type: string
          description: The Region in which License Manager displays the aggregated data for Linux subscriptions.
    LinuxSubscriptionsDiscoverySettings:
      type: object
      properties:
        SourceRegions:
          type: array
          items:
            type: string
          description: The Regions in which to discover data for Linux subscriptions.
        OrganizationIntegration:
          type: string
          description: Details if you have enabled resource discovery across your accounts in Organizations.
      required:
      - SourceRegions
      - OrganizationIntegration
    ListLinuxSubscriptionInstancesRequest:
      type: object
      properties:
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/LicenseManagerLinuxSubscriptionsFilter'
          description: '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'
        MaxResults:
          type: integer
          description: The maximum items to return in a request.
        NextToken:
          type: string
          description: A token to specify where to start paginating. This is the nextToken from a previously truncated response.
    ListLinuxSubscriptionInstancesResponse:
      type: object
      properties:
        Instances:
          type: array
          items:
            $ref: '#/components/schemas/Instance'
          description: An array that contains instance objects.
        NextToken:
          type: string
          description: 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.
    ListLinuxSubscriptionsRequest:
      type: object
      properties:
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/LicenseManagerLinuxSubscriptionsFilter'
          description: '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'
        MaxResults:
          type: integer
          description: The maximum items to return in a request.
        NextToken:
          type: string
          description: A token to specify where to start paginating. This is the nextToken from a previously truncated response.
    ListLinuxSubscriptionsResponse:
      type: object
      properties:
        Subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/Subscription'
          description: An array that contains subscription objects.
        NextToken:
          type: string
          description: 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.
    ListRegisteredSubscriptionProvidersRequest:
      type: object
      properties:
        SubscriptionProviderSources:
          type: array
          items:
            type: string
          description: To filter your results, specify which subscription providers to return in the list.
        MaxResults:
          type: integer
          description: The maximum items to return in a request.
        NextToken:
          type: string
          description: A token to specify where to start paginating. This is the nextToken from a previously truncated response.
    ListRegisteredSubscriptionProvidersResponse:
      type: object
      properties:
        RegisteredSubscriptionProviders:
          type: array
          items:
            $ref: '#/components/schemas/RegisteredSubscriptionProvider'
          description: The list of BYOL registration resources that fit the criteria you specified in the request.
        NextToken:
          type: string
          description: 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.
    RegisterSubscriptionProviderRequest:
      type: object
      properties:
        SubscriptionProviderSource:
          type: string
          description: The supported Linux subscription provider to register.
        SecretArn:
          type: string
          description: 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.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The metadata tags to assign to your registered Linux subscription provider resource.
      required:
      - SubscriptionProviderSource
      - SecretArn
    RegisterSubscriptionProviderResponse:
      type: object
      properties:
        SubscriptionProviderSource:
          type: string
          description: The Linux subscription provider that you registered.
        SubscriptionProviderArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered.
        SubscriptionProviderStatus:
          type: string
          description: Indicates the status of the registration action for the Linux subscription provider that you requested.
    RegisteredSubscriptionProvider:
      type: object
      properties:
        SubscriptionProviderArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered.
        SubscriptionProviderSource:
          type: string
          description: A supported third-party Linux subscription provider. License Manager currently supports Red Hat subscriptions.
        SecretArn:
          type: string
          description: 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.
        SubscriptionProviderStatus:
          type: string
          description: 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:
          type: string
          description: A detailed message that's associated with your BYOL subscription provider token status.
        LastSuccessfulDataRetrievalTime:
          type: string
          description: The timestamp from the last time that License Manager accessed third-party subscription data for your
            account from your registered Linux subscription provider.
    Subscription:
      type: object
      properties:
        Name:
          type: string
          description: The name of the subscription.
        Type:
          type: string
          description: 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.
        InstanceCount:
          type: integer
          description: The total amount of running instances using this subscription.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/license-manager-linux-subscriptions/service/2018-05-10/license-manager-linux-subscriptions-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)