list_pages_by_engagement ¶

def list_pages_by_engagement(
    self,
    engagement_id: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn",
    *,
    config_overrides: Optional[SSMContactsClientConfig] = None,
    next_token: Optional[
        "capo_ssm_contacts.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional["capo_ssm_contacts.types.max_results.MaxResults"] = None,
) -> "capo_ssm_contacts.types.list_pages_by_engagement_result.ListPagesByEngagementResult":
    """<p>Lists the engagements to contact channels that occurred by engaging a contact.</p>

    Args:
        engagement_id: <p>The Amazon Resource Name (ARN) of the engagement.</p>
        next_token: <p>The pagination token to continue to the next page of results.</p>
        max_results: <p>The maximum number of engagements to contact channels to list per page of results.</p>

    Raises:
        capo_ssm_contacts.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this operation.</p>
        capo_ssm_contacts.errors.internal_server_exception.InternalServerException: <p>Unexpected error occurred while processing the request.</p>
        capo_ssm_contacts.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource that doesn't exist.</p>
        capo_ssm_contacts.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_ssm_contacts.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_ssm_contacts.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm_contacts.types.list_pages_by_engagement_request.ListPagesByEngagementRequest]",
    ) -> OperationResponse[
        "capo_ssm_contacts.types.list_pages_by_engagement_result.ListPagesByEngagementResult"
    ]:
        import capo_ssm_contacts._operations.ssm_contacts.list_pages_by_engagement

        output, http_response = (
            capo_ssm_contacts._operations.ssm_contacts.list_pages_by_engagement.list_pages_by_engagement(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPagesByEngagement")
    )
    input_: capo_ssm_contacts.types.list_pages_by_engagement_request.ListPagesByEngagementRequest = {
        "engagement_id": engagement_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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