marketplaceagreement/aws.sdk.kotlin.services.marketplaceagreement/MarketplaceAgreementClient

MarketplaceAgreementClient

interface MarketplaceAgreementClient : SdkClient

AWS Marketplace is a curated digital catalog that customers can use to find, buy, deploy, and manage third-party software, data, and services to build solutions and run their businesses. The AWS Marketplace Agreement Service provides an API interface that helps AWS Marketplace sellers manage their product-related agreements, including listing, searching, and filtering agreements.

To manage agreements in AWS Marketplace, you must ensure that your AWS Identity and Access Management (IAM) policies and roles are set up. The user must have the required policies/permissions that allow them to carry out the actions in AWS:

DescribeAgreement – Grants permission to users to obtain detailed meta data about any of their agreements.
GetAgreementTerms – Grants permission to users to obtain details about the terms of an agreement.
SearchAgreements – Grants permission to users to search through all their agreements.

Types

Builder

class Builder : AbstractSdkClientBuilder<MarketplaceAgreementClient.Config, MarketplaceAgreementClient.Config.Builder, MarketplaceAgreementClient>

Companion

object Companion : AbstractAwsSdkClientFactory<MarketplaceAgreementClient.Config, MarketplaceAgreementClient.Config.Builder, MarketplaceAgreementClient, MarketplaceAgreementClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: MarketplaceAgreementClient.Config

MarketplaceAgreementClient's configuration

Functions

describeAgreement

abstract suspend fun describeAgreement(input: DescribeAgreementRequest): DescribeAgreementResponse

Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

getAgreementTerms

abstract suspend fun getAgreementTerms(input: GetAgreementTermsRequest): GetAgreementTermsResponse

Obtains details about the terms in an agreement that you participated in as proposer or acceptor.

searchAgreements

abstract suspend fun searchAgreements(input: SearchAgreementsRequest = SearchAgreementsRequest { }): SearchAgreementsResponse

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.

Inherited functions

expect abstract fun close()

describeAgreement

inline suspend fun MarketplaceAgreementClient.describeAgreement(crossinline block: DescribeAgreementRequest.Builder.() -> Unit): DescribeAgreementResponse

Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

getAgreementTerms

inline suspend fun MarketplaceAgreementClient.getAgreementTerms(crossinline block: GetAgreementTermsRequest.Builder.() -> Unit): GetAgreementTermsResponse

Obtains details about the terms in an agreement that you participated in as proposer or acceptor.

getAgreementTermsPaginated

fun MarketplaceAgreementClient.getAgreementTermsPaginated(initialRequest: GetAgreementTermsRequest): Flow<GetAgreementTermsResponse>

fun MarketplaceAgreementClient.getAgreementTermsPaginated(block: GetAgreementTermsRequest.Builder.() -> Unit): Flow<GetAgreementTermsResponse>

Paginate over GetAgreementTermsResponse results.

searchAgreements

inline suspend fun MarketplaceAgreementClient.searchAgreements(crossinline block: SearchAgreementsRequest.Builder.() -> Unit): SearchAgreementsResponse

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.

searchAgreementsPaginated

fun MarketplaceAgreementClient.searchAgreementsPaginated(initialRequest: SearchAgreementsRequest = SearchAgreementsRequest { }): Flow<SearchAgreementsResponse>

fun MarketplaceAgreementClient.searchAgreementsPaginated(block: SearchAgreementsRequest.Builder.() -> Unit): Flow<SearchAgreementsResponse>

Paginate over SearchAgreementsResponse results.

withConfig

fun MarketplaceAgreementClient.withConfig(block: MarketplaceAgreementClient.Config.Builder.() -> Unit): MarketplaceAgreementClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.