Amazon Incident Manager Incident Manager Page API
The Incident Manager Page API from Amazon Incident Manager — 4 operation(s) for incident manager page.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-incident-manager:amazon-incident-manager-page-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: AWS Systems Manager Incident Manager Page API
version: '2018-05-10'
description: Generated from AWS's published Smithy model for AWS Systems Manager Incident Manager. 4 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://ssm-contacts.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Page
paths:
/#AcceptPage:
post:
operationId: AcceptPage
summary: Accept Page
description: Used to acknowledge an engagement to a contact channel during an incident.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/AcceptPageResult'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsAccessDeniedException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsInternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsThrottlingException'
'400':
description: ValidationException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- SSMContacts.AcceptPage
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/AcceptPageRequest'
tags:
- Page
/#DescribePage:
post:
operationId: DescribePage
summary: Describe Page
description: Lists details of the engagement to a contact channel.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribePageResult'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsAccessDeniedException'
'400':
description: DataEncryptionException; ValidationException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DataEncryptionException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsInternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsThrottlingException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- SSMContacts.DescribePage
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribePageRequest'
tags:
- Page
/#ListPagesByContact:
post:
operationId: ListPagesByContact
summary: List Pages By Contact
description: Lists the engagements to a contact's contact channels.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListPagesByContactResult'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsAccessDeniedException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsInternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsThrottlingException'
'400':
description: ValidationException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- SSMContacts.ListPagesByContact
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListPagesByContactRequest'
tags:
- Page
/#ListPagesByEngagement:
post:
operationId: ListPagesByEngagement
summary: List Pages By Engagement
description: Lists the engagements to contact channels that occurred by engaging a contact.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListPagesByEngagementResult'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsAccessDeniedException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsInternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsThrottlingException'
'400':
description: ValidationException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/SsmContactsValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- SSMContacts.ListPagesByEngagement
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListPagesByEngagementRequest'
tags:
- Page
components:
schemas:
SsmContactsResourceNotFoundException:
type: object
properties:
Message:
type: string
ResourceId:
type: string
description: Hypothetical resource identifier that was not found
ResourceType:
type: string
description: Hypothetical resource type that was not found
required:
- Message
- ResourceId
- ResourceType
DataEncryptionException:
type: object
properties:
Message:
type: string
required:
- Message
SsmContactsValidationException:
type: object
properties:
Message:
type: string
Reason:
type: string
enum:
- UNKNOWN_OPERATION
- CANNOT_PARSE
- FIELD_VALIDATION_FAILED
- OTHER
description: Reason the request failed validation
Fields:
type: array
items:
$ref: '#/components/schemas/ValidationExceptionField'
description: The fields that caused the error
required:
- Message
SsmContactsInternalServerException:
type: object
properties:
Message:
type: string
RetryAfterSeconds:
type: integer
description: Advice to clients on when the call can be safely retried
required:
- Message
ListPagesByContactResult:
type: object
properties:
NextToken:
type: string
description: The pagination token to continue to the next page of results.
Pages:
type: array
items:
$ref: '#/components/schemas/Page'
description: The list of engagements to a contact's contact channel.
required:
- Pages
ListPagesByEngagementRequest:
type: object
properties:
EngagementId:
type: string
description: The Amazon Resource Name (ARN) of the engagement.
NextToken:
type: string
description: The pagination token to continue to the next page of results.
MaxResults:
type: integer
description: The maximum number of engagements to contact channels to list per page of results.
required:
- EngagementId
DescribePageResult:
type: object
properties:
PageArn:
type: string
description: The Amazon Resource Name (ARN) of the engagement to a contact channel.
EngagementArn:
type: string
description: The ARN of the engagement that engaged the contact channel.
ContactArn:
type: string
description: The ARN of the contact that was engaged.
Sender:
type: string
description: The user that started the engagement.
Subject:
type: string
description: The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.
Content:
type: string
description: The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.
PublicSubject:
type: string
description: The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.
PublicContent:
type: string
description: The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.
IncidentId:
type: string
description: The ARN of the incident that engaged the contact channel.
SentTime:
type: string
format: date-time
description: The time the engagement was sent to the contact channel.
ReadTime:
type: string
format: date-time
description: The time that the contact channel acknowledged the engagement.
DeliveryTime:
type: string
format: date-time
description: The time that the contact channel received the engagement.
required:
- PageArn
- EngagementArn
- ContactArn
- Sender
- Subject
- Content
AcceptPageRequest:
type: object
properties:
PageId:
type: string
description: The Amazon Resource Name (ARN) of the engagement to a contact channel.
ContactChannelId:
type: string
description: The ARN of the contact channel.
AcceptType:
type: string
enum:
- DELIVERED
- READ
description: The type indicates if the page was DELIVERED or READ.
Note:
type: string
description: Information provided by the user when the user acknowledges the page.
AcceptCode:
type: string
description: A 6-digit code used to acknowledge the page.
AcceptCodeValidation:
type: string
enum:
- IGNORE
- ENFORCE
description: An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page. Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.
required:
- PageId
- AcceptType
- AcceptCode
SsmContactsThrottlingException:
type: object
properties:
Message:
type: string
QuotaCode:
type: string
description: Service Quotas requirement to identify originating service
ServiceCode:
type: string
description: Service Quotas requirement to identify originating quota
RetryAfterSeconds:
type: integer
description: Advice to clients on when the call can be safely retried
required:
- Message
SsmContactsAccessDeniedException:
type: object
properties:
Message:
type: string
required:
- Message
ListPagesByContactRequest:
type: object
properties:
ContactId:
type: string
description: The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.
NextToken:
type: string
description: The pagination token to continue to the next page of results.
MaxResults:
type: integer
description: The maximum number of engagements to contact channels to list per page of results.
required:
- ContactId
Page:
type: object
properties:
PageArn:
type: string
description: The Amazon Resource Name (ARN) of the page to the contact channel.
EngagementArn:
type: string
description: The ARN of the engagement that this page is part of.
ContactArn:
type: string
description: The ARN of the contact that Incident Manager is engaging.
Sender:
type: string
description: The user that started the engagement.
IncidentId:
type: string
description: The ARN of the incident that's engaging the contact channel.
SentTime:
type: string
format: date-time
description: The time that Incident Manager engaged the contact channel.
DeliveryTime:
type: string
format: date-time
description: The time the message was delivered to the contact channel.
ReadTime:
type: string
format: date-time
description: The time that the contact channel acknowledged engagement.
required:
- PageArn
- EngagementArn
- ContactArn
- Sender
ListPagesByEngagementResult:
type: object
properties:
NextToken:
type: string
description: The pagination token to continue to the next page of results.
Pages:
type: array
items:
$ref: '#/components/schemas/Page'
description: The list of engagements to contact channels.
required:
- Pages
ValidationExceptionField:
type: object
properties:
Name:
type: string
description: The name of the field that caused the exception.
Message:
type: string
description: Information about what caused the field to cause an exception.
required:
- Name
- Message
DescribePageRequest:
type: object
properties:
PageId:
type: string
description: The ID of the engagement to a contact channel.
required:
- PageId
AcceptPageResult:
type: object
properties: {}
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: ssm-contacts
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ssm-contacts/service/2021-05-03/ssm-contacts-2021-05-03.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)