AWS SDK for PHP 3.x

Client: Aws\LicenseManagerLinuxSubscriptions\LicenseManagerLinuxSubscriptionsClient

Service ID: license-manager-linux-subscriptions

Version: 2018-05-10

This page describes the parameters and results for the operations of the AWS License Manager Linux Subscriptions (2018-05-10), and shows how to use the Aws\LicenseManagerLinuxSubscriptions\LicenseManagerLinuxSubscriptionsClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

DeregisterSubscriptionProvider ( array $params = [] ): Remove a third-party subscription provider from the Bring Your Own License (BYOL) subscriptions registered to your account.
GetRegisteredSubscriptionProvider ( array $params = [] ): Get details for a Bring Your Own License (BYOL) subscription that's registered to your account.
GetServiceSettings ( array $params = [] ): Lists the Linux subscriptions service settings for your account.
ListLinuxSubscriptionInstances ( array $params = [] ): Lists the running Amazon EC2 instances that were discovered with commercial Linux subscriptions.
ListLinuxSubscriptions ( array $params = [] ): Lists the Linux subscriptions that have been discovered.
ListRegisteredSubscriptionProviders ( array $params = [] ): List Bring Your Own License (BYOL) subscription registration resources for your account.
ListTagsForResource ( array $params = [] ): List the metadata tags that are assigned to the specified Amazon Web Services resource.
RegisterSubscriptionProvider ( array $params = [] ): Register the supported third-party subscription provider for your Bring Your Own License (BYOL) subscription.
TagResource ( array $params = [] ): Add metadata tags to the specified Amazon Web Services resource.
UntagResource ( array $params = [] ): Remove one or more metadata tag from the specified Amazon Web Services resource.
UpdateServiceSettings ( array $params = [] ): Updates the service settings for Linux subscriptions.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListLinuxSubscriptionInstances
ListLinuxSubscriptions
ListRegisteredSubscriptionProviders

Operations

DeregisterSubscriptionProvider

$result = $client->deregisterSubscriptionProvider([/* ... */]);
$promise = $client->deregisterSubscriptionProviderAsync([/* ... */]);

Remove a third-party subscription provider from the Bring Your Own License (BYOL) subscriptions registered to your account.

Parameter Syntax

$result = $client->deregisterSubscriptionProvider([
    'SubscriptionProviderArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

SubscriptionProviderArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the subscription provider resource to deregister.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: Unable to find the requested Amazon Web Services resource.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The provided input is not valid. Try your request again.

GetRegisteredSubscriptionProvider

$result = $client->getRegisteredSubscriptionProvider([/* ... */]);
$promise = $client->getRegisteredSubscriptionProviderAsync([/* ... */]);

Get details for a Bring Your Own License (BYOL) subscription that's registered to your account.

Parameter Syntax

$result = $client->getRegisteredSubscriptionProvider([
    'SubscriptionProviderArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

SubscriptionProviderArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the BYOL registration resource to get details for.

Result Syntax

[
    'LastSuccessfulDataRetrievalTime' => '<string>',
    'SecretArn' => '<string>',
    'SubscriptionProviderArn' => '<string>',
    'SubscriptionProviderSource' => 'RedHat',
    'SubscriptionProviderStatus' => 'ACTIVE|INVALID|PENDING',
    'SubscriptionProviderStatusMessage' => '<string>',
]

Result Details

Members

LastSuccessfulDataRetrievalTime

: Type: string

The timestamp from the last time License Manager retrieved subscription details from your registered third-party Linux subscription provider.

SecretArn

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

: Type: string

The Amazon Resource Name (ARN) for the BYOL registration resource specified in the request.

SubscriptionProviderSource

: Type: string

The subscription provider for the BYOL registration resource specified in the request.

SubscriptionProviderStatus

: Type: string

The status of the Linux subscription provider access token from the last successful subscription data request.

SubscriptionProviderStatusMessage

: Type: string

The detailed message from your subscription provider token status.

Errors

InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: Unable to find the requested Amazon Web Services resource.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The provided input is not valid. Try your request again.

GetServiceSettings

$result = $client->getServiceSettings([/* ... */]);
$promise = $client->getServiceSettingsAsync([/* ... */]);

Lists the Linux subscriptions service settings for your account.

Parameter Syntax

$result = $client->getServiceSettings([
]);

Parameter Details

Members

Result Syntax

[
    'HomeRegions' => ['<string>', ...],
    'LinuxSubscriptionsDiscovery' => 'Enabled|Disabled',
    'LinuxSubscriptionsDiscoverySettings' => [
        'OrganizationIntegration' => 'Enabled|Disabled',
        'SourceRegions' => ['<string>', ...],
    ],
    'Status' => 'InProgress|Completed|Successful|Failed',
    'StatusMessage' => ['<string>', ...],
]

Result Details

Members

HomeRegions

: Type: Array of strings

The Region in which License Manager displays the aggregated data for Linux subscriptions.

LinuxSubscriptionsDiscovery

: Type: string

Lists if discovery has been enabled for Linux subscriptions.

LinuxSubscriptionsDiscoverySettings

: Type: LinuxSubscriptionsDiscoverySettings structure

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.

Status

: Type: string

Indicates the status of Linux subscriptions settings being applied.

StatusMessage

: Type: Associative array of custom strings keys (String) to strings

A message which details the Linux subscriptions service settings current status.

Errors

InternalServerException:: An exception occurred with the service.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The provided input is not valid. Try your request again.

ListLinuxSubscriptionInstances

$result = $client->listLinuxSubscriptionInstances([/* ... */]);
$promise = $client->listLinuxSubscriptionInstancesAsync([/* ... */]);

Lists the running Amazon EC2 instances that were discovered with commercial Linux subscriptions.

Parameter Syntax

$result = $client->listLinuxSubscriptionInstances([
    'Filters' => [
        [
            'Name' => '<string>',
            'Operator' => 'Equal|NotEqual|Contains',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

: Type: Array of Filter structures

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

The maximum items to return in a request.

NextToken

: Type: string

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Result 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>',
]

Result Details

Members

Instances

: Type: Array of Instance structures

An array that contains instance objects.

NextToken

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

Errors

InternalServerException:: An exception occurred with the service.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The provided input is not valid. Try your request again.

ListLinuxSubscriptions

$result = $client->listLinuxSubscriptions([/* ... */]);
$promise = $client->listLinuxSubscriptionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listLinuxSubscriptions([
    'Filters' => [
        [
            'Name' => '<string>',
            'Operator' => 'Equal|NotEqual|Contains',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

: Type: Array of Filter structures

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

The maximum items to return in a request.

NextToken

: Type: string

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Result Syntax

[
    'NextToken' => '<string>',
    'Subscriptions' => [
        [
            'InstanceCount' => <integer>,
            'Name' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

Subscriptions

: Type: Array of Subscription structures

An array that contains subscription objects.

Errors

InternalServerException:: An exception occurred with the service.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The provided input is not valid. Try your request again.

ListRegisteredSubscriptionProviders

$result = $client->listRegisteredSubscriptionProviders([/* ... */]);
$promise = $client->listRegisteredSubscriptionProvidersAsync([/* ... */]);

List Bring Your Own License (BYOL) subscription registration resources for your account.

Parameter Syntax

$result = $client->listRegisteredSubscriptionProviders([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SubscriptionProviderSources' => ['<string>', ...],
]);

Parameter Details

Members

MaxResults

: Type: int

The maximum items to return in a request.

NextToken

: Type: string

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

SubscriptionProviderSources

: Type: Array of strings

To filter your results, specify which subscription providers to return in the list.

Result Syntax

[
    'NextToken' => '<string>',
    'RegisteredSubscriptionProviders' => [
        [
            'LastSuccessfulDataRetrievalTime' => '<string>',
            'SecretArn' => '<string>',
            'SubscriptionProviderArn' => '<string>',
            'SubscriptionProviderSource' => 'RedHat',
            'SubscriptionProviderStatus' => 'ACTIVE|INVALID|PENDING',
            'SubscriptionProviderStatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

RegisteredSubscriptionProviders

: Type: Array of RegisteredSubscriptionProvider structures

The list of BYOL registration resources that fit the criteria you specified in the request.

Errors

InternalServerException:: An exception occurred with the service.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The provided input is not valid. Try your request again.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List the metadata tags that are assigned to the specified Amazon Web Services resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource for which to list metadata tags.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

: Type: Associative array of custom strings keys (String) to strings

The metadata tags for the requested resource.

Errors

InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: Unable to find the requested Amazon Web Services resource.
ValidationException:: The provided input is not valid. Try your request again.

RegisterSubscriptionProvider

$result = $client->registerSubscriptionProvider([/* ... */]);
$promise = $client->registerSubscriptionProviderAsync([/* ... */]);

Parameter Syntax

$result = $client->registerSubscriptionProvider([
    'SecretArn' => '<string>', // REQUIRED
    'SubscriptionProviderSource' => 'RedHat', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

SecretArn

: Required: Yes
: Type: string

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

: Required: Yes
: Type: string

The supported Linux subscription provider to register.

Tags

: Type: Associative array of custom strings keys (String) to strings

The metadata tags to assign to your registered Linux subscription provider resource.

Result Syntax

[
    'SubscriptionProviderArn' => '<string>',
    'SubscriptionProviderSource' => 'RedHat',
    'SubscriptionProviderStatus' => 'ACTIVE|INVALID|PENDING',
]

Result Details

Members

SubscriptionProviderArn

: Type: string

The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered.

SubscriptionProviderSource

: Type: string

The Linux subscription provider that you registered.

SubscriptionProviderStatus

: Type: string

Indicates the status of the registration action for the Linux subscription provider that you requested.

Errors

InternalServerException:: An exception occurred with the service.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The provided input is not valid. Try your request again.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Add metadata tags to the specified Amazon Web Services resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the Amazon Web Services resource to which to add the specified metadata tags.

tags

: Required: Yes
: Type: Associative array of custom strings keys (String) to strings

The metadata tags to assign to the Amazon Web Services resource. Tags are formatted as key value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: Unable to find the requested Amazon Web Services resource.
ValidationException:: The provided input is not valid. Try your request again.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Remove one or more metadata tag from the specified Amazon Web Services resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the Amazon Web Services resource to remove the metadata tags from.

tagKeys

: Required: Yes
: Type: Array of strings

A list of metadata tag keys to remove from the requested resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: An exception occurred with the service.
ResourceNotFoundException:: Unable to find the requested Amazon Web Services resource.

UpdateServiceSettings

$result = $client->updateServiceSettings([/* ... */]);
$promise = $client->updateServiceSettingsAsync([/* ... */]);

Updates the service settings for Linux subscriptions.

Parameter Syntax

$result = $client->updateServiceSettings([
    'AllowUpdate' => true || false,
    'LinuxSubscriptionsDiscovery' => 'Enabled|Disabled', // REQUIRED
    'LinuxSubscriptionsDiscoverySettings' => [ // REQUIRED
        'OrganizationIntegration' => 'Enabled|Disabled', // REQUIRED
        'SourceRegions' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Members

AllowUpdate

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

: Required: Yes
: Type: string

Describes if the discovery of Linux subscriptions is enabled.

LinuxSubscriptionsDiscoverySettings

: Required: Yes
: Type: LinuxSubscriptionsDiscoverySettings structure

The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.

Result Syntax

[
    'HomeRegions' => ['<string>', ...],
    'LinuxSubscriptionsDiscovery' => 'Enabled|Disabled',
    'LinuxSubscriptionsDiscoverySettings' => [
        'OrganizationIntegration' => 'Enabled|Disabled',
        'SourceRegions' => ['<string>', ...],
    ],
    'Status' => 'InProgress|Completed|Successful|Failed',
    'StatusMessage' => ['<string>', ...],
]

Result Details

Members

HomeRegions

: Type: Array of strings

The Region in which License Manager displays the aggregated data for Linux subscriptions.

LinuxSubscriptionsDiscovery

: Type: string

Lists if discovery has been enabled for Linux subscriptions.

LinuxSubscriptionsDiscoverySettings

: Type: LinuxSubscriptionsDiscoverySettings structure

The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.

Status

: Type: string

Indicates the status of Linux subscriptions settings being applied.

StatusMessage

: Type: Associative array of custom strings keys (String) to strings

A message which details the Linux subscriptions service settings current status.

Errors

InternalServerException:: An exception occurred with the service.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The provided input is not valid. Try your request again.

Shapes

Filter

Description

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.

Members

Name

: Type: string

The type of name to filter by.

Operator

: Type: string

An operator for filtering results.

Values

: Type: Array of strings

One or more values for the name to filter by.

Instance

Description

Details discovered information about a running instance using Linux subscriptions.

Members

AccountID

: Type: string

The account ID which owns the instance.

AmiId

: Type: string

The AMI ID used to launch the instance.

DualSubscription

: Type: string

Indicates that you have two different license subscriptions for the same software on your instance.

InstanceID

: Type: string

The instance ID of the resource.

InstanceType

: Type: string

The instance type of the resource.

LastUpdatedTime

: Type: string

The time in which the last discovery updated the instance details.

OsVersion

: Type: string

The operating system software version that runs on your instance.

ProductCode

: Type: Array of strings

The product code for the instance. For more information, see Usage operation values in the License Manager User Guide .

Region

: Type: string

The Region the instance is running in.

RegisteredWithSubscriptionProvider

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

: Type: string

The status of the instance.

SubscriptionName

: Type: string

The name of the license subscription that the instance uses.

SubscriptionProviderCreateTime

: Type: string

The timestamp when you registered the third-party Linux subscription provider for the subscription that the instance uses.

SubscriptionProviderUpdateTime

: Type: string

The timestamp from the last time that the instance synced with the registered third-party Linux subscription provider.

UsageOperation

: Type: string

The usage operation of the instance. For more information, see For more information, see Usage operation values in the License Manager User Guide.

InternalServerException

Description

An exception occurred with the service.

Members

message

: Type: string

LinuxSubscriptionsDiscoverySettings

Description

Lists the settings defined for discovering Linux subscriptions.

Members

OrganizationIntegration

: Required: Yes
: Type: string

Details if you have enabled resource discovery across your accounts in Organizations.

SourceRegions

: Required: Yes
: Type: Array of strings

The Regions in which to discover data for Linux subscriptions.

RegisteredSubscriptionProvider

Description

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.

Members

LastSuccessfulDataRetrievalTime

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

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

: Type: string

The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered.

SubscriptionProviderSource

: Type: string

A supported third-party Linux subscription provider. License Manager currently supports Red Hat subscriptions.

SubscriptionProviderStatus

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

: Type: string

A detailed message that's associated with your BYOL subscription provider token status.

ResourceNotFoundException

Description

Unable to find the requested Amazon Web Services resource.

Members

message

: Type: string

Subscription

Description

An object which details a discovered Linux subscription.

Members

InstanceCount

: Type: long (int|float)

The total amount of running instances using this subscription.

Name

: Type: string

The name of the subscription.

Type

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

ThrottlingException

Description

The request was denied due to request throttling.

Members

message

: Type: string

ValidationException

Description

The provided input is not valid. Try your request again.

Members

message

: Type: string

AWS License Manager Linux Subscriptions 2018-05-10

Operation Summary

Paginators

Operations

DeregisterSubscriptionProvider

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetRegisteredSubscriptionProvider

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetServiceSettings

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListLinuxSubscriptionInstances

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListLinuxSubscriptions

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListRegisteredSubscriptionProviders

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTagsForResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

RegisterSubscriptionProvider

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

TagResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

UntagResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details