Class: Aws::MarketplaceAgreement::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MarketplaceAgreement::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb
Overview
An API client for MarketplaceAgreement. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MarketplaceAgreement::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#describe_agreement(params = {}) ⇒ Types::DescribeAgreementOutput
Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
-
#get_agreement_terms(params = {}) ⇒ Types::GetAgreementTermsOutput
Obtains details about the terms in an agreement that you participated in as proposer or acceptor.
-
#search_agreements(params = {}) ⇒ Types::SearchAgreementsOutput
Searches across all agreements that a proposer or an acceptor has in AWS Marketplace.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
474 475 476 |
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 474 def initialize(*args) super end |
Instance Method Details
#describe_agreement(params = {}) ⇒ Types::DescribeAgreementOutput
Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
526 527 528 529 |
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 526 def describe_agreement(params = {}, = {}) req = build_request(:describe_agreement, params) req.send_request() end |
#get_agreement_terms(params = {}) ⇒ Types::GetAgreementTermsOutput
Obtains details about the terms in an agreement that you participated in as proposer or acceptor.
The details include:
TermType
– The type of term, such asLegalTerm
,RenewalTerm
, orConfigurableUpfrontPricingTerm
.TermID
– The ID of the particular term, which is common between offer and agreement.TermPayload
– The key information contained in the term, such as the EULA forLegalTerm
or pricing and dimensions for various pricing terms, such asConfigurableUpfrontPricingTerm
orUsageBasedPricingTerm
. ^Configuration
– The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting theEnableAutoRenew
flag.
^
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
642 643 644 645 |
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 642 def get_agreement_terms(params = {}, = {}) req = build_request(:get_agreement_terms, params) req.send_request() end |
#search_agreements(params = {}) ⇒ Types::SearchAgreementsOutput
Searches across all agreements that a proposer or an acceptor has in AWS Marketplace. The search returns a list of agreements with basic agreement information.
The following filter combinations are supported:
PartyType
asProposer
+AgreementType
+ResourceIdentifier
PartyType
asProposer
+AgreementType
+OfferId
PartyType
asProposer
+AgreementType
+AcceptorAccountId
PartyType
asProposer
+AgreementType
+Status
PartyType
asProposer
+AgreementType
+ResourceIdentifier
+Status
PartyType
asProposer
+AgreementType
+OfferId
+Status
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+Status
PartyType
asProposer
+AgreementType
+ResourceType
+Status
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceType
+Status
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+OfferId
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+OfferId
+Status
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceIdentifier
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceIdentifier
+Status
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceType
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
783 784 785 786 |
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 783 def search_agreements(params = {}, = {}) req = build_request(:search_agreements, params) req.send_request() end |