Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

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

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

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

	// The product code for which the given entitlement applies. Product codes are
	// provided by AWS Marketplace when the product listing is created.
	ProductCode *string

	// The EntitlementValue represents the amount of capacity that the customer is
	// entitled to for the product.
	Value EntitlementValue
}

    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.

    type EntitlementValue

    type EntitlementValue interface {
    	// contains filtered or unexported methods
    }

      The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.

      The following types satisfy this interface:

      EntitlementValueMemberIntegerValue
      EntitlementValueMemberDoubleValue
      EntitlementValueMemberBooleanValue
      EntitlementValueMemberStringValue
      
      Example (OutputUsage)
      Output:
      
      

      type EntitlementValueMemberBooleanValue

      type EntitlementValueMemberBooleanValue struct {
      	Value bool
      }

        The BooleanValue field will be populated with a boolean value when the entitlement is a boolean type. Otherwise, the field will not be set.

        type EntitlementValueMemberDoubleValue

        type EntitlementValueMemberDoubleValue struct {
        	Value float64
        }

          The DoubleValue field will be populated with a double value when the entitlement is a double type. Otherwise, the field will not be set.

          type EntitlementValueMemberIntegerValue

          type EntitlementValueMemberIntegerValue struct {
          	Value int32
          }

            The IntegerValue field will be populated with an integer value when the entitlement is an integer type. Otherwise, the field will not be set.

            type EntitlementValueMemberStringValue

            type EntitlementValueMemberStringValue struct {
            	Value string
            }

              The StringValue field will be populated with a string value when the entitlement is a string type. Otherwise, the field will not be set.

              type GetEntitlementFilterName

              type GetEntitlementFilterName string
              const (
              	GetEntitlementFilterNameCustomerIdentifier GetEntitlementFilterName = "CUSTOMER_IDENTIFIER"
              	GetEntitlementFilterNameDimension          GetEntitlementFilterName = "DIMENSION"
              )

                Enum values for GetEntitlementFilterName

                func (GetEntitlementFilterName) Values

                  Values returns all known values for GetEntitlementFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                  type InternalServiceErrorException

                  type InternalServiceErrorException struct {
                  	Message *string
                  }

                    An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

                    func (*InternalServiceErrorException) Error

                    func (*InternalServiceErrorException) ErrorCode

                    func (e *InternalServiceErrorException) ErrorCode() string

                    func (*InternalServiceErrorException) ErrorFault

                    func (*InternalServiceErrorException) ErrorMessage

                    func (e *InternalServiceErrorException) ErrorMessage() string

                    type InvalidParameterException

                    type InvalidParameterException struct {
                    	Message *string
                    }

                      One or more parameters in your request was invalid.

                      func (*InvalidParameterException) Error

                      func (e *InvalidParameterException) Error() string

                      func (*InvalidParameterException) ErrorCode

                      func (e *InvalidParameterException) ErrorCode() string

                      func (*InvalidParameterException) ErrorFault

                      func (*InvalidParameterException) ErrorMessage

                      func (e *InvalidParameterException) ErrorMessage() string

                      type ThrottlingException

                      type ThrottlingException struct {
                      	Message *string
                      }

                        The calls to the GetEntitlements API are throttled.

                        func (*ThrottlingException) Error

                        func (e *ThrottlingException) Error() string

                        func (*ThrottlingException) ErrorCode

                        func (e *ThrottlingException) ErrorCode() string

                        func (*ThrottlingException) ErrorFault

                        func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

                        func (*ThrottlingException) ErrorMessage

                        func (e *ThrottlingException) ErrorMessage() string

                        type UnknownUnionMember

                        type UnknownUnionMember struct {
                        	Tag   string
                        	Value []byte
                        }

                          UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.