[ aws . ssm-contacts ]
get-contact¶
Description¶
Retrieves information about the specified contact or escalation plan.
See also: AWS API Documentation
Synopsis¶
get-contact
--contact-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--contact-id (string)
The Amazon Resource Name (ARN) of the contact or escalation plan.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
Example 1: To describe a contact plan
The following get-contact example describes a contact.
aws ssm-contacts get-contact \
--contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
Output:
{
"ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
"Alias": "akuam",
"DisplayName": "Akua Mansa",
"Type": "PERSONAL",
"Plan": {
"Stages": [
{
"DurationInMinutes": 5,
"Targets": [
{
"ChannelTargetInfo": {
"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65",
"RetryIntervalInMinutes": 1
}
}
]
},
{
"DurationInMinutes": 5,
"Targets": [
{
"ChannelTargetInfo": {
"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
"RetryIntervalInMinutes": 1
}
}
]
},
{
"DurationInMinutes": 5,
"Targets": [
{
"ChannelTargetInfo": {
"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a",
"RetryIntervalInMinutes": 1
}
}
]
}
]
}
}
Example 2: To describe an escalation plan
The following get-contact example describes an escalation plan.
aws ssm-contacts get-contact \
--contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation"
Output:
{
"ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
"Alias": "example_escalation",
"DisplayName": "Example Escalation",
"Type": "ESCALATION",
"Plan": {
"Stages": [
{
"DurationInMinutes": 5,
"Targets": [
{
"ContactTargetInfo": {
"ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
"IsEssential": true
}
}
]
},
{
"DurationInMinutes": 5,
"Targets": [
{
"ContactTargetInfo": {
"ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr",
"IsEssential": false
}
}
]
},
{
"DurationInMinutes": 0,
"Targets": [
{
"ContactTargetInfo": {
"ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi",
"IsEssential": false
}
}
]
}
]
}
}
For more information, see Contacts in the Incident Manager User Guide.
Output¶
ContactArn -> (string)
The ARN of the contact or escalation plan.
Alias -> (string)
The alias of the contact or escalation plan. The alias is unique and identifiable.
DisplayName -> (string)
The full name of the contact or escalation plan.
Type -> (string)
The type of contact, eitherPERSONALorESCALATION.
Plan -> (structure)
Details about the specific timing or stages and targets of the escalation plan or engagement plan.
Stages -> (list)
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
(structure)
A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.
DurationInMinutes -> (integer)
The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.Targets -> (list)
The contacts or contact methods that the escalation plan or engagement plan is engaging.
(structure)
The contact or contact channel that’s being engaged.
ChannelTargetInfo -> (structure)
Information about the contact channel Incident Manager is engaging.
ContactChannelId -> (string)
The Amazon Resource Name (ARN) of the contact channel.RetryIntervalInMinutes -> (integer)
The number of minutes to wait to retry sending engagement in the case the engagement initially fails.ContactTargetInfo -> (structure)
Information about the contact that Incident Manager is engaging.
ContactId -> (string)
The Amazon Resource Name (ARN) of the contact.IsEssential -> (boolean)
A Boolean value determining if the contact’s acknowledgement stops the progress of stages in the plan.RotationIds -> (list)
The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.
(string)