| 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.LicenseManagerUserSubscriptions
Description
Derived from API version 2018-05-10 of the AWS service descriptions, licensed under Apache 2.0.
With License Manager, you can create user-based subscriptions to utilize licensed software with a per user subscription fee on Amazon EC2 instances.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data AssociateUser = AssociateUser' (Maybe Text) IdentityProvider Text Text
- newAssociateUser :: IdentityProvider -> Text -> Text -> AssociateUser
- data AssociateUserResponse = AssociateUserResponse' Int InstanceUserSummary
- newAssociateUserResponse :: Int -> InstanceUserSummary -> AssociateUserResponse
- data DeregisterIdentityProvider = DeregisterIdentityProvider' IdentityProvider Text
- newDeregisterIdentityProvider :: IdentityProvider -> Text -> DeregisterIdentityProvider
- data DeregisterIdentityProviderResponse = DeregisterIdentityProviderResponse' Int IdentityProviderSummary
- newDeregisterIdentityProviderResponse :: Int -> IdentityProviderSummary -> DeregisterIdentityProviderResponse
- data DisassociateUser = DisassociateUser' (Maybe Text) IdentityProvider Text Text
- newDisassociateUser :: IdentityProvider -> Text -> Text -> DisassociateUser
- data DisassociateUserResponse = DisassociateUserResponse' Int InstanceUserSummary
- newDisassociateUserResponse :: Int -> InstanceUserSummary -> DisassociateUserResponse
- data ListIdentityProviders = ListIdentityProviders' (Maybe Int) (Maybe Text)
- newListIdentityProviders :: ListIdentityProviders
- data ListIdentityProvidersResponse = ListIdentityProvidersResponse' (Maybe Text) Int [IdentityProviderSummary]
- newListIdentityProvidersResponse :: Int -> ListIdentityProvidersResponse
- data ListInstances = ListInstances' (Maybe [Filter]) (Maybe Int) (Maybe Text)
- newListInstances :: ListInstances
- data ListInstancesResponse = ListInstancesResponse' (Maybe [InstanceSummary]) (Maybe Text) Int
- newListInstancesResponse :: Int -> ListInstancesResponse
- data ListProductSubscriptions = ListProductSubscriptions' (Maybe [Filter]) (Maybe Int) (Maybe Text) IdentityProvider Text
- newListProductSubscriptions :: IdentityProvider -> Text -> ListProductSubscriptions
- data ListProductSubscriptionsResponse = ListProductSubscriptionsResponse' (Maybe Text) (Maybe [ProductUserSummary]) Int
- newListProductSubscriptionsResponse :: Int -> ListProductSubscriptionsResponse
- data ListUserAssociations = ListUserAssociations' (Maybe [Filter]) (Maybe Int) (Maybe Text) IdentityProvider Text
- newListUserAssociations :: IdentityProvider -> Text -> ListUserAssociations
- data ListUserAssociationsResponse = ListUserAssociationsResponse' (Maybe [InstanceUserSummary]) (Maybe Text) Int
- newListUserAssociationsResponse :: Int -> ListUserAssociationsResponse
- data RegisterIdentityProvider = RegisterIdentityProvider' (Maybe Settings) IdentityProvider Text
- newRegisterIdentityProvider :: IdentityProvider -> Text -> RegisterIdentityProvider
- data RegisterIdentityProviderResponse = RegisterIdentityProviderResponse' Int IdentityProviderSummary
- newRegisterIdentityProviderResponse :: Int -> IdentityProviderSummary -> RegisterIdentityProviderResponse
- data StartProductSubscription = StartProductSubscription' (Maybe Text) IdentityProvider Text Text
- newStartProductSubscription :: IdentityProvider -> Text -> Text -> StartProductSubscription
- data StartProductSubscriptionResponse = StartProductSubscriptionResponse' Int ProductUserSummary
- newStartProductSubscriptionResponse :: Int -> ProductUserSummary -> StartProductSubscriptionResponse
- data StopProductSubscription = StopProductSubscription' (Maybe Text) IdentityProvider Text Text
- newStopProductSubscription :: IdentityProvider -> Text -> Text -> StopProductSubscription
- data StopProductSubscriptionResponse = StopProductSubscriptionResponse' Int ProductUserSummary
- newStopProductSubscriptionResponse :: Int -> ProductUserSummary -> StopProductSubscriptionResponse
- data UpdateIdentityProviderSettings = UpdateIdentityProviderSettings' IdentityProvider Text UpdateSettings
- newUpdateIdentityProviderSettings :: IdentityProvider -> Text -> UpdateSettings -> UpdateIdentityProviderSettings
- data UpdateIdentityProviderSettingsResponse = UpdateIdentityProviderSettingsResponse' Int IdentityProviderSummary
- newUpdateIdentityProviderSettingsResponse :: Int -> IdentityProviderSummary -> UpdateIdentityProviderSettingsResponse
- data ActiveDirectoryIdentityProvider = ActiveDirectoryIdentityProvider' (Maybe Text)
- newActiveDirectoryIdentityProvider :: ActiveDirectoryIdentityProvider
- data Filter = Filter' (Maybe Text) (Maybe Text) (Maybe Text)
- newFilter :: Filter
- data IdentityProvider = IdentityProvider' (Maybe ActiveDirectoryIdentityProvider)
- newIdentityProvider :: IdentityProvider
- data IdentityProviderSummary = IdentityProviderSummary' (Maybe Text) IdentityProvider Text Settings Text
- newIdentityProviderSummary :: IdentityProvider -> Text -> Settings -> Text -> IdentityProviderSummary
- data InstanceSummary = InstanceSummary' (Maybe Text) (Maybe Text) Text [Text] Text
- newInstanceSummary :: Text -> Text -> InstanceSummary
- data InstanceUserSummary = InstanceUserSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) IdentityProvider Text Text Text
- newInstanceUserSummary :: IdentityProvider -> Text -> Text -> Text -> InstanceUserSummary
- data ProductUserSummary = ProductUserSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) IdentityProvider Text Text Text
- newProductUserSummary :: IdentityProvider -> Text -> Text -> Text -> ProductUserSummary
- data Settings = Settings' Text (NonEmpty Text)
- newSettings :: Text -> NonEmpty Text -> Settings
- data UpdateSettings = UpdateSettings' (Maybe Text) [Text] [Text]
- newUpdateSettings :: UpdateSettings
Service Configuration
defaultService :: Service Source #
API version 2018-05-10 of the Amazon License Manager User 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 LicenseManagerUserSubscriptions.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have sufficient access to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
The request couldn't be completed because it conflicted with the current state of the resource.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
An exception occurred with the service.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource couldn't be found.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request failed because a service quota is exceeded.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied because of request throttling. Retry the request.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
A parameter is not valid.
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.
AssociateUser
data AssociateUser Source #
See: newAssociateUser smart constructor.
Constructors
| AssociateUser' (Maybe Text) IdentityProvider Text Text |
Instances
Arguments
| :: IdentityProvider | |
| -> Text | |
| -> Text | |
| -> AssociateUser |
Create a value of AssociateUser 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:
AssociateUser, associateUser_domain - The domain name of the user.
AssociateUser, associateUser_identityProvider - The identity provider of the user.
AssociateUser, associateUser_instanceId - The ID of the EC2 instance, which provides user-based subscriptions.
AssociateUser, associateUser_username - The user name from the identity provider for the user.
data AssociateUserResponse Source #
See: newAssociateUserResponse smart constructor.
Constructors
| AssociateUserResponse' Int InstanceUserSummary |
Instances
newAssociateUserResponse Source #
Arguments
| :: Int | |
| -> InstanceUserSummary | |
| -> AssociateUserResponse |
Create a value of AssociateUserResponse 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:httpStatus:AssociateUserResponse', associateUserResponse_httpStatus - The response's http status code.
$sel:instanceUserSummary:AssociateUserResponse', associateUserResponse_instanceUserSummary - Metadata that describes the associate user operation.
DeregisterIdentityProvider
data DeregisterIdentityProvider Source #
See: newDeregisterIdentityProvider smart constructor.
Constructors
| DeregisterIdentityProvider' IdentityProvider Text |
Instances
newDeregisterIdentityProvider Source #
Arguments
| :: IdentityProvider | |
| -> Text | |
| -> DeregisterIdentityProvider |
Create a value of DeregisterIdentityProvider 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:
DeregisterIdentityProvider, deregisterIdentityProvider_identityProvider - An object that specifies details for the identity provider.
DeregisterIdentityProvider, deregisterIdentityProvider_product - The name of the user-based subscription product.
data DeregisterIdentityProviderResponse Source #
See: newDeregisterIdentityProviderResponse smart constructor.
Instances
newDeregisterIdentityProviderResponse Source #
Arguments
| :: Int | |
| -> IdentityProviderSummary |
|
| -> DeregisterIdentityProviderResponse |
Create a value of DeregisterIdentityProviderResponse 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:httpStatus:DeregisterIdentityProviderResponse', deregisterIdentityProviderResponse_httpStatus - The response's http status code.
$sel:identityProviderSummary:DeregisterIdentityProviderResponse', deregisterIdentityProviderResponse_identityProviderSummary - Metadata that describes the results of an identity provider operation.
DisassociateUser
data DisassociateUser Source #
See: newDisassociateUser smart constructor.
Constructors
| DisassociateUser' (Maybe Text) IdentityProvider Text Text |
Instances
Arguments
| :: IdentityProvider | |
| -> Text | |
| -> Text | |
| -> DisassociateUser |
Create a value of DisassociateUser 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:
DisassociateUser, disassociateUser_domain - The domain name of the user.
DisassociateUser, disassociateUser_identityProvider - An object that specifies details for the identity provider.
DisassociateUser, disassociateUser_instanceId - The ID of the EC2 instance, which provides user-based subscriptions.
DisassociateUser, disassociateUser_username - The user name from the identity provider for the user.
data DisassociateUserResponse Source #
See: newDisassociateUserResponse smart constructor.
Constructors
| DisassociateUserResponse' Int InstanceUserSummary |
Instances
newDisassociateUserResponse Source #
Arguments
| :: Int | |
| -> InstanceUserSummary | |
| -> DisassociateUserResponse |
Create a value of DisassociateUserResponse 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:httpStatus:DisassociateUserResponse', disassociateUserResponse_httpStatus - The response's http status code.
$sel:instanceUserSummary:DisassociateUserResponse', disassociateUserResponse_instanceUserSummary - Metadata that describes the associate user operation.
ListIdentityProviders (Paginated)
data ListIdentityProviders Source #
See: newListIdentityProviders smart constructor.
Constructors
| ListIdentityProviders' (Maybe Int) (Maybe Text) |
Instances
newListIdentityProviders :: ListIdentityProviders Source #
Create a value of ListIdentityProviders 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:maxResults:ListIdentityProviders', listIdentityProviders_maxResults - Maximum number of results to return in a single call.
ListIdentityProviders, listIdentityProviders_nextToken - Token for the next set of results.
data ListIdentityProvidersResponse Source #
See: newListIdentityProvidersResponse smart constructor.
Constructors
| ListIdentityProvidersResponse' (Maybe Text) Int [IdentityProviderSummary] |
Instances
newListIdentityProvidersResponse Source #
Create a value of ListIdentityProvidersResponse 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:
ListIdentityProviders, listIdentityProvidersResponse_nextToken - Token for the next set of results.
$sel:httpStatus:ListIdentityProvidersResponse', listIdentityProvidersResponse_httpStatus - The response's http status code.
$sel:identityProviderSummaries:ListIdentityProvidersResponse', listIdentityProvidersResponse_identityProviderSummaries - Metadata that describes the list identity providers operation.
ListInstances (Paginated)
data ListInstances Source #
See: newListInstances smart constructor.
Instances
newListInstances :: ListInstances Source #
Create a value of ListInstances 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:ListInstances', listInstances_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.
$sel:maxResults:ListInstances', listInstances_maxResults - Maximum number of results to return in a single call.
ListInstances, listInstances_nextToken - Token for the next set of results.
data ListInstancesResponse Source #
See: newListInstancesResponse smart constructor.
Constructors
| ListInstancesResponse' (Maybe [InstanceSummary]) (Maybe Text) Int |
Instances
newListInstancesResponse Source #
Create a value of ListInstancesResponse 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:instanceSummaries:ListInstancesResponse', listInstancesResponse_instanceSummaries - Metadata that describes the list instances operation.
ListInstances, listInstancesResponse_nextToken - Token for the next set of results.
$sel:httpStatus:ListInstancesResponse', listInstancesResponse_httpStatus - The response's http status code.
ListProductSubscriptions (Paginated)
data ListProductSubscriptions Source #
See: newListProductSubscriptions smart constructor.
Constructors
| ListProductSubscriptions' (Maybe [Filter]) (Maybe Int) (Maybe Text) IdentityProvider Text |
Instances
newListProductSubscriptions Source #
Arguments
| :: IdentityProvider | |
| -> Text | |
| -> ListProductSubscriptions |
Create a value of ListProductSubscriptions 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:ListProductSubscriptions', listProductSubscriptions_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.
$sel:maxResults:ListProductSubscriptions', listProductSubscriptions_maxResults - Maximum number of results to return in a single call.
ListProductSubscriptions, listProductSubscriptions_nextToken - Token for the next set of results.
ListProductSubscriptions, listProductSubscriptions_identityProvider - An object that specifies details for the identity provider.
ListProductSubscriptions, listProductSubscriptions_product - The name of the user-based subscription product.
data ListProductSubscriptionsResponse Source #
See: newListProductSubscriptionsResponse smart constructor.
Constructors
| ListProductSubscriptionsResponse' (Maybe Text) (Maybe [ProductUserSummary]) Int |
Instances
newListProductSubscriptionsResponse Source #
Create a value of ListProductSubscriptionsResponse 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:
ListProductSubscriptions, listProductSubscriptionsResponse_nextToken - Token for the next set of results.
$sel:productUserSummaries:ListProductSubscriptionsResponse', listProductSubscriptionsResponse_productUserSummaries - Metadata that describes the list product subscriptions operation.
$sel:httpStatus:ListProductSubscriptionsResponse', listProductSubscriptionsResponse_httpStatus - The response's http status code.
ListUserAssociations (Paginated)
data ListUserAssociations Source #
See: newListUserAssociations smart constructor.
Constructors
| ListUserAssociations' (Maybe [Filter]) (Maybe Int) (Maybe Text) IdentityProvider Text |
Instances
newListUserAssociations Source #
Create a value of ListUserAssociations 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:ListUserAssociations', listUserAssociations_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.
$sel:maxResults:ListUserAssociations', listUserAssociations_maxResults - Maximum number of results to return in a single call.
ListUserAssociations, listUserAssociations_nextToken - Token for the next set of results.
ListUserAssociations, listUserAssociations_identityProvider - An object that specifies details for the identity provider.
ListUserAssociations, listUserAssociations_instanceId - The ID of the EC2 instance, which provides user-based subscriptions.
data ListUserAssociationsResponse Source #
See: newListUserAssociationsResponse smart constructor.
Constructors
| ListUserAssociationsResponse' (Maybe [InstanceUserSummary]) (Maybe Text) Int |
Instances
newListUserAssociationsResponse Source #
Create a value of ListUserAssociationsResponse 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:instanceUserSummaries:ListUserAssociationsResponse', listUserAssociationsResponse_instanceUserSummaries - Metadata that describes the list user association operation.
ListUserAssociations, listUserAssociationsResponse_nextToken - Token for the next set of results.
$sel:httpStatus:ListUserAssociationsResponse', listUserAssociationsResponse_httpStatus - The response's http status code.
RegisterIdentityProvider
data RegisterIdentityProvider Source #
See: newRegisterIdentityProvider smart constructor.
Constructors
| RegisterIdentityProvider' (Maybe Settings) IdentityProvider Text |
Instances
newRegisterIdentityProvider Source #
Arguments
| :: IdentityProvider | |
| -> Text | |
| -> RegisterIdentityProvider |
Create a value of RegisterIdentityProvider 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:
RegisterIdentityProvider, registerIdentityProvider_settings - The registered identity provider’s product related configuration
settings such as the subnets to provision VPC endpoints.
RegisterIdentityProvider, registerIdentityProvider_identityProvider - An object that specifies details for the identity provider.
RegisterIdentityProvider, registerIdentityProvider_product - The name of the user-based subscription product.
data RegisterIdentityProviderResponse Source #
See: newRegisterIdentityProviderResponse smart constructor.
Instances
newRegisterIdentityProviderResponse Source #
Arguments
| :: Int | |
| -> IdentityProviderSummary |
|
| -> RegisterIdentityProviderResponse |
Create a value of RegisterIdentityProviderResponse 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:httpStatus:RegisterIdentityProviderResponse', registerIdentityProviderResponse_httpStatus - The response's http status code.
$sel:identityProviderSummary:RegisterIdentityProviderResponse', registerIdentityProviderResponse_identityProviderSummary - Metadata that describes the results of an identity provider operation.
StartProductSubscription
data StartProductSubscription Source #
See: newStartProductSubscription smart constructor.
Constructors
| StartProductSubscription' (Maybe Text) IdentityProvider Text Text |
Instances
newStartProductSubscription Source #
Arguments
| :: IdentityProvider | |
| -> Text | |
| -> Text | |
| -> StartProductSubscription |
Create a value of StartProductSubscription 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:
StartProductSubscription, startProductSubscription_domain - The domain name of the user.
StartProductSubscription, startProductSubscription_identityProvider - An object that specifies details for the identity provider.
StartProductSubscription, startProductSubscription_product - The name of the user-based subscription product.
StartProductSubscription, startProductSubscription_username - The user name from the identity provider of the user.
data StartProductSubscriptionResponse Source #
See: newStartProductSubscriptionResponse smart constructor.
Constructors
| StartProductSubscriptionResponse' Int ProductUserSummary |
Instances
newStartProductSubscriptionResponse Source #
Arguments
| :: Int | |
| -> ProductUserSummary | |
| -> StartProductSubscriptionResponse |
Create a value of StartProductSubscriptionResponse 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:httpStatus:StartProductSubscriptionResponse', startProductSubscriptionResponse_httpStatus - The response's http status code.
$sel:productUserSummary:StartProductSubscriptionResponse', startProductSubscriptionResponse_productUserSummary - Metadata that describes the start product subscription operation.
StopProductSubscription
data StopProductSubscription Source #
See: newStopProductSubscription smart constructor.
Constructors
| StopProductSubscription' (Maybe Text) IdentityProvider Text Text |
Instances
newStopProductSubscription Source #
Arguments
| :: IdentityProvider | |
| -> Text | |
| -> Text | |
| -> StopProductSubscription |
Create a value of StopProductSubscription 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:
StopProductSubscription, stopProductSubscription_domain - The domain name of the user.
StopProductSubscription, stopProductSubscription_identityProvider - An object that specifies details for the identity provider.
StopProductSubscription, stopProductSubscription_product - The name of the user-based subscription product.
StopProductSubscription, stopProductSubscription_username - The user name from the identity provider for the user.
data StopProductSubscriptionResponse Source #
See: newStopProductSubscriptionResponse smart constructor.
Constructors
| StopProductSubscriptionResponse' Int ProductUserSummary |
Instances
newStopProductSubscriptionResponse Source #
Arguments
| :: Int | |
| -> ProductUserSummary | |
| -> StopProductSubscriptionResponse |
Create a value of StopProductSubscriptionResponse 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:httpStatus:StopProductSubscriptionResponse', stopProductSubscriptionResponse_httpStatus - The response's http status code.
$sel:productUserSummary:StopProductSubscriptionResponse', stopProductSubscriptionResponse_productUserSummary - Metadata that describes the start product subscription operation.
UpdateIdentityProviderSettings
data UpdateIdentityProviderSettings Source #
See: newUpdateIdentityProviderSettings smart constructor.
Instances
newUpdateIdentityProviderSettings Source #
Arguments
| :: IdentityProvider | |
| -> Text | |
| -> UpdateSettings | |
| -> UpdateIdentityProviderSettings |
Create a value of UpdateIdentityProviderSettings 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:
UpdateIdentityProviderSettings, updateIdentityProviderSettings_identityProvider - Undocumented member.
UpdateIdentityProviderSettings, updateIdentityProviderSettings_product - The name of the user-based subscription product.
$sel:updateSettings:UpdateIdentityProviderSettings', updateIdentityProviderSettings_updateSettings - Updates the registered identity provider’s product related configuration
settings. You can update any combination of settings in a single
operation such as the:
- Subnets which you want to add to provision VPC endpoints.
- Subnets which you want to remove the VPC endpoints from.
- Security group ID which permits traffic to the VPC endpoints.
data UpdateIdentityProviderSettingsResponse Source #
See: newUpdateIdentityProviderSettingsResponse smart constructor.
Instances
newUpdateIdentityProviderSettingsResponse Source #
Arguments
| :: Int | |
| -> IdentityProviderSummary |
|
| -> UpdateIdentityProviderSettingsResponse |
Create a value of UpdateIdentityProviderSettingsResponse 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:httpStatus:UpdateIdentityProviderSettingsResponse', updateIdentityProviderSettingsResponse_httpStatus - The response's http status code.
$sel:identityProviderSummary:UpdateIdentityProviderSettingsResponse', updateIdentityProviderSettingsResponse_identityProviderSummary - Undocumented member.
Types
ActiveDirectoryIdentityProvider
data ActiveDirectoryIdentityProvider Source #
Details about an Active Directory identity provider.
See: newActiveDirectoryIdentityProvider smart constructor.
Constructors
| ActiveDirectoryIdentityProvider' (Maybe Text) |
Instances
newActiveDirectoryIdentityProvider :: ActiveDirectoryIdentityProvider Source #
Create a value of ActiveDirectoryIdentityProvider 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:directoryId:ActiveDirectoryIdentityProvider', activeDirectoryIdentityProvider_directoryId - The directory ID for an Active Directory identity provider.
Filter
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.
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.LicenseManagerUserSubscriptions.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.LicenseManagerUserSubscriptions.Types.Filter" "amazonka-license-manager-user-subscriptions-2.0-FTcAVPsIeL0Hw8vwEQErB1" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attribute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "operation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe 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:attribute:Filter', filter_attribute - The name of an attribute to use as a filter.
$sel:operation:Filter', filter_operation - The type of search (For example, eq, geq, leq)
$sel:value:Filter', filter_value - Value of the filter.
IdentityProvider
data IdentityProvider Source #
Details about an identity provider.
See: newIdentityProvider smart constructor.
Constructors
| IdentityProvider' (Maybe ActiveDirectoryIdentityProvider) |
Instances
newIdentityProvider :: IdentityProvider Source #
Create a value of IdentityProvider 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:activeDirectoryIdentityProvider:IdentityProvider', identityProvider_activeDirectoryIdentityProvider - An object that details an Active Directory identity provider.
IdentityProviderSummary
data IdentityProviderSummary Source #
Describes an identity provider.
See: newIdentityProviderSummary smart constructor.
Constructors
| IdentityProviderSummary' (Maybe Text) IdentityProvider Text Settings Text |
Instances
newIdentityProviderSummary Source #
Arguments
| :: IdentityProvider | |
| -> Text | |
| -> Settings | |
| -> Text | |
| -> IdentityProviderSummary |
Create a value of IdentityProviderSummary 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:failureMessage:IdentityProviderSummary', identityProviderSummary_failureMessage - The failure message associated with an identity provider.
$sel:identityProvider:IdentityProviderSummary', identityProviderSummary_identityProvider - An object that specifies details for the identity provider.
$sel:product:IdentityProviderSummary', identityProviderSummary_product - The name of the user-based subscription product.
$sel:settings:IdentityProviderSummary', identityProviderSummary_settings - An object that details the registered identity provider’s product
related configuration settings such as the subnets to provision VPC
endpoints.
$sel:status:IdentityProviderSummary', identityProviderSummary_status - The status of an identity provider.
InstanceSummary
data InstanceSummary Source #
Describes an EC2 instance providing user-based subscriptions.
See: newInstanceSummary smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> InstanceSummary |
Create a value of InstanceSummary 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:lastStatusCheckDate:InstanceSummary', instanceSummary_lastStatusCheckDate - The date of the last status check.
$sel:statusMessage:InstanceSummary', instanceSummary_statusMessage - The status message for an EC2 instance.
$sel:instanceId:InstanceSummary', instanceSummary_instanceId - The ID of the EC2 instance, which provides user-based subscriptions.
$sel:products:InstanceSummary', instanceSummary_products - A list of provided user-based subscription products.
$sel:status:InstanceSummary', instanceSummary_status - The status of an EC2 instance resource.
InstanceUserSummary
data InstanceUserSummary Source #
Describes users of an EC2 instance providing user-based subscriptions.
See: newInstanceUserSummary smart constructor.
Constructors
| InstanceUserSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) IdentityProvider Text Text Text |
Instances
newInstanceUserSummary Source #
Arguments
| :: IdentityProvider | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> InstanceUserSummary |
Create a value of InstanceUserSummary 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:associationDate:InstanceUserSummary', instanceUserSummary_associationDate - The date a user was associated with an EC2 instance.
$sel:disassociationDate:InstanceUserSummary', instanceUserSummary_disassociationDate - The date a user was disassociated from an EC2 instance.
$sel:domain:InstanceUserSummary', instanceUserSummary_domain - The domain name of the user.
$sel:statusMessage:InstanceUserSummary', instanceUserSummary_statusMessage - The status message for users of an EC2 instance.
$sel:identityProvider:InstanceUserSummary', instanceUserSummary_identityProvider - An object that specifies details for the identity provider.
$sel:instanceId:InstanceUserSummary', instanceUserSummary_instanceId - The ID of the EC2 instance, which provides user-based subscriptions.
$sel:status:InstanceUserSummary', instanceUserSummary_status - The status of a user associated with an EC2 instance.
$sel:username:InstanceUserSummary', instanceUserSummary_username - The user name from the identity provider for the user.
ProductUserSummary
data ProductUserSummary Source #
The summary of the user-based subscription products for a user.
See: newProductUserSummary smart constructor.
Constructors
| ProductUserSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) IdentityProvider Text Text Text |
Instances
newProductUserSummary Source #
Arguments
| :: IdentityProvider | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> ProductUserSummary |
Create a value of ProductUserSummary 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:domain:ProductUserSummary', productUserSummary_domain - The domain name of the user.
$sel:statusMessage:ProductUserSummary', productUserSummary_statusMessage - The status message for a product for a user.
$sel:subscriptionEndDate:ProductUserSummary', productUserSummary_subscriptionEndDate - The end date of a subscription.
$sel:subscriptionStartDate:ProductUserSummary', productUserSummary_subscriptionStartDate - The start date of a subscription.
$sel:identityProvider:ProductUserSummary', productUserSummary_identityProvider - An object that specifies details for the identity provider.
$sel:product:ProductUserSummary', productUserSummary_product - The name of the user-based subscription product.
$sel:status:ProductUserSummary', productUserSummary_status - The status of a product for a user.
$sel:username:ProductUserSummary', productUserSummary_username - The user name from the identity provider of the user.
Settings
The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints, and the security group ID that is associated with the VPC endpoints. The security group should permit inbound TCP port 1688 communication from resources in the VPC.
See: newSettings smart constructor.
Instances
| FromJSON Settings Source # | |
| ToJSON Settings Source # | |
| Generic Settings Source # | |
| Read Settings Source # | |
| Show Settings Source # | |
| NFData Settings Source # | |
| Eq Settings Source # | |
| Hashable Settings Source # | |
| type Rep Settings Source # | |
Defined in Amazonka.LicenseManagerUserSubscriptions.Types.Settings type Rep Settings = D1 ('MetaData "Settings" "Amazonka.LicenseManagerUserSubscriptions.Types.Settings" "amazonka-license-manager-user-subscriptions-2.0-FTcAVPsIeL0Hw8vwEQErB1" 'False) (C1 ('MetaCons "Settings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "securityGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "subnets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))) | |
Create a value of Settings 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:securityGroupId:Settings', settings_securityGroupId - A security group ID that allows inbound TCP port 1688 communication
between resources in your VPC and the VPC endpoint for activation
servers.
$sel:subnets:Settings', settings_subnets - The subnets defined for the registered identity provider.
UpdateSettings
data UpdateSettings Source #
Updates the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
See: newUpdateSettings smart constructor.
Constructors
| UpdateSettings' (Maybe Text) [Text] [Text] |
Instances
newUpdateSettings :: UpdateSettings Source #
Create a value of UpdateSettings 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:securityGroupId:UpdateSettings', updateSettings_securityGroupId - A security group ID that allows inbound TCP port 1688 communication
between resources in your VPC and the VPC endpoints for activation
servers.
$sel:addSubnets:UpdateSettings', updateSettings_addSubnets - The ID of one or more subnets in which License Manager will create a VPC
endpoint for products that require connectivity to activation servers.
$sel:removeSubnets:UpdateSettings', updateSettings_removeSubnets - The ID of one or more subnets to remove.