GetContact - AWS Systems Manager Incident Manager

GetContact

Retrieves information about the specified contact or escalation plan.

Request Syntax

{ "ContactId": "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.

ContactId

The Amazon Resource Name (ARN) of the contact or escalation plan.

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

{ "Alias": "string", "ContactArn": "string", "DisplayName": "string", "Plan": { "Stages": [ { "DurationInMinutes": number, "Targets": [ { "ChannelTargetInfo": { "ContactChannelId": "string", "RetryIntervalInMinutes": number }, "ContactTargetInfo": { "ContactId": "string", "IsEssential": boolean } } ] } ] }, "Type": "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.

Alias

The alias of the contact or escalation plan. The alias is unique and identifiable.

Type: String

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

Pattern: ^[a-z0-9_\-]*$

ContactArn

The ARN of the contact or escalation plan.

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+=\/,.@:-]+)*

DisplayName

The full name of the contact or escalation plan.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: ^[\p{L}\p{Z}\p{N}_.\-]*$

Plan

Details about the specific timing or stages and targets of the escalation plan or engagement plan.

Type: Plan object

Type

The type of contact, either PERSONAL or ESCALATION.

Type: String

Valid Values: PERSONAL | ESCALATION

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 action.

HTTP Status Code: 400

DataEncryptionException

The action 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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: