| 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.Types
Description
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 ActiveDirectoryIdentityProvider = ActiveDirectoryIdentityProvider' {
- directoryId :: Maybe Text
- newActiveDirectoryIdentityProvider :: ActiveDirectoryIdentityProvider
- activeDirectoryIdentityProvider_directoryId :: Lens' ActiveDirectoryIdentityProvider (Maybe Text)
- data Filter = Filter' {}
- newFilter :: Filter
- filter_attribute :: Lens' Filter (Maybe Text)
- filter_operation :: Lens' Filter (Maybe Text)
- filter_value :: Lens' Filter (Maybe Text)
- data IdentityProvider = IdentityProvider' {}
- newIdentityProvider :: IdentityProvider
- identityProvider_activeDirectoryIdentityProvider :: Lens' IdentityProvider (Maybe ActiveDirectoryIdentityProvider)
- data IdentityProviderSummary = IdentityProviderSummary' {}
- newIdentityProviderSummary :: IdentityProvider -> Text -> Settings -> Text -> IdentityProviderSummary
- identityProviderSummary_failureMessage :: Lens' IdentityProviderSummary (Maybe Text)
- identityProviderSummary_identityProvider :: Lens' IdentityProviderSummary IdentityProvider
- identityProviderSummary_product :: Lens' IdentityProviderSummary Text
- identityProviderSummary_settings :: Lens' IdentityProviderSummary Settings
- identityProviderSummary_status :: Lens' IdentityProviderSummary Text
- data InstanceSummary = InstanceSummary' {
- lastStatusCheckDate :: Maybe Text
- statusMessage :: Maybe Text
- instanceId :: Text
- products :: [Text]
- status :: Text
- newInstanceSummary :: Text -> Text -> InstanceSummary
- instanceSummary_lastStatusCheckDate :: Lens' InstanceSummary (Maybe Text)
- instanceSummary_statusMessage :: Lens' InstanceSummary (Maybe Text)
- instanceSummary_instanceId :: Lens' InstanceSummary Text
- instanceSummary_products :: Lens' InstanceSummary [Text]
- instanceSummary_status :: Lens' InstanceSummary Text
- data InstanceUserSummary = InstanceUserSummary' {}
- newInstanceUserSummary :: IdentityProvider -> Text -> Text -> Text -> InstanceUserSummary
- instanceUserSummary_associationDate :: Lens' InstanceUserSummary (Maybe Text)
- instanceUserSummary_disassociationDate :: Lens' InstanceUserSummary (Maybe Text)
- instanceUserSummary_domain :: Lens' InstanceUserSummary (Maybe Text)
- instanceUserSummary_statusMessage :: Lens' InstanceUserSummary (Maybe Text)
- instanceUserSummary_identityProvider :: Lens' InstanceUserSummary IdentityProvider
- instanceUserSummary_instanceId :: Lens' InstanceUserSummary Text
- instanceUserSummary_status :: Lens' InstanceUserSummary Text
- instanceUserSummary_username :: Lens' InstanceUserSummary Text
- data ProductUserSummary = ProductUserSummary' {}
- newProductUserSummary :: IdentityProvider -> Text -> Text -> Text -> ProductUserSummary
- productUserSummary_domain :: Lens' ProductUserSummary (Maybe Text)
- productUserSummary_statusMessage :: Lens' ProductUserSummary (Maybe Text)
- productUserSummary_subscriptionEndDate :: Lens' ProductUserSummary (Maybe Text)
- productUserSummary_subscriptionStartDate :: Lens' ProductUserSummary (Maybe Text)
- productUserSummary_identityProvider :: Lens' ProductUserSummary IdentityProvider
- productUserSummary_product :: Lens' ProductUserSummary Text
- productUserSummary_status :: Lens' ProductUserSummary Text
- productUserSummary_username :: Lens' ProductUserSummary Text
- data Settings = Settings' {}
- newSettings :: Text -> NonEmpty Text -> Settings
- settings_securityGroupId :: Lens' Settings Text
- settings_subnets :: Lens' Settings (NonEmpty Text)
- data UpdateSettings = UpdateSettings' {
- securityGroupId :: Maybe Text
- addSubnets :: [Text]
- removeSubnets :: [Text]
- newUpdateSettings :: UpdateSettings
- updateSettings_securityGroupId :: Lens' UpdateSettings (Maybe Text)
- updateSettings_addSubnets :: Lens' UpdateSettings [Text]
- updateSettings_removeSubnets :: Lens' UpdateSettings [Text]
Service Configuration
defaultService :: Service Source #
API version 2018-05-10 of the Amazon License Manager User Subscriptions SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have sufficient access to perform this action.
_ConflictException :: AsError a => Fold a ServiceError Source #
The request couldn't be completed because it conflicted with the current state of the resource.
_InternalServerException :: AsError a => Fold a ServiceError Source #
An exception occurred with the service.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource couldn't be found.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request failed because a service quota is exceeded.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied because of request throttling. Retry the request.
_ValidationException :: AsError a => Fold a ServiceError Source #
A parameter is not valid.
ActiveDirectoryIdentityProvider
data ActiveDirectoryIdentityProvider Source #
Details about an Active Directory identity provider.
See: newActiveDirectoryIdentityProvider smart constructor.
Constructors
| ActiveDirectoryIdentityProvider' | |
Fields
| |
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.
activeDirectoryIdentityProvider_directoryId :: Lens' ActiveDirectoryIdentityProvider (Maybe Text) Source #
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.
Constructors
| Filter' | |
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.
filter_operation :: Lens' Filter (Maybe Text) Source #
The type of search (For example, eq, geq, leq)
IdentityProvider
data IdentityProvider Source #
Details about an identity provider.
See: newIdentityProvider smart constructor.
Constructors
| IdentityProvider' | |
Fields
| |
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.
identityProvider_activeDirectoryIdentityProvider :: Lens' IdentityProvider (Maybe ActiveDirectoryIdentityProvider) Source #
An object that details an Active Directory identity provider.
IdentityProviderSummary
data IdentityProviderSummary Source #
Describes an identity provider.
See: newIdentityProviderSummary smart constructor.
Constructors
| IdentityProviderSummary' | |
Fields
| |
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.
identityProviderSummary_failureMessage :: Lens' IdentityProviderSummary (Maybe Text) Source #
The failure message associated with an identity provider.
identityProviderSummary_identityProvider :: Lens' IdentityProviderSummary IdentityProvider Source #
An object that specifies details for the identity provider.
identityProviderSummary_product :: Lens' IdentityProviderSummary Text Source #
The name of the user-based subscription product.
identityProviderSummary_settings :: Lens' IdentityProviderSummary Settings Source #
An object that details the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.
identityProviderSummary_status :: Lens' IdentityProviderSummary Text Source #
The status of an identity provider.
InstanceSummary
data InstanceSummary Source #
Describes an EC2 instance providing user-based subscriptions.
See: newInstanceSummary smart constructor.
Constructors
| InstanceSummary' | |
Fields
| |
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.
instanceSummary_lastStatusCheckDate :: Lens' InstanceSummary (Maybe Text) Source #
The date of the last status check.
instanceSummary_statusMessage :: Lens' InstanceSummary (Maybe Text) Source #
The status message for an EC2 instance.
instanceSummary_instanceId :: Lens' InstanceSummary Text Source #
The ID of the EC2 instance, which provides user-based subscriptions.
instanceSummary_products :: Lens' InstanceSummary [Text] Source #
A list of provided user-based subscription products.
instanceSummary_status :: Lens' InstanceSummary Text Source #
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' | |
Fields
| |
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.
instanceUserSummary_associationDate :: Lens' InstanceUserSummary (Maybe Text) Source #
The date a user was associated with an EC2 instance.
instanceUserSummary_disassociationDate :: Lens' InstanceUserSummary (Maybe Text) Source #
The date a user was disassociated from an EC2 instance.
instanceUserSummary_domain :: Lens' InstanceUserSummary (Maybe Text) Source #
The domain name of the user.
instanceUserSummary_statusMessage :: Lens' InstanceUserSummary (Maybe Text) Source #
The status message for users of an EC2 instance.
instanceUserSummary_identityProvider :: Lens' InstanceUserSummary IdentityProvider Source #
An object that specifies details for the identity provider.
instanceUserSummary_instanceId :: Lens' InstanceUserSummary Text Source #
The ID of the EC2 instance, which provides user-based subscriptions.
instanceUserSummary_status :: Lens' InstanceUserSummary Text Source #
The status of a user associated with an EC2 instance.
instanceUserSummary_username :: Lens' InstanceUserSummary Text Source #
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' | |
Fields
| |
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.
productUserSummary_domain :: Lens' ProductUserSummary (Maybe Text) Source #
The domain name of the user.
productUserSummary_statusMessage :: Lens' ProductUserSummary (Maybe Text) Source #
The status message for a product for a user.
productUserSummary_subscriptionEndDate :: Lens' ProductUserSummary (Maybe Text) Source #
The end date of a subscription.
productUserSummary_subscriptionStartDate :: Lens' ProductUserSummary (Maybe Text) Source #
The start date of a subscription.
productUserSummary_identityProvider :: Lens' ProductUserSummary IdentityProvider Source #
An object that specifies details for the identity provider.
productUserSummary_product :: Lens' ProductUserSummary Text Source #
The name of the user-based subscription product.
productUserSummary_status :: Lens' ProductUserSummary Text Source #
The status of a product for a user.
productUserSummary_username :: Lens' ProductUserSummary Text Source #
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.
Constructors
| Settings' | |
Fields
| |
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.
settings_securityGroupId :: Lens' Settings Text Source #
A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.
settings_subnets :: Lens' Settings (NonEmpty Text) Source #
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' | |
Fields
| |
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.
updateSettings_securityGroupId :: Lens' UpdateSettings (Maybe Text) Source #
A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoints for activation servers.
updateSettings_addSubnets :: Lens' UpdateSettings [Text] Source #
The ID of one or more subnets in which License Manager will create a VPC endpoint for products that require connectivity to activation servers.
updateSettings_removeSubnets :: Lens' UpdateSettings [Text] Source #
The ID of one or more subnets to remove.