list_engagement_invitations ¶

def list_engagement_invitations(
    self,
    catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier",
    participant_type: "capo_partnercentral_selling.types.participant_type.ParticipantType",
    *,
    config_overrides: Optional[PartnerCentralSellingClientConfig] = None,
    max_results: Optional[
        "capo_partnercentral_selling.types.page_size.PageSize"
    ] = None,
    next_token: Optional[str] = None,
    sort: Optional[
        "capo_partnercentral_selling.types.opportunity_engagement_invitation_sort.OpportunityEngagementInvitationSort"
    ] = None,
    payload_type: Optional[
        "capo_partnercentral_selling.types.engagement_invitations_payload_type.EngagementInvitationsPayloadType"
    ] = None,
    status: Optional[
        "capo_partnercentral_selling.types.invitation_status_list.InvitationStatusList"
    ] = None,
    engagement_identifier: Optional[
        "capo_partnercentral_selling.types.engagement_identifiers.EngagementIdentifiers"
    ] = None,
    sender_aws_account_id: Optional[
        "capo_partnercentral_selling.types.aws_account_id_or_alias_list.AwsAccountIdOrAliasList"
    ] = None,
) -> "capo_partnercentral_selling.types.list_engagement_invitations_response.ListEngagementInvitationsResponse":
    """<p>Retrieves a list of engagement invitations sent to the partner. This allows partners to view all pending or past engagement invitations, helping them track opportunities shared by AWS.</p>

    Args:
        catalog: <p>Specifies the catalog from which to list the engagement invitations. Use <code>AWS</code> for production invitations or <code>Sandbox</code> for testing environments.</p>
        max_results: <p>Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.</p>
        next_token: <p>A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.</p>
        sort: <p>Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as <code>InvitationDate</code> or <code>Status</code> to help partners view results in their preferred order.</p>
        payload_type: <p>Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.</p>
        participant_type: <p>Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.</p>
        status: <p> Status values to filter the invitations. </p>
        engagement_identifier: <p> Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days. </p>
        sender_aws_account_id: <p> List of sender AWS account IDs to filter the invitations. </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.
    """

    def _handler(
        req: "OperationRequest[capo_partnercentral_selling.types.list_engagement_invitations_request.ListEngagementInvitationsRequest]",
    ) -> OperationResponse[
        "capo_partnercentral_selling.types.list_engagement_invitations_response.ListEngagementInvitationsResponse"
    ]:
        import capo_partnercentral_selling._operations.aws_partner_central_selling.list_engagement_invitations

        output, http_response = (
            capo_partnercentral_selling._operations.aws_partner_central_selling.list_engagement_invitations.list_engagement_invitations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

        return capo_partnercentral_selling.types.list_engagement_invitations_request.redact_sensitive(
            input_
        )

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

        return capo_partnercentral_selling.types.list_engagement_invitations_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListEngagementInvitations",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_partnercentral_selling.types.list_engagement_invitations_request.ListEngagementInvitationsRequest = {
        "catalog": catalog,
        "participant_type": participant_type,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if sort is not None:
        input_["sort"] = sort
    if payload_type is not None:
        input_["payload_type"] = payload_type
    if status is not None:
        input_["status"] = status
    if engagement_identifier is not None:
        input_["engagement_identifier"] = engagement_identifier
    if sender_aws_account_id is not None:
        input_["sender_aws_account_id"] = sender_aws_account_id

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