文件 AWS 開發套件範例 GitHub 儲存庫中有更多可用的 [AWS SDK 範例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# 協議 API 的 AWS Marketplace 協議
下列程式碼範例示範如何使用 AWS Marketplace 協議 API AWS SDKs。
**Topics**
+ [取得所有協議 ID](marketplace-agreement_example_marketplace-agreement_GetAllAgreementsIds_section.md)
+ [取得所有協議](marketplace-agreement_example_marketplace-agreement_GetAllAgreements_section.md)
+ [從協議取得客戶 ID](marketplace-agreement_example_marketplace-agreement_GetAgreementCustomer_section.md)
+ [從協議取得財務詳細資訊](marketplace-agreement_example_marketplace-agreement_GetAgreementFinancialDetails_section.md)
+ [從協議取得免費試用詳細資訊](marketplace-agreement_example_marketplace-agreement_GetAgreementTermsFreeTrialDetails_section.md)
+ [取得協議的相關資訊](marketplace-agreement_example_marketplace-agreement_DescribeAgreement_section.md)
+ [從協議取得產品和優惠詳細資訊](marketplace-agreement_example_marketplace-agreement_GetProductAndOfferDetailFromAgreement_section.md)
+ [取得協議的 EULA](marketplace-agreement_example_marketplace-agreement_GetAgreementTermsEula_section.md)
+ [取得協議的自動續約條款](marketplace-agreement_example_marketplace-agreement_GetAgreementAutoRenewal_section.md)
+ [取得協議中購買的維度](marketplace-agreement_example_marketplace-agreement_GetAgreementTermsDimensionPurchased_section.md)
+ [取得協議中購買的每個維度的執行個體](marketplace-agreement_example_marketplace-agreement_GetAgreementTermsDimensionInstances_section.md)
+ [取得協議的付費排程](marketplace-agreement_example_marketplace-agreement_GetAgreementTermsPaymentSchedule_section.md)
+ [取得協議中每個維度的定價](marketplace-agreement_example_marketplace-agreement_GetAgreementTermsPricingEachDimension_section.md)
+ [取得協議的定價類型](marketplace-agreement_example_marketplace-agreement_GetAgreementPricingType_section.md)
+ [取得協議的產品類型](marketplace-agreement_example_marketplace-agreement_GetAgreementProductType_section.md)
+ [取得協議的狀態](marketplace-agreement_example_marketplace-agreement_GetAgreementStatus_section.md)
+ [取得協議的支援條款](marketplace-agreement_example_marketplace-agreement_GetAgreementTermsSupportTerm_section.md)
+ [取得協議的條款](marketplace-agreement_example_marketplace-agreement_GetAgreementTerms_section.md)
+ [依帳戶 ID 搜尋協議](marketplace-agreement_example_marketplace-agreement_SearchAgreementsByAccountId_section.md)
+ [依協議 ID 搜尋協議](marketplace-agreement_example_marketplace-agreement_SearchAgreementsById_section.md)
+ [依結束日期搜尋協議](marketplace-agreement_example_marketplace-agreement_SearchAgreementsByEndDate_section.md)
+ [依優惠 ID 搜尋協議](marketplace-agreement_example_marketplace-agreement_SearchAgreementsByOfferId_section.md)
+ [依產品 ID 搜尋協議](marketplace-agreement_example_marketplace-agreement_SearchAgreementsByProductId_section.md)
+ [依狀態搜尋協議](marketplace-agreement_example_marketplace-agreement_SearchAgreementsByByStatus_section.md)
+ [依照一個自訂篩選條件搜尋協議](marketplace-agreement_example_marketplace-agreement_SearchAgreementsByOneFilter_section.md)
+ [依照兩個自訂篩選條件搜尋協議](marketplace-agreement_example_marketplace-agreement_SearchAgreementsByTwoFilters_section.md)
# 使用 AWS SDK 取得所有協議 IDs
下列程式碼範例示範如何取得所有協議 ID。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java#agreement-api-reference-code)儲存庫中設定和執行。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package com.example.awsmarketplace.agreementapi;
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.http.apache.ApacheHttpClient;
import software.amazon.awssdk.services.marketplaceagreement.MarketplaceAgreementClient;
import software.amazon.awssdk.services.marketplaceagreement.model.AgreementViewSummary;
import software.amazon.awssdk.services.marketplaceagreement.model.Filter;
import software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest;
import software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsResponse;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import static com.example.awsmarketplace.utils.ReferenceCodesConstants.*;
import com.example.awsmarketplace.utils.ReferenceCodesUtils;
public class GetAllAgreementsIds {
/*
* Get all purchase agreements ids with party type = proposer;
* Depend on the number of agreements in your account, this code may take some time to finish.
*/
public static void main(String[] args) {
List agreementIds = getAllAgreementIds();
ReferenceCodesUtils.formatOutput(agreementIds);
}
public static List getAllAgreementIds() {
MarketplaceAgreementClient marketplaceAgreementClient =
MarketplaceAgreementClient.builder()
.httpClient(ApacheHttpClient.builder().build())
.credentialsProvider(ProfileCredentialsProvider.create())
.build();
// get all filters
Filter partyType = Filter.builder().name(PARTY_TYPE_FILTER_NAME)
.values(PARTY_TYPE_FILTER_VALUE_PROPOSER).build();
Filter agreementType = Filter.builder().name(AGREEMENT_TYPE_FILTER_NAME)
.values(AGREEMENT_TYPE_FILTER_VALUE_PURCHASEAGREEMENT).build();
List searchFilters = new ArrayList();
searchFilters.addAll(Arrays.asList(partyType, agreementType));
// Save all results in a list array
List agreementSummaryList = new ArrayList();
SearchAgreementsRequest searchAgreementsRequest =
SearchAgreementsRequest.builder()
.catalog(AWS_MP_CATALOG)
.filters(searchFilters)
.build();
SearchAgreementsResponse searchAgreementsResponse = marketplaceAgreementClient.searchAgreements(searchAgreementsRequest);
agreementSummaryList.addAll(searchAgreementsResponse.agreementViewSummaries());
while (searchAgreementsResponse.nextToken() != null && searchAgreementsResponse.nextToken().length() > 0) {
searchAgreementsRequest =
SearchAgreementsRequest.builder()
.catalog(AWS_MP_CATALOG)
.nextToken(searchAgreementsResponse.nextToken())
.filters(searchFilters)
.build();
searchAgreementsResponse = marketplaceAgreementClient.searchAgreements(searchAgreementsRequest);
agreementSummaryList.addAll(searchAgreementsResponse.agreementViewSummaries());
}
List agreementIds = new ArrayList();
for (AgreementViewSummary summary : agreementSummaryList) {
agreementIds.add(summary.agreementId());
}
return agreementIds;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [SearchAgreements](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/SearchAgreements)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/blob/main/python#agreement-api-reference-code)儲存庫中設定和執行。
```
# 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 get all agreement ids
AG-09
"""
import logging
import boto3
from botocore.exceptions import ClientError
mp_client = boto3.client("marketplace-agreement")
logger = logging.getLogger(__name__)
MAX_PAGE_RESULTS = 10
def get_agreements():
AgreementSummaryList = []
agreement_id_list = []
try:
agreements = mp_client.search_agreements(
catalog="AWSMarketplace",
maxResults=MAX_PAGE_RESULTS,
filters=[
{"name": "PartyType", "values": ["Proposer"]},
{"name": "AgreementType", "values": ["PurchaseAgreement"]},
],
)
except ClientError as e:
logger.error("Could not complete search_agreements request.")
raise
AgreementSummaryList.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=[
{"name": "PartyType", "values": ["Proposer"]},
{"name": "AgreementType", "values": ["PurchaseAgreement"]},
],
)
except ClientError as e:
logger.error("Could not complete search_agreements request.")
raise
AgreementSummaryList.extend(agreements["agreementViewSummaries"])
for agreement in AgreementSummaryList:
agreement_id_list.append(agreement["agreementId"])
return agreement_id_list
if __name__ == "__main__":
agreement_id_list = get_agreements()
print(agreement_id_list)
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [SearchAgreements](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/SearchAgreements)。
------
# 使用 AWS SDK 取得所有協議
以下程式碼範例描述如何取得所有協議。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java#agreement-api-reference-code)儲存庫中設定和執行。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package com.example.awsmarketplace.agreementapi;
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.http.apache.ApacheHttpClient;
import software.amazon.awssdk.services.marketplaceagreement.MarketplaceAgreementClient;
import software.amazon.awssdk.services.marketplaceagreement.model.AgreementViewSummary;
import software.amazon.awssdk.services.marketplaceagreement.model.Filter;
import software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest;
import software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsResponse;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import static com.example.awsmarketplace.utils.ReferenceCodesConstants.*;
import com.example.awsmarketplace.utils.ReferenceCodesUtils;
public class GetAllAgreements {
/*
* Get all purchase agreements with party type = proposer;
* Depend on the number of agreements in your account, this code may take some time to finish.
*/
public static void main(String[] args) {
List agreementSummaryList = getAllAgreements();
ReferenceCodesUtils.formatOutput(agreementSummaryList);
}
public static List getAllAgreements() {
MarketplaceAgreementClient marketplaceAgreementClient =
MarketplaceAgreementClient.builder()
.httpClient(ApacheHttpClient.builder().build())
.credentialsProvider(ProfileCredentialsProvider.create())
.build();
// get all filters
Filter partyType = Filter.builder().name(PARTY_TYPE_FILTER_NAME)
.values(PARTY_TYPE_FILTER_VALUE_PROPOSER).build();
Filter agreementType = Filter.builder().name(AGREEMENT_TYPE_FILTER_NAME)
.values(AGREEMENT_TYPE_FILTER_VALUE_PURCHASEAGREEMENT).build();
List searchFilters = new ArrayList();
searchFilters.addAll(Arrays.asList(partyType, agreementType));
// Save all results in a list array
List agreementSummaryList = new ArrayList();
SearchAgreementsRequest searchAgreementsRequest =
SearchAgreementsRequest.builder()
.catalog(AWS_MP_CATALOG)
.filters(searchFilters)
.build();
SearchAgreementsResponse searchAgreementsResponse = marketplaceAgreementClient.searchAgreements(searchAgreementsRequest);
agreementSummaryList.addAll(searchAgreementsResponse.agreementViewSummaries());
while (searchAgreementsResponse.nextToken() != null && searchAgreementsResponse.nextToken().length() > 0) {
searchAgreementsRequest =
SearchAgreementsRequest.builder()
.catalog(AWS_MP_CATALOG)
.nextToken(searchAgreementsResponse.nextToken())
.filters(searchFilters).build();
searchAgreementsResponse = marketplaceAgreementClient.searchAgreements(searchAgreementsRequest);
agreementSummaryList.addAll(searchAgreementsResponse.agreementViewSummaries());
}
return agreementSummaryList;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [SearchAgreements](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/SearchAgreements)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/blob/main/python#agreement-api-reference-code)儲存庫中設定和執行。
```
# 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 get all agreements
AG-01
"""
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"]
filter_list = [
{"name": "PartyType", "values": party_type_list},
{"name": "AgreementType", "values": agreement_type_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"])
return agreement_results_list
if __name__ == "__main__":
agreements_list = get_agreements(filter_list)
helper.pretty_print_datetime(agreements_list)
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [SearchAgreements](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/SearchAgreements)。
------
# 使用 AWS SDK 從 協議取得客戶 ID
下列程式碼範例示範如何從協議取得客戶 ID。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java#agreement-api-reference-code)儲存庫中設定和執行。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package com.example.awsmarketplace.agreementapi;
import static com.example.awsmarketplace.utils.ReferenceCodesConstants.*;
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.http.apache.ApacheHttpClient;
import software.amazon.awssdk.services.marketplaceagreement.MarketplaceAgreementClient;
import software.amazon.awssdk.services.marketplaceagreement.model.DescribeAgreementRequest;
import software.amazon.awssdk.services.marketplaceagreement.model.DescribeAgreementResponse;
public class GetAgreementCustomerInfo {
/*
* Obtain metadata about the customer who created the agreement, such as the customer's AWS Account ID
*/
public static void main(String[] args) {
String agreementId = args.length > 0 ? args[0] : AGREEMENT_ID;
DescribeAgreementResponse describeAgreementResponse = getDescribeAgreementResponse(agreementId);
System.out.println("Customer's AWS Account ID is " + describeAgreementResponse.acceptor().accountId());
}
public static DescribeAgreementResponse getDescribeAgreementResponse(String agreementId) {
MarketplaceAgreementClient marketplaceAgreementClient =
MarketplaceAgreementClient.builder()
.httpClient(ApacheHttpClient.builder().build())
.credentialsProvider(ProfileCredentialsProvider.create())
.build();
DescribeAgreementRequest describeAgreementRequest =
DescribeAgreementRequest.builder()
.agreementId(agreementId)
.build();
DescribeAgreementResponse describeAgreementResponse = marketplaceAgreementClient.describeAgreement(describeAgreementRequest);
return describeAgreementResponse;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DescribeAgreement](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/DescribeAgreement)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/blob/main/python#agreement-api-reference-code)儲存庫中設定和執行。
```
# 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 get customer AWS account id
from a given agreement
AG-08
"""
import argparse
import logging
import boto3
from botocore.exceptions import ClientError
mp_client = boto3.client("marketplace-agreement")
logger = logging.getLogger(__name__)
def get_agreement_information(agreement_id):
try:
response = mp_client.describe_agreement(agreementId=agreement_id)
except ClientError as e:
if e.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Agreement with ID %s not found.", agreement_id)
raise e
else:
logger.error("Unexpected error: %s", e)
raise e
return response
if __name__ == "__main__":
parser = argparse.ArgumentParser()
parser.add_argument(
"--agreement-id",
"-aid",
help="Provide agreement ID to describe agreement status",
required=True,
)
args = parser.parse_args()
response = get_agreement_information(agreement_id=args.agreement_id)
print(f"Customer account: {response['acceptor']['accountId']}")
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [DescribeAgreement](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/DescribeAgreement)。
------
# 使用 AWS SDK 從協議取得財務詳細資訊
下列程式碼範例示範如何從協議取得財務詳細資訊。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java#agreement-api-reference-code)儲存庫中設定和執行。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package com.example.awsmarketplace.agreementapi;
import static com.example.awsmarketplace.utils.ReferenceCodesConstants.*;
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.http.apache.ApacheHttpClient;
import software.amazon.awssdk.services.marketplaceagreement.MarketplaceAgreementClient;
import software.amazon.awssdk.services.marketplaceagreement.model.DescribeAgreementRequest;
import software.amazon.awssdk.services.marketplaceagreement.model.DescribeAgreementResponse;
public class GetAgreementFinancialDetails {
/*
* Obtain financial details, such as Total Contract Value of the agreement from a given agreement
*/
public static void main(String[] args) {
String agreementId = args.length > 0 ? args[0] : AGREEMENT_ID;
String totalContractValue = getTotalContractValue(agreementId);
System.out.println("Total Contract Value is " + totalContractValue);
}
public static String getTotalContractValue(String agreementId) {
MarketplaceAgreementClient marketplaceAgreementClient =
MarketplaceAgreementClient.builder()
.httpClient(ApacheHttpClient.builder().build())
.credentialsProvider(ProfileCredentialsProvider.create())
.build();
DescribeAgreementRequest describeAgreementRequest =
DescribeAgreementRequest.builder()
.agreementId(agreementId)
.build();
DescribeAgreementResponse describeAgreementResponse = marketplaceAgreementClient.describeAgreement(describeAgreementRequest);
String totalContractValue = "N/A";
if ( describeAgreementResponse.estimatedCharges() != null ) {
totalContractValue = describeAgreementResponse.estimatedCharges().agreementValue()
+ " "
+ describeAgreementResponse.estimatedCharges().currencyCode();
}
return totalContractValue;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DescribeAgreement](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/DescribeAgreement)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/blob/main/python#agreement-api-reference-code)儲存庫中設定和執行。
```
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
"""
Purpose
Obtain financial details, such as Total Contract Value of the agreementfrom a given agreement
AG-14
Example Usage: python3 get_agreement_financial_details.py --agreement-id
"""
import argparse
import logging
import boto3
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
mp_client = boto3.client("marketplace-agreement")
def get_agreement_information(agreement_id):
try:
agreement = mp_client.describe_agreement(agreementId=agreement_id)
return agreement
except ClientError as e:
if e.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Agreement with ID %s not found.", agreement_id)
else:
logger.error("Unexpected error: %s", e)
return None
if __name__ == "__main__":
parser = argparse.ArgumentParser()
parser.add_argument(
"--agreement-id",
"-aid",
help="Provide agreement ID to describe agreement status",
required=True,
)
args = parser.parse_args()
agreement = get_agreement_information(args.agreement_id)
if agreement is not None:
print(f"Agreement Id: {args.agreement_id}")
print(
f"Agreement Value: {agreement['estimatedCharges']['currencyCode']} {agreement['estimatedCharges']['agreementValue']}"
)
else:
print(f"Agreement with ID {args.agreement_id} is not found")
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [DescribeAgreement](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/DescribeAgreement)。
------
# 使用 AWS SDK 從 協議取得免費試用詳細資訊
下列程式碼範例示範如何從協議取得免費試用詳細資訊。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java#agreement-api-reference-code)儲存庫中設定和執行。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package com.example.awsmarketplace.agreementapi;
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.http.apache.ApacheHttpClient;
import software.amazon.awssdk.services.marketplaceagreement.MarketplaceAgreementClient;
import software.amazon.awssdk.services.marketplaceagreement.model.AcceptedTerm;
import software.amazon.awssdk.services.marketplaceagreement.model.FreeTrialPricingTerm;
import software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest;
import software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsResponse;
import static com.example.awsmarketplace.utils.ReferenceCodesConstants.AGREEMENT_ID;
import java.util.ArrayList;
import java.util.List;
import com.example.awsmarketplace.utils.ReferenceCodesUtils;
public class GetAgreementTermsFreeTrialDetails {
/*
* Obtain the details from an agreement of a free trial I have provided to the customer
*/
public static void main(String[] args) {
String agreementId = args.length > 0 ? args[0] : AGREEMENT_ID;
List freeTrialPricingTerms = getFreeTrialPricingTerms(agreementId);
ReferenceCodesUtils.formatOutput(freeTrialPricingTerms);
}
public static List getFreeTrialPricingTerms(String agreementId) {
MarketplaceAgreementClient marketplaceAgreementClient =
MarketplaceAgreementClient.builder()
.httpClient(ApacheHttpClient.builder().build())
.credentialsProvider(ProfileCredentialsProvider.create())
.build();
GetAgreementTermsRequest getAgreementTermsRequest =
GetAgreementTermsRequest.builder().agreementId(agreementId)
.build();
GetAgreementTermsResponse getAgreementTermsResponse = marketplaceAgreementClient.getAgreementTerms(getAgreementTermsRequest);
List freeTrialPricingTerms = new ArrayList();
for (AcceptedTerm acceptedTerm : getAgreementTermsResponse.acceptedTerms()) {
if (acceptedTerm.freeTrialPricingTerm() != null) {
freeTrialPricingTerms.add(acceptedTerm.freeTrialPricingTerm());
}
}
return freeTrialPricingTerms;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DescribeAgreement](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/DescribeAgreement)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/blob/main/python#agreement-api-reference-code)儲存庫中設定和執行。
```
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
"""
Purpose
Obtain the details from an agreement of a free trial I have provided to the customer
AG-20
Example Usage: python3 get_agreement_free_trial_details.py --agreement-id
"""
import argparse
import logging
import boto3
import utils.helpers as helper
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
mp_client = boto3.client("marketplace-agreement")
def get_agreement_terms(agreement_id):
try:
agreement = mp_client.get_agreement_terms(agreementId=agreement_id)
return agreement
except ClientError as e:
if e.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Agreement with ID %s not found.", agreement_id)
else:
logger.error("Unexpected error: %s", e)
return None
if __name__ == "__main__":
parser = argparse.ArgumentParser()
parser.add_argument(
"--agreement-id",
"-aid",
help="Provide agreement ID to describe agreement status",
required=True,
)
args = parser.parse_args()
agreement = get_agreement_terms(agreement_id=args.agreement_id)
if agreement is not None:
freetrial_found = False
for term in agreement["acceptedTerms"]:
if "freeTrialPricingTerm" in term.keys():
helper.pretty_print_datetime(term)
freetrial_found = True
if not freetrial_found:
print(f"No free trial term found for agreement: {args.agreement_id}")
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [DescribeAgreement](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/DescribeAgreement)。
------
# 使用 AWS SDK 取得協議的相關資訊
下列程式碼範例示範如何取得協議的相關資訊。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java#agreement-api-reference-code)儲存庫中設定和執行。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package com.example.awsmarketplace.agreementapi;
import static com.example.awsmarketplace.utils.ReferenceCodesConstants.*;
import com.example.awsmarketplace.utils.ReferenceCodesUtils;
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.http.apache.ApacheHttpClient;
import software.amazon.awssdk.services.marketplaceagreement.MarketplaceAgreementClient;
import software.amazon.awssdk.services.marketplaceagreement.model.DescribeAgreementRequest;
import software.amazon.awssdk.services.marketplaceagreement.model.DescribeAgreementResponse;
public class DescribeAgreement {
public static void main(String[] args) {
String agreementId = args.length > 0 ? args[0] : AGREEMENT_ID;
DescribeAgreementResponse describeAgreementResponse = getResponse(agreementId);
ReferenceCodesUtils.formatOutput(describeAgreementResponse);
}
public static DescribeAgreementResponse getResponse(String agreementId) {
MarketplaceAgreementClient marketplaceAgreementClient =
MarketplaceAgreementClient.builder()
.httpClient(ApacheHttpClient.builder().build())
.credentialsProvider(ProfileCredentialsProvider.create())
.build();
DescribeAgreementRequest describeAgreementRequest =
DescribeAgreementRequest.builder()
.agreementId(agreementId)
.build();
DescribeAgreementResponse describeAgreementResponse = marketplaceAgreementClient.describeAgreement(describeAgreementRequest);
return describeAgreementResponse;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DescribeAgreement](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/DescribeAgreement)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/blob/main/python#agreement-api-reference-code)儲存庫中設定和執行。
```
# 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 get agreement information
AG-07
"""
import argparse
import logging
import boto3
import utils.helpers as helper
from botocore.exceptions import ClientError
mp_client = boto3.client("marketplace-agreement")
logger = logging.getLogger(__name__)
def get_agreement_information(agreement_id):
try:
response = mp_client.describe_agreement(agreementId=agreement_id)
except ClientError as e:
if e.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Agreement with ID %s not found.", agreement_id)
raise e
else:
logger.error("Unexpected error: %s", e)
raise e
return response
if __name__ == "__main__":
parser = argparse.ArgumentParser()
parser.add_argument(
"--agreement-id",
"-aid",
help="Provide agreement ID to describe agreement status",
required=True,
)
args = parser.parse_args()
response = get_agreement_information(agreement_id=args.agreement_id)
helper.pretty_print_datetime(response)
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [DescribeAgreement](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/DescribeAgreement)。
------
# 使用 AWS SDK 從協議取得產品和優惠詳細資訊
下列程式碼範例示範如何從協議取得產品和優惠的詳細資訊。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java#agreement-api-reference-code)儲存庫中設定和執行。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package com.example.awsmarketplace.agreementapi;
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.http.apache.ApacheHttpClient;
import software.amazon.awssdk.services.marketplaceagreement.MarketplaceAgreementClient;
import software.amazon.awssdk.services.marketplaceagreement.model.DescribeAgreementRequest;
import software.amazon.awssdk.services.marketplaceagreement.model.DescribeAgreementResponse;
import software.amazon.awssdk.services.marketplaceagreement.model.Resource;
import java.util.ArrayList;
import java.util.List;
import static com.example.awsmarketplace.utils.ReferenceCodesConstants.*;
import com.example.awsmarketplace.utils.ReferenceCodesUtils;
import software.amazon.awssdk.services.marketplacecatalog.MarketplaceCatalogClient;
import software.amazon.awssdk.services.marketplacecatalog.model.DescribeEntityRequest;
import software.amazon.awssdk.services.marketplacecatalog.model.DescribeEntityResponse;
public class GetProductAndOfferDetailFromAgreement {
public static void main(String[] args) {
// call Agreement API to get offer and product information for the agreement
String agreementId = args.length > 0 ? args[0] : AGREEMENT_ID;
List entityResponseList = getEntities(agreementId);
for (DescribeEntityResponse response : entityResponseList) {
ReferenceCodesUtils.formatOutput(response);
}
}
public static List getEntities(String agreementId) {
List entityResponseList = new ArrayList ();
MarketplaceAgreementClient marketplaceAgreementClient =
MarketplaceAgreementClient.builder()
.httpClient(ApacheHttpClient.builder().build())
.credentialsProvider(ProfileCredentialsProvider.create())
.build();
DescribeAgreementRequest describeAgreementRequest =
DescribeAgreementRequest.builder()
.agreementId(agreementId)
.build();
DescribeAgreementResponse describeAgreementResponse = marketplaceAgreementClient.describeAgreement(describeAgreementRequest);
// get offer id for the given agreement
String offerId = describeAgreementResponse.proposalSummary().offerId();
// get all the product ids for this agreement
List productIds = new ArrayList();
for (Resource resource : describeAgreementResponse.proposalSummary().resources()) {
productIds.add(resource.id());
}
// call Catalog API to get the details of the offer and products
MarketplaceCatalogClient marketplaceCatalogClient =
MarketplaceCatalogClient.builder()
.httpClient(ApacheHttpClient.builder().build())
.credentialsProvider(ProfileCredentialsProvider.create())
.build();
DescribeEntityRequest describeEntityRequest =
DescribeEntityRequest.builder()
.catalog(AWS_MP_CATALOG)
.entityId(offerId).build();
DescribeEntityResponse describeEntityResponse = marketplaceCatalogClient.describeEntity(describeEntityRequest);
entityResponseList.add(describeEntityResponse);
for (String productId : productIds) {
describeEntityRequest =
DescribeEntityRequest.builder()
.catalog(AWS_MP_CATALOG)
.entityId(productId).build();
describeEntityResponse = marketplaceCatalogClient.describeEntity(describeEntityRequest);
System.out.println("Print details for product " + productId);
entityResponseList.add(describeEntityResponse);
}
return entityResponseList;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DescribeAgreement](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/DescribeAgreement)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/blob/main/python#agreement-api-reference-code)儲存庫中設定和執行。
```
# 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 get product and offer details in a given agreement
AG-10
"""
import argparse
import logging
import boto3
import utils.helpers as helper
from botocore.exceptions import ClientError
mpa_client = boto3.client("marketplace-agreement")
mpc_client = boto3.client("marketplace-catalog")
logger = logging.getLogger(__name__)
def get_agreement_information(agreement_id):
"""
Returns information about a given agreement
Args: agreement_id str: Entity to return
Returns: dict: Dictionary of agreement information
"""
try:
agreement = mpa_client.describe_agreement(agreementId=agreement_id)
return agreement
except ClientError as e:
if e.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Agreement with ID %s not found.", agreement_id)
else:
logger.error("Unexpected error: %s", e)
def get_entity_information(entity_id):
"""
Returns information about a given entity
Args: entity_id str: Entity to return
Returns: dict: Dictionary of entity information
"""
try:
response = mpc_client.describe_entity(
Catalog="AWSMarketplace",
EntityId=entity_id,
)
return response
except ClientError as e:
if e.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Entity with ID %s not found.", entity_id)
else:
logger.error("Unexpected error: %s", e)
def get_agreement_components(agreement_id):
agreement_component_list = []
agreement = get_agreement_information(agreement_id)
if agreement is not None:
productIds = []
for resource in agreement["proposalSummary"]["resources"]:
productIds.append(resource["id"])
for product_id in productIds:
product_document = get_entity_information(product_id)
product_document_dict = {}
product_document_dict["product_id"] = product_id
product_document_dict["document"] = product_document
agreement_component_list.append(product_document_dict)
offerId = agreement["proposalSummary"]["offerId"]
offer_document = get_entity_information(offerId)
offer_document_dict = {}
offer_document_dict["offer_id"] = offerId
offer_document_dict["document"] = offer_document
agreement_component_list.append(offer_document_dict)
return agreement_component_list
else:
print("Agreement with ID " + args.agreement_id + " is not found")
if __name__ == "__main__":
logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
parser = argparse.ArgumentParser()
parser.add_argument(
"--agreement_id",
"-aid",
help="Provide agreement ID to search for product and offer detail",
required=True,
)
args = parser.parse_args()
product_offer_detail = get_agreement_components(agreement_id=args.agreement_id)
helper.pretty_print_datetime(product_offer_detail)
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [DescribeAgreement](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/DescribeAgreement)。
------
# 使用 AWS SDK 取得協議的 EULA
下列程式碼範例示範如何取得協議的 EULA。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java#agreement-api-reference-code)儲存庫中設定和執行。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package com.example.awsmarketplace.agreementapi;
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.http.apache.ApacheHttpClient;
import software.amazon.awssdk.services.marketplaceagreement.MarketplaceAgreementClient;
import software.amazon.awssdk.services.marketplaceagreement.model.DocumentItem;
import software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest;
import software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsResponse;
import java.util.ArrayList;
import java.util.List;
import static com.example.awsmarketplace.utils.ReferenceCodesConstants.AGREEMENT_ID;
import com.example.awsmarketplace.utils.ReferenceCodesUtils;
public class GetAgreementTermsEula {
/*
* Obtain the EULA I have entered into with my customer via the agreement
*/
public static void main(String[] args) {
String agreementId = args.length > 0 ? args[0] : AGREEMENT_ID;
List legalEulaArray = getLegalEula(agreementId);
ReferenceCodesUtils.formatOutput(legalEulaArray);
}
public static List getLegalEula(String agreementId) {
MarketplaceAgreementClient marketplaceAgreementClient =
MarketplaceAgreementClient.builder()
.httpClient(ApacheHttpClient.builder().build())
.credentialsProvider(ProfileCredentialsProvider.create())
.build();
GetAgreementTermsRequest getAgreementTermsRequest =
GetAgreementTermsRequest.builder().agreementId(agreementId)
.build();
GetAgreementTermsResponse getAgreementTermsResponse = marketplaceAgreementClient.getAgreementTerms(getAgreementTermsRequest);
List legalEulaArray = new ArrayList<>();
getAgreementTermsResponse.acceptedTerms().stream()
.filter(acceptedTerm -> acceptedTerm.legalTerm() != null && acceptedTerm.legalTerm().hasDocuments())
.flatMap(acceptedTerm -> acceptedTerm.legalTerm().documents().stream())
.filter(docItem -> docItem.type() != null)
.forEach(legalEulaArray::add);
return legalEulaArray;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [GetAgreementTerms](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/GetAgreementTerms)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/blob/main/python#agreement-api-reference-code)儲存庫中設定和執行。
```
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
"""
Purpose
Obtain the EULA I have entered into with my customer via the agreement
AG-18
"""
import json
import logging
import os
import boto3
import utils.helpers as helper
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
# agreement id
AGREEMENT_ID = "agmt-1111111111111111111111111"
# to use sample file or not
USE_SAMPLE_FILE = False
SAMPLE_FILE_NAME = "mockup_agreement_terms.json"
# attribute name
ROOT_ELEM = "acceptedTerms"
TERM_NAME = "legalTerm"
CONFIG_ELEM = "configuration"
ATTRIBUTE_NAME = "documents"
def get_agreement_information(mp_client, entity_id):
"""
Returns customer AWS Account id about a given agreement
Args: entity_id str: Entity to return
Returns: dict: Dictionary of agreement information
"""
try:
if USE_SAMPLE_FILE:
sample_file = os.path.join(os.path.dirname(__file__), SAMPLE_FILE_NAME)
terms = open_json_file(sample_file)
else:
terms = mp_client.get_agreement_terms(agreementId=entity_id)
legalEulaArray = []
for term in terms[ROOT_ELEM]:
if TERM_NAME in term and ATTRIBUTE_NAME in term[TERM_NAME]:
docs = term[TERM_NAME][ATTRIBUTE_NAME]
for doc in docs:
if "type" in doc:
legalEulaArray.append(doc)
return legalEulaArray
except ClientError as e:
if e.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Agreement with ID %s not found.", entity_id)
else:
logger.error("Unexpected error: %s", e)
def usage_demo():
logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
print("-" * 88)
print("Looking for an agreement in the AWS Marketplace.")
print("-" * 88)
mp_client = boto3.client("marketplace-agreement")
helper.pretty_print_datetime(get_agreement_information(mp_client, AGREEMENT_ID))
# open json file from path
def open_json_file(filename):
with open(filename, "r") as f:
return json.load(f)
if __name__ == "__main__":
usage_demo()
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [GetAgreementTerms](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/GetAgreementTerms)。
------
# 使用 AWS SDK 取得協議的自動續約條款
下列程式碼範例示範如何取得協議的自動續約條款。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java#agreement-api-reference-code)儲存庫中設定和執行。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package com.example.awsmarketplace.agreementapi;
import static com.example.awsmarketplace.utils.ReferenceCodesConstants.*;
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.http.apache.ApacheHttpClient;
import software.amazon.awssdk.services.marketplaceagreement.MarketplaceAgreementClient;
import software.amazon.awssdk.services.marketplaceagreement.model.AcceptedTerm;
import software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest;
import software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsResponse;
public class GetAgreementAutoRenewal {
/*
* Obtain the auto-renewal status of the agreement
*/
public static void main(String[] args) {
String agreementId = args.length > 0 ? args[0] : AGREEMENT_ID;
String autoRenewal = getAutoRenewal(agreementId);
System.out.println("Auto-Renewal status is " + autoRenewal);
}
public static String getAutoRenewal(String agreementId) {
MarketplaceAgreementClient marketplaceAgreementClient =
MarketplaceAgreementClient.builder()
.httpClient(ApacheHttpClient.builder().build())
.credentialsProvider(ProfileCredentialsProvider.create())
.build();
GetAgreementTermsRequest getAgreementTermsRequest =
GetAgreementTermsRequest.builder()
.agreementId(agreementId)
.build();
GetAgreementTermsResponse getAgreementTermsResponse = marketplaceAgreementClient.getAgreementTerms(getAgreementTermsRequest);
String autoRenewal = "No Auto Renewal";
for (AcceptedTerm acceptedTerm : getAgreementTermsResponse.acceptedTerms()) {
if (acceptedTerm.renewalTerm() != null && acceptedTerm.renewalTerm().configuration() != null
&& acceptedTerm.renewalTerm().configuration().enableAutoRenew() != null) {
autoRenewal = String.valueOf(acceptedTerm.renewalTerm().configuration().enableAutoRenew().booleanValue());
break;
}
}
return autoRenewal;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [GetAgreementTerms](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/GetAgreementTerms)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/blob/main/python#agreement-api-reference-code)儲存庫中設定和執行。
```
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
"""
Purpose
Obtain the auto-renewal status of the agreement
AG-15
"""
import json
import logging
import os
import utils.helpers as helper
import boto3
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
# agreement id
AGREEMENT_ID = "agmt-11111111111111111111"
# to use sample file or not
USE_SAMPLE_FILE = False
SAMPLE_FILE_NAME = "mockup_agreement_terms.json"
# attribute name
ROOT_ELEM = "acceptedTerms"
TERM_NAME = "renewalTerm"
CONFIG_ELEM = "configuration"
ATTRIBUTE_NAME = "enableAutoRenew"
def get_agreement_information(mp_client, entity_id):
"""
Returns customer AWS Account id about a given agreement
Args: entity_id str: Entity to return
Returns: dict: Dictionary of agreement information
"""
try:
if USE_SAMPLE_FILE:
sample_file = os.path.join(os.path.dirname(__file__), SAMPLE_FILE_NAME)
terms = open_json_file(sample_file)
else:
terms = mp_client.get_agreement_terms(agreementId=entity_id)
auto_renewal = "No Auto Renewal"
for term in terms[ROOT_ELEM]:
if TERM_NAME in term:
if CONFIG_ELEM in term[TERM_NAME]:
auto_renewal = term[TERM_NAME][CONFIG_ELEM][ATTRIBUTE_NAME]
break
return auto_renewal
except ClientError as e:
if e.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Agreement with ID %s not found.", entity_id)
else:
logger.error("Unexpected error: %s", e)
def usage_demo():
logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
print("-" * 88)
print("Looking for an agreement in the AWS Marketplace.")
print("-" * 88)
mp_client = boto3.client("marketplace-agreement")
agreement = get_agreement_information(mp_client, AGREEMENT_ID)
if agreement is not None:
print(f"Auto Renewal is {agreement}")
else:
print("Agreement with ID " + AGREEMENT_ID + " is not found")
# open json file from path
def open_json_file(filename):
with open(filename, "r") as f:
return json.load(f)
if __name__ == "__main__":
usage_demo()
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [GetAgreementTerms](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/GetAgreementTerms)。
------
# 使用 AWS SDK 取得協議中購買的維度
下列程式碼範例示範如何取得協議中購買的維度。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java#agreement-api-reference-code)儲存庫中設定和執行。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package com.example.awsmarketplace.agreementapi;
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.http.apache.ApacheHttpClient;
import software.amazon.awssdk.services.marketplaceagreement.MarketplaceAgreementClient;
import software.amazon.awssdk.services.marketplaceagreement.model.AcceptedTerm;
import software.amazon.awssdk.services.marketplaceagreement.model.Dimension;
import software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest;
import software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsResponse;
import java.util.ArrayList;
import java.util.List;
import static com.example.awsmarketplace.utils.ReferenceCodesConstants.AGREEMENT_ID;
import com.example.awsmarketplace.utils.ReferenceCodesUtils;
public class GetAgreementTermsDimensionPurchased {
/*
* Obtain the dimensions the buyer has purchased from me via the agreement
*/
public static void main(String[] args) {
String agreementId = args.length > 0 ? args[0] : AGREEMENT_ID;
List dimensionKeys = getDimensionKeys(agreementId);
ReferenceCodesUtils.formatOutput(dimensionKeys);
}
public static List getDimensionKeys(String agreementId) {
MarketplaceAgreementClient marketplaceAgreementClient =
MarketplaceAgreementClient.builder()
.httpClient(ApacheHttpClient.builder().build())
.credentialsProvider(ProfileCredentialsProvider.create())
.build();
GetAgreementTermsRequest getAgreementTermsRequest =
GetAgreementTermsRequest.builder().agreementId(agreementId)
.build();
GetAgreementTermsResponse getAgreementTermsResponse = marketplaceAgreementClient.getAgreementTerms(getAgreementTermsRequest);
List dimensionKeys = new ArrayList();
for (AcceptedTerm acceptedTerm : getAgreementTermsResponse.acceptedTerms()) {
if (acceptedTerm.configurableUpfrontPricingTerm() != null) {
if (acceptedTerm.configurableUpfrontPricingTerm().configuration().selectorValue() != null) {
List dimensions = acceptedTerm.configurableUpfrontPricingTerm().configuration().dimensions();
for (Dimension dimension : dimensions) {
dimensionKeys.add(dimension.dimensionKey());
}
}
}
}
return dimensionKeys;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [GetAgreementTerms](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/GetAgreementTerms)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/blob/main/python#agreement-api-reference-code)儲存庫中設定和執行。
```
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
"""
Purpose
Obtain the dimensions the buyer has purchased from me via the agreement
AG-28
"""
import json
import logging
import os
import boto3
import utils.helpers as helper
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
# agreement id
AGREEMENT_ID = "agmt-1111111111111111111111111"
# to use sample file or not
USE_SAMPLE_FILE = False
SAMPLE_FILE_NAME = "mockup_agreement_terms.json"
# attribute name
ROOT_ELEM = "acceptedTerms"
TERM_NAME = "configurableUpfrontPricingTerm"
CONFIG_ELEM = "configuration"
ATTRIBUTE_NAME = "selectorValue"
def get_agreement_information(mp_client, entity_id):
"""
Returns customer AWS Account id about a given agreement
Args: entity_id str: Entity to return
Returns: dict: Dictionary of agreement information
"""
try:
if USE_SAMPLE_FILE:
sample_file = os.path.join(os.path.dirname(__file__), SAMPLE_FILE_NAME)
terms = open_json_file(sample_file)
else:
terms = mp_client.get_agreement_terms(agreementId=entity_id)
dimensionKeys = []
for term in terms[ROOT_ELEM]:
if TERM_NAME in term:
if CONFIG_ELEM in term[TERM_NAME]:
confParam = term[TERM_NAME][CONFIG_ELEM]
if ATTRIBUTE_NAME in confParam:
if "dimensions" in confParam:
for dimension in confParam["dimensions"]:
if "dimensionKey" in dimension:
dimensionKey = dimension["dimensionKey"]
print(f"Dimension Key: {dimensionKey}")
dimensionKeys.append(dimensionKey)
return dimensionKeys
except ClientError as e:
if e.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Agreement with ID %s not found.", entity_id)
else:
logger.error("Unexpected error: %s", e)
def usage_demo():
logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
print("-" * 88)
print("Looking for an agreement in the AWS Marketplace.")
print("-" * 88)
mp_client = boto3.client("marketplace-agreement")
helper.pretty_print_datetime(get_agreement_information(mp_client, AGREEMENT_ID))
# open json file from path
def open_json_file(filename):
with open(filename, "r") as f:
return json.load(f)
if __name__ == "__main__":
usage_demo()
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [GetAgreementTerms](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/GetAgreementTerms)。
------
# 使用 AWS SDK 取得協議中購買的每個維度的執行個體
下列程式碼範例示範如何取得協議中購買的每個維度的執行個體。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java#agreement-api-reference-code)儲存庫中設定和執行。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package com.example.awsmarketplace.agreementapi;
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.http.apache.ApacheHttpClient;
import software.amazon.awssdk.services.marketplaceagreement.MarketplaceAgreementClient;
import software.amazon.awssdk.services.marketplaceagreement.model.AcceptedTerm;
import software.amazon.awssdk.services.marketplaceagreement.model.Dimension;
import software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest;
import software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsResponse;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import static com.example.awsmarketplace.utils.ReferenceCodesConstants.AGREEMENT_ID;
import com.example.awsmarketplace.utils.ReferenceCodesUtils;
public class GetAgreementTermsDimensionInstances {
/*
* get instances of each dimension that buyer has purchased in the agreement
*/
public static void main(String[] args) {
String agreementId = args.length > 0 ? args[0] : AGREEMENT_ID;
Map> dimensionMap = getDimensions(agreementId);
ReferenceCodesUtils.formatOutput(dimensionMap);
}
public static Map> getDimensions(String agreementId) {
MarketplaceAgreementClient marketplaceAgreementClient =
MarketplaceAgreementClient.builder()
.httpClient(ApacheHttpClient.builder().build())
.credentialsProvider(ProfileCredentialsProvider.create())
.build();
GetAgreementTermsRequest getAgreementTermsRequest =
GetAgreementTermsRequest.builder().agreementId(agreementId)
.build();
GetAgreementTermsResponse getAgreementTermsResponse = marketplaceAgreementClient.getAgreementTerms(getAgreementTermsRequest);
Map> dimensionMap = new HashMap>();
for (AcceptedTerm acceptedTerm : getAgreementTermsResponse.acceptedTerms()) {
List dimensionsList = new ArrayList();
if (acceptedTerm.configurableUpfrontPricingTerm() != null) {
String selectorValue = "";
if (acceptedTerm.configurableUpfrontPricingTerm().configuration() != null) {
if (acceptedTerm.configurableUpfrontPricingTerm().configuration().selectorValue() != null) {
selectorValue = acceptedTerm.configurableUpfrontPricingTerm().configuration().selectorValue();
}
if (acceptedTerm.configurableUpfrontPricingTerm().configuration().hasDimensions()) {
dimensionsList = acceptedTerm.configurableUpfrontPricingTerm().configuration().dimensions();
}
}
if (selectorValue.length() > 0) {
dimensionMap.put(selectorValue, dimensionsList);
}
}
}
return dimensionMap;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [GetAgreementTerms](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/GetAgreementTerms)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/blob/main/python#agreement-api-reference-code)儲存庫中設定和執行。
```
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
"""
Purpose
Obtain instances of each dimension that buyer has purchased in the agreement
AG-30
"""
import logging
import boto3
import utils.helpers as helper
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
# agreement id
AGREEMENT_ID = "agmt-1111111111111111111111111"
# attribute name
ROOT_ELEM = "acceptedTerms"
TERM_NAME = "configurableUpfrontPricingTerm"
CONFIG_ELEM = "configuration"
ATTRIBUTE_NAME = "selectorValue"
logger = logging.getLogger(__name__)
def get_agreement_information(mp_client, entity_id):
"""
Returns customer AWS Account id about a given agreement
Args: entity_id str: Entity to return
Returns: dict: Dictionary of agreement information
"""
try:
terms = mp_client.get_agreement_terms(agreementId=entity_id)
dimensionKeyValueMap = {}
for term in terms[ROOT_ELEM]:
if TERM_NAME in term:
if CONFIG_ELEM in term[TERM_NAME]:
confParam = term[TERM_NAME][CONFIG_ELEM]
if ATTRIBUTE_NAME in confParam:
selectValue = confParam["selectorValue"]
dimensionKeyValueMap["selectorValue"] = selectValue
if "dimensions" in confParam:
dimensionKeyValueMap["dimensions"] = confParam["dimensions"]
"""
for dimension in confParam['dimensions']:
if 'dimensionKey' in dimension:
dimensionValue = dimension['dimensionValue']
dimensionKey = dimension['dimensionKey']
print(f"Selector: {selectValue}, Dimension Key: {dimensionKey}, Dimension Value: {dimensionValue}")
dimensionKeyValueMap[dimensionKey] = dimensionValue
"""
return dimensionKeyValueMap
except ClientError as e:
if e.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Agreement with ID %s not found.", entity_id)
else:
logger.error("Unexpected error: %s", e)
def usage_demo():
logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
print("-" * 88)
print("Looking for an agreement in the AWS Marketplace.")
print("-" * 88)
mp_client = boto3.client("marketplace-agreement")
helper.pretty_print_datetime(get_agreement_information(mp_client, AGREEMENT_ID))
if __name__ == "__main__":
usage_demo()
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [GetAgreementTerms](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/GetAgreementTerms)。
------
# 使用 AWS SDK 取得協議的付款排程
下列程式碼範例示範如何取得協議的付費排程。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java#agreement-api-reference-code)儲存庫中設定和執行。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package com.example.awsmarketplace.agreementapi;
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.http.apache.ApacheHttpClient;
import software.amazon.awssdk.services.marketplaceagreement.MarketplaceAgreementClient;
import software.amazon.awssdk.services.marketplaceagreement.model.AcceptedTerm;
import software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest;
import software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsResponse;
import software.amazon.awssdk.services.marketplaceagreement.model.PaymentScheduleTerm;
import software.amazon.awssdk.services.marketplaceagreement.model.ScheduleItem;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import static com.example.awsmarketplace.utils.ReferenceCodesConstants.*;
import com.example.awsmarketplace.utils.ReferenceCodesUtils;
public class GetAgreementTermsPaymentSchedule {
/*
* Obtain the payment schedule I have agreed to with the agreement, including the invoice date and invoice amount
*/
public static void main(String[] args) {
String agreementId = args.length > 0 ? args[0] : AGREEMENT_ID;
List> paymentScheduleArray = getPaymentSchedules(agreementId);
ReferenceCodesUtils.formatOutput(paymentScheduleArray);
}
public static List> getPaymentSchedules(String agreementId) {
MarketplaceAgreementClient marketplaceAgreementClient =
MarketplaceAgreementClient.builder()
.httpClient(ApacheHttpClient.builder().build())
.credentialsProvider(ProfileCredentialsProvider.create())
.build();
GetAgreementTermsRequest getAgreementTermsRequest =
GetAgreementTermsRequest.builder().agreementId(agreementId)
.build();
GetAgreementTermsResponse getAgreementTermsResponse = marketplaceAgreementClient.getAgreementTerms(getAgreementTermsRequest);
List> paymentScheduleArray = new ArrayList<>();
String currencyCode = "";
for (AcceptedTerm acceptedTerm : getAgreementTermsResponse.acceptedTerms()) {
if (acceptedTerm.paymentScheduleTerm() != null) {
PaymentScheduleTerm paymentScheduleTerm = acceptedTerm.paymentScheduleTerm();
if (paymentScheduleTerm.currencyCode() != null) {
currencyCode = paymentScheduleTerm.currencyCode();
}
if (paymentScheduleTerm.hasSchedule()) {
for (ScheduleItem schedule : paymentScheduleTerm.schedule()) {
if (schedule.chargeDate() != null) {
String chargeDate = schedule.chargeDate().toString();
String chargeAmount = schedule.chargeAmount();
Map scheduleMap = new HashMap<>();
scheduleMap.put(ATTRIBUTE_CURRENCY_CODE, currencyCode);
scheduleMap.put(ATTRIBUTE_CHARGE_DATE, chargeDate);
scheduleMap.put(ATTRIBUTE_CHARGE_AMOUNT, chargeAmount);
paymentScheduleArray.add(scheduleMap);
}
}
}
}
}
return paymentScheduleArray;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [GetAgreementTerms](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/GetAgreementTerms)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/blob/main/python#agreement-api-reference-code)儲存庫中設定和執行。
```
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
"""
Purpose
Obtain the payment schedule I have agreed to with the agreement, including the invoice date and invoice amount
AG-17
"""
import json
import logging
import os
import boto3
import utils.helpers as helper
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
# agreement id
AGREEMENT_ID = "agmt-1111111111111111111111111"
# to use sample file or not
USE_SAMPLE_FILE = False
SAMPLE_FILE_NAME = "mockup_agreement_terms.json"
# attribute name
ROOT_ELEM = "acceptedTerms"
TERM_NAME = "paymentScheduleTerm"
CONFIG_ELEM = "configuration"
ATTRIBUTE_NAME = "selectorValue"
def get_agreement_information(mp_client, entity_id):
"""
Returns customer AWS Account id about a given agreement
Args: entity_id str: Entity to return
Returns: dict: Dictionary of agreement information
"""
try:
if USE_SAMPLE_FILE:
sample_file = os.path.join(os.path.dirname(__file__), SAMPLE_FILE_NAME)
terms = open_json_file(sample_file)
else:
terms = mp_client.get_agreement_terms(agreementId=entity_id)
paymentScheduleArray = []
currencyCode = ""
for term in terms[ROOT_ELEM]:
if TERM_NAME in term:
paymentSchedule = term[TERM_NAME]
if "currencyCode" in paymentSchedule:
currencyCode = paymentSchedule["currencyCode"]
if "schedule" in paymentSchedule:
for sch in paymentSchedule["schedule"]:
if "chargeDate" in sch:
chargeDate = sch["chargeDate"]
chargeAmount = sch["chargeAmount"]
# print(f"chargeDate: {chargeDate}, chargeAmount: {chargeAmount}")
schedule = {
"currencyCode": currencyCode,
"chargeDate": chargeDate,
"chargeAmount": chargeAmount,
}
paymentScheduleArray.append(schedule)
return paymentScheduleArray
except ClientError as e:
if e.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Agreement with ID %s not found.", entity_id)
else:
logger.error("Unexpected error: %s", e)
def usage_demo():
logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
print("-" * 88)
print("Looking for an agreement in the AWS Marketplace.")
print("-" * 88)
mp_client = boto3.client("marketplace-agreement")
helper.pretty_print_datetime(get_agreement_information(mp_client, AGREEMENT_ID))
# open json file from path
def open_json_file(filename):
with open(filename, "r") as f:
return json.load(f)
if __name__ == "__main__":
usage_demo()
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [GetAgreementTerms](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/GetAgreementTerms)。
------
# 使用 AWS SDK 取得協議中每個維度的定價
下列程式碼範例示範如何在協議中取得每個維度的定價。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS Marketplace API 參考程式庫](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java#agreement-api-reference-code)儲存庫中設定和執行。
```
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package com.example.awsmarketplace.agreementapi;
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.http.apache.ApacheHttpClient;
import software.amazon.awssdk.services.marketplaceagreement.MarketplaceAgreementClient;
import software.amazon.awssdk.services.marketplaceagreement.model.AcceptedTerm;
import software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest;
import software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsResponse;
import java.util.ArrayList;
import java.util.List;
import static com.example.awsmarketplace.utils.ReferenceCodesConstants.AGREEMENT_ID;
import com.example.awsmarketplace.utils.ReferenceCodesUtils;
public class GetAgreementTermsPricingEachDimension {
/*
* Obtain pricing per each dimension in the agreement
*/
public static void main(String[] args) {
String agreementId = args.length > 0 ? args[0] : AGREEMENT_ID;
List