licensemanagerlinuxsubscriptions

package
v1.44.194 Latest Latest
Warning

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

 Go to latest Published: Feb 3, 2023 License: Apache-2.0 Imports: 9 Imported by: 6

Documentation

Overview

Package licensemanagerlinuxsubscriptions provides the client and types for making API requests to AWS License Manager Linux Subscriptions.

With License Manager, you can discover and track your commercial Linux subscriptions on running Amazon EC2 instances.

See https://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10 for more information on this service.

See licensemanagerlinuxsubscriptions package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/licensemanagerlinuxsubscriptions/

Using the Client

To contact AWS License Manager Linux Subscriptions with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS License Manager Linux Subscriptions client LicenseManagerLinuxSubscriptions for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/licensemanagerlinuxsubscriptions/#New

Index

Constants

View Source 
const (
	// LinuxSubscriptionsDiscoveryEnabled is a LinuxSubscriptionsDiscovery enum value
	LinuxSubscriptionsDiscoveryEnabled = "Enabled"

	// LinuxSubscriptionsDiscoveryDisabled is a LinuxSubscriptionsDiscovery enum value
	LinuxSubscriptionsDiscoveryDisabled = "Disabled"
)
View Source 
const (
	// OperatorEqual is a Operator enum value
	OperatorEqual = "Equal"

	// OperatorNotEqual is a Operator enum value
	OperatorNotEqual = "NotEqual"

	// OperatorContains is a Operator enum value
	OperatorContains = "Contains"
)
View Source 
const (
	// OrganizationIntegrationEnabled is a OrganizationIntegration enum value
	OrganizationIntegrationEnabled = "Enabled"

	// OrganizationIntegrationDisabled is a OrganizationIntegration enum value
	OrganizationIntegrationDisabled = "Disabled"
)
View Source 
const (
	// StatusInProgress is a Status enum value
	StatusInProgress = "InProgress"

	// StatusCompleted is a Status enum value
	StatusCompleted = "Completed"

	// StatusSuccessful is a Status enum value
	StatusSuccessful = "Successful"

	// StatusFailed is a Status enum value
	StatusFailed = "Failed"
)
View Source 
const (

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An exception occurred with the service.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The provided input is not valid. Try your request again.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "License Manager Linux Subscriptions" // Name of service.
	EndpointsID = "license-manager-linux-subscriptions" // ID to lookup a service endpoint with.
	ServiceID   = "License Manager Linux Subscriptions" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func LinuxSubscriptionsDiscovery_Values 

func LinuxSubscriptionsDiscovery_Values() []string

LinuxSubscriptionsDiscovery_Values returns all elements of the LinuxSubscriptionsDiscovery enum

func Operator_Values 

func Operator_Values() []string

Operator_Values returns all elements of the Operator enum

func OrganizationIntegration_Values 

func OrganizationIntegration_Values() []string

OrganizationIntegration_Values returns all elements of the OrganizationIntegration enum

func Status_Values 

func Status_Values() []string

Status_Values returns all elements of the Status enum

Types

type Filter 

type Filter struct {

	// The type of name to filter by.
	Name *string `type:"string"`

	// An operator for filtering results.
	Operator *string `min:"1" type:"string" enum:"Operator"`

	// One or more values for the name to filter by.
	Values []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

A filter object that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria.

func (Filter) GoString 

func (s Filter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) SetName 

func (s *Filter) SetName(v string) *Filter

SetName sets the Name field's value.

func (*Filter) SetOperator 

func (s *Filter) SetOperator(v string) *Filter

SetOperator sets the Operator field's value.

func (*Filter) SetValues 

func (s *Filter) SetValues(v []*string) *Filter

SetValues sets the Values field's value.

func (Filter) String 

func (s Filter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) Validate 

func (s *Filter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetServiceSettingsInput 

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

func (GetServiceSettingsInput) GoString 

func (s GetServiceSettingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetServiceSettingsInput) String 

func (s GetServiceSettingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetServiceSettingsOutput 

type GetServiceSettingsOutput struct {

	// The Region in which License Manager displays the aggregated data for Linux
	// subscriptions.
	HomeRegions []*string `min:"1" type:"list"`

	// Lists if discovery has been enabled for Linux subscriptions.
	LinuxSubscriptionsDiscovery *string `type:"string" enum:"LinuxSubscriptionsDiscovery"`

	// Lists the settings defined for Linux subscriptions discovery. The settings
	// include if Organizations integration has been enabled, and which Regions
	// data will be aggregated from.
	LinuxSubscriptionsDiscoverySettings *LinuxSubscriptionsDiscoverySettings `type:"structure"`

	// Indicates the status of Linux subscriptions settings being applied.
	Status *string `type:"string" enum:"Status"`

	// A message which details the Linux subscriptions service settings current
	// status.
	StatusMessage map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (GetServiceSettingsOutput) GoString 

func (s GetServiceSettingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetServiceSettingsOutput) SetHomeRegions 

func (s *GetServiceSettingsOutput) SetHomeRegions(v []*string) *GetServiceSettingsOutput

SetHomeRegions sets the HomeRegions field's value.

func (*GetServiceSettingsOutput) SetLinuxSubscriptionsDiscovery 

func (s *GetServiceSettingsOutput) SetLinuxSubscriptionsDiscovery(v string) *GetServiceSettingsOutput

SetLinuxSubscriptionsDiscovery sets the LinuxSubscriptionsDiscovery field's value.

func (*GetServiceSettingsOutput) SetLinuxSubscriptionsDiscoverySettings 

func (s *GetServiceSettingsOutput) SetLinuxSubscriptionsDiscoverySettings(v *LinuxSubscriptionsDiscoverySettings) *GetServiceSettingsOutput

SetLinuxSubscriptionsDiscoverySettings sets the LinuxSubscriptionsDiscoverySettings field's value.

func (*GetServiceSettingsOutput) SetStatus 

func (s *GetServiceSettingsOutput) SetStatus(v string) *GetServiceSettingsOutput

SetStatus sets the Status field's value.

func (*GetServiceSettingsOutput) SetStatusMessage 

func (s *GetServiceSettingsOutput) SetStatusMessage(v map[string]*string) *GetServiceSettingsOutput

SetStatusMessage sets the StatusMessage field's value.

func (GetServiceSettingsOutput) String 

func (s GetServiceSettingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Instance 

type Instance struct {

	// The account ID which owns the instance.
	AccountID *string `type:"string"`

	// The AMI ID used to launch the instance.
	AmiId *string `type:"string"`

	// The instance ID of the resource.
	InstanceID *string `type:"string"`

	// The instance type of the resource.
	InstanceType *string `type:"string"`

	// The time in which the last discovery updated the instance details.
	LastUpdatedTime *string `type:"string"`

	// The product code for the instance. For more information, see Usage operation
	// values (https://docs.aws.amazon.com/license-manager/latest/userguide/linux-subscriptions-usage-operation.html)
	// in the License Manager User Guide .
	ProductCode []*string `type:"list"`

	// The Region the instance is running in.
	Region *string `type:"string"`

	// The status of the instance.
	Status *string `type:"string"`

	// The name of the subscription being used by the instance.
	SubscriptionName *string `type:"string"`

	// The usage operation of the instance. For more information, see For more information,
	// see Usage operation values (https://docs.aws.amazon.com/license-manager/latest/userguide/linux-subscriptions-usage-operation.html)
	// in the License Manager User Guide.
	UsageOperation *string `type:"string"`
	// contains filtered or unexported fields
}

Details discovered information about a running instance using Linux subscriptions.

func (Instance) GoString 

func (s Instance) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Instance) SetAccountID 

func (s *Instance) SetAccountID(v string) *Instance

SetAccountID sets the AccountID field's value.

func (*Instance) SetAmiId 

func (s *Instance) SetAmiId(v string) *Instance

SetAmiId sets the AmiId field's value.

func (*Instance) SetInstanceID 

func (s *Instance) SetInstanceID(v string) *Instance

SetInstanceID sets the InstanceID field's value.

func (*Instance) SetInstanceType 

func (s *Instance) SetInstanceType(v string) *Instance

SetInstanceType sets the InstanceType field's value.

func (*Instance) SetLastUpdatedTime 

func (s *Instance) SetLastUpdatedTime(v string) *Instance

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*Instance) SetProductCode 

func (s *Instance) SetProductCode(v []*string) *Instance

SetProductCode sets the ProductCode field's value.

func (*Instance) SetRegion 

func (s *Instance) SetRegion(v string) *Instance

SetRegion sets the Region field's value.

func (*Instance) SetStatus 

func (s *Instance) SetStatus(v string) *Instance

SetStatus sets the Status field's value.

func (*Instance) SetSubscriptionName 

func (s *Instance) SetSubscriptionName(v string) *Instance

SetSubscriptionName sets the SubscriptionName field's value.

func (*Instance) SetUsageOperation 

func (s *Instance) SetUsageOperation(v string) *Instance

SetUsageOperation sets the UsageOperation field's value.

func (Instance) String 

func (s Instance) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An exception occurred with the service.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LicenseManagerLinuxSubscriptions 

type LicenseManagerLinuxSubscriptions struct {
	*client.Client
}

LicenseManagerLinuxSubscriptions provides the API operation methods for making requests to AWS License Manager Linux Subscriptions. See this package's package overview docs for details on the service.

LicenseManagerLinuxSubscriptions methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *LicenseManagerLinuxSubscriptions

New creates a new instance of the LicenseManagerLinuxSubscriptions client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a LicenseManagerLinuxSubscriptions client from just a session.
svc := licensemanagerlinuxsubscriptions.New(mySession)

// Create a LicenseManagerLinuxSubscriptions client with additional configuration
svc := licensemanagerlinuxsubscriptions.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*LicenseManagerLinuxSubscriptions) GetServiceSettings 

func (c *LicenseManagerLinuxSubscriptions) GetServiceSettings(input *GetServiceSettingsInput) (*GetServiceSettingsOutput, error)

GetServiceSettings API operation for AWS License Manager Linux Subscriptions.

Lists the Linux subscriptions service settings.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS License Manager Linux Subscriptions's API operation GetServiceSettings for usage and error information.

Returned Error Types:

  • InternalServerException An exception occurred with the service.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The provided input is not valid. Try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/GetServiceSettings

func (*LicenseManagerLinuxSubscriptions) GetServiceSettingsRequest 

func (c *LicenseManagerLinuxSubscriptions) GetServiceSettingsRequest(input *GetServiceSettingsInput) (req *request.Request, output *GetServiceSettingsOutput)

GetServiceSettingsRequest generates a "aws/request.Request" representing the client's request for the GetServiceSettings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetServiceSettings for more information on using the GetServiceSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetServiceSettingsRequest method.
req, resp := client.GetServiceSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/GetServiceSettings

func (*LicenseManagerLinuxSubscriptions) GetServiceSettingsWithContext 

func (c *LicenseManagerLinuxSubscriptions) GetServiceSettingsWithContext(ctx aws.Context, input *GetServiceSettingsInput, opts ...request.Option) (*GetServiceSettingsOutput, error)

GetServiceSettingsWithContext is the same as GetServiceSettings with the addition of the ability to pass a context and additional request options.

See GetServiceSettings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionInstances 

func (c *LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionInstances(input *ListLinuxSubscriptionInstancesInput) (*ListLinuxSubscriptionInstancesOutput, error)

ListLinuxSubscriptionInstances API operation for AWS License Manager Linux Subscriptions.

Lists the running Amazon EC2 instances that were discovered with commercial Linux subscriptions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS License Manager Linux Subscriptions's API operation ListLinuxSubscriptionInstances for usage and error information.

Returned Error Types:

  • InternalServerException An exception occurred with the service.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The provided input is not valid. Try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/ListLinuxSubscriptionInstances

func (*LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionInstancesPages 

func (c *LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionInstancesPages(input *ListLinuxSubscriptionInstancesInput, fn func(*ListLinuxSubscriptionInstancesOutput, bool) bool) error

ListLinuxSubscriptionInstancesPages iterates over the pages of a ListLinuxSubscriptionInstances operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListLinuxSubscriptionInstances method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListLinuxSubscriptionInstances operation.
pageNum := 0
err := client.ListLinuxSubscriptionInstancesPages(params,
    func(page *licensemanagerlinuxsubscriptions.ListLinuxSubscriptionInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionInstancesPagesWithContext 

func (c *LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionInstancesPagesWithContext(ctx aws.Context, input *ListLinuxSubscriptionInstancesInput, fn func(*ListLinuxSubscriptionInstancesOutput, bool) bool, opts ...request.Option) error

ListLinuxSubscriptionInstancesPagesWithContext same as ListLinuxSubscriptionInstancesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionInstancesRequest 

func (c *LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionInstancesRequest(input *ListLinuxSubscriptionInstancesInput) (req *request.Request, output *ListLinuxSubscriptionInstancesOutput)

ListLinuxSubscriptionInstancesRequest generates a "aws/request.Request" representing the client's request for the ListLinuxSubscriptionInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListLinuxSubscriptionInstances for more information on using the ListLinuxSubscriptionInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListLinuxSubscriptionInstancesRequest method.
req, resp := client.ListLinuxSubscriptionInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/ListLinuxSubscriptionInstances

func (*LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionInstancesWithContext 

func (c *LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionInstancesWithContext(ctx aws.Context, input *ListLinuxSubscriptionInstancesInput, opts ...request.Option) (*ListLinuxSubscriptionInstancesOutput, error)

ListLinuxSubscriptionInstancesWithContext is the same as ListLinuxSubscriptionInstances with the addition of the ability to pass a context and additional request options.

See ListLinuxSubscriptionInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LicenseManagerLinuxSubscriptions) ListLinuxSubscriptions 

func (c *LicenseManagerLinuxSubscriptions) ListLinuxSubscriptions(input *ListLinuxSubscriptionsInput) (*ListLinuxSubscriptionsOutput, error)

ListLinuxSubscriptions API operation for AWS License Manager Linux Subscriptions.

Lists the Linux subscriptions that have been discovered. If you have linked your organization, the returned results will include data aggregated across your accounts in Organizations.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS License Manager Linux Subscriptions's API operation ListLinuxSubscriptions for usage and error information.

Returned Error Types:

  • InternalServerException An exception occurred with the service.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The provided input is not valid. Try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/ListLinuxSubscriptions

func (*LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionsPages 

func (c *LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionsPages(input *ListLinuxSubscriptionsInput, fn func(*ListLinuxSubscriptionsOutput, bool) bool) error

ListLinuxSubscriptionsPages iterates over the pages of a ListLinuxSubscriptions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListLinuxSubscriptions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListLinuxSubscriptions operation.
pageNum := 0
err := client.ListLinuxSubscriptionsPages(params,
    func(page *licensemanagerlinuxsubscriptions.ListLinuxSubscriptionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionsPagesWithContext 

func (c *LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionsPagesWithContext(ctx aws.Context, input *ListLinuxSubscriptionsInput, fn func(*ListLinuxSubscriptionsOutput, bool) bool, opts ...request.Option) error

ListLinuxSubscriptionsPagesWithContext same as ListLinuxSubscriptionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionsRequest 

func (c *LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionsRequest(input *ListLinuxSubscriptionsInput) (req *request.Request, output *ListLinuxSubscriptionsOutput)

ListLinuxSubscriptionsRequest generates a "aws/request.Request" representing the client's request for the ListLinuxSubscriptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListLinuxSubscriptions for more information on using the ListLinuxSubscriptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListLinuxSubscriptionsRequest method.
req, resp := client.ListLinuxSubscriptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/ListLinuxSubscriptions

func (*LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionsWithContext 

func (c *LicenseManagerLinuxSubscriptions) ListLinuxSubscriptionsWithContext(ctx aws.Context, input *ListLinuxSubscriptionsInput, opts ...request.Option) (*ListLinuxSubscriptionsOutput, error)

ListLinuxSubscriptionsWithContext is the same as ListLinuxSubscriptions with the addition of the ability to pass a context and additional request options.

See ListLinuxSubscriptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*LicenseManagerLinuxSubscriptions) UpdateServiceSettings 

func (c *LicenseManagerLinuxSubscriptions) UpdateServiceSettings(input *UpdateServiceSettingsInput) (*UpdateServiceSettingsOutput, error)

UpdateServiceSettings API operation for AWS License Manager Linux Subscriptions.

Updates the service settings for Linux subscriptions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS License Manager Linux Subscriptions's API operation UpdateServiceSettings for usage and error information.

Returned Error Types:

  • InternalServerException An exception occurred with the service.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The provided input is not valid. Try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/UpdateServiceSettings

func (*LicenseManagerLinuxSubscriptions) UpdateServiceSettingsRequest 

func (c *LicenseManagerLinuxSubscriptions) UpdateServiceSettingsRequest(input *UpdateServiceSettingsInput) (req *request.Request, output *UpdateServiceSettingsOutput)

UpdateServiceSettingsRequest generates a "aws/request.Request" representing the client's request for the UpdateServiceSettings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateServiceSettings for more information on using the UpdateServiceSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateServiceSettingsRequest method.
req, resp := client.UpdateServiceSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/license-manager-linux-subscriptions-2018-05-10/UpdateServiceSettings

func (*LicenseManagerLinuxSubscriptions) UpdateServiceSettingsWithContext 

func (c *LicenseManagerLinuxSubscriptions) UpdateServiceSettingsWithContext(ctx aws.Context, input *UpdateServiceSettingsInput, opts ...request.Option) (*UpdateServiceSettingsOutput, error)

UpdateServiceSettingsWithContext is the same as UpdateServiceSettings with the addition of the ability to pass a context and additional request options.

See UpdateServiceSettings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type LinuxSubscriptionsDiscoverySettings 

type LinuxSubscriptionsDiscoverySettings struct {

	// Details if you have enabled resource discovery across your accounts in Organizations.
	//
	// OrganizationIntegration is a required field
	OrganizationIntegration *string `type:"string" required:"true" enum:"OrganizationIntegration"`

	// The Regions in which to discover data for Linux subscriptions.
	//
	// SourceRegions is a required field
	SourceRegions []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Lists the settings defined for discovering Linux subscriptions.

func (LinuxSubscriptionsDiscoverySettings) GoString 

func (s LinuxSubscriptionsDiscoverySettings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LinuxSubscriptionsDiscoverySettings) SetOrganizationIntegration 

func (s *LinuxSubscriptionsDiscoverySettings) SetOrganizationIntegration(v string) *LinuxSubscriptionsDiscoverySettings

SetOrganizationIntegration sets the OrganizationIntegration field's value.

func (*LinuxSubscriptionsDiscoverySettings) SetSourceRegions 

func (s *LinuxSubscriptionsDiscoverySettings) SetSourceRegions(v []*string) *LinuxSubscriptionsDiscoverySettings

SetSourceRegions sets the SourceRegions field's value.

func (LinuxSubscriptionsDiscoverySettings) String 

func (s LinuxSubscriptionsDiscoverySettings) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LinuxSubscriptionsDiscoverySettings) Validate 

func (s *LinuxSubscriptionsDiscoverySettings) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListLinuxSubscriptionInstancesInput 

type ListLinuxSubscriptionInstancesInput struct {

	// An array of structures that you can use to filter the results to those that
	// match one or more sets of key-value pairs that you specify. For example,
	// you can filter by the name of AmiID with an optional operator to see subscriptions
	// that match, partially match, or don't match a certain Amazon Machine Image
	// (AMI) ID.
	//
	// The valid names for this filter are:
	//
	//    * AmiID
	//
	//    * InstanceID
	//
	//    * AccountID
	//
	//    * Status
	//
	//    * Region
	//
	//    * UsageOperation
	//
	//    * ProductCode
	//
	//    * InstanceType
	//
	// The valid Operators for this filter are:
	//
	//    * contains
	//
	//    * equals
	//
	//    * Notequal
	Filters []*Filter `type:"list"`

	// Maximum number of results to return in a single call.
	MaxResults *int64 `type:"integer"`

	// Token for the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

NextToken length limit is half of ddb accepted limit. Increase this limit if parameters in request increases.

func (ListLinuxSubscriptionInstancesInput) GoString 

func (s ListLinuxSubscriptionInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLinuxSubscriptionInstancesInput) SetFilters 

func (s *ListLinuxSubscriptionInstancesInput) SetFilters(v []*Filter) *ListLinuxSubscriptionInstancesInput

SetFilters sets the Filters field's value.

func (*ListLinuxSubscriptionInstancesInput) SetMaxResults 

func (s *ListLinuxSubscriptionInstancesInput) SetMaxResults(v int64) *ListLinuxSubscriptionInstancesInput

SetMaxResults sets the MaxResults field's value.

func (*ListLinuxSubscriptionInstancesInput) SetNextToken 

func (s *ListLinuxSubscriptionInstancesInput) SetNextToken(v string) *ListLinuxSubscriptionInstancesInput

SetNextToken sets the NextToken field's value.

func (ListLinuxSubscriptionInstancesInput) String 

func (s ListLinuxSubscriptionInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLinuxSubscriptionInstancesInput) Validate 

func (s *ListLinuxSubscriptionInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListLinuxSubscriptionInstancesOutput 

type ListLinuxSubscriptionInstancesOutput struct {

	// An array that contains instance objects.
	Instances []*Instance `type:"list"`

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

func (ListLinuxSubscriptionInstancesOutput) GoString 

func (s ListLinuxSubscriptionInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLinuxSubscriptionInstancesOutput) SetInstances 

func (s *ListLinuxSubscriptionInstancesOutput) SetInstances(v []*Instance) *ListLinuxSubscriptionInstancesOutput

SetInstances sets the Instances field's value.

func (*ListLinuxSubscriptionInstancesOutput) SetNextToken 

func (s *ListLinuxSubscriptionInstancesOutput) SetNextToken(v string) *ListLinuxSubscriptionInstancesOutput

SetNextToken sets the NextToken field's value.

func (ListLinuxSubscriptionInstancesOutput) String 

func (s ListLinuxSubscriptionInstancesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListLinuxSubscriptionsInput 

type ListLinuxSubscriptionsInput struct {

	// An array of structures that you can use to filter the results to those that
	// match one or more sets of key-value pairs that you specify. For example,
	// you can filter by the name of Subscription with an optional operator to see
	// subscriptions that match, partially match, or don't match a certain subscription's
	// name.
	//
	// The valid names for this filter are:
	//
	//    * Subscription
	//
	// The valid Operators for this filter are:
	//
	//    * contains
	//
	//    * equals
	//
	//    * Notequal
	Filters []*Filter `type:"list"`

	// Maximum number of results to return in a single call.
	MaxResults *int64 `type:"integer"`

	// Token for the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

NextToken length limit is half of ddb accepted limit. Increase this limit if parameters in request increases.

func (ListLinuxSubscriptionsInput) GoString 

func (s ListLinuxSubscriptionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLinuxSubscriptionsInput) SetFilters 

func (s *ListLinuxSubscriptionsInput) SetFilters(v []*Filter) *ListLinuxSubscriptionsInput

SetFilters sets the Filters field's value.

func (*ListLinuxSubscriptionsInput) SetMaxResults 

func (s *ListLinuxSubscriptionsInput) SetMaxResults(v int64) *ListLinuxSubscriptionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListLinuxSubscriptionsInput) SetNextToken 

func (s *ListLinuxSubscriptionsInput) SetNextToken(v string) *ListLinuxSubscriptionsInput

SetNextToken sets the NextToken field's value.

func (ListLinuxSubscriptionsInput) String 

func (s ListLinuxSubscriptionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLinuxSubscriptionsInput) Validate 

func (s *ListLinuxSubscriptionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListLinuxSubscriptionsOutput 

type ListLinuxSubscriptionsOutput struct {

	// Token for the next set of results.
	NextToken *string `type:"string"`

	// An array that contains subscription objects.
	Subscriptions []*Subscription `type:"list"`
	// contains filtered or unexported fields
}

func (ListLinuxSubscriptionsOutput) GoString 

func (s ListLinuxSubscriptionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLinuxSubscriptionsOutput) SetNextToken 

func (s *ListLinuxSubscriptionsOutput) SetNextToken(v string) *ListLinuxSubscriptionsOutput

SetNextToken sets the NextToken field's value.

func (*ListLinuxSubscriptionsOutput) SetSubscriptions 

func (s *ListLinuxSubscriptionsOutput) SetSubscriptions(v []*Subscription) *ListLinuxSubscriptionsOutput

SetSubscriptions sets the Subscriptions field's value.

func (ListLinuxSubscriptionsOutput) String 

func (s ListLinuxSubscriptionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Subscription 

type Subscription struct {

	// The total amount of running instances using this subscription.
	InstanceCount *int64 `type:"long"`

	// The name of the subscription.
	Name *string `type:"string"`

	// The type of subscription. The type can be subscription-included with Amazon
	// EC2, Bring Your Own Subscription model (BYOS), or from the Amazon Web Services
	// Marketplace. Certain subscriptions may use licensing from the Amazon Web
	// Services Marketplace as well as OS licensing from Amazon EC2 or BYOS.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

An object which details a discovered Linux subscription.

func (Subscription) GoString 

func (s Subscription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Subscription) SetInstanceCount 

func (s *Subscription) SetInstanceCount(v int64) *Subscription

SetInstanceCount sets the InstanceCount field's value.

func (*Subscription) SetName 

func (s *Subscription) SetName(v string) *Subscription

SetName sets the Name field's value.

func (*Subscription) SetType 

func (s *Subscription) SetType(v string) *Subscription

SetType sets the Type field's value.

func (Subscription) String 

func (s Subscription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateServiceSettingsInput 

type UpdateServiceSettingsInput struct {

	// Describes if updates are allowed to the service settings for Linux subscriptions.
	// If you allow updates, you can aggregate Linux subscription data in more than
	// one home Region.
	AllowUpdate *bool `type:"boolean"`

	// Describes if the discovery of Linux subscriptions is enabled.
	//
	// LinuxSubscriptionsDiscovery is a required field
	LinuxSubscriptionsDiscovery *string `type:"string" required:"true" enum:"LinuxSubscriptionsDiscovery"`

	// The settings defined for Linux subscriptions discovery. The settings include
	// if Organizations integration has been enabled, and which Regions data will
	// be aggregated from.
	//
	// LinuxSubscriptionsDiscoverySettings is a required field
	LinuxSubscriptionsDiscoverySettings *LinuxSubscriptionsDiscoverySettings `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateServiceSettingsInput) GoString 

func (s UpdateServiceSettingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateServiceSettingsInput) SetAllowUpdate 

func (s *UpdateServiceSettingsInput) SetAllowUpdate(v bool) *UpdateServiceSettingsInput

SetAllowUpdate sets the AllowUpdate field's value.

func (*UpdateServiceSettingsInput) SetLinuxSubscriptionsDiscovery 

func (s *UpdateServiceSettingsInput) SetLinuxSubscriptionsDiscovery(v string) *UpdateServiceSettingsInput

SetLinuxSubscriptionsDiscovery sets the LinuxSubscriptionsDiscovery field's value.

func (*UpdateServiceSettingsInput) SetLinuxSubscriptionsDiscoverySettings 

func (s *UpdateServiceSettingsInput) SetLinuxSubscriptionsDiscoverySettings(v *LinuxSubscriptionsDiscoverySettings) *UpdateServiceSettingsInput

SetLinuxSubscriptionsDiscoverySettings sets the LinuxSubscriptionsDiscoverySettings field's value.

func (UpdateServiceSettingsInput) String 

func (s UpdateServiceSettingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateServiceSettingsInput) Validate 

func (s *UpdateServiceSettingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateServiceSettingsOutput 

type UpdateServiceSettingsOutput struct {

	// The Region in which License Manager displays the aggregated data for Linux
	// subscriptions.
	HomeRegions []*string `min:"1" type:"list"`

	// Lists if discovery has been enabled for Linux subscriptions.
	LinuxSubscriptionsDiscovery *string `type:"string" enum:"LinuxSubscriptionsDiscovery"`

	// The settings defined for Linux subscriptions discovery. The settings include
	// if Organizations integration has been enabled, and which Regions data will
	// be aggregated from.
	LinuxSubscriptionsDiscoverySettings *LinuxSubscriptionsDiscoverySettings `type:"structure"`

	// Indicates the status of Linux subscriptions settings being applied.
	Status *string `type:"string" enum:"Status"`

	// A message which details the Linux subscriptions service settings current
	// status.
	StatusMessage map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (UpdateServiceSettingsOutput) GoString 

func (s UpdateServiceSettingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateServiceSettingsOutput) SetHomeRegions 

func (s *UpdateServiceSettingsOutput) SetHomeRegions(v []*string) *UpdateServiceSettingsOutput

SetHomeRegions sets the HomeRegions field's value.

func (*UpdateServiceSettingsOutput) SetLinuxSubscriptionsDiscovery 

func (s *UpdateServiceSettingsOutput) SetLinuxSubscriptionsDiscovery(v string) *UpdateServiceSettingsOutput

SetLinuxSubscriptionsDiscovery sets the LinuxSubscriptionsDiscovery field's value.

func (*UpdateServiceSettingsOutput) SetLinuxSubscriptionsDiscoverySettings 

func (s *UpdateServiceSettingsOutput) SetLinuxSubscriptionsDiscoverySettings(v *LinuxSubscriptionsDiscoverySettings) *UpdateServiceSettingsOutput

SetLinuxSubscriptionsDiscoverySettings sets the LinuxSubscriptionsDiscoverySettings field's value.

func (*UpdateServiceSettingsOutput) SetStatus 

func (s *UpdateServiceSettingsOutput) SetStatus(v string) *UpdateServiceSettingsOutput

SetStatus sets the Status field's value.

func (*UpdateServiceSettingsOutput) SetStatusMessage 

func (s *UpdateServiceSettingsOutput) SetStatusMessage(v map[string]*string) *UpdateServiceSettingsOutput

SetStatusMessage sets the StatusMessage field's value.

func (UpdateServiceSettingsOutput) String 

func (s UpdateServiceSettingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The provided input is not valid. Try your request again.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package licensemanagerlinuxsubscriptionsiface provides an interface to enable mocking the AWS License Manager Linux Subscriptions service client for testing your code.
 Package licensemanagerlinuxsubscriptionsiface provides an interface to enable mocking the AWS License Manager Linux Subscriptions service client for testing your code.

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.