licensemanager

package module
v1.25.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 5, 2024 License: Apache-2.0 Imports: 39 Imported by: 7

Documentation

Overview

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

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

Index

Constants

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

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.19.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.22.2

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.22.2

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AcceptGrantInput added in v0.31.0

type AcceptGrantInput struct {

	// Amazon Resource Name (ARN) of the grant.
	//
	// This member is required.
	GrantArn *string
	// contains filtered or unexported fields
}

type AcceptGrantOutput added in v0.31.0

type AcceptGrantOutput struct {

	// Grant ARN.
	GrantArn *string

	// Grant status.
	Status types.GrantStatus

	// Grant version.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.22.2

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.22.2

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type CheckInLicenseInput added in v0.31.0

type CheckInLicenseInput struct {

	// License consumption token.
	//
	// This member is required.
	LicenseConsumptionToken *string

	// License beneficiary.
	Beneficiary *string
	// contains filtered or unexported fields
}

type CheckInLicenseOutput added in v0.31.0

type CheckInLicenseOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CheckoutBorrowLicenseInput added in v0.31.0

type CheckoutBorrowLicenseInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	//
	// This member is required.
	ClientToken *string

	// Digital signature method. The possible value is JSON Web Signature (JWS)
	// algorithm PS384. For more information, see RFC 7518 Digital Signature with
	// RSASSA-PSS (https://tools.ietf.org/html/rfc7518#section-3.5) .
	//
	// This member is required.
	DigitalSignatureMethod types.DigitalSignatureMethod

	// License entitlements. Partial checkouts are not supported.
	//
	// This member is required.
	Entitlements []types.EntitlementData

	// Amazon Resource Name (ARN) of the license. The license must use the borrow
	// consumption configuration.
	//
	// This member is required.
	LicenseArn *string

	// Information about constraints.
	CheckoutMetadata []types.Metadata

	// Node ID.
	NodeId *string
	// contains filtered or unexported fields
}

type CheckoutBorrowLicenseOutput added in v0.31.0

type CheckoutBorrowLicenseOutput struct {

	// Information about constraints.
	CheckoutMetadata []types.Metadata

	// Allowed license entitlements.
	EntitlementsAllowed []types.EntitlementData

	// Date and time at which the license checkout expires.
	Expiration *string

	// Date and time at which the license checkout is issued.
	IssuedAt *string

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

	// License consumption token.
	LicenseConsumptionToken *string

	// Node ID.
	NodeId *string

	// Signed token.
	SignedToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CheckoutLicenseInput added in v0.31.0

type CheckoutLicenseInput struct {

	// Checkout type.
	//
	// This member is required.
	CheckoutType types.CheckoutType

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	//
	// This member is required.
	ClientToken *string

	// License entitlements.
	//
	// This member is required.
	Entitlements []types.EntitlementData

	// Key fingerprint identifying the license.
	//
	// This member is required.
	KeyFingerprint *string

	// Product SKU.
	//
	// This member is required.
	ProductSKU *string

	// License beneficiary.
	Beneficiary *string

	// Node ID.
	NodeId *string
	// contains filtered or unexported fields
}

type CheckoutLicenseOutput added in v0.31.0

type CheckoutLicenseOutput struct {

	// Checkout type.
	CheckoutType types.CheckoutType

	// Allowed license entitlements.
	EntitlementsAllowed []types.EntitlementData

	// Date and time at which the license checkout expires.
	Expiration *string

	// Date and time at which the license checkout is issued.
	IssuedAt *string

	// Amazon Resource Name (ARN) of the checkout license.
	LicenseArn *string

	// License consumption token.
	LicenseConsumptionToken *string

	// Node ID.
	NodeId *string

	// Signed token.
	SignedToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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) AcceptGrant added in v0.31.0

func (c *Client) AcceptGrant(ctx context.Context, params *AcceptGrantInput, optFns ...func(*Options)) (*AcceptGrantOutput, error)

Accepts the specified grant.

func (*Client) CheckInLicense added in v0.31.0

func (c *Client) CheckInLicense(ctx context.Context, params *CheckInLicenseInput, optFns ...func(*Options)) (*CheckInLicenseOutput, error)

Checks in the specified license. Check in a license when it is no longer in use.

func (*Client) CheckoutBorrowLicense added in v0.31.0

func (c *Client) CheckoutBorrowLicense(ctx context.Context, params *CheckoutBorrowLicenseInput, optFns ...func(*Options)) (*CheckoutBorrowLicenseOutput, error)

Checks out the specified license for offline use.

func (*Client) CheckoutLicense added in v0.31.0

func (c *Client) CheckoutLicense(ctx context.Context, params *CheckoutLicenseInput, optFns ...func(*Options)) (*CheckoutLicenseOutput, error)

Checks out the specified license. If the account that created the license is the same that is performing the check out, you must specify the account as the beneficiary.

func (*Client) CreateGrant added in v0.31.0

func (c *Client) CreateGrant(ctx context.Context, params *CreateGrantInput, optFns ...func(*Options)) (*CreateGrantOutput, error)

Creates a grant for the specified license. A grant shares the use of license entitlements with a specific Amazon Web Services account, an organization, or an organizational unit (OU). For more information, see Granted licenses in License Manager (https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html) in the License Manager User Guide.

func (*Client) CreateGrantVersion added in v0.31.0

func (c *Client) CreateGrantVersion(ctx context.Context, params *CreateGrantVersionInput, optFns ...func(*Options)) (*CreateGrantVersionOutput, error)

Creates a new version of the specified grant. For more information, see Granted licenses in License Manager (https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html) in the License Manager User Guide.

func (*Client) CreateLicense added in v0.31.0

func (c *Client) CreateLicense(ctx context.Context, params *CreateLicenseInput, optFns ...func(*Options)) (*CreateLicenseOutput, error)

Creates a license.

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) CreateLicenseConversionTaskForResource added in v1.8.0

func (c *Client) CreateLicenseConversionTaskForResource(ctx context.Context, params *CreateLicenseConversionTaskForResourceInput, optFns ...func(*Options)) (*CreateLicenseConversionTaskForResourceOutput, error)

Creates a new license conversion task.

func (*Client) CreateLicenseManagerReportGenerator added in v1.4.0

func (c *Client) CreateLicenseManagerReportGenerator(ctx context.Context, params *CreateLicenseManagerReportGeneratorInput, optFns ...func(*Options)) (*CreateLicenseManagerReportGeneratorOutput, error)

Creates a report generator.

func (*Client) CreateLicenseVersion added in v0.31.0

func (c *Client) CreateLicenseVersion(ctx context.Context, params *CreateLicenseVersionInput, optFns ...func(*Options)) (*CreateLicenseVersionOutput, error)

Creates a new version of the specified license.

func (*Client) CreateToken added in v0.31.0

func (c *Client) CreateToken(ctx context.Context, params *CreateTokenInput, optFns ...func(*Options)) (*CreateTokenOutput, error)

Creates a long-lived token. A refresh token is a JWT token used to get an access token. With an access token, you can call AssumeRoleWithWebIdentity to get role credentials that you can use to call License Manager to manage the specified license.

func (*Client) DeleteGrant added in v0.31.0

func (c *Client) DeleteGrant(ctx context.Context, params *DeleteGrantInput, optFns ...func(*Options)) (*DeleteGrantOutput, error)

Deletes the specified grant.

func (*Client) DeleteLicense added in v0.31.0

func (c *Client) DeleteLicense(ctx context.Context, params *DeleteLicenseInput, optFns ...func(*Options)) (*DeleteLicenseOutput, error)

Deletes the specified license.

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) DeleteLicenseManagerReportGenerator added in v1.4.0

func (c *Client) DeleteLicenseManagerReportGenerator(ctx context.Context, params *DeleteLicenseManagerReportGeneratorInput, optFns ...func(*Options)) (*DeleteLicenseManagerReportGeneratorOutput, error)

Deletes the specified report generator. This action deletes the report generator, which stops it from generating future reports. The action cannot be reversed. It has no effect on the previous reports from this generator.

func (*Client) DeleteToken added in v0.31.0

func (c *Client) DeleteToken(ctx context.Context, params *DeleteTokenInput, optFns ...func(*Options)) (*DeleteTokenOutput, error)

Deletes the specified token. Must be called in the license home Region.

func (*Client) ExtendLicenseConsumption added in v0.31.0

func (c *Client) ExtendLicenseConsumption(ctx context.Context, params *ExtendLicenseConsumptionInput, optFns ...func(*Options)) (*ExtendLicenseConsumptionOutput, error)

Extends the expiration date for license consumption.

func (*Client) GetAccessToken added in v0.31.0

func (c *Client) GetAccessToken(ctx context.Context, params *GetAccessTokenInput, optFns ...func(*Options)) (*GetAccessTokenOutput, error)

Gets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens are valid for one hour.

func (*Client) GetGrant added in v0.31.0

func (c *Client) GetGrant(ctx context.Context, params *GetGrantInput, optFns ...func(*Options)) (*GetGrantOutput, error)

Gets detailed information about the specified grant.

func (*Client) GetLicense added in v0.31.0

func (c *Client) GetLicense(ctx context.Context, params *GetLicenseInput, optFns ...func(*Options)) (*GetLicenseOutput, error)

Gets detailed information about the specified license.

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) GetLicenseConversionTask added in v1.8.0

func (c *Client) GetLicenseConversionTask(ctx context.Context, params *GetLicenseConversionTaskInput, optFns ...func(*Options)) (*GetLicenseConversionTaskOutput, error)

Gets information about the specified license type conversion task.

func (*Client) GetLicenseManagerReportGenerator added in v1.4.0

func (c *Client) GetLicenseManagerReportGenerator(ctx context.Context, params *GetLicenseManagerReportGeneratorInput, optFns ...func(*Options)) (*GetLicenseManagerReportGeneratorOutput, error)

Gets information about the specified report generator.

func (*Client) GetLicenseUsage added in v0.31.0

func (c *Client) GetLicenseUsage(ctx context.Context, params *GetLicenseUsageInput, optFns ...func(*Options)) (*GetLicenseUsageOutput, error)

Gets detailed information about the usage of the specified license.

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) ListDistributedGrants added in v0.31.0

func (c *Client) ListDistributedGrants(ctx context.Context, params *ListDistributedGrantsInput, optFns ...func(*Options)) (*ListDistributedGrantsOutput, error)

Lists the grants distributed for the specified license.

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) ListLicenseConversionTasks added in v1.8.0

func (c *Client) ListLicenseConversionTasks(ctx context.Context, params *ListLicenseConversionTasksInput, optFns ...func(*Options)) (*ListLicenseConversionTasksOutput, error)

Lists the license type conversion tasks for your account.

func (*Client) ListLicenseManagerReportGenerators added in v1.4.0

func (c *Client) ListLicenseManagerReportGenerators(ctx context.Context, params *ListLicenseManagerReportGeneratorsInput, optFns ...func(*Options)) (*ListLicenseManagerReportGeneratorsOutput, error)

Lists the report generators 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) ListLicenseVersions added in v0.31.0

func (c *Client) ListLicenseVersions(ctx context.Context, params *ListLicenseVersionsInput, optFns ...func(*Options)) (*ListLicenseVersionsOutput, error)

Lists all versions of the specified license.

func (*Client) ListLicenses added in v0.31.0

func (c *Client) ListLicenses(ctx context.Context, params *ListLicensesInput, optFns ...func(*Options)) (*ListLicensesOutput, error)

Lists the licenses for your account.

func (*Client) ListReceivedGrants added in v0.31.0

func (c *Client) ListReceivedGrants(ctx context.Context, params *ListReceivedGrantsInput, optFns ...func(*Options)) (*ListReceivedGrantsOutput, error)

Lists grants that are received. Received grants are grants created while specifying the recipient as this Amazon Web Services account, your organization, or an organizational unit (OU) to which this member account belongs.

func (*Client) ListReceivedGrantsForOrganization added in v1.16.0

func (c *Client) ListReceivedGrantsForOrganization(ctx context.Context, params *ListReceivedGrantsForOrganizationInput, optFns ...func(*Options)) (*ListReceivedGrantsForOrganizationOutput, error)

Lists the grants received for all accounts in the organization.

func (*Client) ListReceivedLicenses added in v0.31.0

func (c *Client) ListReceivedLicenses(ctx context.Context, params *ListReceivedLicensesInput, optFns ...func(*Options)) (*ListReceivedLicensesOutput, error)

Lists received licenses.

func (*Client) ListReceivedLicensesForOrganization added in v1.16.0

func (c *Client) ListReceivedLicensesForOrganization(ctx context.Context, params *ListReceivedLicensesForOrganizationInput, optFns ...func(*Options)) (*ListReceivedLicensesForOrganizationOutput, error)

Lists the licenses received for all accounts in the organization.

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) ListTokens added in v0.31.0

func (c *Client) ListTokens(ctx context.Context, params *ListTokensInput, optFns ...func(*Options)) (*ListTokensOutput, error)

Lists your tokens.

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) Options added in v1.23.0

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) RejectGrant added in v0.31.0

func (c *Client) RejectGrant(ctx context.Context, params *RejectGrantInput, optFns ...func(*Options)) (*RejectGrantOutput, error)

Rejects the specified grant.

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) UpdateLicenseManagerReportGenerator added in v1.4.0

func (c *Client) UpdateLicenseManagerReportGenerator(ctx context.Context, params *UpdateLicenseManagerReportGeneratorInput, optFns ...func(*Options)) (*UpdateLicenseManagerReportGeneratorOutput, error)

Updates a report generator. After you make changes to a report generator, it starts generating new reports within 60 minutes of being updated.

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 Amazon Web Services resource. You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and 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 CreateGrantInput added in v0.31.0

type CreateGrantInput struct {

	// Allowed operations for the grant.
	//
	// This member is required.
	AllowedOperations []types.AllowedOperation

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	//
	// This member is required.
	ClientToken *string

	// Grant name.
	//
	// This member is required.
	GrantName *string

	// Home Region of the grant.
	//
	// This member is required.
	HomeRegion *string

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

	// The grant principals. You can specify one of the following as an Amazon
	// Resource Name (ARN):
	//   - An Amazon Web Services account, which includes only the account specified.
	//
	//   - An organizational unit (OU), which includes all accounts in the OU.
	//
	//   - An organization, which will include all accounts across your organization.
	//
	// This member is required.
	Principals []string
	// contains filtered or unexported fields
}

type CreateGrantOutput added in v0.31.0

type CreateGrantOutput struct {

	// Grant ARN.
	GrantArn *string

	// Grant status.
	Status types.GrantStatus

	// Grant version.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateGrantVersionInput added in v0.31.0

type CreateGrantVersionInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	//
	// This member is required.
	ClientToken *string

	// Amazon Resource Name (ARN) of the grant.
	//
	// This member is required.
	GrantArn *string

	// Allowed operations for the grant.
	AllowedOperations []types.AllowedOperation

	// Grant name.
	GrantName *string

	// The options specified for the grant.
	Options *types.Options

	// Current version of the grant.
	SourceVersion *string

	// Grant status.
	Status types.GrantStatus

	// Grant status reason.
	StatusReason *string
	// contains filtered or unexported fields
}

type CreateGrantVersionOutput added in v0.31.0

type CreateGrantVersionOutput struct {

	// Grant ARN.
	GrantArn *string

	// Grant status.
	Status types.GrantStatus

	// New version of the grant.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

	// When true, disassociates a resource when software is uninstalled.
	DisassociateWhenNotFound *bool

	// 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type CreateLicenseConversionTaskForResourceInput added in v1.8.0

type CreateLicenseConversionTaskForResourceInput struct {

	// Information that identifies the license type you are converting to. For the
	// structure of the destination license, see Convert a license type using the CLI  (https://docs.aws.amazon.com/license-manager/latest/userguide/conversion-procedures.html#conversion-cli)
	// in the License Manager User Guide.
	//
	// This member is required.
	DestinationLicenseContext *types.LicenseConversionContext

	// Amazon Resource Name (ARN) of the resource you are converting the license type
	// for.
	//
	// This member is required.
	ResourceArn *string

	// Information that identifies the license type you are converting from. For the
	// structure of the source license, see Convert a license type using the CLI  (https://docs.aws.amazon.com/license-manager/latest/userguide/conversion-procedures.html#conversion-cli)
	// in the License Manager User Guide.
	//
	// This member is required.
	SourceLicenseContext *types.LicenseConversionContext
	// contains filtered or unexported fields
}

type CreateLicenseConversionTaskForResourceOutput added in v1.8.0

type CreateLicenseConversionTaskForResourceOutput struct {

	// The ID of the created license type conversion task.
	LicenseConversionTaskId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateLicenseInput added in v0.31.0

type CreateLicenseInput struct {

	// License beneficiary.
	//
	// This member is required.
	Beneficiary *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	//
	// This member is required.
	ClientToken *string

	// 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.
	//
	// This member is required.
	ConsumptionConfiguration *types.ConsumptionConfiguration

	// License entitlements.
	//
	// This member is required.
	Entitlements []types.Entitlement

	// Home Region for the license.
	//
	// This member is required.
	HomeRegion *string

	// License issuer.
	//
	// This member is required.
	Issuer *types.Issuer

	// License name.
	//
	// This member is required.
	LicenseName *string

	// Product name.
	//
	// This member is required.
	ProductName *string

	// Product SKU.
	//
	// This member is required.
	ProductSKU *string

	// Date and time range during which the license is valid, in ISO8601-UTC format.
	//
	// This member is required.
	Validity *types.DatetimeRange

	// Information about the license.
	LicenseMetadata []types.Metadata
	// contains filtered or unexported fields
}

type CreateLicenseManagerReportGeneratorInput added in v1.4.0

type CreateLicenseManagerReportGeneratorInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	//
	// This member is required.
	ClientToken *string

	// Defines the type of license configuration the report generator tracks.
	//
	// This member is required.
	ReportContext *types.ReportContext

	// Frequency by which reports are generated. Reports can be generated daily,
	// monthly, or weekly.
	//
	// This member is required.
	ReportFrequency *types.ReportFrequency

	// Name of the report generator.
	//
	// This member is required.
	ReportGeneratorName *string

	// 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.
	//
	// This member is required.
	Type []types.ReportType

	// Description of the report generator.
	Description *string

	// Tags to add to the report generator.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateLicenseManagerReportGeneratorOutput added in v1.4.0

type CreateLicenseManagerReportGeneratorOutput struct {

	// The Amazon Resource Name (ARN) of the new report generator.
	LicenseManagerReportGeneratorArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateLicenseOutput added in v0.31.0

type CreateLicenseOutput struct {

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

	// License status.
	Status types.LicenseStatus

	// License version.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateLicenseVersionInput added in v0.31.0

type CreateLicenseVersionInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	//
	// This member is required.
	ClientToken *string

	// 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.
	//
	// This member is required.
	ConsumptionConfiguration *types.ConsumptionConfiguration

	// License entitlements.
	//
	// This member is required.
	Entitlements []types.Entitlement

	// Home Region of the license.
	//
	// This member is required.
	HomeRegion *string

	// License issuer.
	//
	// This member is required.
	Issuer *types.Issuer

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

	// License name.
	//
	// This member is required.
	LicenseName *string

	// Product name.
	//
	// This member is required.
	ProductName *string

	// License status.
	//
	// This member is required.
	Status types.LicenseStatus

	// Date and time range during which the license is valid, in ISO8601-UTC format.
	//
	// This member is required.
	Validity *types.DatetimeRange

	// Information about the license.
	LicenseMetadata []types.Metadata

	// Current version of the license.
	SourceVersion *string
	// contains filtered or unexported fields
}

type CreateLicenseVersionOutput added in v0.31.0

type CreateLicenseVersionOutput struct {

	// License ARN.
	LicenseArn *string

	// License status.
	Status types.LicenseStatus

	// New version of the license.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateTokenInput added in v0.31.0

type CreateTokenInput struct {

	// Idempotency token, valid for 10 minutes.
	//
	// This member is required.
	ClientToken *string

	// Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim
	// of the JWT token.
	//
	// This member is required.
	LicenseArn *string

	// Token expiration, in days, counted from token creation. The default is 365 days.
	ExpirationInDays *int32

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

	// Data specified by the caller to be included in the JWT token. The data is
	// mapped to the amr claim of the JWT token.
	TokenProperties []string
	// contains filtered or unexported fields
}

type CreateTokenOutput added in v0.31.0

type CreateTokenOutput struct {

	// Refresh token, encoded as a JWT token.
	Token *string

	// Token ID.
	TokenId *string

	// Token type.
	TokenType types.TokenType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteGrantInput added in v0.31.0

type DeleteGrantInput struct {

	// Amazon Resource Name (ARN) of the grant.
	//
	// This member is required.
	GrantArn *string

	// Current version of the grant.
	//
	// This member is required.
	Version *string

	// The Status reason for the delete request.
	StatusReason *string
	// contains filtered or unexported fields
}

type DeleteGrantOutput added in v0.31.0

type DeleteGrantOutput struct {

	// Grant ARN.
	GrantArn *string

	// Grant status.
	Status types.GrantStatus

	// Grant version.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLicenseConfigurationInput

type DeleteLicenseConfigurationInput struct {

	// ID of the license configuration.
	//
	// This member is required.
	LicenseConfigurationArn *string
	// contains filtered or unexported fields
}

type DeleteLicenseConfigurationOutput

type DeleteLicenseConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLicenseInput added in v0.31.0

type DeleteLicenseInput struct {

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

	// Current version of the license.
	//
	// This member is required.
	SourceVersion *string
	// contains filtered or unexported fields
}

type DeleteLicenseManagerReportGeneratorInput added in v1.4.0

type DeleteLicenseManagerReportGeneratorInput struct {

	// Amazon Resource Name (ARN) of the report generator to be deleted.
	//
	// This member is required.
	LicenseManagerReportGeneratorArn *string
	// contains filtered or unexported fields
}

type DeleteLicenseManagerReportGeneratorOutput added in v1.4.0

type DeleteLicenseManagerReportGeneratorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLicenseOutput added in v0.31.0

type DeleteLicenseOutput struct {

	// Date when the license is deleted.
	DeletionDate *string

	// License status.
	Status types.LicenseDeletionStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTokenInput added in v0.31.0

type DeleteTokenInput struct {

	// Token ID.
	//
	// This member is required.
	TokenId *string
	// contains filtered or unexported fields
}

type DeleteTokenOutput added in v0.31.0

type DeleteTokenOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.19.0

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.19.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.19.0

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

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 added in v0.29.0

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.19.0

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.19.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type ExtendLicenseConsumptionInput added in v0.31.0

type ExtendLicenseConsumptionInput struct {

	// License consumption token.
	//
	// This member is required.
	LicenseConsumptionToken *string

	// 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.
	DryRun bool
	// contains filtered or unexported fields
}

type ExtendLicenseConsumptionOutput added in v0.31.0

type ExtendLicenseConsumptionOutput struct {

	// Date and time at which the license consumption expires.
	Expiration *string

	// License consumption token.
	LicenseConsumptionToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAccessTokenInput added in v0.31.0

type GetAccessTokenInput struct {

	// Refresh token, encoded as a JWT token.
	//
	// This member is required.
	Token *string

	// Token properties to validate against those present in the JWT token.
	TokenProperties []string
	// contains filtered or unexported fields
}

type GetAccessTokenOutput added in v0.31.0

type GetAccessTokenOutput struct {

	// Temporary access token.
	AccessToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetGrantInput added in v0.31.0

type GetGrantInput struct {

	// Amazon Resource Name (ARN) of the grant.
	//
	// This member is required.
	GrantArn *string

	// Grant version.
	Version *string
	// contains filtered or unexported fields
}

type GetGrantOutput added in v0.31.0

type GetGrantOutput struct {

	// Grant details.
	Grant *types.Grant

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetLicenseConfigurationInput

type GetLicenseConfigurationInput struct {

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

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

	// When true, disassociates a resource when software is uninstalled.
	DisassociateWhenNotFound *bool

	// 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 for 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
	// contains filtered or unexported fields
}

type GetLicenseConversionTaskInput added in v1.8.0

type GetLicenseConversionTaskInput struct {

	// ID of the license type conversion task to retrieve information on.
	//
	// This member is required.
	LicenseConversionTaskId *string
	// contains filtered or unexported fields
}

type GetLicenseConversionTaskOutput added in v1.8.0

type GetLicenseConversionTaskOutput struct {

	// Information about the license type converted to.
	DestinationLicenseContext *types.LicenseConversionContext

	// Time at which the license type conversion task was completed.
	EndTime *time.Time

	// ID of the license type conversion task.
	LicenseConversionTaskId *string

	// Amount of time to complete the license type conversion.
	LicenseConversionTime *time.Time

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

	// Information about the license type converted from.
	SourceLicenseContext *types.LicenseConversionContext

	// Time at which the license type conversion task was started .
	StartTime *time.Time

	// Status of the license type conversion task.
	Status types.LicenseConversionTaskStatus

	// The status message for the conversion task.
	StatusMessage *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetLicenseInput added in v0.31.0

type GetLicenseInput struct {

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

	// License version.
	Version *string
	// contains filtered or unexported fields
}

type GetLicenseManagerReportGeneratorInput added in v1.4.0

type GetLicenseManagerReportGeneratorInput struct {

	// Amazon Resource Name (ARN) of the report generator.
	//
	// This member is required.
	LicenseManagerReportGeneratorArn *string
	// contains filtered or unexported fields
}

type GetLicenseManagerReportGeneratorOutput added in v1.4.0

type GetLicenseManagerReportGeneratorOutput struct {

	// A report generator that creates periodic reports about your license
	// configurations.
	ReportGenerator *types.ReportGenerator

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetLicenseOutput added in v0.31.0

type GetLicenseOutput struct {

	// License details.
	License *types.License

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetLicenseUsageInput added in v0.31.0

type GetLicenseUsageInput struct {

	// Amazon Resource Name (ARN) of the license.
	//
	// This member is required.
	LicenseArn *string
	// contains filtered or unexported fields
}

type GetLicenseUsageOutput added in v0.31.0

type GetLicenseUsageOutput struct {

	// License usage details.
	LicenseUsage *types.LicenseUsage

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetServiceSettingsInput

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

type GetServiceSettingsOutput

type GetServiceSettingsOutput struct {

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

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

	// Indicates whether Organizations is 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
	// contains filtered or unexported fields
}

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, optFns ...func(*v4.SignerOptions)) 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListDistributedGrantsInput added in v0.31.0

type ListDistributedGrantsInput struct {

	// Filters to scope the results. The following filters are supported:
	//   - LicenseArn
	//   - GrantStatus
	//   - GranteePrincipalARN
	//   - ProductSKU
	//   - LicenseIssuerName
	Filters []types.Filter

	// Amazon Resource Names (ARNs) of the grants.
	GrantArns []string

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

	// Token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDistributedGrantsOutput added in v0.31.0

type ListDistributedGrantsOutput struct {

	// Distributed grant details.
	Grants []types.Grant

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListLicenseConfigurationsInput

type ListLicenseConfigurationsInput struct {

	// 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 .
	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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListLicenseConversionTasksInput added in v1.8.0

type ListLicenseConversionTasksInput struct {

	// Filters to scope the results. Valid filters are ResourceArns and Status .
	Filters []types.Filter

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

	// Token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLicenseConversionTasksOutput added in v1.8.0

type ListLicenseConversionTasksOutput struct {

	// Information about the license configuration tasks for your account.
	LicenseConversionTasks []types.LicenseConversionTask

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLicenseManagerReportGeneratorsInput added in v1.4.0

type ListLicenseManagerReportGeneratorsInput struct {

	// Filters to scope the results. The following filters are supported:
	//   - LicenseConfigurationArn
	Filters []types.Filter

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

	// Token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLicenseManagerReportGeneratorsOutput added in v1.4.0

type ListLicenseManagerReportGeneratorsOutput struct {

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

	// A report generator that creates periodic reports about your license
	// configurations.
	ReportGenerators []types.ReportGenerator

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListLicenseVersionsInput added in v0.31.0

type ListLicenseVersionsInput struct {

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

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

	// Token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLicenseVersionsOutput added in v0.31.0

type ListLicenseVersionsOutput struct {

	// License details.
	Licenses []types.License

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLicensesInput added in v0.31.0

type ListLicensesInput struct {

	// Filters to scope the results. The following filters are supported:
	//   - Beneficiary
	//   - ProductSKU
	//   - Fingerprint
	//   - Status
	Filters []types.Filter

	// Amazon Resource Names (ARNs) of the licenses.
	LicenseArns []string

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

	// Token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLicensesOutput added in v0.31.0

type ListLicensesOutput struct {

	// License details.
	Licenses []types.License

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListReceivedGrantsForOrganizationInput added in v1.16.0

type ListReceivedGrantsForOrganizationInput struct {

	// The Amazon Resource Name (ARN) of the received license.
	//
	// This member is required.
	LicenseArn *string

	// Filters to scope the results. The following filters are supported:
	//   - ParentArn
	//   - GranteePrincipalArn
	Filters []types.Filter

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

	// Token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListReceivedGrantsForOrganizationOutput added in v1.16.0

type ListReceivedGrantsForOrganizationOutput struct {

	// Lists the grants the organization has received.
	Grants []types.Grant

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListReceivedGrantsInput added in v0.31.0

type ListReceivedGrantsInput struct {

	// Filters to scope the results. The following filters are supported:
	//   - ProductSKU
	//   - LicenseIssuerName
	//   - LicenseArn
	//   - GrantStatus
	//   - GranterAccountId
	Filters []types.Filter

	// Amazon Resource Names (ARNs) of the grants.
	GrantArns []string

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

	// Token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListReceivedGrantsOutput added in v0.31.0

type ListReceivedGrantsOutput struct {

	// Received grant details.
	Grants []types.Grant

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListReceivedLicensesForOrganizationInput added in v1.16.0

type ListReceivedLicensesForOrganizationInput struct {

	// Filters to scope the results. The following filters are supported:
	//   - Beneficiary
	//   - ProductSKU
	Filters []types.Filter

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

	// Token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListReceivedLicensesForOrganizationOutput added in v1.16.0

type ListReceivedLicensesForOrganizationOutput struct {

	// Lists the licenses the organization has received.
	Licenses []types.GrantedLicense

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListReceivedLicensesInput added in v0.31.0

type ListReceivedLicensesInput struct {

	// Filters to scope the results. The following filters are supported:
	//   - ProductSKU
	//   - Status
	//   - Fingerprint
	//   - IssuerName
	//   - Beneficiary
	Filters []types.Filter

	// Amazon Resource Names (ARNs) of the licenses.
	LicenseArns []string

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

	// Token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListReceivedLicensesOutput added in v0.31.0

type ListReceivedLicensesOutput struct {

	// Received license details.
	Licenses []types.GrantedLicense

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListResourceInventoryInput

type ListResourceInventoryInput struct {

	// 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: - The key/value combination of a tag assigned to the resource. Logical
	//   operators are EQUALS (single account) or EQUALS | NOT_EQUALS (cross account).
	Filters []types.InventoryFilter

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

	// Token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

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

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTokensInput added in v0.31.0

type ListTokensInput struct {

	// Filters to scope the results. The following filter is supported:
	//   - LicenseArns
	Filters []types.Filter

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

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

	// Token IDs.
	TokenIds []string
	// contains filtered or unexported fields
}

type ListTokensOutput added in v0.31.0

type ListTokensOutput struct {

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

	// Received token details.
	Tokens []types.TokenData

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// 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 configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

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

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// 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

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

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

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver added in v1.22.2

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type RejectGrantInput added in v0.31.0

type RejectGrantInput struct {

	// Amazon Resource Name (ARN) of the grant.
	//
	// This member is required.
	GrantArn *string
	// contains filtered or unexported fields
}

type RejectGrantOutput added in v0.31.0

type RejectGrantOutput struct {

	// Grant ARN.
	GrantArn *string

	// Grant status.
	Status types.GrantStatus

	// Grant version.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

	// When true, disassociates a resource when software is uninstalled.
	DisassociateWhenNotFound *bool

	// 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
	// contains filtered or unexported fields
}

type UpdateLicenseConfigurationOutput

type UpdateLicenseConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateLicenseManagerReportGeneratorInput added in v1.4.0

type UpdateLicenseManagerReportGeneratorInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	//
	// This member is required.
	ClientToken *string

	// Amazon Resource Name (ARN) of the report generator to update.
	//
	// This member is required.
	LicenseManagerReportGeneratorArn *string

	// The report context.
	//
	// This member is required.
	ReportContext *types.ReportContext

	// Frequency by which reports are generated.
	//
	// This member is required.
	ReportFrequency *types.ReportFrequency

	// Name of the report generator.
	//
	// This member is required.
	ReportGeneratorName *string

	// 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.
	//
	// This member is required.
	Type []types.ReportType

	// Description of the report generator.
	Description *string
	// contains filtered or unexported fields
}

type UpdateLicenseManagerReportGeneratorOutput added in v1.4.0

type UpdateLicenseManagerReportGeneratorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateLicenseSpecificationsForResourceInput

type UpdateLicenseSpecificationsForResourceInput struct {

	// Amazon Resource Name (ARN) of the Amazon Web Services 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
	// contains filtered or unexported fields
}

type UpdateLicenseSpecificationsForResourceOutput

type UpdateLicenseSpecificationsForResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateServiceSettingsInput

type UpdateServiceSettingsInput struct {

	// Activates cross-account discovery.
	EnableCrossAccountsDiscovery *bool

	// Enables integration with 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
	// contains filtered or unexported fields
}

type UpdateServiceSettingsOutput

type UpdateServiceSettingsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL