Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribePage

Lists details of the engagement to a contact channel.

Request Syntax


{
   "PageId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

PageId

The ID of the engagement to a contact channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*

Required: Yes

Response Syntax


{
   "ContactArn": "string",
   "Content": "string",
   "DeliveryTime": number,
   "EngagementArn": "string",
   "IncidentId": "string",
   "PageArn": "string",
   "PublicContent": "string",
   "PublicSubject": "string",
   "ReadTime": number,
   "Sender": "string",
   "SentTime": number,
   "Subject": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ContactArn

The ARN of the contact that was engaged.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*

Content

The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: ^[.\s\S]*$

DeliveryTime

The time that the contact channel received the engagement.

Type: Timestamp

EngagementArn

The ARN of the engagement that engaged the contact channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*

IncidentId

The ARN of the incident that engaged the contact channel.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^[\\a-zA-Z0-9_@#%*+=:?.\/!\s-]*$

PageArn

The Amazon Resource Name (ARN) of the engagement to a contact channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*

PublicContent

The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: ^[.\s\S]*$

PublicSubject

The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^[.\s\S]*$

ReadTime

The time that the contact channel acknowledged the engagement.

Type: Timestamp

Sender

The user that started the engagement.

Type: String

Length Constraints: Maximum length of 255.

Pattern: ^[\\a-zA-Z0-9_@#%*+=:?.\/!\s-]*$

SentTime

The time the engagement was sent to the contact channel.

Type: Timestamp

Subject

The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^[.\s\S]*$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this operation.

HTTP Status Code: 400

DataEncryptionException

The operation failed to due an encryption key error.

HTTP Status Code: 400

InternalServerException

Unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource that doesn't exist.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribePage.

Sample Request


POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.DescribePage
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/ssm-contacts.describe-page
X-Amz-Date: 20220816T193722Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220816/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 105

{
	"PageId": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/2f92b456-2350-442b-95e7-ed8b0EXAMPLE"
}

Sample Response


{
    "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/2f92b456-2350-442b-95e7-ed8b0EXAMPLE",
    "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/27bd86cf-6d50-49d2-a9ab-da39bEXAMPLE",
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
    "Sender": "cli",
    "Subject": "cli-test",
    "Content": "Testing engagements via CLI",
    "PublicSubject": "cli-test",
    "PublicContent": "Testing engagements via CLI",
    "SentTime": "2022-08-16T18:57:52.058000+00:00",
    "ReadTime": "2022-08-16T19:11:58.746000+00:00"
}