| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.LicenseManagerLinuxSubscriptions
Description
Derived from API version 2018-05-10 of the AWS service descriptions, licensed under Apache 2.0.
With License Manager, you can discover and track your commercial Linux subscriptions on running Amazon EC2 instances.
Synopsis
- defaultService :: Service
- _InternalServerException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data GetServiceSettings = GetServiceSettings' {
- newGetServiceSettings :: GetServiceSettings
- data GetServiceSettingsResponse = GetServiceSettingsResponse' (Maybe (NonEmpty Text)) (Maybe LinuxSubscriptionsDiscovery) (Maybe LinuxSubscriptionsDiscoverySettings) (Maybe Status) (Maybe (HashMap Text Text)) Int
- newGetServiceSettingsResponse :: Int -> GetServiceSettingsResponse
- data ListLinuxSubscriptionInstances = ListLinuxSubscriptionInstances' (Maybe [Filter]) (Maybe Int) (Maybe Text)
- newListLinuxSubscriptionInstances :: ListLinuxSubscriptionInstances
- data ListLinuxSubscriptionInstancesResponse = ListLinuxSubscriptionInstancesResponse' (Maybe [Instance]) (Maybe Text) Int
- newListLinuxSubscriptionInstancesResponse :: Int -> ListLinuxSubscriptionInstancesResponse
- data ListLinuxSubscriptions = ListLinuxSubscriptions' (Maybe [Filter]) (Maybe Int) (Maybe Text)
- newListLinuxSubscriptions :: ListLinuxSubscriptions
- data ListLinuxSubscriptionsResponse = ListLinuxSubscriptionsResponse' (Maybe Text) (Maybe [Subscription]) Int
- newListLinuxSubscriptionsResponse :: Int -> ListLinuxSubscriptionsResponse
- data UpdateServiceSettings = UpdateServiceSettings' (Maybe Bool) LinuxSubscriptionsDiscovery LinuxSubscriptionsDiscoverySettings
- newUpdateServiceSettings :: LinuxSubscriptionsDiscovery -> LinuxSubscriptionsDiscoverySettings -> UpdateServiceSettings
- data UpdateServiceSettingsResponse = UpdateServiceSettingsResponse' (Maybe (NonEmpty Text)) (Maybe LinuxSubscriptionsDiscovery) (Maybe LinuxSubscriptionsDiscoverySettings) (Maybe Status) (Maybe (HashMap Text Text)) Int
- newUpdateServiceSettingsResponse :: Int -> UpdateServiceSettingsResponse
- newtype LinuxSubscriptionsDiscovery where
- newtype Operator where
- Operator' {
- fromOperator :: Text
- pattern Operator_Contains :: Operator
- pattern Operator_Equal :: Operator
- pattern Operator_NotEqual :: Operator
- Operator' {
- newtype OrganizationIntegration where
- newtype Status where
- Status' {
- fromStatus :: Text
- pattern Status_Completed :: Status
- pattern Status_Failed :: Status
- pattern Status_InProgress :: Status
- pattern Status_Successful :: Status
- Status' {
- data Filter = Filter' (Maybe Text) (Maybe Operator) (Maybe (NonEmpty Text))
- newFilter :: Filter
- data Instance = Instance' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newInstance :: Instance
- data LinuxSubscriptionsDiscoverySettings = LinuxSubscriptionsDiscoverySettings' OrganizationIntegration (NonEmpty Text)
- newLinuxSubscriptionsDiscoverySettings :: OrganizationIntegration -> NonEmpty Text -> LinuxSubscriptionsDiscoverySettings
- data Subscription = Subscription' (Maybe Integer) (Maybe Text) (Maybe Text)
- newSubscription :: Subscription
Service Configuration
defaultService :: Service Source #
API version 2018-05-10 of the Amazon License Manager Linux Subscriptions SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by LicenseManagerLinuxSubscriptions.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
An exception occurred with the service.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The provided input is not valid. Try your request again.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
GetServiceSettings
data GetServiceSettings Source #
See: newGetServiceSettings smart constructor.
Constructors
| GetServiceSettings' | |
Instances
newGetServiceSettings :: GetServiceSettings Source #
Create a value of GetServiceSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetServiceSettingsResponse Source #
See: newGetServiceSettingsResponse smart constructor.
Constructors
| GetServiceSettingsResponse' (Maybe (NonEmpty Text)) (Maybe LinuxSubscriptionsDiscovery) (Maybe LinuxSubscriptionsDiscoverySettings) (Maybe Status) (Maybe (HashMap Text Text)) Int |
Instances
newGetServiceSettingsResponse Source #
Create a value of GetServiceSettingsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:homeRegions:GetServiceSettingsResponse', getServiceSettingsResponse_homeRegions - The Region in which License Manager displays the aggregated data for
Linux subscriptions.
$sel:linuxSubscriptionsDiscovery:GetServiceSettingsResponse', getServiceSettingsResponse_linuxSubscriptionsDiscovery - Lists if discovery has been enabled for Linux subscriptions.
$sel:linuxSubscriptionsDiscoverySettings:GetServiceSettingsResponse', getServiceSettingsResponse_linuxSubscriptionsDiscoverySettings - 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.
GetServiceSettingsResponse, getServiceSettingsResponse_status - Indicates the status of Linux subscriptions settings being applied.
$sel:statusMessage:GetServiceSettingsResponse', getServiceSettingsResponse_statusMessage - A message which details the Linux subscriptions service settings current
status.
$sel:httpStatus:GetServiceSettingsResponse', getServiceSettingsResponse_httpStatus - The response's http status code.
ListLinuxSubscriptionInstances (Paginated)
data ListLinuxSubscriptionInstances Source #
NextToken length limit is half of ddb accepted limit. Increase this limit if parameters in request increases.
See: newListLinuxSubscriptionInstances smart constructor.
Instances
newListLinuxSubscriptionInstances :: ListLinuxSubscriptionInstances Source #
Create a value of ListLinuxSubscriptionInstances with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListLinuxSubscriptionInstances', listLinuxSubscriptionInstances_filters - 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
$sel:maxResults:ListLinuxSubscriptionInstances', listLinuxSubscriptionInstances_maxResults - Maximum number of results to return in a single call.
ListLinuxSubscriptionInstances, listLinuxSubscriptionInstances_nextToken - Token for the next set of results.
data ListLinuxSubscriptionInstancesResponse Source #
See: newListLinuxSubscriptionInstancesResponse smart constructor.
Instances
newListLinuxSubscriptionInstancesResponse Source #
Arguments
| :: Int | |
| -> ListLinuxSubscriptionInstancesResponse |
Create a value of ListLinuxSubscriptionInstancesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instances:ListLinuxSubscriptionInstancesResponse', listLinuxSubscriptionInstancesResponse_instances - An array that contains instance objects.
ListLinuxSubscriptionInstances, listLinuxSubscriptionInstancesResponse_nextToken - Token for the next set of results.
$sel:httpStatus:ListLinuxSubscriptionInstancesResponse', listLinuxSubscriptionInstancesResponse_httpStatus - The response's http status code.
ListLinuxSubscriptions (Paginated)
data ListLinuxSubscriptions Source #
NextToken length limit is half of ddb accepted limit. Increase this limit if parameters in request increases.
See: newListLinuxSubscriptions smart constructor.
Instances
newListLinuxSubscriptions :: ListLinuxSubscriptions Source #
Create a value of ListLinuxSubscriptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListLinuxSubscriptions', listLinuxSubscriptions_filters - 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
$sel:maxResults:ListLinuxSubscriptions', listLinuxSubscriptions_maxResults - Maximum number of results to return in a single call.
ListLinuxSubscriptions, listLinuxSubscriptions_nextToken - Token for the next set of results.
data ListLinuxSubscriptionsResponse Source #
See: newListLinuxSubscriptionsResponse smart constructor.
Constructors
| ListLinuxSubscriptionsResponse' (Maybe Text) (Maybe [Subscription]) Int |
Instances
newListLinuxSubscriptionsResponse Source #
Create a value of ListLinuxSubscriptionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListLinuxSubscriptions, listLinuxSubscriptionsResponse_nextToken - Token for the next set of results.
$sel:subscriptions:ListLinuxSubscriptionsResponse', listLinuxSubscriptionsResponse_subscriptions - An array that contains subscription objects.
$sel:httpStatus:ListLinuxSubscriptionsResponse', listLinuxSubscriptionsResponse_httpStatus - The response's http status code.
UpdateServiceSettings
data UpdateServiceSettings Source #
See: newUpdateServiceSettings smart constructor.
Constructors
| UpdateServiceSettings' (Maybe Bool) LinuxSubscriptionsDiscovery LinuxSubscriptionsDiscoverySettings |
Instances
newUpdateServiceSettings Source #
Arguments
| :: LinuxSubscriptionsDiscovery | |
| -> LinuxSubscriptionsDiscoverySettings | |
| -> UpdateServiceSettings |
Create a value of UpdateServiceSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowUpdate:UpdateServiceSettings', updateServiceSettings_allowUpdate - 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.
UpdateServiceSettings, updateServiceSettings_linuxSubscriptionsDiscovery - Describes if the discovery of Linux subscriptions is enabled.
UpdateServiceSettings, updateServiceSettings_linuxSubscriptionsDiscoverySettings - The settings defined for Linux subscriptions discovery. The settings
include if Organizations integration has been enabled, and which Regions
data will be aggregated from.
data UpdateServiceSettingsResponse Source #
See: newUpdateServiceSettingsResponse smart constructor.
Constructors
| UpdateServiceSettingsResponse' (Maybe (NonEmpty Text)) (Maybe LinuxSubscriptionsDiscovery) (Maybe LinuxSubscriptionsDiscoverySettings) (Maybe Status) (Maybe (HashMap Text Text)) Int |
Instances
newUpdateServiceSettingsResponse Source #
Create a value of UpdateServiceSettingsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:homeRegions:UpdateServiceSettingsResponse', updateServiceSettingsResponse_homeRegions - The Region in which License Manager displays the aggregated data for
Linux subscriptions.
UpdateServiceSettings, updateServiceSettingsResponse_linuxSubscriptionsDiscovery - Lists if discovery has been enabled for Linux subscriptions.
UpdateServiceSettings, updateServiceSettingsResponse_linuxSubscriptionsDiscoverySettings - The settings defined for Linux subscriptions discovery. The settings
include if Organizations integration has been enabled, and which Regions
data will be aggregated from.
UpdateServiceSettingsResponse, updateServiceSettingsResponse_status - Indicates the status of Linux subscriptions settings being applied.
$sel:statusMessage:UpdateServiceSettingsResponse', updateServiceSettingsResponse_statusMessage - A message which details the Linux subscriptions service settings current
status.
$sel:httpStatus:UpdateServiceSettingsResponse', updateServiceSettingsResponse_httpStatus - The response's http status code.
Types
LinuxSubscriptionsDiscovery
newtype LinuxSubscriptionsDiscovery Source #
Constructors
| LinuxSubscriptionsDiscovery' | |
Fields | |
Bundled Patterns
| pattern LinuxSubscriptionsDiscovery_Disabled :: LinuxSubscriptionsDiscovery | |
| pattern LinuxSubscriptionsDiscovery_Enabled :: LinuxSubscriptionsDiscovery |
Instances
Operator
Constructors
| Operator' | |
Fields
| |
Bundled Patterns
| pattern Operator_Contains :: Operator | |
| pattern Operator_Equal :: Operator | |
| pattern Operator_NotEqual :: Operator |
Instances
OrganizationIntegration
newtype OrganizationIntegration Source #
Constructors
| OrganizationIntegration' | |
Fields | |
Bundled Patterns
| pattern OrganizationIntegration_Disabled :: OrganizationIntegration | |
| pattern OrganizationIntegration_Enabled :: OrganizationIntegration |
Instances
Status
Constructors
| Status' | |
Fields
| |
Bundled Patterns
| pattern Status_Completed :: Status | |
| pattern Status_Failed :: Status | |
| pattern Status_InProgress :: Status | |
| pattern Status_Successful :: Status |
Instances
Filter
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.
See: newFilter smart constructor.
Instances
| ToJSON Filter Source # | |
| Generic Filter Source # | |
| Read Filter Source # | |
| Show Filter Source # | |
| NFData Filter Source # | |
| Eq Filter Source # | |
| Hashable Filter Source # | |
| type Rep Filter Source # | |
Defined in Amazonka.LicenseManagerLinuxSubscriptions.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.LicenseManagerLinuxSubscriptions.Types.Filter" "amazonka-license-manager-linux-subscriptions-2.0-AO29CJRkexAJPaOYE130NE" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "operator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Operator)) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))))) | |
Create a value of Filter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Filter', filter_name - The type of name to filter by.
$sel:operator:Filter', filter_operator - An operator for filtering results.
$sel:values:Filter', filter_values - One or more values for the name to filter by.
Instance
Details discovered information about a running instance using Linux subscriptions.
See: newInstance smart constructor.
Constructors
| Instance' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newInstance :: Instance Source #
Create a value of Instance with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountID:Instance', instance_accountID - The account ID which owns the instance.
$sel:amiId:Instance', instance_amiId - The AMI ID used to launch the instance.
$sel:instanceID:Instance', instance_instanceID - The instance ID of the resource.
$sel:instanceType:Instance', instance_instanceType - The instance type of the resource.
$sel:lastUpdatedTime:Instance', instance_lastUpdatedTime - The time in which the last discovery updated the instance details.
$sel:productCode:Instance', instance_productCode - The product code for the instance. For more information, see
Usage operation values
in the License Manager User Guide .
$sel:region:Instance', instance_region - The Region the instance is running in.
$sel:status:Instance', instance_status - The status of the instance.
$sel:subscriptionName:Instance', instance_subscriptionName - The name of the subscription being used by the instance.
$sel:usageOperation:Instance', instance_usageOperation - The usage operation of the instance. For more information, see For more
information, see
Usage operation values
in the License Manager User Guide.
LinuxSubscriptionsDiscoverySettings
data LinuxSubscriptionsDiscoverySettings Source #
Lists the settings defined for discovering Linux subscriptions.
See: newLinuxSubscriptionsDiscoverySettings smart constructor.
Instances
newLinuxSubscriptionsDiscoverySettings Source #
Arguments
| :: OrganizationIntegration |
|
| -> NonEmpty Text | |
| -> LinuxSubscriptionsDiscoverySettings |
Create a value of LinuxSubscriptionsDiscoverySettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:organizationIntegration:LinuxSubscriptionsDiscoverySettings', linuxSubscriptionsDiscoverySettings_organizationIntegration - Details if you have enabled resource discovery across your accounts in
Organizations.
$sel:sourceRegions:LinuxSubscriptionsDiscoverySettings', linuxSubscriptionsDiscoverySettings_sourceRegions - The Regions in which to discover data for Linux subscriptions.
Subscription
data Subscription Source #
An object which details a discovered Linux subscription.
See: newSubscription smart constructor.
Instances
newSubscription :: Subscription Source #
Create a value of Subscription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instanceCount:Subscription', subscription_instanceCount - The total amount of running instances using this subscription.
$sel:name:Subscription', subscription_name - The name of the subscription.
$sel:type':Subscription', subscription_type - 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.