Sélectionner vos préférences de cookies

Nous utilisons des cookies essentiels et des outils similaires qui sont nécessaires au fonctionnement de notre site et à la fourniture de nos services. Nous utilisons des cookies de performance pour collecter des statistiques anonymes afin de comprendre comment les clients utilisent notre site et d’apporter des améliorations. Les cookies essentiels ne peuvent pas être désactivés, mais vous pouvez cliquer sur « Personnaliser » ou « Refuser » pour refuser les cookies de performance.

Si vous êtes d’accord, AWS et les tiers approuvés utiliseront également des cookies pour fournir des fonctionnalités utiles au site, mémoriser vos préférences et afficher du contenu pertinent, y compris des publicités pertinentes. Pour accepter ou refuser tous les cookies non essentiels, cliquez sur « Accepter » ou « Refuser ». Pour effectuer des choix plus détaillés, cliquez sur « Personnaliser ».

ListContacts - AWS Systems Manager Incident Manager
Cette page n'a pas été traduite dans votre langue. Demande de traduction

ListContacts

Lists all contacts and escalation plans in Incident Manager.

Request Syntax

{ "AliasPrefix": "string", "MaxResults": number, "NextToken": "string", "Type": "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.

AliasPrefix

Used to list only contacts who's aliases start with the specified prefix.

Type: String

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

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

Required: No

MaxResults

The maximum number of contacts and escalation plans per page of results.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1024.

Required: No

NextToken

The pagination token to continue to the next page of results.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^[\\\/a-zA-Z0-9_+=\-]*$

Required: No

Type

The type of contact.

Type: String

Valid Values: PERSONAL | ESCALATION | ONCALL_SCHEDULE

Required: No

Response Syntax

{ "Contacts": [ { "Alias": "string", "ContactArn": "string", "DisplayName": "string", "Type": "string" } ], "NextToken": "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.

Contacts

A list of the contacts and escalation plans in your Incident Manager account.

Type: Array of Contact objects

NextToken

The pagination token to continue to the next page of results.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^[\\\/a-zA-Z0-9_+=\-]*$

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

InternalServerException

Unexpected error occurred while processing the request.

HTTP Status Code: 500

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

Sample Request

POST / HTTP/1.1 Host: ssm-contacts.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: SSMContacts.ListContacts 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.list-contacts X-Amz-Date: 20220816T215005Z 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: 2 {}

Sample Response

{ "Contacts": [ { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", "Alias": "akuam", "DisplayName": "Akua Mansa", "Type": "PERSONAL" }, { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/test_escalation_plan", "Alias": "test_escalation_plan", "DisplayName": "Test Escalation Plan", "Type": "ESCALATION" } ] }

See Also

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

Rubrique suivante :

ListEngagements

Rubrique précédente :

ListContactChannels
ConfidentialitéConditions d'utilisation du sitePréférences de cookies
© 2025, Amazon Web Services, Inc. ou ses affiliés. Tous droits réservés.