Struct aws_sdk_marketplaceagreement::client::Client

pub struct Client { /* private fields */ }

Client for AWS Marketplace Agreement Service

Client for invoking operations on AWS Marketplace Agreement Service. Each operation on AWS Marketplace Agreement Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_marketplaceagreement::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_marketplaceagreement::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the DescribeAgreement operation has a Client::describe_agreement, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.describe_agreement()
    .agreement_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn describe_agreement(&self) -> DescribeAgreementFluentBuilder

Constructs a fluent builder for the DescribeAgreement operation.

• The fluent builder is configurable:
  • agreement_id(impl Into<String>) / set_agreement_id(Option<String>):
    required: true
    

    The unique identifier of the agreement.

    
    
• On success, responds with DescribeAgreementOutput with field(s):
  • agreement_id(Option<String>):

    The unique identifier of the agreement.

  • acceptor(Option<Acceptor>):

    The details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.

  • proposer(Option<Proposer>):

    The details of the party proposing the agreement terms. This is commonly the seller for PurchaseAgreement.

  • start_time(Option<DateTime>):

    The date and time when the agreement starts.

  • end_time(Option<DateTime>):

    The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.

  • acceptance_time(Option<DateTime>):

    The date and time the offer was accepted or the agreement was created.

    AcceptanceTime and StartTime can differ for future dated agreements (FDAs).

  • agreement_type(Option<String>):

    The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.

  • estimated_charges(Option<EstimatedCharges>):

    The estimated cost of the agreement.

  • proposal_summary(Option<ProposalSummary>):

    A summary of the proposal received from the proposer.

  • status(Option<AgreementStatus>):

    The current status of the agreement.

    Statuses include:

    • ACTIVE – The terms of the agreement are active.

    • ARCHIVED – The agreement ended without a specified reason.

    • CANCELLED – The acceptor ended the agreement before the defined end date.

    • EXPIRED – The agreement ended on the defined end date.

    • RENEWED – The agreement was renewed into a new agreement (for example, an auto-renewal).

    • REPLACED – The agreement was replaced using an agreement replacement offer.

    • ROLLED_BACK (Only applicable to inactive agreement revisions) – The agreement revision has been rolled back because of an error. An earlier revision is now active.

    • SUPERCEDED (Only applicable to inactive agreement revisions) – The agreement revision is no longer active and another agreement revision is now active.

    • TERMINATED – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).

• On failure, responds with SdkError<DescribeAgreementError>

impl Client

pub fn get_agreement_terms(&self) -> GetAgreementTermsFluentBuilder

Constructs a fluent builder for the GetAgreementTerms operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • agreement_id(impl Into<String>) / set_agreement_id(Option<String>):
    required: true
    

    The unique identifier of the agreement.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of agreements to return in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to specify where to start pagination

    
    
• On success, responds with GetAgreementTermsOutput with field(s):
  • accepted_terms(Option<Vec::<AcceptedTerm>>):

    A subset of terms proposed by the proposer that have been accepted by the acceptor as part of the agreement creation.

  • next_token(Option<String>):

    A token to specify where to start pagination

• On failure, responds with SdkError<GetAgreementTermsError>

impl Client

pub fn search_agreements(&self) -> SearchAgreementsFluentBuilder

Constructs a fluent builder for the SearchAgreements operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • catalog(impl Into<String>) / set_catalog(Option<String>):
    required: false
    

    The catalog in which the agreement was created.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    The filter name and value pair used to return a specific list of results.

    The following filters are supported:

    • ResourceIdentifier – The unique identifier of the resource.

    • ResourceType – Type of the resource, which is the product (AmiProduct, ContainerProduct, or SaaSProduct).

    • PartyType – The party type (either Acceptor or Proposer) of the caller. For agreements where the caller is the proposer, use the Proposer filter. For agreements where the caller is the acceptor, use the Acceptor filter.

    • AcceptorAccountId – The AWS account ID of the party accepting the agreement terms.

    • OfferId – The unique identifier of the offer in which the terms are registered in the agreement token.

    • Status – The current status of the agreement. Values include ACTIVE, ARCHIVED, CANCELLED, EXPIRED, RENEWED, REPLACED, and TERMINATED.

    • BeforeEndTime – A date used to filter agreements with a date before the endTime of an agreement.

    • AfterEndTime – A date used to filter agreements with a date after the endTime of an agreement.

    • AgreementType – The type of agreement. Values include PurchaseAgreement or VendorInsightsAgreement.

    
    
  • sort(Sort) / set_sort(Option<Sort>):
    required: false
    

    An object that contains the SortBy and SortOrder attributes.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of agreements to return in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to specify where to start pagination.

    
    
• On success, responds with SearchAgreementsOutput with field(s):
  • agreement_view_summaries(Option<Vec::<AgreementViewSummary>>):

    A summary of the agreement, including top-level attributes (for example, the agreement ID, version, proposer, and acceptor).

  • next_token(Option<String>):

    The token used for pagination. The field is null if there are no more results.

• On failure, responds with SdkError<SearchAgreementsError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.