Documentation ¶
Overview ¶
Package marketplaceentitlementservice provides the client and types for making API requests to AWS Marketplace Entitlement Service.
This reference provides descriptions of the AWS Marketplace Entitlement Service API.
AWS Marketplace Entitlement Service is used to determine the entitlement of a customer to a given product. An entitlement represents capacity in a product owned by the customer. For example, a customer might own some number of users or seats in an SaaS application or some amount of data capacity in a multi-tenant database.
Getting Entitlement Records
- GetEntitlements- Gets the entitlements for a Marketplace product.
See https://docs.aws.amazon.com/goto/WebAPI/entitlement.marketplace-2017-01-11 for more information on this service.
See marketplaceentitlementservice package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/marketplaceentitlementservice/
Using the Client ¶
To use AWS Marketplace Entitlement Service 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 Marketplace Entitlement Service client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/marketplaceentitlementservice/#New
Index ¶
Constants ¶
const ( ServiceName = "AWS Marketplace Entitlement Service" // Service's name ServiceID = "MarketplaceEntitlementService" // Service's identifier EndpointsID = "entitlement.marketplace" // Service's Endpoint identifier )
const ( // ErrCodeInternalServiceErrorException for service response error code // "InternalServiceErrorException". // // An internal error has occurred. Retry your request. If the problem persists, // post a message with details on the AWS forums. ErrCodeInternalServiceErrorException = "InternalServiceErrorException" // ErrCodeInvalidParameterException for service response error code // "InvalidParameterException". // // One or more parameters in your request was invalid. ErrCodeInvalidParameterException = "InvalidParameterException" // ErrCodeThrottlingException for service response error code // "ThrottlingException". // // The calls to the GetEntitlements API are throttled. ErrCodeThrottlingException = "ThrottlingException" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶ added in v0.9.0
Client provides the API operation methods for making requests to AWS Marketplace Entitlement Service. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := marketplaceentitlementservice.New(myConfig)
func (*Client) GetEntitlementsRequest ¶ added in v0.9.0
func (c *Client) GetEntitlementsRequest(input *GetEntitlementsInput) GetEntitlementsRequest
GetEntitlementsRequest returns a request value for making API operation for AWS Marketplace Entitlement Service.
GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.
// Example sending a request using GetEntitlementsRequest. req := client.GetEntitlementsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/entitlement.marketplace-2017-01-11/GetEntitlements
type Entitlement ¶
type Entitlement struct { // The customer identifier is a handle to each unique customer in an application. // Customer identifiers are obtained through the ResolveCustomer operation in // AWS Marketplace Metering Service. CustomerIdentifier *string `type:"string"` // The dimension for which the given entitlement applies. Dimensions represent // categories of capacity in a product and are specified when the product is // listed in AWS Marketplace. Dimension *string `type:"string"` // The expiration date represents the minimum date through which this entitlement // is expected to remain valid. For contractual products listed on AWS Marketplace, // the expiration date is the date at which the customer will renew or cancel // their contract. Customers who are opting to renew their contract will still // have entitlements with an expiration date. ExpirationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The product code for which the given entitlement applies. Product codes are // provided by AWS Marketplace when the product listing is created. ProductCode *string `min:"1" type:"string"` // The EntitlementValue represents the amount of capacity that the customer // is entitled to for the product. Value *EntitlementValue `type:"structure"` // contains filtered or unexported fields }
An entitlement represents capacity in a product owned by the customer. For example, a customer might own some number of users or seats in an SaaS application or some amount of data capacity in a multi-tenant database. Please also see https://docs.aws.amazon.com/goto/WebAPI/entitlement.marketplace-2017-01-11/Entitlement
func (Entitlement) String ¶
func (s Entitlement) String() string
String returns the string representation
type EntitlementValue ¶
type EntitlementValue struct { // The BooleanValue field will be populated with a boolean value when the entitlement // is a boolean type. Otherwise, the field will not be set. BooleanValue *bool `type:"boolean"` // The DoubleValue field will be populated with a double value when the entitlement // is a double type. Otherwise, the field will not be set. DoubleValue *float64 `type:"double"` // The IntegerValue field will be populated with an integer value when the entitlement // is an integer type. Otherwise, the field will not be set. IntegerValue *int64 `type:"integer"` // The StringValue field will be populated with a string value when the entitlement // is a string type. Otherwise, the field will not be set. StringValue *string `type:"string"` // contains filtered or unexported fields }
The EntitlementValue represents the amount of capacity that the customer is entitled to for the product. Please also see https://docs.aws.amazon.com/goto/WebAPI/entitlement.marketplace-2017-01-11/EntitlementValue
func (EntitlementValue) String ¶
func (s EntitlementValue) String() string
String returns the string representation
type GetEntitlementFilterName ¶
type GetEntitlementFilterName string
const ( GetEntitlementFilterNameCustomerIdentifier GetEntitlementFilterName = "CUSTOMER_IDENTIFIER" GetEntitlementFilterNameDimension GetEntitlementFilterName = "DIMENSION" )
Enum values for GetEntitlementFilterName
func (GetEntitlementFilterName) MarshalValue ¶ added in v0.3.0
func (enum GetEntitlementFilterName) MarshalValue() (string, error)
func (GetEntitlementFilterName) MarshalValueBuf ¶ added in v0.3.0
func (enum GetEntitlementFilterName) MarshalValueBuf(b []byte) ([]byte, error)
type GetEntitlementsInput ¶
type GetEntitlementsInput struct { // Filter is used to return entitlements for a specific customer or for a specific // dimension. Filters are described as keys mapped to a lists of values. Filtered // requests are unioned for each value in the value list, and then intersected // for each filter key. Filter map[string][]string `type:"map"` // The maximum number of items to retrieve from the GetEntitlements operation. // For pagination, use the NextToken field in subsequent calls to GetEntitlements. MaxResults *int64 `type:"integer"` // For paginated calls to GetEntitlements, pass the NextToken from the previous // GetEntitlementsResult. NextToken *string `type:"string"` // Product code is used to uniquely identify a product in AWS Marketplace. The // product code will be provided by AWS Marketplace when the product listing // is created. // // ProductCode is a required field ProductCode *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The GetEntitlementsRequest contains parameters for the GetEntitlements operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/entitlement.marketplace-2017-01-11/GetEntitlementsRequest
func (GetEntitlementsInput) String ¶
func (s GetEntitlementsInput) String() string
String returns the string representation
func (*GetEntitlementsInput) Validate ¶
func (s *GetEntitlementsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetEntitlementsOutput ¶
type GetEntitlementsOutput struct { // The set of entitlements found through the GetEntitlements operation. If the // result contains an empty set of entitlements, NextToken might still be present // and should be used. Entitlements []Entitlement `type:"list"` // For paginated results, use NextToken in subsequent calls to GetEntitlements. // If the result contains an empty set of entitlements, NextToken might still // be present and should be used. NextToken *string `type:"string"` // contains filtered or unexported fields }
The GetEntitlementsRequest contains results from the GetEntitlements operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/entitlement.marketplace-2017-01-11/GetEntitlementsResult
func (GetEntitlementsOutput) String ¶
func (s GetEntitlementsOutput) String() string
String returns the string representation
type GetEntitlementsRequest ¶
type GetEntitlementsRequest struct { *aws.Request Input *GetEntitlementsInput Copy func(*GetEntitlementsInput) GetEntitlementsRequest }
GetEntitlementsRequest is the request type for the GetEntitlements API operation.
func (GetEntitlementsRequest) Send ¶
func (r GetEntitlementsRequest) Send(ctx context.Context) (*GetEntitlementsResponse, error)
Send marshals and sends the GetEntitlements API request.
type GetEntitlementsResponse ¶ added in v0.9.0
type GetEntitlementsResponse struct { *GetEntitlementsOutput // contains filtered or unexported fields }
GetEntitlementsResponse is the response type for the GetEntitlements API operation.
func (*GetEntitlementsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetEntitlementsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetEntitlements request.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package marketplaceentitlementserviceiface provides an interface to enable mocking the AWS Marketplace Entitlement Service service client for testing your code.
|
Package marketplaceentitlementserviceiface provides an interface to enable mocking the AWS Marketplace Entitlement Service service client for testing your code. |