AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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.

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

  • AgreementType
  • AgreementType + EndTime
  • AgreementType + ResourceType
  • AgreementType + ResourceType + EndTime
  • AgreementType + ResourceType + Status
  • AgreementType + ResourceType + Status + EndTime
  • AgreementType + ResourceIdentifier
  • AgreementType + ResourceIdentifier + EndTime
  • AgreementType + ResourceIdentifier + Status
  • AgreementType + ResourceIdentifier + Status + EndTime
  • AgreementType + AcceptorAccountId
  • AgreementType + AcceptorAccountId + EndTime
  • AgreementType + AcceptorAccountId + Status
  • AgreementType + AcceptorAccountId + Status + EndTime
  • AgreementType + AcceptorAccountId + OfferId
  • AgreementType + AcceptorAccountId + OfferId + Status
  • AgreementType + AcceptorAccountId + OfferId + EndTime
  • AgreementType + AcceptorAccountId + OfferId + Status + EndTime
  • AgreementType + AcceptorAccountId + ResourceIdentifier
  • AgreementType + AcceptorAccountId + ResourceIdentifier + Status
  • AgreementType + AcceptorAccountId + ResourceIdentifier + EndTime
  • AgreementType + AcceptorAccountId + ResourceIdentifier + Status + EndTime
  • AgreementType + AcceptorAccountId + ResourceType
  • AgreementType + AcceptorAccountId + ResourceType + EndTime
  • AgreementType + AcceptorAccountId + ResourceType + Status
  • AgreementType + AcceptorAccountId + ResourceType + Status + EndTime
  • AgreementType + Status
  • AgreementType + Status + 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 and/or AfterEndTime . Only EndTime is supported for sorting.

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

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>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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>]
[--v2-debug]

Options

--catalog (string)

The catalog in which the agreement was created.

--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 , 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.

(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.

values -> (list)

The filter value.

(string)

Shorthand Syntax:

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

JSON Syntax:

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

--sort (structure)

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

sortBy -> (string)

The attribute on which the data is grouped, which can be by StartTime and EndTime . The default value is EndTime .

sortOrder -> (string)

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

Shorthand Syntax:

sortBy=string,sortOrder=string

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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 .

--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 .

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

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.

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.

agreementType -> (string)

The type of agreement.

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.

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.

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 .

type -> (string)

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

offerId -> (string)

The unique identifier of the offer in AWS Marketplace.

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.

status -> (string)

The current status of the agreement.

nextToken -> (string)

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