The AWS Marketplace API Reference was restructured. For more information about the supported API operations, see the AWS Marketplace API Reference.
Search for agreements by status using an AWS SDK
The following code example shows how to search for agreements by status.
- Python
-
- SDK for Python (Boto3)
-
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
"""
Purpose
Shows how to use the AWS SDK for Python (Boto3) to filter agreements by status
AG-04
Example Usage: python3 search_agreements_by_status.py
"""
import logging
import boto3
import utils.helpers as helper
from botocore.exceptions import ClientError
mp_client = boto3.client("marketplace-agreement")
logger = logging.getLogger(__name__)
MAX_PAGE_RESULTS = 10
party_type_list = ["Proposer"]
agreement_type_list = ["PurchaseAgreement"]
# Accepted values: "ACTIVE", "TERMINATED", "CANCELED", "EXPIRED", "REPLACED", "RENEWED"
status_list = ["ACTIVE"]
filter_list = [
{"name": "PartyType", "values": party_type_list},
{"name": "AgreementType", "values": agreement_type_list},
{"name": "Status", "values": status_list},
]
agreement_results_list = []
def get_agreements(filter_list=filter_list):
try:
agreements = mp_client.search_agreements(
catalog="AWSMarketplace",
maxResults=MAX_PAGE_RESULTS,
filters=filter_list,
)
except ClientError as e:
logger.error("Could not complete search_agreements request.")
raise e
agreement_results_list.extend(agreements["agreementViewSummaries"])
while "nextToken" in agreements and agreements["nextToken"] is not None:
try:
agreements = mp_client.search_agreements(
catalog="AWSMarketplace",
maxResults=MAX_PAGE_RESULTS,
nextToken=agreements["nextToken"],
filters=filter_list,
)
except ClientError as e:
logger.error("Could not complete search_agreements request.")
raise e
agreement_results_list.extend(agreements["agreementViewSummaries"])
helper.pretty_print_datetime(agreement_results_list)
return agreement_results_list
if __name__ == "__main__":
agreements_list = get_agreements(filter_list)
For a complete list of AWS SDK developer guides and code examples, see
Using this service with an AWS SDK.
This topic also includes information about getting started and details about previous SDK versions.