Lists all of the engagements to contact channels that have been acknowledged.
Parameters:
-
page_id
(SsmContactsArn)
–
The Amazon Resource Name (ARN) of the engagement to a specific contact channel.
-
next_token
(Optional[PaginationToken], default:
None
)
–
The pagination token to continue to the next page of results.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of acknowledgements per page of results.
Raises:
Source code in docs_src/capo_ssm_contacts/_services/ssm_contacts.py
| def list_page_receipts(
self,
page_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_page_receipts_result.ListPageReceiptsResult":
"""<p>Lists all of the engagements to contact channels that have been acknowledged.</p>
Args:
page_id: <p>The Amazon Resource Name (ARN) of the engagement to a specific contact channel.</p>
next_token: <p>The pagination token to continue to the next page of results.</p>
max_results: <p>The maximum number of acknowledgements 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_page_receipts_request.ListPageReceiptsRequest]",
) -> OperationResponse[
"capo_ssm_contacts.types.list_page_receipts_result.ListPageReceiptsResult"
]:
import capo_ssm_contacts._operations.ssm_contacts.list_page_receipts
output, http_response = (
capo_ssm_contacts._operations.ssm_contacts.list_page_receipts.list_page_receipts(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListPageReceipts")
)
input_: capo_ssm_contacts.types.list_page_receipts_request.ListPageReceiptsRequest = {
"page_id": page_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
|