libZSservicesZSamazonka-license-managerZSamazonka-license-manager
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.LicenseManager.Lens

Contents

Description

 
Synopsis

Operations

ListLicenseManagerReportGenerators

listLicenseManagerReportGenerators_filters :: Lens' ListLicenseManagerReportGenerators (Maybe [Filter]) Source #

Filters to scope the results. The following filters are supported:

  • LicenseConfigurationArn

listLicenseManagerReportGeneratorsResponse_reportGenerators :: Lens' ListLicenseManagerReportGeneratorsResponse (Maybe [ReportGenerator]) Source #

A report generator that creates periodic reports about your license configurations.

DeleteLicenseManagerReportGenerator

UpdateLicenseManagerReportGenerator

updateLicenseManagerReportGenerator_type :: Lens' UpdateLicenseManagerReportGenerator [ReportType] Source #

Type of reports to generate. The following report types are supported:

  • License configuration report - Reports the number and details of consumed licenses for a license configuration.
  • Resource report - Reports the tracked licenses and resource consumption for a license configuration.

updateLicenseManagerReportGenerator_clientToken :: Lens' UpdateLicenseManagerReportGenerator Text Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

ListUsageForLicenseConfiguration

listUsageForLicenseConfiguration_filters :: Lens' ListUsageForLicenseConfiguration (Maybe [Filter]) Source #

Filters to scope the results. The following filters and logical operators are supported:

  • resourceArn - The ARN of the license configuration resource. Logical operators are EQUALS | NOT_EQUALS.
  • resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators are EQUALS | NOT_EQUALS.
  • resourceAccount - The ID of the account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.

listUsageForLicenseConfiguration_maxResults :: Lens' ListUsageForLicenseConfiguration (Maybe Int) Source #

Maximum number of results to return in a single call.

CreateLicenseConfiguration

createLicenseConfiguration_licenseCount :: Lens' CreateLicenseConfiguration (Maybe Integer) Source #

Number of licenses managed by the license configuration.

createLicenseConfiguration_licenseCountHardLimit :: Lens' CreateLicenseConfiguration (Maybe Bool) Source #

Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.

createLicenseConfiguration_disassociateWhenNotFound :: Lens' CreateLicenseConfiguration (Maybe Bool) Source #

When true, disassociates a resource when software is uninstalled.

createLicenseConfiguration_licenseRules :: Lens' CreateLicenseConfiguration (Maybe [Text]) Source #

License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.

  • Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores
  • Instances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets | minimumSockets | maximumVcpus | minimumVcpus
  • Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets
  • vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus

The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.

createLicenseConfiguration_tags :: Lens' CreateLicenseConfiguration (Maybe [Tag]) Source #

Tags to add to the license configuration.

CreateLicense

createLicense_homeRegion :: Lens' CreateLicense Text Source #

Home Region for the license.

createLicense_validity :: Lens' CreateLicense DatetimeRange Source #

Date and time range during which the license is valid, in ISO8601-UTC format.

createLicense_consumptionConfiguration :: Lens' CreateLicense ConsumptionConfiguration Source #

Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.

createLicense_clientToken :: Lens' CreateLicense Text Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createLicenseResponse_licenseArn :: Lens' CreateLicenseResponse (Maybe Text) Source #

Amazon Resource Name (ARN) of the license.

ListLicenseConversionTasks

listLicenseConversionTasks_filters :: Lens' ListLicenseConversionTasks (Maybe [Filter]) Source #

Filters to scope the results. Valid filters are ResourceArns and Status.

listLicenseConversionTasks_maxResults :: Lens' ListLicenseConversionTasks (Maybe Int) Source #

Maximum number of results to return in a single call.

ListResourceInventory

listResourceInventory_filters :: Lens' ListResourceInventory (Maybe [InventoryFilter]) Source #

Filters to scope the results. The following filters and logical operators are supported:

  • account_id - The ID of the Amazon Web Services account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.
  • application_name - The name of the application. Logical operators are EQUALS | BEGINS_WITH.
  • license_included - The type of license included. Logical operators are EQUALS | NOT_EQUALS. Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.
  • platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH.
  • resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS.
  • tag:<key> - The key/value combination of a tag assigned to the resource. Logical operators are EQUALS (single account) or EQUALS | NOT_EQUALS (cross account).

listResourceInventory_maxResults :: Lens' ListResourceInventory (Maybe Int) Source #

Maximum number of results to return in a single call.

DeleteToken

DeleteLicenseConfiguration

UpdateLicenseConfiguration

updateLicenseConfiguration_licenseCount :: Lens' UpdateLicenseConfiguration (Maybe Integer) Source #

New number of licenses managed by the license configuration.

updateLicenseConfiguration_disassociateWhenNotFound :: Lens' UpdateLicenseConfiguration (Maybe Bool) Source #

When true, disassociates a resource when software is uninstalled.

updateLicenseConfiguration_licenseRules :: Lens' UpdateLicenseConfiguration (Maybe [Text]) Source #

New license rule. The only rule that you can add after you create a license configuration is licenseAffinityToHost.

updateLicenseConfiguration_licenseConfigurationArn :: Lens' UpdateLicenseConfiguration Text Source #

Amazon Resource Name (ARN) of the license configuration.

CheckInLicense

ListTokens

listTokens_filters :: Lens' ListTokens (Maybe [Filter]) Source #

Filters to scope the results. The following filter is supported:

  • LicenseArns

listTokens_nextToken :: Lens' ListTokens (Maybe Text) Source #

Token for the next set of results.

listTokens_maxResults :: Lens' ListTokens (Maybe Natural) Source #

Maximum number of results to return in a single call.

listTokensResponse_nextToken :: Lens' ListTokensResponse (Maybe Text) Source #

Token for the next set of results.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

Amazon Resource Name (ARN) of the license configuration.

CreateGrant

createGrant_clientToken :: Lens' CreateGrant Text Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createGrant_licenseArn :: Lens' CreateGrant Text Source #

Amazon Resource Name (ARN) of the license.

createGrant_homeRegion :: Lens' CreateGrant Text Source #

Home Region of the grant.

UpdateLicenseSpecificationsForResource

updateLicenseSpecificationsForResource_resourceArn :: Lens' UpdateLicenseSpecificationsForResource Text Source #

Amazon Resource Name (ARN) of the Amazon Web Services resource.

CreateLicenseVersion

createLicenseVersion_licenseArn :: Lens' CreateLicenseVersion Text Source #

Amazon Resource Name (ARN) of the license.

createLicenseVersion_validity :: Lens' CreateLicenseVersion DatetimeRange Source #

Date and time range during which the license is valid, in ISO8601-UTC format.

createLicenseVersion_consumptionConfiguration :: Lens' CreateLicenseVersion ConsumptionConfiguration Source #

Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.

createLicenseVersion_clientToken :: Lens' CreateLicenseVersion Text Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

GetLicense

getLicense_licenseArn :: Lens' GetLicense Text Source #

Amazon Resource Name (ARN) of the license.

GetLicenseConfiguration

getLicenseConfiguration_licenseConfigurationArn :: Lens' GetLicenseConfiguration Text Source #

Amazon Resource Name (ARN) of the license configuration.

getLicenseConfigurationResponse_disassociateWhenNotFound :: Lens' GetLicenseConfigurationResponse (Maybe Bool) Source #

When true, disassociates a resource when software is uninstalled.

ListReceivedGrants

listReceivedGrants_filters :: Lens' ListReceivedGrants (Maybe [Filter]) Source #

Filters to scope the results. The following filters are supported:

  • ProductSKU
  • LicenseIssuerName
  • LicenseArn
  • GrantStatus
  • GranterAccountId

listReceivedGrants_nextToken :: Lens' ListReceivedGrants (Maybe Text) Source #

Token for the next set of results.

listReceivedGrants_grantArns :: Lens' ListReceivedGrants (Maybe [Text]) Source #

Amazon Resource Names (ARNs) of the grants.

listReceivedGrants_maxResults :: Lens' ListReceivedGrants (Maybe Natural) Source #

Maximum number of results to return in a single call.

GetLicenseConversionTask

getLicenseConversionTask_licenseConversionTaskId :: Lens' GetLicenseConversionTask Text Source #

ID of the license type conversion task to retrieve information on.

getLicenseConversionTaskResponse_startTime :: Lens' GetLicenseConversionTaskResponse (Maybe UTCTime) Source #

Time at which the license type conversion task was started .

getLicenseConversionTaskResponse_resourceArn :: Lens' GetLicenseConversionTaskResponse (Maybe Text) Source #

Amazon Resource Names (ARN) of the resources the license conversion task is associated with.

getLicenseConversionTaskResponse_endTime :: Lens' GetLicenseConversionTaskResponse (Maybe UTCTime) Source #

Time at which the license type conversion task was completed.

GetLicenseUsage

getLicenseUsage_licenseArn :: Lens' GetLicenseUsage Text Source #

Amazon Resource Name (ARN) of the license.

ExtendLicenseConsumption

extendLicenseConsumption_dryRun :: Lens' ExtendLicenseConsumption (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request. Provides an error response if you do not have the required permissions.

extendLicenseConsumptionResponse_expiration :: Lens' ExtendLicenseConsumptionResponse (Maybe Text) Source #

Date and time at which the license consumption expires.

GetGrant

getGrant_grantArn :: Lens' GetGrant Text Source #

Amazon Resource Name (ARN) of the grant.

getGrantResponse_httpStatus :: Lens' GetGrantResponse Int Source #

The response's http status code.

CheckoutLicense

checkoutLicense_keyFingerprint :: Lens' CheckoutLicense Text Source #

Key fingerprint identifying the license.

checkoutLicense_clientToken :: Lens' CheckoutLicense Text Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

checkoutLicenseResponse_expiration :: Lens' CheckoutLicenseResponse (Maybe Text) Source #

Date and time at which the license checkout expires.

checkoutLicenseResponse_issuedAt :: Lens' CheckoutLicenseResponse (Maybe Text) Source #

Date and time at which the license checkout is issued.

checkoutLicenseResponse_licenseArn :: Lens' CheckoutLicenseResponse (Maybe Text) Source #

Amazon Resource Name (ARN) of the checkout license.

CreateLicenseConversionTaskForResource

createLicenseConversionTaskForResource_resourceArn :: Lens' CreateLicenseConversionTaskForResource Text Source #

Amazon Resource Name (ARN) of the resource you are converting the license type for.

createLicenseConversionTaskForResource_sourceLicenseContext :: Lens' CreateLicenseConversionTaskForResource LicenseConversionContext Source #

Information that identifies the license type you are converting from. For the structure of the source license, see Convert a license type using the AWS CLI in the License Manager User Guide.

createLicenseConversionTaskForResource_destinationLicenseContext :: Lens' CreateLicenseConversionTaskForResource LicenseConversionContext Source #

Information that identifies the license type you are converting to. For the structure of the destination license, see Convert a license type using the AWS CLI in the License Manager User Guide.

AcceptGrant

acceptGrant_grantArn :: Lens' AcceptGrant Text Source #

Amazon Resource Name (ARN) of the grant.

ListLicenseSpecificationsForResource

listLicenseSpecificationsForResource_resourceArn :: Lens' ListLicenseSpecificationsForResource Text Source #

Amazon Resource Name (ARN) of a resource that has an associated license configuration.

CheckoutBorrowLicense

checkoutBorrowLicense_licenseArn :: Lens' CheckoutBorrowLicense Text Source #

Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.

checkoutBorrowLicense_entitlements :: Lens' CheckoutBorrowLicense [EntitlementData] Source #

License entitlements. Partial checkouts are not supported.

checkoutBorrowLicense_digitalSignatureMethod :: Lens' CheckoutBorrowLicense DigitalSignatureMethod Source #

Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.

checkoutBorrowLicense_clientToken :: Lens' CheckoutBorrowLicense Text Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

checkoutBorrowLicenseResponse_expiration :: Lens' CheckoutBorrowLicenseResponse (Maybe Text) Source #

Date and time at which the license checkout expires.

checkoutBorrowLicenseResponse_issuedAt :: Lens' CheckoutBorrowLicenseResponse (Maybe Text) Source #

Date and time at which the license checkout is issued.

GetServiceSettings

getServiceSettingsResponse_snsTopicArn :: Lens' GetServiceSettingsResponse (Maybe Text) Source #

SNS topic configured to receive notifications from License Manager.

getServiceSettingsResponse_licenseManagerResourceShareArn :: Lens' GetServiceSettingsResponse (Maybe Text) Source #

Amazon Resource Name (ARN) of the resource share. The License Manager management account provides member accounts with access to this share.

getServiceSettingsResponse_s3BucketArn :: Lens' GetServiceSettingsResponse (Maybe Text) Source #

Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.

getServiceSettingsResponse_organizationConfiguration :: Lens' GetServiceSettingsResponse (Maybe OrganizationConfiguration) Source #

Indicates whether Organizations is integrated with License Manager for cross-account discovery.

RejectGrant

rejectGrant_grantArn :: Lens' RejectGrant Text Source #

Amazon Resource Name (ARN) of the grant.

UpdateServiceSettings

updateServiceSettings_snsTopicArn :: Lens' UpdateServiceSettings (Maybe Text) Source #

Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.

updateServiceSettings_s3BucketArn :: Lens' UpdateServiceSettings (Maybe Text) Source #

Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information is stored.

updateServiceSettings_organizationConfiguration :: Lens' UpdateServiceSettings (Maybe OrganizationConfiguration) Source #

Enables integration with Organizations for cross-account discovery.

ListDistributedGrants

listDistributedGrants_filters :: Lens' ListDistributedGrants (Maybe [Filter]) Source #

Filters to scope the results. The following filters are supported:

  • LicenseArn
  • GrantStatus
  • GranteePrincipalARN
  • ProductSKU
  • LicenseIssuerName

listDistributedGrants_grantArns :: Lens' ListDistributedGrants (Maybe [Text]) Source #

Amazon Resource Names (ARNs) of the grants.

listDistributedGrants_maxResults :: Lens' ListDistributedGrants (Maybe Natural) Source #

Maximum number of results to return in a single call.

ListFailuresForLicenseConfigurationOperations

DeleteGrant

deleteGrant_statusReason :: Lens' DeleteGrant (Maybe Text) Source #

The Status reason for the delete request.

deleteGrant_grantArn :: Lens' DeleteGrant Text Source #

Amazon Resource Name (ARN) of the grant.

deleteGrant_version :: Lens' DeleteGrant Text Source #

Current version of the grant.

CreateToken

createToken_tokenProperties :: Lens' CreateToken (Maybe [Text]) Source #

Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.

createToken_roleArns :: Lens' CreateToken (Maybe [Text]) Source #

Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use.

createToken_expirationInDays :: Lens' CreateToken (Maybe Int) Source #

Token expiration, in days, counted from token creation. The default is 365 days.

createToken_licenseArn :: Lens' CreateToken Text Source #

Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.

createToken_clientToken :: Lens' CreateToken Text Source #

Idempotency token, valid for 10 minutes.

createTokenResponse_token :: Lens' CreateTokenResponse (Maybe Text) Source #

Refresh token, encoded as a JWT token.

DeleteLicense

deleteLicense_licenseArn :: Lens' DeleteLicense Text Source #

Amazon Resource Name (ARN) of the license.

deleteLicense_sourceVersion :: Lens' DeleteLicense Text Source #

Current version of the license.

ListLicenses

listLicenses_filters :: Lens' ListLicenses (Maybe [Filter]) Source #

Filters to scope the results. The following filters are supported:

  • Beneficiary
  • ProductSKU
  • Fingerprint
  • Status

listLicenses_nextToken :: Lens' ListLicenses (Maybe Text) Source #

Token for the next set of results.

listLicenses_licenseArns :: Lens' ListLicenses (Maybe [Text]) Source #

Amazon Resource Names (ARNs) of the licenses.

listLicenses_maxResults :: Lens' ListLicenses (Maybe Natural) Source #

Maximum number of results to return in a single call.

ListLicenseConfigurations

listLicenseConfigurations_filters :: Lens' ListLicenseConfigurations (Maybe [Filter]) Source #

Filters to scope the results. The following filters and logical operators are supported:

  • licenseCountingType - The dimension for which licenses are counted. Possible values are vCPU | Instance | Core | Socket. Logical operators are EQUALS | NOT_EQUALS.
  • enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used. Logical operators are EQUALS | NOT_EQUALS.
  • usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded. Logical operators are EQUALS | NOT_EQUALS.

listLicenseConfigurations_licenseConfigurationArns :: Lens' ListLicenseConfigurations (Maybe [Text]) Source #

Amazon Resource Names (ARN) of the license configurations.

listLicenseConfigurations_maxResults :: Lens' ListLicenseConfigurations (Maybe Int) Source #

Maximum number of results to return in a single call.

ListReceivedLicenses

listReceivedLicenses_filters :: Lens' ListReceivedLicenses (Maybe [Filter]) Source #

Filters to scope the results. The following filters are supported:

  • ProductSKU
  • Status
  • Fingerprint
  • IssuerName
  • Beneficiary

listReceivedLicenses_licenseArns :: Lens' ListReceivedLicenses (Maybe [Text]) Source #

Amazon Resource Names (ARNs) of the licenses.

listReceivedLicenses_maxResults :: Lens' ListReceivedLicenses (Maybe Natural) Source #

Maximum number of results to return in a single call.

CreateGrantVersion

createGrantVersion_clientToken :: Lens' CreateGrantVersion Text Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createGrantVersion_grantArn :: Lens' CreateGrantVersion Text Source #

Amazon Resource Name (ARN) of the grant.

ListAssociationsForLicenseConfiguration

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

Amazon Resource Name (ARN) of the license configuration.

ListLicenseVersions

listLicenseVersions_maxResults :: Lens' ListLicenseVersions (Maybe Natural) Source #

Maximum number of results to return in a single call.

listLicenseVersions_licenseArn :: Lens' ListLicenseVersions Text Source #

Amazon Resource Name (ARN) of the license.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

Amazon Resource Name (ARN) of the license configuration.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

Keys identifying the tags to remove.

GetLicenseManagerReportGenerator

getLicenseManagerReportGeneratorResponse_reportGenerator :: Lens' GetLicenseManagerReportGeneratorResponse (Maybe ReportGenerator) Source #

A report generator that creates periodic reports about your license configurations.

GetAccessToken

getAccessToken_tokenProperties :: Lens' GetAccessToken (Maybe [Text]) Source #

Token properties to validate against those present in the JWT token.

getAccessToken_token :: Lens' GetAccessToken Text Source #

Refresh token, encoded as a JWT token.

CreateLicenseManagerReportGenerator

createLicenseManagerReportGenerator_type :: Lens' CreateLicenseManagerReportGenerator [ReportType] Source #

Type of reports to generate. The following report types an be generated:

  • License configuration report - Reports the number and details of consumed licenses for a license configuration.
  • Resource report - Reports the tracked licenses and resource consumption for a license configuration.

createLicenseManagerReportGenerator_reportContext :: Lens' CreateLicenseManagerReportGenerator ReportContext Source #

Defines the type of license configuration the report generator tracks.

createLicenseManagerReportGenerator_reportFrequency :: Lens' CreateLicenseManagerReportGenerator ReportFrequency Source #

Frequency by which reports are generated. Reports can be generated daily, monthly, or weekly.

createLicenseManagerReportGenerator_clientToken :: Lens' CreateLicenseManagerReportGenerator Text Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Types

AutomatedDiscoveryInformation

BorrowConfiguration

borrowConfiguration_allowEarlyCheckIn :: Lens' BorrowConfiguration Bool Source #

Indicates whether early check-ins are allowed.

borrowConfiguration_maxTimeToLiveInMinutes :: Lens' BorrowConfiguration Int Source #

Maximum time for the borrow configuration, in minutes.

ConsumedLicenseSummary

consumedLicenseSummary_resourceType :: Lens' ConsumedLicenseSummary (Maybe ResourceType) Source #

Resource type of the resource consuming a license.

ConsumptionConfiguration

DatetimeRange

datetimeRange_begin :: Lens' DatetimeRange Text Source #

Start of the time range.

Entitlement

entitlement_maxCount :: Lens' Entitlement (Maybe Integer) Source #

Maximum entitlement count. Use if the unit is not None.

entitlement_value :: Lens' Entitlement (Maybe Text) Source #

Entitlement resource. Use only if the unit is None.

entitlement_overage :: Lens' Entitlement (Maybe Bool) Source #

Indicates whether overages are allowed.

entitlement_allowCheckIn :: Lens' Entitlement (Maybe Bool) Source #

Indicates whether check-ins are allowed.

EntitlementData

EntitlementUsage

entitlementUsage_maxCount :: Lens' EntitlementUsage (Maybe Text) Source #

Maximum entitlement usage count.

Filter

filter_values :: Lens' Filter (Maybe [Text]) Source #

Filter values. Filter values are case-sensitive.

filter_name :: Lens' Filter (Maybe Text) Source #

Name of the filter. Filter names are case-sensitive.

Grant

grant_statusReason :: Lens' Grant (Maybe Text) Source #

Grant status reason.

grant_grantArn :: Lens' Grant Text Source #

Amazon Resource Name (ARN) of the grant.

grant_granteePrincipalArn :: Lens' Grant Text Source #

The grantee principal ARN.

grant_homeRegion :: Lens' Grant Text Source #

Home Region of the grant.

GrantedLicense

grantedLicense_homeRegion :: Lens' GrantedLicense (Maybe Text) Source #

Home Region of the granted license.

grantedLicense_version :: Lens' GrantedLicense (Maybe Text) Source #

Version of the granted license.

grantedLicense_validity :: Lens' GrantedLicense (Maybe DatetimeRange) Source #

Date and time range during which the granted license is valid, in ISO8601-UTC format.

grantedLicense_licenseArn :: Lens' GrantedLicense (Maybe Text) Source #

Amazon Resource Name (ARN) of the license.

grantedLicense_createTime :: Lens' GrantedLicense (Maybe Text) Source #

Creation time of the granted license.

InventoryFilter

Issuer

issuer_signKey :: Lens' Issuer (Maybe Text) Source #

Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

IssuerDetails

issuerDetails_signKey :: Lens' IssuerDetails (Maybe Text) Source #

Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

License

license_homeRegion :: Lens' License (Maybe Text) Source #

Home Region of the license.

license_validity :: Lens' License (Maybe DatetimeRange) Source #

Date and time range during which the license is valid, in ISO8601-UTC format.

license_consumptionConfiguration :: Lens' License (Maybe ConsumptionConfiguration) Source #

Configuration for consumption of the license.

license_licenseArn :: Lens' License (Maybe Text) Source #

Amazon Resource Name (ARN) of the license.

license_createTime :: Lens' License (Maybe Text) Source #

License creation time.

LicenseConfiguration

licenseConfiguration_status :: Lens' LicenseConfiguration (Maybe Text) Source #

Status of the license configuration.

licenseConfiguration_ownerAccountId :: Lens' LicenseConfiguration (Maybe Text) Source #

Account ID of the license configuration's owner.

licenseConfiguration_licenseCount :: Lens' LicenseConfiguration (Maybe Integer) Source #

Number of licenses managed by the license configuration.

licenseConfiguration_name :: Lens' LicenseConfiguration (Maybe Text) Source #

Name of the license configuration.

licenseConfiguration_licenseCountHardLimit :: Lens' LicenseConfiguration (Maybe Bool) Source #

Number of available licenses as a hard limit.

licenseConfiguration_disassociateWhenNotFound :: Lens' LicenseConfiguration (Maybe Bool) Source #

When true, disassociates a resource when software is uninstalled.

licenseConfiguration_description :: Lens' LicenseConfiguration (Maybe Text) Source #

Description of the license configuration.

licenseConfiguration_licenseConfigurationArn :: Lens' LicenseConfiguration (Maybe Text) Source #

Amazon Resource Name (ARN) of the license configuration.

LicenseConfigurationAssociation

licenseConfigurationAssociation_amiAssociationScope :: Lens' LicenseConfigurationAssociation (Maybe Text) Source #

Scope of AMI associations. The possible value is cross-account.

licenseConfigurationAssociation_associationTime :: Lens' LicenseConfigurationAssociation (Maybe UTCTime) Source #

Time when the license configuration was associated with the resource.

licenseConfigurationAssociation_resourceOwnerId :: Lens' LicenseConfigurationAssociation (Maybe Text) Source #

ID of the Amazon Web Services account that owns the resource consuming licenses.

LicenseConfigurationUsage

licenseConfigurationUsage_associationTime :: Lens' LicenseConfigurationUsage (Maybe UTCTime) Source #

Time when the license configuration was initially associated with the resource.

LicenseConversionContext

licenseConversionContext_usageOperation :: Lens' LicenseConversionContext (Maybe Text) Source #

The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform

LicenseConversionTask

licenseConversionTask_startTime :: Lens' LicenseConversionTask (Maybe UTCTime) Source #

The time the conversion task was started at.

licenseConversionTask_destinationLicenseContext :: Lens' LicenseConversionTask (Maybe LicenseConversionContext) Source #

Information about the license type this conversion task converted to.

licenseConversionTask_resourceArn :: Lens' LicenseConversionTask (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource associated with the license type conversion task.

licenseConversionTask_statusMessage :: Lens' LicenseConversionTask (Maybe Text) Source #

The status message for the conversion task.

licenseConversionTask_endTime :: Lens' LicenseConversionTask (Maybe UTCTime) Source #

The time the conversion task was completed.

licenseConversionTask_licenseConversionTime :: Lens' LicenseConversionTask (Maybe UTCTime) Source #

The time the usage operation value of the resource was changed.

licenseConversionTask_sourceLicenseContext :: Lens' LicenseConversionTask (Maybe LicenseConversionContext) Source #

Information about the license type this conversion task converted from.

LicenseOperationFailure

licenseOperationFailure_operationRequestedBy :: Lens' LicenseOperationFailure (Maybe Text) Source #

The requester is "License Manager Automated Discovery".

licenseOperationFailure_resourceArn :: Lens' LicenseOperationFailure (Maybe Text) Source #

Amazon Resource Name (ARN) of the resource.

licenseOperationFailure_resourceOwnerId :: Lens' LicenseOperationFailure (Maybe Text) Source #

ID of the Amazon Web Services account that owns the resource.

LicenseSpecification

licenseSpecification_amiAssociationScope :: Lens' LicenseSpecification (Maybe Text) Source #

Scope of AMI associations. The possible value is cross-account.

licenseSpecification_licenseConfigurationArn :: Lens' LicenseSpecification Text Source #

Amazon Resource Name (ARN) of the license configuration.

LicenseUsage

ManagedResourceSummary

Metadata

OrganizationConfiguration

ProductInformation

productInformation_resourceType :: Lens' ProductInformation Text Source #

Resource type. The possible values are SSM_MANAGED | RDS.

productInformation_productInformationFilterList :: Lens' ProductInformation [ProductInformationFilter] Source #

A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.

Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.

The following filters and are supported when the resource type is SSM_MANAGED:

  • Application Name - The name of the application. Logical operator is EQUALS.
  • Application Publisher - The publisher of the application. Logical operator is EQUALS.
  • Application Version - The version of the application. Logical operator is EQUALS.
  • Platform Name - The name of the platform. Logical operator is EQUALS.
  • Platform Type - The platform type. Logical operator is EQUALS.
  • Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.
  • AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.
  • License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

The following filters and logical operators are supported when the resource type is RDS:

  • Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2.
  • License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.

ProductInformationFilter

ProvisionalConfiguration

provisionalConfiguration_maxTimeToLiveInMinutes :: Lens' ProvisionalConfiguration Int Source #

Maximum time for the provisional configuration, in minutes.

ReceivedMetadata

ReportContext

reportContext_licenseConfigurationArns :: Lens' ReportContext [Text] Source #

Amazon Resource Name (ARN) of the license configuration that this generator reports on.

ReportFrequency

reportFrequency_period :: Lens' ReportFrequency (Maybe ReportFrequencyType) Source #

Time period between each report. The period can be daily, weekly, or monthly.

reportFrequency_value :: Lens' ReportFrequency (Maybe Int) Source #

Number of times within the frequency period that a report is generated. The only supported value is 1.

ReportGenerator

reportGenerator_lastRunFailureReason :: Lens' ReportGenerator (Maybe Text) Source #

Failure message for the last report generation attempt.

reportGenerator_lastRunStatus :: Lens' ReportGenerator (Maybe Text) Source #

Status of the last report generation attempt.

reportGenerator_reportFrequency :: Lens' ReportGenerator (Maybe ReportFrequency) Source #

Details about how frequently reports are generated.

reportGenerator_s3Location :: Lens' ReportGenerator (Maybe S3Location) Source #

Details of the S3 bucket that report generator reports are published to.

reportGenerator_licenseManagerReportGeneratorArn :: Lens' ReportGenerator (Maybe Text) Source #

Amazon Resource Name (ARN) of the report generator.

reportGenerator_reportCreatorAccount :: Lens' ReportGenerator (Maybe Text) Source #

The Amazon Web Services account ID used to create the report generator.

reportGenerator_description :: Lens' ReportGenerator (Maybe Text) Source #

Description of the report generator.

reportGenerator_reportType :: Lens' ReportGenerator (Maybe [ReportType]) Source #

Type of reports that are generated.

reportGenerator_tags :: Lens' ReportGenerator (Maybe [Tag]) Source #

Tags associated with the report generator.

reportGenerator_reportContext :: Lens' ReportGenerator (Maybe ReportContext) Source #

License configuration type for this generator.

ResourceInventory

resourceInventory_platformVersion :: Lens' ResourceInventory (Maybe Text) Source #

Platform version of the resource in the inventory.

resourceInventory_resourceArn :: Lens' ResourceInventory (Maybe Text) Source #

Amazon Resource Name (ARN) of the resource.

S3Location

s3Location_bucket :: Lens' S3Location (Maybe Text) Source #

Name of the S3 bucket reports are published to.

s3Location_keyPrefix :: Lens' S3Location (Maybe Text) Source #

Prefix of the S3 bucket reports are published to.

Tag

TokenData

tokenData_status :: Lens' TokenData (Maybe Text) Source #

Token status. The possible values are AVAILABLE and DELETED.

tokenData_tokenProperties :: Lens' TokenData (Maybe [Text]) Source #

Data specified by the caller.

tokenData_roleArns :: Lens' TokenData (Maybe [Text]) Source #

Amazon Resource Names (ARN) of the roles included in the token.

tokenData_tokenType :: Lens' TokenData (Maybe Text) Source #

Type of token generated. The supported value is REFRESH_TOKEN.

tokenData_expirationTime :: Lens' TokenData (Maybe Text) Source #

Token expiration time, in ISO8601-UTC format.

tokenData_licenseArn :: Lens' TokenData (Maybe Text) Source #

Amazon Resource Name (ARN) of the license.