aws-sdk-marketplaceentitlementservice 1.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-marketplaceentitlementservice/client.rb +255 -0
- data/lib/aws-sdk-marketplaceentitlementservice/client_api.rb +94 -0
- data/lib/aws-sdk-marketplaceentitlementservice/customizations.rb +0 -0
- data/lib/aws-sdk-marketplaceentitlementservice/errors.rb +14 -0
- data/lib/aws-sdk-marketplaceentitlementservice/resource.rb +23 -0
- data/lib/aws-sdk-marketplaceentitlementservice/types.rb +167 -0
- data/lib/aws-sdk-marketplaceentitlementservice.rb +47 -0
- metadata +80 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: ab538225009ce0794b7ddbee9d267a698bba9876
|
4
|
+
data.tar.gz: ce72fcac1710079d0835bf1d9645031eab271ec2
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 1960ed4f0bd022d8a4bd962ce4d8ddec6b4ef34ef698e0f7a18948826356d3e3903ce527f6ca9e2b5ef5cad705aa28063022d0a22656eaf365339bff0376c88c
|
7
|
+
data.tar.gz: 988822bbcef9d833302d3e0d1f9fa4941c83e068398dd37b884574b9b4d17bca162a82af05ef674c9ffebe1f50ac24995dd96c0e8124b3b61624245ab72e14ea
|
@@ -0,0 +1,255 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
22
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
23
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
24
|
+
|
25
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:marketplaceentitlementservice)
|
26
|
+
|
27
|
+
module Aws::MarketplaceEntitlementService
|
28
|
+
class Client < Seahorse::Client::Base
|
29
|
+
|
30
|
+
include Aws::ClientStubs
|
31
|
+
|
32
|
+
@identifier = :marketplaceentitlementservice
|
33
|
+
|
34
|
+
set_api(ClientApi::API)
|
35
|
+
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
49
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
50
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
51
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
52
|
+
|
53
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
54
|
+
# Your AWS credentials. This can be an instance of any one of the
|
55
|
+
# following classes:
|
56
|
+
#
|
57
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
58
|
+
# credentials.
|
59
|
+
#
|
60
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
61
|
+
# from an EC2 IMDS on an EC2 instance.
|
62
|
+
#
|
63
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
64
|
+
# shared file, such as `~/.aws/config`.
|
65
|
+
#
|
66
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
67
|
+
#
|
68
|
+
# When `:credentials` are not configured directly, the following
|
69
|
+
# locations will be searched for credentials:
|
70
|
+
#
|
71
|
+
# * `Aws.config[:credentials]`
|
72
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
73
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
74
|
+
# * `~/.aws/credentials`
|
75
|
+
# * `~/.aws/config`
|
76
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
77
|
+
# very aggressive. Construct and pass an instance of
|
78
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
79
|
+
# timeouts.
|
80
|
+
#
|
81
|
+
# @option options [required, String] :region
|
82
|
+
# The AWS region to connect to. The configured `:region` is
|
83
|
+
# used to determine the service `:endpoint`. When not passed,
|
84
|
+
# a default `:region` is search for in the following locations:
|
85
|
+
#
|
86
|
+
# * `Aws.config[:region]`
|
87
|
+
# * `ENV['AWS_REGION']`
|
88
|
+
# * `ENV['AMAZON_REGION']`
|
89
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
90
|
+
# * `~/.aws/credentials`
|
91
|
+
# * `~/.aws/config`
|
92
|
+
#
|
93
|
+
# @option options [String] :access_key_id
|
94
|
+
#
|
95
|
+
# @option options [Boolean] :convert_params (true)
|
96
|
+
# When `true`, an attempt is made to coerce request parameters into
|
97
|
+
# the required types.
|
98
|
+
#
|
99
|
+
# @option options [String] :endpoint
|
100
|
+
# The client endpoint is normally constructed from the `:region`
|
101
|
+
# option. You should only configure an `:endpoint` when connecting
|
102
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
103
|
+
#
|
104
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
105
|
+
# The log formatter.
|
106
|
+
#
|
107
|
+
# @option options [Symbol] :log_level (:info)
|
108
|
+
# The log level to send messages to the `:logger` at.
|
109
|
+
#
|
110
|
+
# @option options [Logger] :logger
|
111
|
+
# The Logger instance to send log messages to. If this option
|
112
|
+
# is not set, logging will be disabled.
|
113
|
+
#
|
114
|
+
# @option options [String] :profile ("default")
|
115
|
+
# Used when loading credentials from the shared credentials file
|
116
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
117
|
+
#
|
118
|
+
# @option options [Integer] :retry_limit (3)
|
119
|
+
# The maximum number of times to retry failed requests. Only
|
120
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
121
|
+
# are retried. Generally, these are throttling errors, data
|
122
|
+
# checksum errors, networking errors, timeout errors and auth
|
123
|
+
# errors from expired credentials.
|
124
|
+
#
|
125
|
+
# @option options [String] :secret_access_key
|
126
|
+
#
|
127
|
+
# @option options [String] :session_token
|
128
|
+
#
|
129
|
+
# @option options [Boolean] :simple_json (false)
|
130
|
+
# Disables request parameter conversion, validation, and formatting.
|
131
|
+
# Also disable response data type conversions. This option is useful
|
132
|
+
# when you want to ensure the highest level of performance by
|
133
|
+
# avoiding overhead of walking request parameters and response data
|
134
|
+
# structures.
|
135
|
+
#
|
136
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
137
|
+
# be formatted exactly as the DynamoDB API expects.
|
138
|
+
#
|
139
|
+
# @option options [Boolean] :stub_responses (false)
|
140
|
+
# Causes the client to return stubbed responses. By default
|
141
|
+
# fake responses are generated and returned. You can specify
|
142
|
+
# the response data to return or errors to raise by calling
|
143
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
144
|
+
#
|
145
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
146
|
+
# requests are made, and retries are disabled.
|
147
|
+
#
|
148
|
+
# @option options [Boolean] :validate_params (true)
|
149
|
+
# When `true`, request parameters are validated before
|
150
|
+
# sending the request.
|
151
|
+
#
|
152
|
+
def initialize(*args)
|
153
|
+
super
|
154
|
+
end
|
155
|
+
|
156
|
+
# @!group API Operations
|
157
|
+
|
158
|
+
# GetEntitlements retrieves entitlement values for a given product. The
|
159
|
+
# results can be filtered based on customer identifier or product
|
160
|
+
# dimensions.
|
161
|
+
#
|
162
|
+
# @option params [required, String] :product_code
|
163
|
+
# Product code is used to uniquely identify a product in AWS
|
164
|
+
# Marketplace. The product code will be provided by AWS Marketplace when
|
165
|
+
# the product listing is created.
|
166
|
+
#
|
167
|
+
# @option params [Hash<String,Array>] :filter
|
168
|
+
# Filter is used to return entitlements for a specific customer or for a
|
169
|
+
# specific dimension. Filters are described as keys mapped to a lists of
|
170
|
+
# values. Filtered requests are *unioned* for each value in the value
|
171
|
+
# list, and then *intersected* for each filter key.
|
172
|
+
#
|
173
|
+
# @option params [String] :next_token
|
174
|
+
# For paginated calls to GetEntitlements, pass the NextToken from the
|
175
|
+
# previous GetEntitlementsResult.
|
176
|
+
#
|
177
|
+
# @option params [Integer] :max_results
|
178
|
+
# The maximum number of items to retrieve from the GetEntitlements
|
179
|
+
# operation. For pagination, use the NextToken field in subsequent calls
|
180
|
+
# to GetEntitlements.
|
181
|
+
#
|
182
|
+
# @return [Types::GetEntitlementsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
183
|
+
#
|
184
|
+
# * {Types::GetEntitlementsResult#entitlements #entitlements} => Array<Types::Entitlement>
|
185
|
+
# * {Types::GetEntitlementsResult#next_token #next_token} => String
|
186
|
+
#
|
187
|
+
# @example Request syntax with placeholder values
|
188
|
+
#
|
189
|
+
# resp = client.get_entitlements({
|
190
|
+
# product_code: "ProductCode", # required
|
191
|
+
# filter: {
|
192
|
+
# "CUSTOMER_IDENTIFIER" => ["FilterValue"],
|
193
|
+
# },
|
194
|
+
# next_token: "NonEmptyString",
|
195
|
+
# max_results: 1,
|
196
|
+
# })
|
197
|
+
#
|
198
|
+
# @example Response structure
|
199
|
+
#
|
200
|
+
# resp.entitlements #=> Array
|
201
|
+
# resp.entitlements[0].product_code #=> String
|
202
|
+
# resp.entitlements[0].dimension #=> String
|
203
|
+
# resp.entitlements[0].customer_identifier #=> String
|
204
|
+
# resp.entitlements[0].value.integer_value #=> Integer
|
205
|
+
# resp.entitlements[0].value.double_value #=> Float
|
206
|
+
# resp.entitlements[0].value.boolean_value #=> Boolean
|
207
|
+
# resp.entitlements[0].value.string_value #=> String
|
208
|
+
# resp.entitlements[0].expiration_date #=> Time
|
209
|
+
# resp.next_token #=> String
|
210
|
+
#
|
211
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entitlement.marketplace-2017-01-11/GetEntitlements AWS API Documentation
|
212
|
+
#
|
213
|
+
# @overload get_entitlements(params = {})
|
214
|
+
# @param [Hash] params ({})
|
215
|
+
def get_entitlements(params = {}, options = {})
|
216
|
+
req = build_request(:get_entitlements, params)
|
217
|
+
req.send_request(options)
|
218
|
+
end
|
219
|
+
|
220
|
+
# @!endgroup
|
221
|
+
|
222
|
+
# @param params ({})
|
223
|
+
# @api private
|
224
|
+
def build_request(operation_name, params = {})
|
225
|
+
handlers = @handlers.for(operation_name)
|
226
|
+
context = Seahorse::Client::RequestContext.new(
|
227
|
+
operation_name: operation_name,
|
228
|
+
operation: config.api.operation(operation_name),
|
229
|
+
client: self,
|
230
|
+
params: params,
|
231
|
+
config: config)
|
232
|
+
context[:gem_name] = 'aws-sdk-marketplaceentitlementservice'
|
233
|
+
context[:gem_version] = '1.0.0.rc1'
|
234
|
+
Seahorse::Client::Request.new(handlers, context)
|
235
|
+
end
|
236
|
+
|
237
|
+
# @api private
|
238
|
+
# @deprecated
|
239
|
+
def waiter_names
|
240
|
+
[]
|
241
|
+
end
|
242
|
+
|
243
|
+
class << self
|
244
|
+
|
245
|
+
# @api private
|
246
|
+
attr_reader :identifier
|
247
|
+
|
248
|
+
# @api private
|
249
|
+
def errors_module
|
250
|
+
Errors
|
251
|
+
end
|
252
|
+
|
253
|
+
end
|
254
|
+
end
|
255
|
+
end
|
@@ -0,0 +1,94 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::MarketplaceEntitlementService
|
9
|
+
# @api private
|
10
|
+
module ClientApi
|
11
|
+
|
12
|
+
include Seahorse::Model
|
13
|
+
|
14
|
+
Boolean = Shapes::BooleanShape.new(name: 'Boolean')
|
15
|
+
Double = Shapes::FloatShape.new(name: 'Double')
|
16
|
+
Entitlement = Shapes::StructureShape.new(name: 'Entitlement')
|
17
|
+
EntitlementList = Shapes::ListShape.new(name: 'EntitlementList')
|
18
|
+
EntitlementValue = Shapes::StructureShape.new(name: 'EntitlementValue')
|
19
|
+
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
20
|
+
FilterValue = Shapes::StringShape.new(name: 'FilterValue')
|
21
|
+
FilterValueList = Shapes::ListShape.new(name: 'FilterValueList')
|
22
|
+
GetEntitlementFilterName = Shapes::StringShape.new(name: 'GetEntitlementFilterName')
|
23
|
+
GetEntitlementFilters = Shapes::MapShape.new(name: 'GetEntitlementFilters')
|
24
|
+
GetEntitlementsRequest = Shapes::StructureShape.new(name: 'GetEntitlementsRequest')
|
25
|
+
GetEntitlementsResult = Shapes::StructureShape.new(name: 'GetEntitlementsResult')
|
26
|
+
Integer = Shapes::IntegerShape.new(name: 'Integer')
|
27
|
+
InternalServiceErrorException = Shapes::StructureShape.new(name: 'InternalServiceErrorException')
|
28
|
+
InvalidParameterException = Shapes::StructureShape.new(name: 'InvalidParameterException')
|
29
|
+
NonEmptyString = Shapes::StringShape.new(name: 'NonEmptyString')
|
30
|
+
ProductCode = Shapes::StringShape.new(name: 'ProductCode')
|
31
|
+
String = Shapes::StringShape.new(name: 'String')
|
32
|
+
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
33
|
+
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
34
|
+
|
35
|
+
Entitlement.add_member(:product_code, Shapes::ShapeRef.new(shape: ProductCode, location_name: "ProductCode"))
|
36
|
+
Entitlement.add_member(:dimension, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "Dimension"))
|
37
|
+
Entitlement.add_member(:customer_identifier, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "CustomerIdentifier"))
|
38
|
+
Entitlement.add_member(:value, Shapes::ShapeRef.new(shape: EntitlementValue, location_name: "Value"))
|
39
|
+
Entitlement.add_member(:expiration_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "ExpirationDate"))
|
40
|
+
Entitlement.struct_class = Types::Entitlement
|
41
|
+
|
42
|
+
EntitlementList.member = Shapes::ShapeRef.new(shape: Entitlement)
|
43
|
+
|
44
|
+
EntitlementValue.add_member(:integer_value, Shapes::ShapeRef.new(shape: Integer, location_name: "IntegerValue"))
|
45
|
+
EntitlementValue.add_member(:double_value, Shapes::ShapeRef.new(shape: Double, location_name: "DoubleValue"))
|
46
|
+
EntitlementValue.add_member(:boolean_value, Shapes::ShapeRef.new(shape: Boolean, location_name: "BooleanValue"))
|
47
|
+
EntitlementValue.add_member(:string_value, Shapes::ShapeRef.new(shape: String, location_name: "StringValue"))
|
48
|
+
EntitlementValue.struct_class = Types::EntitlementValue
|
49
|
+
|
50
|
+
FilterValueList.member = Shapes::ShapeRef.new(shape: FilterValue)
|
51
|
+
|
52
|
+
GetEntitlementFilters.key = Shapes::ShapeRef.new(shape: GetEntitlementFilterName)
|
53
|
+
GetEntitlementFilters.value = Shapes::ShapeRef.new(shape: FilterValueList)
|
54
|
+
|
55
|
+
GetEntitlementsRequest.add_member(:product_code, Shapes::ShapeRef.new(shape: ProductCode, required: true, location_name: "ProductCode"))
|
56
|
+
GetEntitlementsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: GetEntitlementFilters, location_name: "Filter"))
|
57
|
+
GetEntitlementsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "NextToken"))
|
58
|
+
GetEntitlementsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: Integer, location_name: "MaxResults"))
|
59
|
+
GetEntitlementsRequest.struct_class = Types::GetEntitlementsRequest
|
60
|
+
|
61
|
+
GetEntitlementsResult.add_member(:entitlements, Shapes::ShapeRef.new(shape: EntitlementList, location_name: "Entitlements"))
|
62
|
+
GetEntitlementsResult.add_member(:next_token, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "NextToken"))
|
63
|
+
GetEntitlementsResult.struct_class = Types::GetEntitlementsResult
|
64
|
+
|
65
|
+
|
66
|
+
# @api private
|
67
|
+
API = Seahorse::Model::Api.new.tap do |api|
|
68
|
+
|
69
|
+
api.version = "2017-01-11"
|
70
|
+
|
71
|
+
api.metadata = {
|
72
|
+
"endpointPrefix" => "entitlement.marketplace",
|
73
|
+
"jsonVersion" => "1.1",
|
74
|
+
"protocol" => "json",
|
75
|
+
"serviceFullName" => "AWS Marketplace Entitlement Service",
|
76
|
+
"signatureVersion" => "v4",
|
77
|
+
"signingName" => "aws-marketplace",
|
78
|
+
"targetPrefix" => "AWSMPEntitlementService",
|
79
|
+
}
|
80
|
+
|
81
|
+
api.add_operation(:get_entitlements, Seahorse::Model::Operation.new.tap do |o|
|
82
|
+
o.name = "GetEntitlements"
|
83
|
+
o.http_method = "POST"
|
84
|
+
o.http_request_uri = "/"
|
85
|
+
o.input = Shapes::ShapeRef.new(shape: GetEntitlementsRequest)
|
86
|
+
o.output = Shapes::ShapeRef.new(shape: GetEntitlementsResult)
|
87
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
88
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
89
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException)
|
90
|
+
end)
|
91
|
+
end
|
92
|
+
|
93
|
+
end
|
94
|
+
end
|
File without changes
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::MarketplaceEntitlementService
|
9
|
+
module Errors
|
10
|
+
|
11
|
+
extend Aws::Errors::DynamicErrors
|
12
|
+
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::MarketplaceEntitlementService
|
9
|
+
class Resource
|
10
|
+
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
16
|
+
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
20
|
+
end
|
21
|
+
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,167 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::MarketplaceEntitlementService
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# An entitlement represents capacity in a product owned by the customer.
|
12
|
+
# For example, a customer might own some number of users or seats in an
|
13
|
+
# SaaS application or some amount of data capacity in a multi-tenant
|
14
|
+
# database.
|
15
|
+
#
|
16
|
+
# @!attribute [rw] product_code
|
17
|
+
# The product code for which the given entitlement applies. Product
|
18
|
+
# codes are provided by AWS Marketplace when the product listing is
|
19
|
+
# created.
|
20
|
+
# @return [String]
|
21
|
+
#
|
22
|
+
# @!attribute [rw] dimension
|
23
|
+
# The dimension for which the given entitlement applies. Dimensions
|
24
|
+
# represent categories of capacity in a product and are specified when
|
25
|
+
# the product is listed in AWS Marketplace.
|
26
|
+
# @return [String]
|
27
|
+
#
|
28
|
+
# @!attribute [rw] customer_identifier
|
29
|
+
# The customer identifier is a handle to each unique customer in an
|
30
|
+
# application. Customer identifiers are obtained through the
|
31
|
+
# ResolveCustomer operation in AWS Marketplace Metering Service.
|
32
|
+
# @return [String]
|
33
|
+
#
|
34
|
+
# @!attribute [rw] value
|
35
|
+
# The EntitlementValue represents the amount of capacity that the
|
36
|
+
# customer is entitled to for the product.
|
37
|
+
# @return [Types::EntitlementValue]
|
38
|
+
#
|
39
|
+
# @!attribute [rw] expiration_date
|
40
|
+
# The expiration date represents the minimum date through which this
|
41
|
+
# entitlement is expected to remain valid. For contractual products
|
42
|
+
# listed on AWS Marketplace, the expiration date is the date at which
|
43
|
+
# the customer will renew or cancel their contract. Customers who are
|
44
|
+
# opting to renew their contract will still have entitlements with an
|
45
|
+
# expiration date.
|
46
|
+
# @return [Time]
|
47
|
+
#
|
48
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entitlement.marketplace-2017-01-11/Entitlement AWS API Documentation
|
49
|
+
#
|
50
|
+
class Entitlement < Struct.new(
|
51
|
+
:product_code,
|
52
|
+
:dimension,
|
53
|
+
:customer_identifier,
|
54
|
+
:value,
|
55
|
+
:expiration_date)
|
56
|
+
include Aws::Structure
|
57
|
+
end
|
58
|
+
|
59
|
+
# The EntitlementValue represents the amount of capacity that the
|
60
|
+
# customer is entitled to for the product.
|
61
|
+
#
|
62
|
+
# @!attribute [rw] integer_value
|
63
|
+
# The IntegerValue field will be populated with an integer value when
|
64
|
+
# the entitlement is an integer type. Otherwise, the field will not be
|
65
|
+
# set.
|
66
|
+
# @return [Integer]
|
67
|
+
#
|
68
|
+
# @!attribute [rw] double_value
|
69
|
+
# The DoubleValue field will be populated with a double value when the
|
70
|
+
# entitlement is a double type. Otherwise, the field will not be set.
|
71
|
+
# @return [Float]
|
72
|
+
#
|
73
|
+
# @!attribute [rw] boolean_value
|
74
|
+
# The BooleanValue field will be populated with a boolean value when
|
75
|
+
# the entitlement is a boolean type. Otherwise, the field will not be
|
76
|
+
# set.
|
77
|
+
# @return [Boolean]
|
78
|
+
#
|
79
|
+
# @!attribute [rw] string_value
|
80
|
+
# The StringValue field will be populated with a string value when the
|
81
|
+
# entitlement is a string type. Otherwise, the field will not be set.
|
82
|
+
# @return [String]
|
83
|
+
#
|
84
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entitlement.marketplace-2017-01-11/EntitlementValue AWS API Documentation
|
85
|
+
#
|
86
|
+
class EntitlementValue < Struct.new(
|
87
|
+
:integer_value,
|
88
|
+
:double_value,
|
89
|
+
:boolean_value,
|
90
|
+
:string_value)
|
91
|
+
include Aws::Structure
|
92
|
+
end
|
93
|
+
|
94
|
+
# The GetEntitlementsRequest contains parameters for the GetEntitlements
|
95
|
+
# operation.
|
96
|
+
#
|
97
|
+
# @note When making an API call, you may pass GetEntitlementsRequest
|
98
|
+
# data as a hash:
|
99
|
+
#
|
100
|
+
# {
|
101
|
+
# product_code: "ProductCode", # required
|
102
|
+
# filter: {
|
103
|
+
# "CUSTOMER_IDENTIFIER" => ["FilterValue"],
|
104
|
+
# },
|
105
|
+
# next_token: "NonEmptyString",
|
106
|
+
# max_results: 1,
|
107
|
+
# }
|
108
|
+
#
|
109
|
+
# @!attribute [rw] product_code
|
110
|
+
# Product code is used to uniquely identify a product in AWS
|
111
|
+
# Marketplace. The product code will be provided by AWS Marketplace
|
112
|
+
# when the product listing is created.
|
113
|
+
# @return [String]
|
114
|
+
#
|
115
|
+
# @!attribute [rw] filter
|
116
|
+
# Filter is used to return entitlements for a specific customer or for
|
117
|
+
# a specific dimension. Filters are described as keys mapped to a
|
118
|
+
# lists of values. Filtered requests are *unioned* for each value in
|
119
|
+
# the value list, and then *intersected* for each filter key.
|
120
|
+
# @return [Hash<String,Array<String>>]
|
121
|
+
#
|
122
|
+
# @!attribute [rw] next_token
|
123
|
+
# For paginated calls to GetEntitlements, pass the NextToken from the
|
124
|
+
# previous GetEntitlementsResult.
|
125
|
+
# @return [String]
|
126
|
+
#
|
127
|
+
# @!attribute [rw] max_results
|
128
|
+
# The maximum number of items to retrieve from the GetEntitlements
|
129
|
+
# operation. For pagination, use the NextToken field in subsequent
|
130
|
+
# calls to GetEntitlements.
|
131
|
+
# @return [Integer]
|
132
|
+
#
|
133
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entitlement.marketplace-2017-01-11/GetEntitlementsRequest AWS API Documentation
|
134
|
+
#
|
135
|
+
class GetEntitlementsRequest < Struct.new(
|
136
|
+
:product_code,
|
137
|
+
:filter,
|
138
|
+
:next_token,
|
139
|
+
:max_results)
|
140
|
+
include Aws::Structure
|
141
|
+
end
|
142
|
+
|
143
|
+
# The GetEntitlementsRequest contains results from the GetEntitlements
|
144
|
+
# operation.
|
145
|
+
#
|
146
|
+
# @!attribute [rw] entitlements
|
147
|
+
# The set of entitlements found through the GetEntitlements operation.
|
148
|
+
# If the result contains an empty set of entitlements, NextToken might
|
149
|
+
# still be present and should be used.
|
150
|
+
# @return [Array<Types::Entitlement>]
|
151
|
+
#
|
152
|
+
# @!attribute [rw] next_token
|
153
|
+
# For paginated results, use NextToken in subsequent calls to
|
154
|
+
# GetEntitlements. If the result contains an empty set of
|
155
|
+
# entitlements, NextToken might still be present and should be used.
|
156
|
+
# @return [String]
|
157
|
+
#
|
158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entitlement.marketplace-2017-01-11/GetEntitlementsResult AWS API Documentation
|
159
|
+
#
|
160
|
+
class GetEntitlementsResult < Struct.new(
|
161
|
+
:entitlements,
|
162
|
+
:next_token)
|
163
|
+
include Aws::Structure
|
164
|
+
end
|
165
|
+
|
166
|
+
end
|
167
|
+
end
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-marketplaceentitlementservice/types'
|
12
|
+
require_relative 'aws-sdk-marketplaceentitlementservice/client_api'
|
13
|
+
require_relative 'aws-sdk-marketplaceentitlementservice/client'
|
14
|
+
require_relative 'aws-sdk-marketplaceentitlementservice/errors'
|
15
|
+
require_relative 'aws-sdk-marketplaceentitlementservice/resource'
|
16
|
+
require_relative 'aws-sdk-marketplaceentitlementservice/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS Marketplace Entitlement Service. This module is available in the
|
19
|
+
# `aws-sdk-marketplaceentitlementservice` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from AWS Marketplace Entitlement Service all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::MarketplaceEntitlementService::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::MarketplaceEntitlementService
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc1'
|
46
|
+
|
47
|
+
end
|
metadata
ADDED
@@ -0,0 +1,80 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: aws-sdk-marketplaceentitlementservice
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0.rc1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Amazon Web Services
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-05-05 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: aws-sdk-core
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - '='
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 3.0.0.rc1
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - '='
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 3.0.0.rc1
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: aws-sigv4
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.0'
|
41
|
+
description: Official AWS Ruby gem for AWS Marketplace Entitlement Service. This gem
|
42
|
+
is part of the AWS SDK for Ruby.
|
43
|
+
email:
|
44
|
+
- trevrowe@amazon.com
|
45
|
+
executables: []
|
46
|
+
extensions: []
|
47
|
+
extra_rdoc_files: []
|
48
|
+
files:
|
49
|
+
- lib/aws-sdk-marketplaceentitlementservice.rb
|
50
|
+
- lib/aws-sdk-marketplaceentitlementservice/client.rb
|
51
|
+
- lib/aws-sdk-marketplaceentitlementservice/client_api.rb
|
52
|
+
- lib/aws-sdk-marketplaceentitlementservice/customizations.rb
|
53
|
+
- lib/aws-sdk-marketplaceentitlementservice/errors.rb
|
54
|
+
- lib/aws-sdk-marketplaceentitlementservice/resource.rb
|
55
|
+
- lib/aws-sdk-marketplaceentitlementservice/types.rb
|
56
|
+
homepage: http://github.com/aws/aws-sdk-ruby
|
57
|
+
licenses:
|
58
|
+
- Apache-2.0
|
59
|
+
metadata: {}
|
60
|
+
post_install_message:
|
61
|
+
rdoc_options: []
|
62
|
+
require_paths:
|
63
|
+
- lib
|
64
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
70
|
+
requirements:
|
71
|
+
- - ">"
|
72
|
+
- !ruby/object:Gem::Version
|
73
|
+
version: 1.3.1
|
74
|
+
requirements: []
|
75
|
+
rubyforge_project:
|
76
|
+
rubygems_version: 2.5.1
|
77
|
+
signing_key:
|
78
|
+
specification_version: 4
|
79
|
+
summary: AWS SDK for Ruby - AWS Marketplace Entitlement Service
|
80
|
+
test_files: []
|