licensemanager – github.com/aws/aws-sdk-go-v2/service/licensemanager Index | Files | Directories

package licensemanager

import "github.com/aws/aws-sdk-go-v2/service/licensemanager"

Package licensemanager provides the API client, operations, and parameter types for AWS License Manager.

AWS License Manager AWS License Manager makes it easier to manage licenses from software vendors across multiple AWS accounts and on-premises servers.

Index

Constants

const ServiceAPIVersion = "2018-08-01"
const ServiceID = "License Manager"

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS License Manager.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateLicenseConfiguration

func (c *Client) CreateLicenseConfiguration(ctx context.Context, params *CreateLicenseConfigurationInput, optFns ...func(*Options)) (*CreateLicenseConfigurationOutput, error)

Creates a license configuration. 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), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), license affinity to host (how long a license must be associated with a host), and the number of licenses purchased and used.

func (*Client) DeleteLicenseConfiguration

func (c *Client) DeleteLicenseConfiguration(ctx context.Context, params *DeleteLicenseConfigurationInput, optFns ...func(*Options)) (*DeleteLicenseConfigurationOutput, error)

Deletes the specified license configuration. You cannot delete a license configuration that is in use.

func (*Client) GetLicenseConfiguration

func (c *Client) GetLicenseConfiguration(ctx context.Context, params *GetLicenseConfigurationInput, optFns ...func(*Options)) (*GetLicenseConfigurationOutput, error)

Gets detailed information about the specified license configuration.

func (*Client) GetServiceSettings

func (c *Client) GetServiceSettings(ctx context.Context, params *GetServiceSettingsInput, optFns ...func(*Options)) (*GetServiceSettingsOutput, error)

Gets the License Manager settings for the current Region.

func (*Client) ListAssociationsForLicenseConfiguration

func (c *Client) ListAssociationsForLicenseConfiguration(ctx context.Context, params *ListAssociationsForLicenseConfigurationInput, optFns ...func(*Options)) (*ListAssociationsForLicenseConfigurationOutput, error)

Lists the resource associations for the specified license configuration. Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance might not consume a license (depending on the license rules).

func (*Client) ListFailuresForLicenseConfigurationOperations

func (c *Client) ListFailuresForLicenseConfigurationOperations(ctx context.Context, params *ListFailuresForLicenseConfigurationOperationsInput, optFns ...func(*Options)) (*ListFailuresForLicenseConfigurationOperationsOutput, error)

Lists the license configuration operations that failed.

func (*Client) ListLicenseConfigurations

func (c *Client) ListLicenseConfigurations(ctx context.Context, params *ListLicenseConfigurationsInput, optFns ...func(*Options)) (*ListLicenseConfigurationsOutput, error)

Lists the license configurations for your account.

func (*Client) ListLicenseSpecificationsForResource

func (c *Client) ListLicenseSpecificationsForResource(ctx context.Context, params *ListLicenseSpecificationsForResourceInput, optFns ...func(*Options)) (*ListLicenseSpecificationsForResourceOutput, error)

Describes the license configurations for the specified resource.

func (*Client) ListResourceInventory

func (c *Client) ListResourceInventory(ctx context.Context, params *ListResourceInventoryInput, optFns ...func(*Options)) (*ListResourceInventoryOutput, error)

Lists resources managed using Systems Manager inventory.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags for the specified license configuration.

func (*Client) ListUsageForLicenseConfiguration

func (c *Client) ListUsageForLicenseConfiguration(ctx context.Context, params *ListUsageForLicenseConfigurationInput, optFns ...func(*Options)) (*ListUsageForLicenseConfigurationOutput, error)

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.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds the specified tags to the specified license configuration.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes the specified tags from the specified license configuration.

func (*Client) UpdateLicenseConfiguration

func (c *Client) UpdateLicenseConfiguration(ctx context.Context, params *UpdateLicenseConfigurationInput, optFns ...func(*Options)) (*UpdateLicenseConfigurationOutput, error)

Modifies the attributes of an existing license configuration.

func (*Client) UpdateLicenseSpecificationsForResource

func (c *Client) UpdateLicenseSpecificationsForResource(ctx context.Context, params *UpdateLicenseSpecificationsForResourceInput, optFns ...func(*Options)) (*UpdateLicenseSpecificationsForResourceOutput, error)

Adds or removes the specified license configurations for the specified AWS resource. You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and AWS CloudFormation templates, as they send license configurations to the operation that creates the resource.

func (*Client) UpdateServiceSettings

func (c *Client) UpdateServiceSettings(ctx context.Context, params *UpdateServiceSettingsInput, optFns ...func(*Options)) (*UpdateServiceSettingsOutput, error)

Updates License Manager settings for the current Region.

type CreateLicenseConfigurationInput

type CreateLicenseConfigurationInput struct {

	// Dimension used to track the license inventory.
	//
	// This member is required.
	LicenseCountingType types.LicenseCountingType

	// Name of the license configuration.
	//
	// This member is required.
	Name *string

	// Description of the license configuration.
	Description *string

	// Number of licenses managed by the license configuration.
	LicenseCount *int64

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

	// 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.
	LicenseRules []string

	// Product information.
	ProductInformationList []types.ProductInformation

	// Tags to add to the license configuration.
	Tags []types.Tag
}

type CreateLicenseConfigurationOutput

type CreateLicenseConfigurationOutput struct {

	// Amazon Resource Name (ARN) of the license configuration.
	LicenseConfigurationArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteLicenseConfigurationInput

type DeleteLicenseConfigurationInput struct {

	// ID of the license configuration.
	//
	// This member is required.
	LicenseConfigurationArn *string
}

type DeleteLicenseConfigurationOutput

type DeleteLicenseConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetLicenseConfigurationInput

type GetLicenseConfigurationInput struct {

	// Amazon Resource Name (ARN) of the license configuration.
	//
	// This member is required.
	LicenseConfigurationArn *string
}

type GetLicenseConfigurationOutput

type GetLicenseConfigurationOutput struct {

	// Automated discovery information.
	AutomatedDiscoveryInformation *types.AutomatedDiscoveryInformation

	// Summaries of the licenses consumed by resources.
	ConsumedLicenseSummaryList []types.ConsumedLicenseSummary

	// Number of licenses assigned to resources.
	ConsumedLicenses *int64

	// Description of the license configuration.
	Description *string

	// Amazon Resource Name (ARN) of the license configuration.
	LicenseConfigurationArn *string

	// Unique ID for the license configuration.
	LicenseConfigurationId *string

	// Number of available licenses.
	LicenseCount *int64

	// Sets the number of available licenses as a hard limit.
	LicenseCountHardLimit *bool

	// Dimension on which the licenses are counted.
	LicenseCountingType types.LicenseCountingType

	// License rules.
	LicenseRules []string

	// Summaries of the managed resources.
	ManagedResourceSummaryList []types.ManagedResourceSummary

	// Name of the license configuration.
	Name *string

	// Account ID of the owner of the license configuration.
	OwnerAccountId *string

	// Product information.
	ProductInformationList []types.ProductInformation

	// License configuration status.
	Status *string

	// Tags for the license configuration.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetServiceSettingsInput

type GetServiceSettingsInput struct {
}

type GetServiceSettingsOutput

type GetServiceSettingsOutput struct {

	// Indicates whether cross-account discovery has been enabled.
	EnableCrossAccountsDiscovery *bool

	// Amazon Resource Name (ARN) of the AWS resource share. The License Manager master
	// account will provide member accounts with access to this share.
	LicenseManagerResourceShareArn *string

	// Indicates whether AWS Organizations has been integrated with License Manager for
	// cross-account discovery.
	OrganizationConfiguration *types.OrganizationConfiguration

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

	// SNS topic configured to receive notifications from License Manager.
	SnsTopicArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type ListAssociationsForLicenseConfigurationInput

type ListAssociationsForLicenseConfigurationInput struct {

	// Amazon Resource Name (ARN) of a license configuration.
	//
	// This member is required.
	LicenseConfigurationArn *string

	// Maximum number of results to return in a single call.
	MaxResults *int32

	// Token for the next set of results.
	NextToken *string
}

type ListAssociationsForLicenseConfigurationOutput

type ListAssociationsForLicenseConfigurationOutput struct {

	// Information about the associations for the license configuration.
	LicenseConfigurationAssociations []types.LicenseConfigurationAssociation

	// Token for the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListFailuresForLicenseConfigurationOperationsInput

type ListFailuresForLicenseConfigurationOperationsInput struct {

	// Amazon Resource Name of the license configuration.
	//
	// This member is required.
	LicenseConfigurationArn *string

	// Maximum number of results to return in a single call.
	MaxResults *int32

	// Token for the next set of results.
	NextToken *string
}

type ListFailuresForLicenseConfigurationOperationsOutput

type ListFailuresForLicenseConfigurationOperationsOutput struct {

	// License configuration operations that failed.
	LicenseOperationFailureList []types.LicenseOperationFailure

	// Token for the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListLicenseConfigurationsInput

type ListLicenseConfigurationsInput struct {

	// Filters to scope the results. The following filters and logical operators are
	// supported:
	//
	// * licenseCountingType - The dimension on 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.
	Filters []types.Filter

	// Amazon Resource Names (ARN) of the license configurations.
	LicenseConfigurationArns []string

	// Maximum number of results to return in a single call.
	MaxResults *int32

	// Token for the next set of results.
	NextToken *string
}

type ListLicenseConfigurationsOutput

type ListLicenseConfigurationsOutput struct {

	// Information about the license configurations.
	LicenseConfigurations []types.LicenseConfiguration

	// Token for the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListLicenseSpecificationsForResourceInput

type ListLicenseSpecificationsForResourceInput struct {

	// Amazon Resource Name (ARN) of a resource that has an associated license
	// configuration.
	//
	// This member is required.
	ResourceArn *string

	// Maximum number of results to return in a single call.
	MaxResults *int32

	// Token for the next set of results.
	NextToken *string
}

type ListLicenseSpecificationsForResourceOutput

type ListLicenseSpecificationsForResourceOutput struct {

	// License configurations associated with a resource.
	LicenseSpecifications []types.LicenseSpecification

	// Token for the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListResourceInventoryInput

type ListResourceInventoryInput struct {

	// Filters to scope the results. The following filters and logical operators are
	// supported:
	//
	// * account_id - The ID of the AWS 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.
	Filters []types.InventoryFilter

	// Maximum number of results to return in a single call.
	MaxResults *int32

	// Token for the next set of results.
	NextToken *string
}

type ListResourceInventoryOutput

type ListResourceInventoryOutput struct {

	// Token for the next set of results.
	NextToken *string

	// Information about the resources.
	ResourceInventoryList []types.ResourceInventory

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// Amazon Resource Name (ARN) of the license configuration.
	//
	// This member is required.
	ResourceArn *string
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// Information about the tags.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListUsageForLicenseConfigurationInput

type ListUsageForLicenseConfigurationInput struct {

	// Amazon Resource Name (ARN) of the license configuration.
	//
	// This member is required.
	LicenseConfigurationArn *string

	// 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.
	Filters []types.Filter

	// Maximum number of results to return in a single call.
	MaxResults *int32

	// Token for the next set of results.
	NextToken *string
}

type ListUsageForLicenseConfigurationOutput

type ListUsageForLicenseConfigurationOutput struct {

	// Information about the license configurations.
	LicenseConfigurationUsageList []types.LicenseConfigurationUsage

	// Token for the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type TagResourceInput

type TagResourceInput struct {

	// Amazon Resource Name (ARN) of the license configuration.
	//
	// This member is required.
	ResourceArn *string

	// One or more tags.
	//
	// This member is required.
	Tags []types.Tag
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput

type UntagResourceInput struct {

	// Amazon Resource Name (ARN) of the license configuration.
	//
	// This member is required.
	ResourceArn *string

	// Keys identifying the tags to remove.
	//
	// This member is required.
	TagKeys []string
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateLicenseConfigurationInput

type UpdateLicenseConfigurationInput struct {

	// Amazon Resource Name (ARN) of the license configuration.
	//
	// This member is required.
	LicenseConfigurationArn *string

	// New description of the license configuration.
	Description *string

	// New status of the license configuration.
	LicenseConfigurationStatus types.LicenseConfigurationStatus

	// New number of licenses managed by the license configuration.
	LicenseCount *int64

	// New hard limit of the number of available licenses.
	LicenseCountHardLimit *bool

	// New license rule. The only rule that you can add after you create a license
	// configuration is licenseAffinityToHost.
	LicenseRules []string

	// New name of the license configuration.
	Name *string

	// New product information.
	ProductInformationList []types.ProductInformation
}

type UpdateLicenseConfigurationOutput

type UpdateLicenseConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateLicenseSpecificationsForResourceInput

type UpdateLicenseSpecificationsForResourceInput struct {

	// Amazon Resource Name (ARN) of the AWS resource.
	//
	// This member is required.
	ResourceArn *string

	// ARNs of the license configurations to add.
	AddLicenseSpecifications []types.LicenseSpecification

	// ARNs of the license configurations to remove.
	RemoveLicenseSpecifications []types.LicenseSpecification
}

type UpdateLicenseSpecificationsForResourceOutput

type UpdateLicenseSpecificationsForResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateServiceSettingsInput

type UpdateServiceSettingsInput struct {

	// Activates cross-account discovery.
	EnableCrossAccountsDiscovery *bool

	// Enables integration with AWS Organizations for cross-account discovery.
	OrganizationConfiguration *types.OrganizationConfiguration

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

	// Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager
	// alerts.
	SnsTopicArn *string
}

type UpdateServiceSettingsOutput

type UpdateServiceSettingsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

api_client.go api_op_CreateLicenseConfiguration.go api_op_DeleteLicenseConfiguration.go api_op_GetLicenseConfiguration.go api_op_GetServiceSettings.go api_op_ListAssociationsForLicenseConfiguration.go api_op_ListFailuresForLicenseConfigurationOperations.go api_op_ListLicenseConfigurations.go api_op_ListLicenseSpecificationsForResource.go api_op_ListResourceInventory.go api_op_ListTagsForResource.go api_op_ListUsageForLicenseConfiguration.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateLicenseConfiguration.go api_op_UpdateLicenseSpecificationsForResource.go api_op_UpdateServiceSettings.go deserializers.go doc.go endpoints.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v0.30.0
Published
Nov 30, 2020
Platform
js/wasm
Imports
27 packages
Last checked
now

Tools for package owners.