Class: Aws::MarketplaceAgreement::Types::SearchAgreementsInput

Inherits:

Struct

• Object
• Struct
• Aws::MarketplaceAgreement::Types::SearchAgreementsInput

Includes:

Structure

Defined in:

lib/aws-sdk-marketplaceagreement/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #catalog ⇒ String

  The catalog in which the agreement was created.

• #filters ⇒ Array<Types::Filter>

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

• #max_results ⇒ Integer

  The maximum number of agreements to return in the response.

• #next_token ⇒ String

  A token to specify where to start pagination.

• #sort ⇒ Types::Sort

  An object that contains the ‘SortBy` and `SortOrder` attributes.

Instance Attribute Details

#catalog ⇒ String

The catalog in which the agreement was created.

Returns:

• (String)

# File 'lib/aws-sdk-marketplaceagreement/types.rb', line 1040

class SearchAgreementsInput < Struct.new(
  :catalog,
  :filters,
  :sort,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

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`, `SaaSProduct`, `ProfessionalServicesProduct`, or `MachineLearningProduct`).

• ‘PartyType` – The party type of the caller. For agreements where the caller is the proposer, use the `Proposer` 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. Supported value includes `PurchaseAgreement`.

• ‘OfferSetId` – A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-marketplaceagreement/types.rb', line 1040

class SearchAgreementsInput < Struct.new(
  :catalog,
  :filters,
  :sort,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of agreements to return in the response.

Returns:

• (Integer)

# File 'lib/aws-sdk-marketplaceagreement/types.rb', line 1040

class SearchAgreementsInput < Struct.new(
  :catalog,
  :filters,
  :sort,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A token to specify where to start pagination.

Returns:

• (String)

# File 'lib/aws-sdk-marketplaceagreement/types.rb', line 1040

class SearchAgreementsInput < Struct.new(
  :catalog,
  :filters,
  :sort,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#sort ⇒ Types::Sort

An object that contains the ‘SortBy` and `SortOrder` attributes. Only `EndTime` is supported for `SearchAgreements`. The default sort is `EndTime` descending.

Returns:

• (Types::Sort)

# File 'lib/aws-sdk-marketplaceagreement/types.rb', line 1040

class SearchAgreementsInput < Struct.new(
  :catalog,
  :filters,
  :sort,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end