Skip to content

describe_agreement async

describe_agreement(
    agreement_id: ResourceId,
    *,
    config_overrides: Optional[AsyncMarketplaceAgreementClientConfig] = None,
) -> DescribeAgreementOutput

Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

Parameters:

  • agreement_id (ResourceId) –

    The unique identifier of the agreement.

Raises:

Source code in docs_src/capo_marketplace_agreement/_services/async_marketplace_agreement.py
async def describe_agreement(
    self,
    agreement_id: "capo_marketplace_agreement.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[AsyncMarketplaceAgreementClientConfig] = None,
) -> "capo_marketplace_agreement.types.describe_agreement_output.DescribeAgreementOutput":
    """<p>Provides details about an agreement, such as the proposer, acceptor, start date, and end date.</p>

    Args:
        agreement_id: <p>The unique identifier of the agreement.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_marketplace_agreement.types.describe_agreement_input.DescribeAgreementInput]",
    ) -> AsyncOperationResponse[
        "capo_marketplace_agreement.types.describe_agreement_output.DescribeAgreementOutput"
    ]:
        import capo_marketplace_agreement._operations.awsmp_commerce_service_v20200301.describe_agreement

        (
            output,
            http_response,
        ) = await capo_marketplace_agreement._operations.awsmp_commerce_service_v20200301.describe_agreement.async_describe_agreement(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAgreement")
    )
    input_: capo_marketplace_agreement.types.describe_agreement_input.DescribeAgreementInput = {
        "agreement_id": agreement_id
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output