AWS License Manager Linux Subscriptions 2018-05-10
- 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 */)
.
- GetServiceSettings ( array $params = [] )
Lists the Linux subscriptions service settings.
- 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.
- 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:
Operations
GetServiceSettings
$result = $client->getServiceSettings
([/* ... */]); $promise = $client->getServiceSettingsAsync
([/* ... */]);
Lists the Linux subscriptions service settings.
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
-
An exception occurred with the service.
-
The request was denied due to request throttling.
-
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 to those that match one or more sets of key-value pairs that you specify. For example, you can filter by the name of
AmiID
with an optional operator to see subscriptions that match, partially match, or don't match a certain Amazon Machine Image (AMI) ID.The valid names for this filter are:
-
AmiID
-
InstanceID
-
AccountID
-
Status
-
Region
-
UsageOperation
-
ProductCode
-
InstanceType
The valid Operators for this filter are:
-
contains
-
equals
-
Notequal
- MaxResults
-
- Type: int
Maximum number of results to return in a single call.
- NextToken
-
- Type: string
Token for the next set of results.
Result Syntax
[ 'Instances' => [ [ 'AccountID' => '<string>', 'AmiId' => '<string>', 'InstanceID' => '<string>', 'InstanceType' => '<string>', 'LastUpdatedTime' => '<string>', 'ProductCode' => ['<string>', ...], 'Region' => '<string>', 'Status' => '<string>', 'SubscriptionName' => '<string>', 'UsageOperation' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Instances
-
- Type: Array of Instance structures
An array that contains instance objects.
- NextToken
-
- Type: string
Token for the next set of results.
Errors
-
An exception occurred with the service.
-
The request was denied due to request throttling.
-
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
Maximum number of results to return in a single call.
- NextToken
-
- Type: string
Token for the next set of results.
Result Syntax
[ 'NextToken' => '<string>', 'Subscriptions' => [ [ 'InstanceCount' => <integer>, 'Name' => '<string>', 'Type' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
Token for the next set of results.
- Subscriptions
-
- Type: Array of Subscription structures
An array that contains subscription objects.
Errors
-
An exception occurred with the service.
-
The request was denied due to request throttling.
-
The provided input is not valid. Try your request again.
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
-
An exception occurred with the service.
-
The request was denied due to request throttling.
-
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.
- 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.
- 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.
- Status
-
- Type: string
The status of the instance.
- SubscriptionName
-
- Type: string
The name of the subscription being used by the instance.
- 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.
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