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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalog ⇒ String

The catalog in which the agreement was created.

Returns:

  • (String) 


1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb', line 1029

class SearchAgreementsInput < Struct.new(
  :catalog,
  :filters,
  :max_results,
  :next_token,
  :sort)
  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, 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.

Returns:



1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb', line 1029

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

#max_results ⇒ Integer

The maximum number of agreements to return in the response.

Returns:

  • (Integer) 


1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb', line 1029

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

#next_token ⇒ String

A token to specify where to start pagination.

Returns:

  • (String) 


1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb', line 1029

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

#sort ⇒ Types::Sort

An object that contains the SortBy and SortOrder attributes.

Returns:



1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb', line 1029

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