licensemanagerusersubscriptions

package module
v1.14.1 Latest Latest
Warning

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

 Go to latest Published: Nov 18, 2024 License: Apache-2.0 Imports: 42 Imported by: 6

Documentation

Overview

Package licensemanagerusersubscriptions provides the API client, operations, and parameter types for AWS License Manager User Subscriptions.

With License Manager, you can create user-based subscriptions to utilize licensed software with a per user subscription fee on Amazon EC2 instances.

Index

Constants

View Source 
const ServiceAPIVersion = "2018-05-10"
View Source 
const ServiceID = "License Manager User Subscriptions"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

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.3.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.6.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.6.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 AssociateUserInput 

type AssociateUserInput struct {

	// The identity provider for the user.
	//
	// This member is required.
	IdentityProvider types.IdentityProvider

	// The ID of the EC2 instance that provides the user-based subscription.
	//
	// This member is required.
	InstanceId *string

	// The user name from the identity provider.
	//
	// This member is required.
	Username *string

	// The domain name of the Active Directory that contains information for the user
	// to associate.
	Domain *string

	// The tags that apply for the user association.
	Tags map[string]string
	// contains filtered or unexported fields
}

type AssociateUserOutput 

type AssociateUserOutput struct {

	// Metadata that describes the associate user operation.
	//
	// This member is required.
	InstanceUserSummary *types.InstanceUserSummary

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

type AuthResolverParameters added in v1.6.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.6.2 

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

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

type Client 

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

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

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) AssociateUser 

func (c *Client) AssociateUser(ctx context.Context, params *AssociateUserInput, optFns ...func(*Options)) (*AssociateUserOutput, error)

Associates the user to an EC2 instance to utilize user-based subscriptions.

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly chargesin the Amazon Web Services Billing User Guide.

func (*Client) CreateLicenseServerEndpoint added in v1.14.0 

func (c *Client) CreateLicenseServerEndpoint(ctx context.Context, params *CreateLicenseServerEndpointInput, optFns ...func(*Options)) (*CreateLicenseServerEndpointOutput, error)

Creates a network endpoint for the Remote Desktop Services (RDS) license server.

func (*Client) DeleteLicenseServerEndpoint added in v1.14.0 

func (c *Client) DeleteLicenseServerEndpoint(ctx context.Context, params *DeleteLicenseServerEndpointInput, optFns ...func(*Options)) (*DeleteLicenseServerEndpointOutput, error)

Deletes a LicenseServerEndpoint resource.

func (*Client) DeregisterIdentityProvider 

func (c *Client) DeregisterIdentityProvider(ctx context.Context, params *DeregisterIdentityProviderInput, optFns ...func(*Options)) (*DeregisterIdentityProviderOutput, error)

Deregisters the Active Directory identity provider from License Manager user-based subscriptions.

func (*Client) DisassociateUser 

func (c *Client) DisassociateUser(ctx context.Context, params *DisassociateUserInput, optFns ...func(*Options)) (*DisassociateUserOutput, error)

Disassociates the user from an EC2 instance providing user-based subscriptions.

func (*Client) ListIdentityProviders 

func (c *Client) ListIdentityProviders(ctx context.Context, params *ListIdentityProvidersInput, optFns ...func(*Options)) (*ListIdentityProvidersOutput, error)

Lists the Active Directory identity providers for user-based subscriptions.

func (*Client) ListInstances 

func (c *Client) ListInstances(ctx context.Context, params *ListInstancesInput, optFns ...func(*Options)) (*ListInstancesOutput, error)

Lists the EC2 instances providing user-based subscriptions.

func (*Client) ListLicenseServerEndpoints added in v1.14.0 

func (c *Client) ListLicenseServerEndpoints(ctx context.Context, params *ListLicenseServerEndpointsInput, optFns ...func(*Options)) (*ListLicenseServerEndpointsOutput, error)

List the Remote Desktop Services (RDS) License Server endpoints

func (*Client) ListProductSubscriptions 

func (c *Client) ListProductSubscriptions(ctx context.Context, params *ListProductSubscriptionsInput, optFns ...func(*Options)) (*ListProductSubscriptionsOutput, error)

Lists the user-based subscription products available from an identity provider.

func (*Client) ListTagsForResource added in v1.14.0 

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

Returns the list of tags for the specified resource.

func (*Client) ListUserAssociations 

func (c *Client) ListUserAssociations(ctx context.Context, params *ListUserAssociationsInput, optFns ...func(*Options)) (*ListUserAssociationsOutput, error)

Lists user associations for an identity provider.

func (*Client) Options added in v1.7.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) RegisterIdentityProvider 

func (c *Client) RegisterIdentityProvider(ctx context.Context, params *RegisterIdentityProviderInput, optFns ...func(*Options)) (*RegisterIdentityProviderOutput, error)

Registers an identity provider for user-based subscriptions.

func (*Client) StartProductSubscription 

func (c *Client) StartProductSubscription(ctx context.Context, params *StartProductSubscriptionInput, optFns ...func(*Options)) (*StartProductSubscriptionOutput, error)

Starts a product subscription for a user with the specified identity provider.

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly chargesin the Amazon Web Services Billing User Guide.

func (*Client) StopProductSubscription 

func (c *Client) StopProductSubscription(ctx context.Context, params *StopProductSubscriptionInput, optFns ...func(*Options)) (*StopProductSubscriptionOutput, error)

Stops a product subscription for a user with the specified identity provider.

func (*Client) TagResource added in v1.14.0 

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

Adds tags to a resource.

func (*Client) UntagResource added in v1.14.0 

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

Removes tags from a resource.

func (*Client) UpdateIdentityProviderSettings added in v1.1.0 

func (c *Client) UpdateIdentityProviderSettings(ctx context.Context, params *UpdateIdentityProviderSettingsInput, optFns ...func(*Options)) (*UpdateIdentityProviderSettingsOutput, error)

Updates additional product configuration settings for the registered identity provider.

type CreateLicenseServerEndpointInput added in v1.14.0 

type CreateLicenseServerEndpointInput struct {

	// The Amazon Resource Name (ARN) that identifies the IdentityProvider resource
	// that contains details about a registered identity provider. In the case of
	// Active Directory, that can be a self-managed Active Directory or an Amazon Web
	// Services Managed Active Directory that contains user identity details.
	//
	// This member is required.
	IdentityProviderArn *string

	// The LicenseServerSettings resource to create for the endpoint. The settings
	// include the type of license server and the Secrets Manager secret that enables
	// administrators to add or remove users associated with the license server.
	//
	// This member is required.
	LicenseServerSettings *types.LicenseServerSettings

	// The tags that apply for the license server endpoint.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateLicenseServerEndpointOutput added in v1.14.0 

type CreateLicenseServerEndpointOutput struct {

	// The Amazon Resource Name (ARN) of the identity provider specified in the
	// request.
	IdentityProviderArn *string

	// The ARN of the LicenseServerEndpoint resource.
	LicenseServerEndpointArn *string

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

type DeleteLicenseServerEndpointInput added in v1.14.0 

type DeleteLicenseServerEndpointInput struct {

	// The Amazon Resource Name (ARN) that identifies the LicenseServerEndpoint
	// resource to delete.
	//
	// This member is required.
	LicenseServerEndpointArn *string

	// The type of License Server that the delete request refers to.
	//
	// This member is required.
	ServerType types.ServerType
	// contains filtered or unexported fields
}

type DeleteLicenseServerEndpointOutput added in v1.14.0 

type DeleteLicenseServerEndpointOutput struct {

	// Shows details from the LicenseServerEndpoint resource that was deleted.
	LicenseServerEndpoint *types.LicenseServerEndpoint

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

type DeregisterIdentityProviderInput 

type DeregisterIdentityProviderInput struct {

	// An object that specifies details for the Active Directory identity provider.
	IdentityProvider types.IdentityProvider

	// The Amazon Resource Name (ARN) that identifies the identity provider to
	// deregister.
	IdentityProviderArn *string

	// The name of the user-based subscription product.
	//
	// Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL |
	// OFFICE_PROFESSIONAL_PLUS
	Product *string
	// contains filtered or unexported fields
}

type DeregisterIdentityProviderOutput 

type DeregisterIdentityProviderOutput struct {

	// Metadata that describes the results of an identity provider operation.
	//
	// This member is required.
	IdentityProviderSummary *types.IdentityProviderSummary

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

type DisassociateUserInput 

type DisassociateUserInput struct {

	// The domain name of the Active Directory that contains information for the user
	// to disassociate.
	Domain *string

	// An object that specifies details for the Active Directory identity provider.
	IdentityProvider types.IdentityProvider

	// The ID of the EC2 instance which provides user-based subscriptions.
	InstanceId *string

	// The Amazon Resource Name (ARN) of the user to disassociate from the EC2
	// instance.
	InstanceUserArn *string

	// The user name from the Active Directory identity provider for the user.
	Username *string
	// contains filtered or unexported fields
}

type DisassociateUserOutput 

type DisassociateUserOutput struct {

	// Metadata that describes the associate user operation.
	//
	// This member is required.
	InstanceUserSummary *types.InstanceUserSummary

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

type EndpointParameters added in v1.3.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.3.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.3.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 

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 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.3.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.3.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

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 ListIdentityProvidersAPIClient 

type ListIdentityProvidersAPIClient interface {
	ListIdentityProviders(context.Context, *ListIdentityProvidersInput, ...func(*Options)) (*ListIdentityProvidersOutput, error)
}

ListIdentityProvidersAPIClient is a client that implements the ListIdentityProviders operation.

type ListIdentityProvidersInput 

type ListIdentityProvidersInput struct {

	// You can use the following filters to streamline results:
	//
	//   - Product
	//
	//   - DirectoryId
	Filters []types.Filter

	// The maximum number of results to return from a single request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListIdentityProvidersOutput 

type ListIdentityProvidersOutput struct {

	// An array of IdentityProviderSummary resources that contain details about the
	// Active Directory identity providers that meet the request criteria.
	//
	// This member is required.
	IdentityProviderSummaries []types.IdentityProviderSummary

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

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

type ListIdentityProvidersPaginator 

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

ListIdentityProvidersPaginator is a paginator for ListIdentityProviders

func NewListIdentityProvidersPaginator 

func NewListIdentityProvidersPaginator(client ListIdentityProvidersAPIClient, params *ListIdentityProvidersInput, optFns ...func(*ListIdentityProvidersPaginatorOptions)) *ListIdentityProvidersPaginator

NewListIdentityProvidersPaginator returns a new ListIdentityProvidersPaginator

func (*ListIdentityProvidersPaginator) HasMorePages 

func (p *ListIdentityProvidersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIdentityProvidersPaginator) NextPage 

func (p *ListIdentityProvidersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIdentityProvidersOutput, error)

NextPage retrieves the next ListIdentityProviders page.

type ListIdentityProvidersPaginatorOptions 

type ListIdentityProvidersPaginatorOptions struct {
	// The maximum number of results to return from a single request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListIdentityProvidersPaginatorOptions is the paginator options for ListIdentityProviders

type ListInstancesAPIClient 

type ListInstancesAPIClient interface {
	ListInstances(context.Context, *ListInstancesInput, ...func(*Options)) (*ListInstancesOutput, error)
}

ListInstancesAPIClient is a client that implements the ListInstances operation.

type ListInstancesInput 

type ListInstancesInput struct {

	// You can use the following filters to streamline results:
	//
	//   - Status
	//
	//   - InstanceId
	Filters []types.Filter

	// The maximum number of results to return from a single request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListInstancesOutput 

type ListInstancesOutput struct {

	// An array of InstanceSummary resources that contain details about the instances
	// that provide user-based subscriptions and also meet the request criteria.
	InstanceSummaries []types.InstanceSummary

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

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

type ListInstancesPaginator 

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

ListInstancesPaginator is a paginator for ListInstances

func NewListInstancesPaginator 

func NewListInstancesPaginator(client ListInstancesAPIClient, params *ListInstancesInput, optFns ...func(*ListInstancesPaginatorOptions)) *ListInstancesPaginator

NewListInstancesPaginator returns a new ListInstancesPaginator

func (*ListInstancesPaginator) HasMorePages 

func (p *ListInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInstancesPaginator) NextPage 

func (p *ListInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInstancesOutput, error)

NextPage retrieves the next ListInstances page.

type ListInstancesPaginatorOptions 

type ListInstancesPaginatorOptions struct {
	// The maximum number of results to return from a single request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListInstancesPaginatorOptions is the paginator options for ListInstances

type ListLicenseServerEndpointsAPIClient added in v1.14.0 

type ListLicenseServerEndpointsAPIClient interface {
	ListLicenseServerEndpoints(context.Context, *ListLicenseServerEndpointsInput, ...func(*Options)) (*ListLicenseServerEndpointsOutput, error)
}

ListLicenseServerEndpointsAPIClient is a client that implements the ListLicenseServerEndpoints operation.

type ListLicenseServerEndpointsInput added in v1.14.0 

type ListLicenseServerEndpointsInput struct {

	// You can use the following filters to streamline results:
	//
	//   - IdentityProviderArn
	Filters []types.Filter

	// The maximum number of results to return from a single request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLicenseServerEndpointsOutput added in v1.14.0 

type ListLicenseServerEndpointsOutput struct {

	// An array of LicenseServerEndpoint resources that contain detailed information
	// about the RDS License Servers that meet the request criteria.
	LicenseServerEndpoints []types.LicenseServerEndpoint

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

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

type ListLicenseServerEndpointsPaginator added in v1.14.0 

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

ListLicenseServerEndpointsPaginator is a paginator for ListLicenseServerEndpoints

func NewListLicenseServerEndpointsPaginator added in v1.14.0 

func NewListLicenseServerEndpointsPaginator(client ListLicenseServerEndpointsAPIClient, params *ListLicenseServerEndpointsInput, optFns ...func(*ListLicenseServerEndpointsPaginatorOptions)) *ListLicenseServerEndpointsPaginator

NewListLicenseServerEndpointsPaginator returns a new ListLicenseServerEndpointsPaginator

func (*ListLicenseServerEndpointsPaginator) HasMorePages added in v1.14.0 

func (p *ListLicenseServerEndpointsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLicenseServerEndpointsPaginator) NextPage added in v1.14.0 

func (p *ListLicenseServerEndpointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLicenseServerEndpointsOutput, error)

NextPage retrieves the next ListLicenseServerEndpoints page.

type ListLicenseServerEndpointsPaginatorOptions added in v1.14.0 

type ListLicenseServerEndpointsPaginatorOptions struct {
	// The maximum number of results to return from a single request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLicenseServerEndpointsPaginatorOptions is the paginator options for ListLicenseServerEndpoints

type ListProductSubscriptionsAPIClient 

type ListProductSubscriptionsAPIClient interface {
	ListProductSubscriptions(context.Context, *ListProductSubscriptionsInput, ...func(*Options)) (*ListProductSubscriptionsOutput, error)
}

ListProductSubscriptionsAPIClient is a client that implements the ListProductSubscriptions operation.

type ListProductSubscriptionsInput 

type ListProductSubscriptionsInput struct {

	// An object that specifies details for the identity provider.
	//
	// This member is required.
	IdentityProvider types.IdentityProvider

	// You can use the following filters to streamline results:
	//
	//   - Status
	//
	//   - Username
	//
	//   - Domain
	Filters []types.Filter

	// The maximum number of results to return from a single request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string

	// The name of the user-based subscription product.
	//
	// Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL |
	// OFFICE_PROFESSIONAL_PLUS
	Product *string
	// contains filtered or unexported fields
}

type ListProductSubscriptionsOutput 

type ListProductSubscriptionsOutput struct {

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

	// Metadata that describes the list product subscriptions operation.
	ProductUserSummaries []types.ProductUserSummary

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

type ListProductSubscriptionsPaginator 

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

ListProductSubscriptionsPaginator is a paginator for ListProductSubscriptions

func NewListProductSubscriptionsPaginator 

func NewListProductSubscriptionsPaginator(client ListProductSubscriptionsAPIClient, params *ListProductSubscriptionsInput, optFns ...func(*ListProductSubscriptionsPaginatorOptions)) *ListProductSubscriptionsPaginator

NewListProductSubscriptionsPaginator returns a new ListProductSubscriptionsPaginator

func (*ListProductSubscriptionsPaginator) HasMorePages 

func (p *ListProductSubscriptionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProductSubscriptionsPaginator) NextPage 

func (p *ListProductSubscriptionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProductSubscriptionsOutput, error)

NextPage retrieves the next ListProductSubscriptions page.

type ListProductSubscriptionsPaginatorOptions 

type ListProductSubscriptionsPaginatorOptions struct {
	// The maximum number of results to return from a single request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListProductSubscriptionsPaginatorOptions is the paginator options for ListProductSubscriptions

type ListTagsForResourceInput added in v1.14.0 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput added in v1.14.0 

type ListTagsForResourceOutput struct {

	// The tags for the specified resource.
	Tags map[string]string

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

type ListUserAssociationsAPIClient 

type ListUserAssociationsAPIClient interface {
	ListUserAssociations(context.Context, *ListUserAssociationsInput, ...func(*Options)) (*ListUserAssociationsOutput, error)
}

ListUserAssociationsAPIClient is a client that implements the ListUserAssociations operation.

type ListUserAssociationsInput 

type ListUserAssociationsInput struct {

	// An object that specifies details for the identity provider.
	//
	// This member is required.
	IdentityProvider types.IdentityProvider

	// The ID of the EC2 instance, which provides user-based subscriptions.
	//
	// This member is required.
	InstanceId *string

	// You can use the following filters to streamline results:
	//
	//   - Status
	//
	//   - Username
	//
	//   - Domain
	Filters []types.Filter

	// The maximum number of results to return from a single request.
	MaxResults *int32

	// A token to specify where to start paginating. This is the nextToken from a
	// previously truncated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListUserAssociationsOutput 

type ListUserAssociationsOutput struct {

	// Metadata that describes the list user association operation.
	InstanceUserSummaries []types.InstanceUserSummary

	// The next token used for paginated responses. When this field isn't empty, there
	// are additional elements that the service hasn't included in this request. Use
	// this token with the next request to retrieve additional objects.
	NextToken *string

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

type ListUserAssociationsPaginator 

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

ListUserAssociationsPaginator is a paginator for ListUserAssociations

func NewListUserAssociationsPaginator 

func NewListUserAssociationsPaginator(client ListUserAssociationsAPIClient, params *ListUserAssociationsInput, optFns ...func(*ListUserAssociationsPaginatorOptions)) *ListUserAssociationsPaginator

NewListUserAssociationsPaginator returns a new ListUserAssociationsPaginator

func (*ListUserAssociationsPaginator) HasMorePages 

func (p *ListUserAssociationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUserAssociationsPaginator) NextPage 

func (p *ListUserAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUserAssociationsOutput, error)

NextPage retrieves the next ListUserAssociations page.

type ListUserAssociationsPaginatorOptions 

type ListUserAssociationsPaginatorOptions struct {
	// The maximum number of results to return from a single request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListUserAssociationsPaginatorOptions is the paginator options for ListUserAssociations

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 client meter provider.
	MeterProvider metrics.MeterProvider

	// 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 client tracer provider.
	TracerProvider tracing.TracerProvider

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

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

type RegisterIdentityProviderInput 

type RegisterIdentityProviderInput struct {

	// An object that specifies details for the identity provider to register.
	//
	// This member is required.
	IdentityProvider types.IdentityProvider

	// The name of the user-based subscription product.
	//
	// Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL |
	// OFFICE_PROFESSIONAL_PLUS
	//
	// This member is required.
	Product *string

	// The registered identity provider’s product related configuration settings such
	// as the subnets to provision VPC endpoints.
	Settings *types.Settings

	// The tags that apply to the identity provider's registration.
	Tags map[string]string
	// contains filtered or unexported fields
}

type RegisterIdentityProviderOutput 

type RegisterIdentityProviderOutput struct {

	// Metadata that describes the results of an identity provider operation.
	//
	// This member is required.
	IdentityProviderSummary *types.IdentityProviderSummary

	// 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 (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartProductSubscriptionInput 

type StartProductSubscriptionInput struct {

	// An object that specifies details for the identity provider.
	//
	// This member is required.
	IdentityProvider types.IdentityProvider

	// The name of the user-based subscription product.
	//
	// Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL |
	// OFFICE_PROFESSIONAL_PLUS
	//
	// This member is required.
	Product *string

	// The user name from the identity provider of the user.
	//
	// This member is required.
	Username *string

	// The domain name of the Active Directory that contains the user for whom to
	// start the product subscription.
	Domain *string

	// The tags that apply to the product subscription.
	Tags map[string]string
	// contains filtered or unexported fields
}

type StartProductSubscriptionOutput 

type StartProductSubscriptionOutput struct {

	// Metadata that describes the start product subscription operation.
	//
	// This member is required.
	ProductUserSummary *types.ProductUserSummary

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

type StopProductSubscriptionInput 

type StopProductSubscriptionInput struct {

	// The domain name of the Active Directory that contains the user for whom to stop
	// the product subscription.
	Domain *string

	// An object that specifies details for the identity provider.
	IdentityProvider types.IdentityProvider

	// The name of the user-based subscription product.
	//
	// Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL |
	// OFFICE_PROFESSIONAL_PLUS
	Product *string

	// The Amazon Resource Name (ARN) of the product user.
	ProductUserArn *string

	// The user name from the identity provider for the user.
	Username *string
	// contains filtered or unexported fields
}

type StopProductSubscriptionOutput 

type StopProductSubscriptionOutput struct {

	// Metadata that describes the start product subscription operation.
	//
	// This member is required.
	ProductUserSummary *types.ProductUserSummary

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

type TagResourceInput added in v1.14.0 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to tag.
	//
	// This member is required.
	ResourceArn *string

	// The tags to apply to the specified resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput added in v1.14.0 

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

type UntagResourceInput added in v1.14.0 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to remove tags
	// from.
	//
	// This member is required.
	ResourceArn *string

	// The tag keys to remove from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput added in v1.14.0 

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

type UpdateIdentityProviderSettingsInput added in v1.1.0 

type UpdateIdentityProviderSettingsInput struct {

	// Updates the registered identity provider’s product related configuration
	// settings. You can update any combination of settings in a single operation such
	// as the:
	//
	//   - Subnets which you want to add to provision VPC endpoints.
	//
	//   - Subnets which you want to remove the VPC endpoints from.
	//
	//   - Security group ID which permits traffic to the VPC endpoints.
	//
	// This member is required.
	UpdateSettings *types.UpdateSettings

	// Refers to an identity provider.
	IdentityProvider types.IdentityProvider

	// The Amazon Resource Name (ARN) of the identity provider to update.
	IdentityProviderArn *string

	// The name of the user-based subscription product.
	//
	// Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL |
	// OFFICE_PROFESSIONAL_PLUS
	Product *string
	// contains filtered or unexported fields
}

type UpdateIdentityProviderSettingsOutput added in v1.1.0 

type UpdateIdentityProviderSettingsOutput struct {

	// Describes an identity provider.
	//
	// This member is required.
	IdentityProviderSummary *types.IdentityProviderSummary

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

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.