Skip to content

describe_page

describe_page(
    page_id: SsmContactsArn,
    *,
    config_overrides: Optional[SSMContactsClientConfig] = None,
) -> DescribePageResult

Lists details of the engagement to a contact channel.

Parameters:

  • page_id (SsmContactsArn) –

    The ID of the engagement to a contact channel.

Raises:

Source code in docs_src/capo_ssm_contacts/_services/ssm_contacts.py
def describe_page(
    self,
    page_id: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn",
    *,
    config_overrides: Optional[SSMContactsClientConfig] = None,
) -> "capo_ssm_contacts.types.describe_page_result.DescribePageResult":
    """<p>Lists details of the engagement to a contact channel.</p>

    Args:
        page_id: <p>The ID of the engagement to a contact channel.</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.data_encryption_exception.DataEncryptionException: <p>The operation failed to due an encryption key error.</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.describe_page_request.DescribePageRequest]",
    ) -> OperationResponse[
        "capo_ssm_contacts.types.describe_page_result.DescribePageResult"
    ]:
        import capo_ssm_contacts._operations.ssm_contacts.describe_page

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePage")
    )
    input_: capo_ssm_contacts.types.describe_page_request.DescribePageRequest = {
        "page_id": page_id
    }

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