Skip to content

describe_engagement async 

describe_engagement(
    engagement_id: SsmContactsArn,
    *,
    config_overrides: Optional[AsyncSSMContactsClientConfig] = None,
) -> DescribeEngagementResult

Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.

Parameters:

  • engagement_id (SsmContactsArn) –

    The Amazon Resource Name (ARN) of the engagement you want the details of.

Raises:

Source code in docs_src/capo_ssm_contacts/_services/async_ssm_contacts.py 
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
async def describe_engagement(
    self,
    engagement_id: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn",
    *,
    config_overrides: Optional[AsyncSSMContactsClientConfig] = None,
) -> "capo_ssm_contacts.types.describe_engagement_result.DescribeEngagementResult":
    """<p>Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.</p>

    Args:
        engagement_id: <p>The Amazon Resource Name (ARN) of the engagement you want the details of.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ssm_contacts.types.describe_engagement_request.DescribeEngagementRequest]",
    ) -> AsyncOperationResponse[
        "capo_ssm_contacts.types.describe_engagement_result.DescribeEngagementResult"
    ]:
        import capo_ssm_contacts._operations.ssm_contacts.describe_engagement

        (
            output,
            http_response,
        ) = await capo_ssm_contacts._operations.ssm_contacts.describe_engagement.async_describe_engagement(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEngagement")
    )
    input_: capo_ssm_contacts.types.describe_engagement_request.DescribeEngagementRequest = {
        "engagement_id": engagement_id
    }

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