Skip to content

get_agreement_terms

get_agreement_terms(
    agreement_id: ResourceId,
    *,
    config_overrides: Optional[MarketplaceAgreementClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> GetAgreementTermsOutput

Obtains details about the terms in an agreement that you participated in as proposer or acceptor.

The details include:

  • TermType – The type of term, such as LegalTerm, RenewalTerm, or ConfigurableUpfrontPricingTerm.

  • TermID – The ID of the particular term, which is common between offer and agreement.

  • TermPayload – The key information contained in the term, such as the EULA for LegalTerm or pricing and dimensions for various pricing terms, such as ConfigurableUpfrontPricingTerm or UsageBasedPricingTerm.

  • Configuration – The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting the EnableAutoRenew flag.

Parameters:

  • agreement_id (ResourceId) –

    The unique identifier of the agreement.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of agreements to return in the response.

  • next_token (Optional[NextToken], default: None ) –

    A token to specify where to start pagination.

Raises:

Source code in docs_src/capo_marketplace_agreement/_services/marketplace_agreement.py
def get_agreement_terms(
    self,
    agreement_id: "capo_marketplace_agreement.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[MarketplaceAgreementClientConfig] = None,
    max_results: Optional[
        "capo_marketplace_agreement.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_marketplace_agreement.types.next_token.NextToken"
    ] = None,
) -> "capo_marketplace_agreement.types.get_agreement_terms_output.GetAgreementTermsOutput":
    """<p>Obtains details about the terms in an agreement that you participated in as proposer or acceptor.</p> <p>The details include:</p> <ul> <li> <p> <code>TermType</code> – The type of term, such as <code>LegalTerm</code>, <code>RenewalTerm</code>, or <code>ConfigurableUpfrontPricingTerm</code>.</p> </li> <li> <p> <code>TermID</code> – The ID of the particular term, which is common between offer and agreement.</p> </li> <li> <p> <code>TermPayload</code> – The key information contained in the term, such as the EULA for <code>LegalTerm</code> or pricing and dimensions for various pricing terms, such as <code>ConfigurableUpfrontPricingTerm</code> or <code>UsageBasedPricingTerm</code>.</p> </li> </ul> <ul> <li> <p> <code>Configuration</code> – The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting the <code>EnableAutoRenew</code> flag.</p> </li> </ul>

    Args:
        agreement_id: <p>The unique identifier of the agreement.</p>
        max_results: <p>The maximum number of agreements to return in the response.</p>
        next_token: <p>A token to specify where to start pagination.</p>

    Raises:
        capo_marketplace_agreement.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_marketplace_agreement.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_marketplace_agreement.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_marketplace_agreement.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_marketplace_agreement.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_marketplace_agreement.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_marketplace_agreement.types.get_agreement_terms_input.GetAgreementTermsInput]",
    ) -> OperationResponse[
        "capo_marketplace_agreement.types.get_agreement_terms_output.GetAgreementTermsOutput"
    ]:
        import capo_marketplace_agreement._operations.awsmp_commerce_service_v20200301.get_agreement_terms

        output, http_response = (
            capo_marketplace_agreement._operations.awsmp_commerce_service_v20200301.get_agreement_terms.get_agreement_terms(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAgreementTerms")
    )
    input_: capo_marketplace_agreement.types.get_agreement_terms_input.GetAgreementTermsInput = {
        "agreement_id": agreement_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output