AgreementService / Client / search_agreements

search_agreements#

AgreementService.Client.search_agreements(**kwargs)#

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:

  • PartyType as Proposer + AgreementType + ResourceIdentifier

  • PartyType as Proposer + AgreementType + OfferId

  • PartyType as Proposer + AgreementType + AcceptorAccountId

  • PartyType as Proposer + AgreementType + Status

  • PartyType as Proposer + AgreementType + ResourceIdentifier + Status

  • PartyType as Proposer + AgreementType + OfferId + Status

  • PartyType as Proposer + AgreementType + AcceptorAccountId + Status

  • PartyType as Proposer + AgreementType + ResourceType + Status

  • PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceType + Status

  • PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId

  • PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId + Status

  • PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceIdentifier

  • PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceIdentifier + Status

  • PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceType

See also: AWS API Documentation

Request Syntax

response = client.search_agreements(
    catalog='string',
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    maxResults=123,
    nextToken='string',
    sort={
        'sortBy': 'string',
        'sortOrder': 'ASCENDING'|'DESCENDING'
    }
)
Parameters:

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

    • (dict) –

      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) –

  • maxResults (integer) – The maximum number of agreements to return in the response.

  • nextToken (string) – A token to specify where to start pagination.

  • sort (dict) –

    An object that contains the SortBy and SortOrder attributes.

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

Return type:

dict

Returns:

Response Syntax

{
    'agreementViewSummaries': [
        {
            'acceptanceTime': datetime(2015, 1, 1),
            'acceptor': {
                'accountId': 'string'
            },
            'agreementId': 'string',
            'agreementType': 'string',
            'endTime': datetime(2015, 1, 1),
            'proposalSummary': {
                'offerId': 'string',
                'resources': [
                    {
                        'id': 'string',
                        'type': 'string'
                    },
                ]
            },
            'proposer': {
                'accountId': 'string'
            },
            'startTime': datetime(2015, 1, 1),
            'status': 'ACTIVE'|'ARCHIVED'|'CANCELLED'|'EXPIRED'|'RENEWED'|'REPLACED'|'ROLLED_BACK'|'SUPERSEDED'|'TERMINATED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • agreementViewSummaries (list) –

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

      • (dict) –

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

        • acceptanceTime (datetime) –

          The date and time that the agreement was accepted.

        • acceptor (dict) –

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

          • accountId (string) –

            The AWS account ID of the acceptor.

        • agreementId (string) –

          The unique identifier of the agreement.

        • agreementType (string) –

          The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.

        • endTime (datetime) –

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

        • proposalSummary (dict) –

          A summary of the proposal

          • offerId (string) –

            The unique identifier of the offer in AWS Marketplace.

          • resources (list) –

            The list of resources involved in the agreement.

            • (dict) –

              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. Values include SaaSProduct or AmiProduct.

        • proposer (dict) –

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

          • accountId (string) –

            The AWS account ID of the proposer.

        • startTime (datetime) –

          The date and time when the agreement starts.

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

Exceptions