AWS CLI Command Reference

[ aws . marketplace-agreement ]

search-agreements

Description

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.

See also: AWS API Documentation

search-agreements is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: agreementViewSummaries

Synopsis

  search-agreements
[--catalog <value>]
[--filters <value>]
[--sort <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--catalog (string)

The catalog in which the agreement was created.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-zA-Z0-9.-]+

--filters (list)

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. Use Proposer or Acceptor .
  • 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 , 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.
  • BeforeStartTime – A date used to filter agreements with a date before the startTime of an agreement.
  • AfterStartTime – A date used to filter agreements with a date after the startTime of an agreement.
  • BeforeLastUpdateTime – A date used to filter agreements with a date before the lastUpdateTime of an agreement.
  • AfterLastUpdateTime – A date used to filter agreements with a date after the lastUpdateTime 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.
  • EndTimeBehaviorType – What happens to the agreement when it reaches its end date. Values include RENEW , REPLACE , and EXPIRE .
  • EndTimeBehaviorReasonCode – The reason why the agreement doesn’t renew at its end date. Values include PROPOSER_RENEW_OPTED_OUT , ACCEPTOR_RENEW_OPTED_OUT , NO_RENEWAL_TERM , and RENEWAL_LIMIT_EXHAUSTED .
  • InitialAgreementId – The unique identifier of the very first agreement in a chain of related agreements. Use this filter to return every agreement in the same chain.
  • LicenseArn – The Amazon Resource Name (ARN) of the AWS License Manager license associated with an entitlement granted by the agreement.

A proposer can use any combination of the preceding filters along with AgreementType , which is required.

The following filter combinations are supported when the PartyType is Acceptor :

  • AgreementType
  • AgreementType + Status
  • AgreementType + EndTime
  • AgreementType + Status + EndTime
  • AgreementType + ResourceIdentifier
  • AgreementType + ResourceIdentifier + EndTime
  • AgreementType + ResourceIdentifier + Status
  • AgreementType + ResourceIdentifier + Status + EndTime
  • AgreementType + ResourceType
  • AgreementType + ResourceType + EndTime
  • AgreementType + OfferId
  • AgreementType + OfferId + EndTime
  • AgreementType + OfferId + Status
  • AgreementType + OfferId + Status + EndTime
  • AgreementType + OfferSetId
  • AgreementType + OfferSetId + EndTime
  • AgreementType + OfferSetId + Status
  • AgreementType + OfferSetId + Status + EndTime

Note

To filter by EndTime , you can use BeforeEndTime , AfterEndTime , or both.

Constraints:

  • min: 1
  • max: 10

(structure)

The filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as offerId or productId .

name -> (string)

The name of the filter.

Constraints:

  • min: 1
  • max: 32
  • pattern: [A-Za-z_]+

values -> (list)

The filter value.

Constraints:

  • min: 1
  • max: 1

(string)

Constraints:

  • min: 1
  • max: 256
  • pattern: [A-Za-z0-9.,+:/_-]+

Shorthand Syntax:

name=string,values=string,string ...

JSON Syntax:

[
  {
    "name": "string",
    "values": ["string", ...]
  }
  ...
]

--sort (structure)

An object that contains the SortBy and SortOrder attributes. For SearchAgreements , SortBy supports EndTime for both party types, and StartTime and LastUpdateTime only when PartyType is Proposer . The default SortBy value is EndTime .

sortBy -> (string)

The attribute on which the data is grouped, which can be EndTime , StartTime , or LastUpdateTime . StartTime and LastUpdateTime are supported only when PartyType is Proposer . The default value is EndTime .

Constraints:

  • min: 1
  • max: 255
  • pattern: [A-Za-z_]+

sortOrder -> (string)

The sorting order, which can be ASCENDING or DESCENDING . The default value is ASCENDING .

Possible values:

  • ASCENDING
  • DESCENDING

Shorthand Syntax:

sortBy=string,sortOrder=string

JSON Syntax:

{
  "sortBy": "string",
  "sortOrder": "ASCENDING"|"DESCENDING"
}

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

  • min: 1
  • max: 50

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

agreementViewSummaries -> (list)

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

(structure)

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

agreementId -> (string)

The unique identifier of the agreement.

Constraints:

  • min: 1
  • max: 64
  • pattern: [A-Za-z0-9_/-]+

acceptanceTime -> (timestamp)

The date and time that the agreement was accepted.

startTime -> (timestamp)

The date and time when the agreement starts.

endTime -> (timestamp)

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

lastUpdateTime -> (timestamp)

The date and time when the agreement was last updated. An agreement is updated when any of its attributes or accepted terms change. Amendments, renewals, and a party changing whether the agreement renews are all examples.

Use the BeforeLastUpdateTime and AfterLastUpdateTime filters to search on this value, and LastUpdateTime as the SortBy value to sort by it. Sorting by LastUpdateTime is supported only when PartyType is Proposer .

agreementType -> (string)

The type of agreement.

Constraints:

  • min: 1
  • max: 64
  • pattern: [A-Za-z]+

acceptor -> (structure)

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

accountId -> (string)

The AWS account ID of the acceptor.

Constraints:

  • min: 12
  • max: 12
  • pattern: [0-9]+

proposer -> (structure)

Details of the party proposing the agreement terms, most commonly the seller for PurchaseAgreement .

accountId -> (string)

The AWS account ID of the proposer.

Constraints:

  • min: 12
  • max: 12
  • pattern: [0-9]+

proposalSummary -> (structure)

A summary of the proposal

resources -> (list)

The list of resources involved in the agreement.

(structure)

The list of resources involved in the agreement.

id -> (string)

The unique identifier of the resource.

Note

We mention the term resource, which is most commonly a product, so a resourceId is also a productId .

Constraints:

  • min: 1
  • max: 64
  • pattern: [A-Za-z0-9_/-]+

type -> (string)

Type of the resource, which is the product (for example, SaaSProduct , AmiProduct , ContainerProduct ).

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-zA-Z]+

offerId -> (string)

The unique identifier of the offer in AWS Marketplace.

Constraints:

  • min: 1
  • max: 64
  • pattern: \S{1,64}

offerSetId -> (string)

A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.

Constraints:

  • pattern: \S{1,50}

status -> (string)

The current status of the agreement.

Possible values:

  • ACTIVE
  • ARCHIVED
  • CANCELLED
  • EXPIRED
  • RENEWED
  • REPLACED
  • ROLLED_BACK
  • SUPERSEDED
  • TERMINATED

entitlements -> (list)

A list of entitlements associated with the agreement.

(structure)

Represents an entitlement associated with an agreement.

licenseArn -> (string)

The Amazon Resource Name (ARN) of the AWS License Manager license associated with the entitlement.

initialAgreementId -> (string)

The unique identifier of the very first agreement in a chain of related agreements, such as renewals or replacements. It stays the same across all agreements in that chain, which lets you trace an agreement back to the original. You can also use it as the InitialAgreementId filter value to return every agreement in the same chain.

Constraints:

  • min: 1
  • max: 64
  • pattern: [A-Za-z0-9_/-]+

endTimeBehaviorType -> (string)

The behavior of the agreement when it reaches its end date. The field is null for agreements that have no end date, because those agreements never reach an end time.

Types include:

  • RENEW – A new agreement is created from the accepted terms of this agreement.
  • REPLACE – A new agreement is created from a different offer than the one this agreement was created from. This happens, for example, when a private offer reaches its end date and the acceptor transitions to the public offer for the product.
  • EXPIRE – The agreement ends and isn’t renewed or replaced.

Possible values:

  • RENEW
  • REPLACE
  • EXPIRE

endTimeBehaviorReasonCode -> (string)

The reason why the agreement doesn’t renew at its end date. The field is null when the agreement renews.

More than one reason can apply to the same agreement. When that happens, the operation returns only one reason code, and PROPOSER_RENEW_OPTED_OUT takes precedence over all others.

The EnableAutoRenew field reflects only the acceptor’s preference, and doesn’t reflect the other reasons an agreement might not renew.

Reason codes include:

  • PROPOSER_RENEW_OPTED_OUT – The proposer opted out of renewing the agreement.
  • ACCEPTOR_RENEW_OPTED_OUT – The acceptor opted out of renewing the agreement.
  • NO_RENEWAL_TERM – The accepted terms of the agreement don’t include a renewal term, which is required for an agreement to renew.
  • RENEWAL_LIMIT_EXHAUSTED – The agreement reached the maximum number of renewals allowed by its renewal term.

Possible values:

  • PROPOSER_RENEW_OPTED_OUT
  • ACCEPTOR_RENEW_OPTED_OUT
  • NO_RENEWAL_TERM
  • RENEWAL_LIMIT_EXHAUSTED

nextToken -> (string)

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

Constraints:

  • min: 0
  • max: 8192
  • pattern: [a-zA-Z0-9+/=_-]+
© Copyright 2026, Amazon Web Services. Created using Sphinx.