Skip to content

get_agreement_entitlements 

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

Obtains details about the entitlements of an agreement.

Parameters:

  • agreement_id (ResourceId) –

    The unique identifier of the agreement.

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

    The maximum number of agreement entitlements 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 
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
def get_agreement_entitlements(
    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_entitlements_output.GetAgreementEntitlementsOutput":
    """<p>Obtains details about the entitlements of an agreement.</p>

    Args:
        agreement_id: <p>The unique identifier of the agreement.</p>
        max_results: <p>The maximum number of agreement entitlements 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_entitlements_input.GetAgreementEntitlementsInput]",
    ) -> OperationResponse[
        "capo_marketplace_agreement.types.get_agreement_entitlements_output.GetAgreementEntitlementsOutput"
    ]:
        import capo_marketplace_agreement._operations.awsmp_commerce_service_v20200301.get_agreement_entitlements

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAgreementEntitlements")
    )
    input_: capo_marketplace_agreement.types.get_agreement_entitlements_input.GetAgreementEntitlementsInput = {
        "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