list_engagements async ¶

async def list_engagements(
    self,
    catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier",
    *,
    config_overrides: Optional[AsyncPartnerCentralSellingClientConfig] = None,
    created_by: Optional[
        "capo_partnercentral_selling.types.aws_account_list.AwsAccountList"
    ] = None,
    exclude_created_by: Optional[
        "capo_partnercentral_selling.types.aws_account_list.AwsAccountList"
    ] = None,
    context_types: Optional[
        "capo_partnercentral_selling.types.engagement_context_type_list.EngagementContextTypeList"
    ] = None,
    exclude_context_types: Optional[
        "capo_partnercentral_selling.types.engagement_context_type_list.EngagementContextTypeList"
    ] = None,
    sort: Optional[
        "capo_partnercentral_selling.types.engagement_sort.EngagementSort"
    ] = None,
    max_results: Optional[
        "capo_partnercentral_selling.types.engagement_page_size.EngagementPageSize"
    ] = None,
    next_token: Optional[str] = None,
    engagement_identifier: Optional[
        "capo_partnercentral_selling.types.engagement_identifiers.EngagementIdentifiers"
    ] = None,
) -> "capo_partnercentral_selling.types.list_engagements_response.ListEngagementsResponse":
    """<p>This action allows users to retrieve a list of Engagement records from Partner Central. This action can be used to manage and track various engagements across different stages of the partner selling process. </p>

    Args:
        catalog: <p> Specifies the catalog related to the request. </p>
        created_by: <p> A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members. </p>
        exclude_created_by: <p>An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users. </p>
        context_types: <p>Filters engagements to include only those containing the specified context types, such as "CustomerProject" or "Lead". Use this to find engagements that have specific types of contextual information associated with them.</p>
        exclude_context_types: <p>Filters engagements to exclude those containing the specified context types. Use this to find engagements that do not have certain types of contextual information, helping to narrow results based on context exclusion criteria.</p>
        max_results: <p>The maximum number of results to return in a single call.</p>
        next_token: <p>The token for the next set of results. This value is returned from a previous call.</p>
        engagement_identifier: <p>An array of strings representing engagement identifiers to retrieve.</p>

    Raises:
        capo_partnercentral_selling.errors.access_denied_exception.AccessDeniedException: <p>This error occurs when you don't have permission to perform the requested action.</p> <p>You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.</p>
        capo_partnercentral_selling.errors.internal_server_exception.InternalServerException: <p>This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.</p> <p>Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.</p>
        capo_partnercentral_selling.errors.resource_not_found_exception.ResourceNotFoundException: <p>This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.</p> <p>Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.</p>
        capo_partnercentral_selling.errors.throttling_exception.ThrottlingException: <p>This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.</p> <p>This error occurs when there are too many requests sent. Review the provided <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> and retry after the provided delay.</p>
        capo_partnercentral_selling.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service or business validation rules.</p> <p>Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.</p>
        capo_partnercentral_selling.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_partnercentral_selling.types.list_engagements_request.ListEngagementsRequest]",
    ) -> AsyncOperationResponse[
        "capo_partnercentral_selling.types.list_engagements_response.ListEngagementsResponse"
    ]:
        import capo_partnercentral_selling._operations.aws_partner_central_selling.list_engagements

        (
            output,
            http_response,
        ) = await capo_partnercentral_selling._operations.aws_partner_central_selling.list_engagements.async_list_engagements(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_partnercentral_selling.types.list_engagements_request.ListEngagementsRequest",
    ) -> dict[str, Any]:
        import capo_partnercentral_selling.types.list_engagements_request

        return capo_partnercentral_selling.types.list_engagements_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_partnercentral_selling.types.list_engagements_response.ListEngagementsResponse",
    ) -> dict[str, Any]:
        import capo_partnercentral_selling.types.list_engagements_response

        return capo_partnercentral_selling.types.list_engagements_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListEngagements",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_partnercentral_selling.types.list_engagements_request.ListEngagementsRequest = {
        "catalog": catalog
    }
    if created_by is not None:
        input_["created_by"] = created_by
    if exclude_created_by is not None:
        input_["exclude_created_by"] = exclude_created_by
    if context_types is not None:
        input_["context_types"] = context_types
    if exclude_context_types is not None:
        input_["exclude_context_types"] = exclude_context_types
    if sort is not None:
        input_["sort"] = sort
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if engagement_identifier is not None:
        input_["engagement_identifier"] = engagement_identifier

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