AWS.Tools.LicenseManager.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.LicenseManager</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.LICM.AddLICMResourceTagCmdlet"> <summary> Attach one of more tags to any resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.AddLICMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>Resource of the ARN to be tagged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.AddLICMResourceTagCmdlet.Tag"> <summary> <para> <para>Names of the tags to attach to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.AddLICMResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.AddLICMResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LICM.GetLICMAssociationsForLicenseConfigurationListCmdlet"> <summary> Lists the resource associations for a license configuration. Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance may not consume a license (depending on the license rules). Use this operation to find all resources associated with a license configuration.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMAssociationsForLicenseConfigurationListCmdlet.LicenseConfigurationArn"> <summary> <para> <para>ARN of a <code>LicenseConfiguration</code> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMAssociationsForLicenseConfigurationListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMAssociationsForLicenseConfigurationListCmdlet.NextToken"> <summary> <para> <para>Token for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LICM.GetLICMLicenseConfigurationCmdlet"> <summary> Returns a detailed description of a license configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMLicenseConfigurationCmdlet.LicenseConfigurationArn"> <summary> <para> <para>ARN of the license configuration being requested.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LICM.GetLICMLicenseConfigurationListCmdlet"> <summary> Lists license configuration objects for an account, each containing the name, description, license type, and other license terms modeled from a license agreement.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMLicenseConfigurationListCmdlet.Filter"> <summary> <para> <para>One or more filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMLicenseConfigurationListCmdlet.LicenseConfigurationArn"> <summary> <para> <para>An array of ARNs for the calling account’s license configurations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMLicenseConfigurationListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMLicenseConfigurationListCmdlet.NextToken"> <summary> <para> <para>Token for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LICM.GetLICMLicenseSpecificationsForResourceListCmdlet"> <summary> Returns the license configuration for a resource.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMLicenseSpecificationsForResourceListCmdlet.ResourceArn"> <summary> <para> <para>ARN of an AMI or Amazon EC2 instance that has an associated license configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMLicenseSpecificationsForResourceListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMLicenseSpecificationsForResourceListCmdlet.NextToken"> <summary> <para> <para>Token for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LICM.GetLICMResourceInventoryListCmdlet"> <summary> Returns a detailed list of resources.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMResourceInventoryListCmdlet.Filter"> <summary> <para> <para>One or more filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMResourceInventoryListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMResourceInventoryListCmdlet.NextToken"> <summary> <para> <para>Token for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LICM.GetLICMResourceTagListCmdlet"> <summary> Lists tags attached to a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMResourceTagListCmdlet.ResourceArn"> <summary> <para> <para>ARN for the resource.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LICM.GetLICMServiceSettingCmdlet"> <summary> Gets License Manager settings for a region. Exposes the configured S3 bucket, SNS topic, etc., for inspection. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LICM.GetLICMUsageForLicenseConfigurationListCmdlet"> <summary> Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMUsageForLicenseConfigurationListCmdlet.Filter"> <summary> <para> <para>List of filters to apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMUsageForLicenseConfigurationListCmdlet.LicenseConfigurationArn"> <summary> <para> <para>ARN of the targeted <code>LicenseConfiguration</code> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMUsageForLicenseConfigurationListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.GetLICMUsageForLicenseConfigurationListCmdlet.NextToken"> <summary> <para> <para>Token for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LICM.NewLICMLicenseConfigurationCmdlet"> <summary> Creates a new license configuration object. A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or VCPU), tenancy (shared tenancy, Amazon EC2 Dedicated Instance, Amazon EC2 Dedicated Host, or any of these), host affinity (how long a VM must be associated with a host), the number of licenses purchased and used. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.NewLICMLicenseConfigurationCmdlet.Description"> <summary> <para> <para>Human-friendly description of the license configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.NewLICMLicenseConfigurationCmdlet.LicenseCount"> <summary> <para> <para>Number of licenses managed by the license configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.NewLICMLicenseConfigurationCmdlet.LicenseCountHardLimit"> <summary> <para> <para>Flag indicating whether hard or soft license enforcement is used. Exceeding a hard limit results in the blocked deployment of new instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.NewLICMLicenseConfigurationCmdlet.LicenseCountingType"> <summary> <para> <para>Dimension to use to track the license inventory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.NewLICMLicenseConfigurationCmdlet.LicenseRule"> <summary> <para> <para>Array of configured License Manager rules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.NewLICMLicenseConfigurationCmdlet.Name"> <summary> <para> <para>Name of the license configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.NewLICMLicenseConfigurationCmdlet.Tag"> <summary> <para> <para>The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags .</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.NewLICMLicenseConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LICM.RemoveLICMLicenseConfigurationCmdlet"> <summary> Deletes an existing license configuration. This action fails if the configuration is in use. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.RemoveLICMLicenseConfigurationCmdlet.LicenseConfigurationArn"> <summary> <para> <para>Unique ID of the configuration object to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.RemoveLICMLicenseConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the LicenseConfigurationArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.RemoveLICMLicenseConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LICM.RemoveLICMResourceTagCmdlet"> <summary> Remove tags from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.RemoveLICMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.RemoveLICMResourceTagCmdlet.TagKey"> <summary> <para> <para>List keys identifying tags to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.RemoveLICMResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.RemoveLICMResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseConfigurationCmdlet"> <summary> Modifies the attributes of an existing license configuration object. A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (Instances, cores, sockets, VCPUs), tenancy (shared or Dedicated Host), host affinity (how long a VM is associated with a host), the number of licenses purchased and used. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseConfigurationCmdlet.Description"> <summary> <para> <para>New human-friendly description of the license configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseConfigurationCmdlet.LicenseConfigurationArn"> <summary> <para> <para>ARN for a license configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseConfigurationCmdlet.LicenseConfigurationStatus"> <summary> <para> <para>New status of the license configuration (<code>ACTIVE</code> or <code>INACTIVE</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseConfigurationCmdlet.LicenseCount"> <summary> <para> <para>New number of licenses managed by the license configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseConfigurationCmdlet.LicenseCountHardLimit"> <summary> <para> <para>Sets the number of available licenses as a hard limit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseConfigurationCmdlet.LicenseRule"> <summary> <para> <para>List of flexible text strings designating license rules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseConfigurationCmdlet.Name"> <summary> <para> <para>New name of the license configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the LicenseConfigurationArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseSpecificationsForResourceCmdlet"> <summary> Adds or removes license configurations for a specified AWS resource. This operation currently supports updating the license specifications of AMIs, instances, and hosts. Launch templates and AWS CloudFormation templates are not managed from this operation as those resources send the license configurations directly to a resource creation operation, such as <code>RunInstances</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseSpecificationsForResourceCmdlet.AddLicenseSpecification"> <summary> <para> <para>License configuration ARNs to be added to a resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseSpecificationsForResourceCmdlet.RemoveLicenseSpecification"> <summary> <para> <para>License configuration ARNs to be removed from a resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseSpecificationsForResourceCmdlet.ResourceArn"> <summary> <para> <para>ARN for an AWS server resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseSpecificationsForResourceCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMLicenseSpecificationsForResourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMServiceSettingCmdlet"> <summary> Updates License Manager service settings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMServiceSettingCmdlet.EnableCrossAccountsDiscovery"> <summary> <para> <para>Activates cross-account discovery.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMServiceSettingCmdlet.OrganizationConfiguration_EnableIntegration"> <summary> <para> <para>Flag to activate AWS Organization integration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMServiceSettingCmdlet.S3BucketArn"> <summary> <para> <para>ARN of the Amazon S3 bucket where License Manager information is stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMServiceSettingCmdlet.SnsTopicArn"> <summary> <para> <para>ARN of the Amazon SNS topic used for License Manager alerts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LICM.UpdateLICMServiceSettingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |