AWS SDK for PHP 3.x

Client: Aws\SSMIncidents\SSMIncidentsClient

Service ID: ssm-incidents

Version: 2018-05-10

This page describes the parameters and results for the operations of the AWS Systems Manager Incident Manager (2018-05-10), and shows how to use the Aws\SSMIncidents\SSMIncidentsClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

BatchGetIncidentFindings ( array $params = [] ): Retrieves details about all specified findings for an incident, including descriptive details about each finding.
CreateReplicationSet ( array $params = [] ): A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.
CreateResponsePlan ( array $params = [] ): Creates a response plan that automates the initial response to incidents.
CreateTimelineEvent ( array $params = [] ): Creates a custom timeline event on the incident details page of an incident record.
DeleteIncidentRecord ( array $params = [] ): Delete an incident record from Incident Manager.
DeleteReplicationSet ( array $params = [] ): Deletes all Regions in your replication set.
DeleteResourcePolicy ( array $params = [] ): Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource.
DeleteResponsePlan ( array $params = [] ): Deletes the specified response plan.
DeleteTimelineEvent ( array $params = [] ): Deletes a timeline event from an incident.
GetIncidentRecord ( array $params = [] ): Returns the details for the specified incident record.
GetReplicationSet ( array $params = [] ): Retrieve your Incident Manager replication set.
GetResourcePolicies ( array $params = [] ): Retrieves the resource policies attached to the specified response plan.
GetResponsePlan ( array $params = [] ): Retrieves the details of the specified response plan.
GetTimelineEvent ( array $params = [] ): Retrieves a timeline event based on its ID and incident record.
ListIncidentFindings ( array $params = [] ): Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident.
ListIncidentRecords ( array $params = [] ): Lists all incident records in your account.
ListRelatedItems ( array $params = [] ): List all related items for an incident record.
ListReplicationSets ( array $params = [] ): Lists details about the replication set configured in your account.
ListResponsePlans ( array $params = [] ): Lists all response plans in your account.
ListTagsForResource ( array $params = [] ): Lists the tags that are attached to the specified response plan or incident.
ListTimelineEvents ( array $params = [] ): Lists timeline events for the specified incident record.
PutResourcePolicy ( array $params = [] ): Adds a resource policy to the specified response plan.
StartIncident ( array $params = [] ): Used to start an incident from CloudWatch alarms, EventBridge events, or manually.
TagResource ( array $params = [] ): Adds a tag to a response plan.
UntagResource ( array $params = [] ): Removes a tag from a resource.
UpdateDeletionProtection ( array $params = [] ): Update deletion protection to either allow or deny deletion of the final Region in a replication set.
UpdateIncidentRecord ( array $params = [] ): Update the details of an incident record.
UpdateRelatedItems ( array $params = [] ): Add or remove related items from the related items tab of an incident record.
UpdateReplicationSet ( array $params = [] ): Add or delete Regions from your replication set.
UpdateResponsePlan ( array $params = [] ): Updates the specified response plan.
UpdateTimelineEvent ( array $params = [] ): Updates a timeline event.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

GetResourcePolicies
ListIncidentFindings
ListIncidentRecords
ListRelatedItems
ListReplicationSets
ListResponsePlans
ListTimelineEvents

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name	API Operation	Delay	Max Attempts
WaitForReplicationSetActive	GetReplicationSet	30	5
WaitForReplicationSetDeleted	GetReplicationSet	30	5

Operations

BatchGetIncidentFindings

$result = $client->batchGetIncidentFindings([/* ... */]);
$promise = $client->batchGetIncidentFindingsAsync([/* ... */]);

Retrieves details about all specified findings for an incident, including descriptive details about each finding. A finding represents a recent application environment change made by an CodeDeploy deployment or an CloudFormation stack creation or update that can be investigated as a potential cause of the incident.

Parameter Syntax

$result = $client->batchGetIncidentFindings([
    'findingIds' => ['<string>', ...], // REQUIRED
    'incidentRecordArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

findingIds

: Required: Yes
: Type: Array of strings

A list of IDs of findings for which you want to view details.

incidentRecordArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident for which you want to view finding details.

Result Syntax

[
    'errors' => [
        [
            'code' => '<string>',
            'findingId' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
    'findings' => [
        [
            'creationTime' => <DateTime>,
            'details' => [
                'cloudFormationStackUpdate' => [
                    'endTime' => <DateTime>,
                    'stackArn' => '<string>',
                    'startTime' => <DateTime>,
                ],
                'codeDeployDeployment' => [
                    'deploymentGroupArn' => '<string>',
                    'deploymentId' => '<string>',
                    'endTime' => <DateTime>,
                    'startTime' => <DateTime>,
                ],
            ],
            'id' => '<string>',
            'lastModifiedTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members

errors

: Required: Yes
: Type: Array of BatchGetIncidentFindingsError structures

A list of errors encountered during the operation.

findings

: Required: Yes
: Type: Array of Finding structures

Information about the requested findings.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

CreateReplicationSet

$result = $client->createReplicationSet([/* ... */]);
$promise = $client->createReplicationSetAsync([/* ... */]);

A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.

Parameter Syntax

$result = $client->createReplicationSet([
    'clientToken' => '<string>',
    'regions' => [ // REQUIRED
        '<RegionName>' => [
            'sseKmsKeyId' => '<string>',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

clientToken

: Type: string

A token that ensures that the operation is called only once with the specified details.

regions

: Required: Yes
: Type: Associative array of custom strings keys (RegionName) to RegionMapInputValue structures

The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

A list of tags to add to the replication set.

Result Syntax

[
    'arn' => '<string>',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the replication set.

Errors

ServiceQuotaExceededException:: Request would cause a service quota to be exceeded.
ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
ConflictException:: Updating or deleting a resource causes an inconsistent state.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

CreateResponsePlan

$result = $client->createResponsePlan([/* ... */]);
$promise = $client->createResponsePlanAsync([/* ... */]);

Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident.

Parameter Syntax

$result = $client->createResponsePlan([
    'actions' => [
        [
            'ssmAutomation' => [
                'documentName' => '<string>', // REQUIRED
                'documentVersion' => '<string>',
                'dynamicParameters' => [
                    '<DynamicSsmParametersKeyString>' => [
                        'variable' => 'INCIDENT_RECORD_ARN|INVOLVED_RESOURCES',
                    ],
                    // ...
                ],
                'parameters' => [
                    '<SsmParametersKeyString>' => ['<string>', ...],
                    // ...
                ],
                'roleArn' => '<string>', // REQUIRED
                'targetAccount' => 'RESPONSE_PLAN_OWNER_ACCOUNT|IMPACTED_ACCOUNT',
            ],
        ],
        // ...
    ],
    'chatChannel' => [
        'chatbotSns' => ['<string>', ...],
        'empty' => [
        ],
    ],
    'clientToken' => '<string>',
    'displayName' => '<string>',
    'engagements' => ['<string>', ...],
    'incidentTemplate' => [ // REQUIRED
        'dedupeString' => '<string>',
        'impact' => <integer>, // REQUIRED
        'incidentTags' => ['<string>', ...],
        'notificationTargets' => [
            [
                'snsTopicArn' => '<string>',
            ],
            // ...
        ],
        'summary' => '<string>',
        'title' => '<string>', // REQUIRED
    ],
    'integrations' => [
        [
            'pagerDutyConfiguration' => [
                'name' => '<string>', // REQUIRED
                'pagerDutyIncidentConfiguration' => [ // REQUIRED
                    'serviceId' => '<string>', // REQUIRED
                ],
                'secretId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

actions

: Type: Array of Action structures

The actions that the response plan starts at the beginning of an incident.

chatChannel

: Type: ChatChannel structure

The Chatbot chat channel used for collaboration during an incident.

clientToken

: Type: string

A token ensuring that the operation is called only once with the specified details.

displayName

: Type: string

The long format of the response plan name. This field can contain spaces.

engagements

: Type: Array of strings

The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

incidentTemplate

: Required: Yes
: Type: IncidentTemplate structure

Details used to create an incident when using this response plan.

integrations

: Type: Array of Integration structures

Information about third-party services integrated into the response plan.

name

: Required: Yes
: Type: string

The short format name of the response plan. Can't include spaces.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

A list of tags that you are adding to the response plan.

Result Syntax

[
    'arn' => '<string>',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the response plan.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
ConflictException:: Updating or deleting a resource causes an inconsistent state.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

CreateTimelineEvent

$result = $client->createTimelineEvent([/* ... */]);
$promise = $client->createTimelineEventAsync([/* ... */]);

Creates a custom timeline event on the incident details page of an incident record. Incident Manager automatically creates timeline events that mark key moments during an incident. You can create custom timeline events to mark important events that Incident Manager can detect automatically.

Parameter Syntax

$result = $client->createTimelineEvent([
    'clientToken' => '<string>',
    'eventData' => '<string>', // REQUIRED
    'eventReferences' => [
        [
            'relatedItemId' => '<string>',
            'resource' => '<string>',
        ],
        // ...
    ],
    'eventTime' => <integer || string || DateTime>, // REQUIRED
    'eventType' => '<string>', // REQUIRED
    'incidentRecordArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

clientToken

: Type: string

A token that ensures that a client calls the action only once with the specified details.

eventData

: Required: Yes
: Type: string

A short description of the event.

eventReferences

: Type: Array of EventReference structures

Adds one or more references to the TimelineEvent. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

eventTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the event occurred.

eventType

: Required: Yes
: Type: string

The type of event. You can create timeline events of type Custom Event and Note.

To make a Note-type event appear on the Incident notes panel in the console, specify eventType as Noteand enter the Amazon Resource Name (ARN) of the incident as the value for eventReference.

incidentRecordArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident record that the action adds the incident to.

Result Syntax

[
    'eventId' => '<string>',
    'incidentRecordArn' => '<string>',
]

Result Details

Members

eventId

: Required: Yes
: Type: string

The ID of the event for easy reference later.

incidentRecordArn

: Required: Yes
: Type: string

The ARN of the incident record that you added the event to.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
ConflictException:: Updating or deleting a resource causes an inconsistent state.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

DeleteIncidentRecord

$result = $client->deleteIncidentRecord([/* ... */]);
$promise = $client->deleteIncidentRecordAsync([/* ... */]);

Delete an incident record from Incident Manager.

Parameter Syntax

$result = $client->deleteIncidentRecord([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident record you are deleting.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

DeleteReplicationSet

$result = $client->deleteReplicationSet([/* ... */]);
$promise = $client->deleteReplicationSetAsync([/* ... */]);

Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.

Parameter Syntax

$result = $client->deleteReplicationSet([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the replication set you're deleting.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource.

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'policyId' => '<string>', // REQUIRED
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

policyId

: Required: Yes
: Type: string

The ID of the resource policy you're deleting.

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource you're deleting the policy from.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

DeleteResponsePlan

$result = $client->deleteResponsePlan([/* ... */]);
$promise = $client->deleteResponsePlanAsync([/* ... */]);

Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan.

Parameter Syntax

$result = $client->deleteResponsePlan([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the response plan.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

DeleteTimelineEvent

$result = $client->deleteTimelineEvent([/* ... */]);
$promise = $client->deleteTimelineEventAsync([/* ... */]);

Deletes a timeline event from an incident.

Parameter Syntax

$result = $client->deleteTimelineEvent([
    'eventId' => '<string>', // REQUIRED
    'incidentRecordArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

eventId

: Required: Yes
: Type: string

The ID of the event to update. You can use ListTimelineEvents to find an event's ID.

incidentRecordArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident that includes the timeline event.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

GetIncidentRecord

$result = $client->getIncidentRecord([/* ... */]);
$promise = $client->getIncidentRecordAsync([/* ... */]);

Returns the details for the specified incident record.

Parameter Syntax

$result = $client->getIncidentRecord([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident record.

Result Syntax

[
    'incidentRecord' => [
        'arn' => '<string>',
        'automationExecutions' => [
            [
                'ssmExecutionArn' => '<string>',
            ],
            // ...
        ],
        'chatChannel' => [
            'chatbotSns' => ['<string>', ...],
            'empty' => [
            ],
        ],
        'creationTime' => <DateTime>,
        'dedupeString' => '<string>',
        'impact' => <integer>,
        'incidentRecordSource' => [
            'createdBy' => '<string>',
            'invokedBy' => '<string>',
            'resourceArn' => '<string>',
            'source' => '<string>',
        ],
        'lastModifiedBy' => '<string>',
        'lastModifiedTime' => <DateTime>,
        'notificationTargets' => [
            [
                'snsTopicArn' => '<string>',
            ],
            // ...
        ],
        'resolvedTime' => <DateTime>,
        'status' => 'OPEN|RESOLVED',
        'summary' => '<string>',
        'title' => '<string>',
    ],
]

Result Details

Members

incidentRecord

: Required: Yes
: Type: IncidentRecord structure

Details the structure of the incident record.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

GetReplicationSet

$result = $client->getReplicationSet([/* ... */]);
$promise = $client->getReplicationSetAsync([/* ... */]);

Retrieve your Incident Manager replication set.

Parameter Syntax

$result = $client->getReplicationSet([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the replication set you want to retrieve.

Result Syntax

[
    'replicationSet' => [
        'arn' => '<string>',
        'createdBy' => '<string>',
        'createdTime' => <DateTime>,
        'deletionProtected' => true || false,
        'lastModifiedBy' => '<string>',
        'lastModifiedTime' => <DateTime>,
        'regionMap' => [
            '<RegionName>' => [
                'sseKmsKeyId' => '<string>',
                'status' => 'ACTIVE|CREATING|DELETING|FAILED',
                'statusMessage' => '<string>',
                'statusUpdateDateTime' => <DateTime>,
            ],
            // ...
        ],
        'status' => 'ACTIVE|CREATING|UPDATING|DELETING|FAILED',
    ],
]

Result Details

Members

replicationSet

: Required: Yes
: Type: ReplicationSet structure

Details of the replication set.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

GetResourcePolicies

$result = $client->getResourcePolicies([/* ... */]);
$promise = $client->getResourcePoliciesAsync([/* ... */]);

Retrieves the resource policies attached to the specified response plan.

Parameter Syntax

$result = $client->getResourcePolicies([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of resource policies to display for each page of results.

nextToken

: Type: string

The pagination token for the next set of items to return. (You received this token from a previous call.)

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the response plan with the attached resource policy.

Result Syntax

[
    'nextToken' => '<string>',
    'resourcePolicies' => [
        [
            'policyDocument' => '<string>',
            'policyId' => '<string>',
            'ramResourceShareRegion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.

resourcePolicies

: Required: Yes
: Type: Array of ResourcePolicy structures

Details about the resource policy attached to the response plan.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

GetResponsePlan

$result = $client->getResponsePlan([/* ... */]);
$promise = $client->getResponsePlanAsync([/* ... */]);

Retrieves the details of the specified response plan.

Parameter Syntax

$result = $client->getResponsePlan([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the response plan.

Result Syntax

[
    'actions' => [
        [
            'ssmAutomation' => [
                'documentName' => '<string>',
                'documentVersion' => '<string>',
                'dynamicParameters' => [
                    '<DynamicSsmParametersKeyString>' => [
                        'variable' => 'INCIDENT_RECORD_ARN|INVOLVED_RESOURCES',
                    ],
                    // ...
                ],
                'parameters' => [
                    '<SsmParametersKeyString>' => ['<string>', ...],
                    // ...
                ],
                'roleArn' => '<string>',
                'targetAccount' => 'RESPONSE_PLAN_OWNER_ACCOUNT|IMPACTED_ACCOUNT',
            ],
        ],
        // ...
    ],
    'arn' => '<string>',
    'chatChannel' => [
        'chatbotSns' => ['<string>', ...],
        'empty' => [
        ],
    ],
    'displayName' => '<string>',
    'engagements' => ['<string>', ...],
    'incidentTemplate' => [
        'dedupeString' => '<string>',
        'impact' => <integer>,
        'incidentTags' => ['<string>', ...],
        'notificationTargets' => [
            [
                'snsTopicArn' => '<string>',
            ],
            // ...
        ],
        'summary' => '<string>',
        'title' => '<string>',
    ],
    'integrations' => [
        [
            'pagerDutyConfiguration' => [
                'name' => '<string>',
                'pagerDutyIncidentConfiguration' => [
                    'serviceId' => '<string>',
                ],
                'secretId' => '<string>',
            ],
        ],
        // ...
    ],
    'name' => '<string>',
]

Result Details

Members

actions

: Type: Array of Action structures

The actions that this response plan takes at the beginning of the incident.

arn

: Required: Yes
: Type: string

The ARN of the response plan.

chatChannel

: Type: ChatChannel structure

The Chatbot chat channel used for collaboration during an incident.

displayName

: Type: string

The long format name of the response plan. Can contain spaces.

engagements

: Type: Array of strings

The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

incidentTemplate

: Required: Yes
: Type: IncidentTemplate structure

Details used to create the incident when using this response plan.

integrations

: Type: Array of Integration structures

Information about third-party services integrated into the Incident Manager response plan.

name

: Required: Yes
: Type: string

The short format name of the response plan. The name can't contain spaces.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

GetTimelineEvent

$result = $client->getTimelineEvent([/* ... */]);
$promise = $client->getTimelineEventAsync([/* ... */]);

Retrieves a timeline event based on its ID and incident record.

Parameter Syntax

$result = $client->getTimelineEvent([
    'eventId' => '<string>', // REQUIRED
    'incidentRecordArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

eventId

: Required: Yes
: Type: string

The ID of the event. You can get an event's ID when you create it, or by using ListTimelineEvents.

incidentRecordArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident that includes the timeline event.

Result Syntax

[
    'event' => [
        'eventData' => '<string>',
        'eventId' => '<string>',
        'eventReferences' => [
            [
                'relatedItemId' => '<string>',
                'resource' => '<string>',
            ],
            // ...
        ],
        'eventTime' => <DateTime>,
        'eventType' => '<string>',
        'eventUpdatedTime' => <DateTime>,
        'incidentRecordArn' => '<string>',
    ],
]

Result Details

Members

event

: Required: Yes
: Type: TimelineEvent structure

Details about the timeline event.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

ListIncidentFindings

$result = $client->listIncidentFindings([/* ... */]);
$promise = $client->listIncidentFindingsAsync([/* ... */]);

Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident. A finding represents a recent application environment change made by an CloudFormation stack creation or update or an CodeDeploy deployment that can be investigated as a potential cause of the incident.

Parameter Syntax

$result = $client->listIncidentFindings([
    'incidentRecordArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

incidentRecordArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident for which you want to view associated findings.

maxResults

: Type: int

The maximum number of findings to retrieve per call.

nextToken

: Type: string

The pagination token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'findings' => [
        [
            'id' => '<string>',
            'lastModifiedTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

findings

: Required: Yes
: Type: Array of FindingSummary structures

A list of findings that represent deployments that might be the potential cause of the incident.

nextToken

: Type: string

The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

ListIncidentRecords

$result = $client->listIncidentRecords([/* ... */]);
$promise = $client->listIncidentRecordsAsync([/* ... */]);

Lists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update.

Parameter Syntax

$result = $client->listIncidentRecords([
    'filters' => [
        [
            'condition' => [ // REQUIRED
                'after' => <integer || string || DateTime>,
                'before' => <integer || string || DateTime>,
                'equals' => [
                    'integerValues' => [<integer>, ...],
                    'stringValues' => ['<string>', ...],
                ],
            ],
            'key' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filters

: Type: Array of Filter structures

Filters the list of incident records you want to search through. You can filter on the following keys:

creationTime
impact
status
createdBy

Note the following when when you use Filters:

If you don't specify a Filter, the response includes all incident records.
If you specify more than one filter in a single request, the response returns incident records that match all filters.
If you specify a filter with more than one value, the response returns incident records that match any of the values provided.

maxResults

: Type: int

The maximum number of results per page.

nextToken

: Type: string

The pagination token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'incidentRecordSummaries' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'impact' => <integer>,
            'incidentRecordSource' => [
                'createdBy' => '<string>',
                'invokedBy' => '<string>',
                'resourceArn' => '<string>',
                'source' => '<string>',
            ],
            'resolvedTime' => <DateTime>,
            'status' => 'OPEN|RESOLVED',
            'title' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

incidentRecordSummaries

: Required: Yes
: Type: Array of IncidentRecordSummary structures

The details of each listed incident record.

nextToken

: Type: string

The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

ListRelatedItems

$result = $client->listRelatedItems([/* ... */]);
$promise = $client->listRelatedItemsAsync([/* ... */]);

List all related items for an incident record.

Parameter Syntax

$result = $client->listRelatedItems([
    'incidentRecordArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

incidentRecordArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident record containing the listed related items.

maxResults

: Type: int

The maximum number of related items per page.

nextToken

: Type: string

The pagination token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'nextToken' => '<string>',
    'relatedItems' => [
        [
            'generatedId' => '<string>',
            'identifier' => [
                'type' => 'ANALYSIS|INCIDENT|METRIC|PARENT|ATTACHMENT|OTHER|AUTOMATION|INVOLVED_RESOURCE|TASK',
                'value' => [
                    'arn' => '<string>',
                    'metricDefinition' => '<string>',
                    'pagerDutyIncidentDetail' => [
                        'autoResolve' => true || false,
                        'id' => '<string>',
                        'secretId' => '<string>',
                    ],
                    'url' => '<string>',
                ],
            ],
            'title' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.

relatedItems

: Required: Yes
: Type: Array of RelatedItem structures

Details about each related item.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

ListReplicationSets

$result = $client->listReplicationSets([/* ... */]);
$promise = $client->listReplicationSetsAsync([/* ... */]);

Lists details about the replication set configured in your account.

Parameter Syntax

$result = $client->listReplicationSets([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results per page.

nextToken

: Type: string

The pagination token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'nextToken' => '<string>',
    'replicationSetArns' => ['<string>', ...],
]

Result Details

Members

nextToken

: Type: string

The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.

replicationSetArns

: Required: Yes
: Type: Array of strings

The Amazon Resource Name (ARN) of the list replication set.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

ListResponsePlans

$result = $client->listResponsePlans([/* ... */]);
$promise = $client->listResponsePlansAsync([/* ... */]);

Lists all response plans in your account.

Parameter Syntax

$result = $client->listResponsePlans([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of response plans per page.

nextToken

: Type: string

The pagination token for the next set of items to return. (You received this token from a previous call.)

Result Syntax

[
    'nextToken' => '<string>',
    'responsePlanSummaries' => [
        [
            'arn' => '<string>',
            'displayName' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.

responsePlanSummaries

: Required: Yes
: Type: Array of ResponsePlanSummary structures

Details of each response plan.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags that are attached to the specified response plan or incident.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the response plan or incident.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

A list of tags for the response plan or incident.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

ListTimelineEvents

$result = $client->listTimelineEvents([/* ... */]);
$promise = $client->listTimelineEventsAsync([/* ... */]);

Lists timeline events for the specified incident record.

Parameter Syntax

$result = $client->listTimelineEvents([
    'filters' => [
        [
            'condition' => [ // REQUIRED
                'after' => <integer || string || DateTime>,
                'before' => <integer || string || DateTime>,
                'equals' => [
                    'integerValues' => [<integer>, ...],
                    'stringValues' => ['<string>', ...],
                ],
            ],
            'key' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'incidentRecordArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => 'EVENT_TIME',
    'sortOrder' => 'ASCENDING|DESCENDING',
]);

Parameter Details

Members

filters

: Type: Array of Filter structures

Filters the timeline events based on the provided conditional values. You can filter timeline events with the following keys:

eventReference
eventTime
eventType

Note the following when deciding how to use Filters:

If you don't specify a Filter, the response includes all timeline events.
If you specify more than one filter in a single request, the response returns timeline events that match all filters.
If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.

incidentRecordArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident that includes the timeline event.

maxResults

: Type: int

The maximum number of results per page.

nextToken

: Type: string

The pagination token for the next set of items to return. (You received this token from a previous call.)

sortBy

: Type: string

Sort timeline events by the specified key value pair.

sortOrder

: Type: string

Sorts the order of timeline events by the value specified in the sortBy field.

Result Syntax

[
    'eventSummaries' => [
        [
            'eventId' => '<string>',
            'eventReferences' => [
                [
                    'relatedItemId' => '<string>',
                    'resource' => '<string>',
                ],
                // ...
            ],
            'eventTime' => <DateTime>,
            'eventType' => '<string>',
            'eventUpdatedTime' => <DateTime>,
            'incidentRecordArn' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

eventSummaries

: Required: Yes
: Type: Array of EventSummary structures

Details about each event that occurred during the incident.

nextToken

: Type: string

The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

Adds a resource policy to the specified response plan. The resource policy is used to share the response plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Cross-Region and cross-account incident management.

Parameter Syntax

$result = $client->putResourcePolicy([
    'policy' => '<string>', // REQUIRED
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

policy

: Required: Yes
: Type: string

Details of the resource policy.

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the response plan to add the resource policy to.

Result Syntax

[
    'policyId' => '<string>',
]

Result Details

Members

policyId

: Required: Yes
: Type: string

The ID of the resource policy.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

StartIncident

$result = $client->startIncident([/* ... */]);
$promise = $client->startIncidentAsync([/* ... */]);

Used to start an incident from CloudWatch alarms, EventBridge events, or manually.

Parameter Syntax

$result = $client->startIncident([
    'clientToken' => '<string>',
    'impact' => <integer>,
    'relatedItems' => [
        [
            'generatedId' => '<string>',
            'identifier' => [ // REQUIRED
                'type' => 'ANALYSIS|INCIDENT|METRIC|PARENT|ATTACHMENT|OTHER|AUTOMATION|INVOLVED_RESOURCE|TASK', // REQUIRED
                'value' => [ // REQUIRED
                    'arn' => '<string>',
                    'metricDefinition' => '<string>',
                    'pagerDutyIncidentDetail' => [
                        'autoResolve' => true || false,
                        'id' => '<string>', // REQUIRED
                        'secretId' => '<string>',
                    ],
                    'url' => '<string>',
                ],
            ],
            'title' => '<string>',
        ],
        // ...
    ],
    'responsePlanArn' => '<string>', // REQUIRED
    'title' => '<string>',
    'triggerDetails' => [
        'rawData' => '<string>',
        'source' => '<string>', // REQUIRED
        'timestamp' => <integer || string || DateTime>, // REQUIRED
        'triggerArn' => '<string>',
    ],
]);

Parameter Details

Members

clientToken

: Type: string

A token ensuring that the operation is called only once with the specified details.

impact

: Type: int

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

Supported impact codes

1 - Critical
2 - High
3 - Medium
4 - Low
5 - No Impact

relatedItems

: Type: Array of RelatedItem structures

Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket.

responsePlanArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident.

title

: Type: string

Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

triggerDetails

: Type: TriggerDetails structure

Details of what created the incident record in Incident Manager.

Result Syntax

[
    'incidentRecordArn' => '<string>',
]

Result Details

Members

incidentRecordArn

: Required: Yes
: Type: string

The ARN of the newly created incident record.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
ConflictException:: Updating or deleting a resource causes an inconsistent state.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds a tag to a response plan.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the response plan you're adding the tags to.

tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

A list of tags to add to the response plan.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceQuotaExceededException:: Request would cause a service quota to be exceeded.
ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
ConflictException:: Updating or deleting a resource causes an inconsistent state.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the response plan you're removing a tag from.

tagKeys

: Required: Yes
: Type: Array of strings

The name of the tag to remove from the response plan.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
ConflictException:: Updating or deleting a resource causes an inconsistent state.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

UpdateDeletionProtection

$result = $client->updateDeletionProtection([/* ... */]);
$promise = $client->updateDeletionProtectionAsync([/* ... */]);

Update deletion protection to either allow or deny deletion of the final Region in a replication set.

Parameter Syntax

$result = $client->updateDeletionProtection([
    'arn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'deletionProtected' => true || false, // REQUIRED
]);

Parameter Details

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the replication set to update.

clientToken

: Type: string

A token that ensures that the operation is called only once with the specified details.

deletionProtected

: Required: Yes
: Type: boolean

Specifies if deletion protection is turned on or off in your account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

UpdateIncidentRecord

$result = $client->updateIncidentRecord([/* ... */]);
$promise = $client->updateIncidentRecordAsync([/* ... */]);

Update the details of an incident record. You can use this operation to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat.

Parameter Syntax

$result = $client->updateIncidentRecord([
    'arn' => '<string>', // REQUIRED
    'chatChannel' => [
        'chatbotSns' => ['<string>', ...],
        'empty' => [
        ],
    ],
    'clientToken' => '<string>',
    'impact' => <integer>,
    'notificationTargets' => [
        [
            'snsTopicArn' => '<string>',
        ],
        // ...
    ],
    'status' => 'OPEN|RESOLVED',
    'summary' => '<string>',
    'title' => '<string>',
]);

Parameter Details

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident record you are updating.

chatChannel

: Type: ChatChannel structure

The Chatbot chat channel where responders can collaborate.

clientToken

: Type: string

A token that ensures that a client calls the operation only once with the specified details.

impact

: Type: int

Defines the impact of the incident to customers and applications. If you provide an impact for an incident, it overwrites the impact provided by the response plan.

Supported impact codes

1 - Critical
2 - High
3 - Medium
4 - Low
5 - No Impact

notificationTargets

: Type: Array of NotificationTargetItem structures

The Amazon SNS targets that Incident Manager notifies when a client updates an incident.

Using multiple SNS topics creates redundancy in the event that a Region is down during the incident.

status

: Type: string

The status of the incident. Possible statuses are Open or Resolved.

summary

: Type: string

A longer description of what occurred during the incident.

title

: Type: string

A brief description of the incident.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
ConflictException:: Updating or deleting a resource causes an inconsistent state.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

UpdateRelatedItems

$result = $client->updateRelatedItems([/* ... */]);
$promise = $client->updateRelatedItemsAsync([/* ... */]);

Add or remove related items from the related items tab of an incident record.

Parameter Syntax

$result = $client->updateRelatedItems([
    'clientToken' => '<string>',
    'incidentRecordArn' => '<string>', // REQUIRED
    'relatedItemsUpdate' => [ // REQUIRED
        'itemToAdd' => [
            'generatedId' => '<string>',
            'identifier' => [ // REQUIRED
                'type' => 'ANALYSIS|INCIDENT|METRIC|PARENT|ATTACHMENT|OTHER|AUTOMATION|INVOLVED_RESOURCE|TASK', // REQUIRED
                'value' => [ // REQUIRED
                    'arn' => '<string>',
                    'metricDefinition' => '<string>',
                    'pagerDutyIncidentDetail' => [
                        'autoResolve' => true || false,
                        'id' => '<string>', // REQUIRED
                        'secretId' => '<string>',
                    ],
                    'url' => '<string>',
                ],
            ],
            'title' => '<string>',
        ],
        'itemToRemove' => [
            'type' => 'ANALYSIS|INCIDENT|METRIC|PARENT|ATTACHMENT|OTHER|AUTOMATION|INVOLVED_RESOURCE|TASK', // REQUIRED
            'value' => [ // REQUIRED
                'arn' => '<string>',
                'metricDefinition' => '<string>',
                'pagerDutyIncidentDetail' => [
                    'autoResolve' => true || false,
                    'id' => '<string>', // REQUIRED
                    'secretId' => '<string>',
                ],
                'url' => '<string>',
            ],
        ],
    ],
]);

Parameter Details

Members

clientToken

: Type: string

A token that ensures that a client calls the operation only once with the specified details.

incidentRecordArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident record that contains the related items that you update.

relatedItemsUpdate

: Required: Yes
: Type: RelatedItemsUpdate structure

Details about the item that you are add to, or delete from, an incident.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
ConflictException:: Updating or deleting a resource causes an inconsistent state.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

UpdateReplicationSet

$result = $client->updateReplicationSet([/* ... */]);
$promise = $client->updateReplicationSetAsync([/* ... */]);

Add or delete Regions from your replication set.

Parameter Syntax

$result = $client->updateReplicationSet([
    'actions' => [ // REQUIRED
        [
            'addRegionAction' => [
                'regionName' => '<string>', // REQUIRED
                'sseKmsKeyId' => '<string>',
            ],
            'deleteRegionAction' => [
                'regionName' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'arn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
]);

Parameter Details

Members

actions

: Required: Yes
: Type: Array of UpdateReplicationSetAction structures

An action to add or delete a Region.

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the replication set you're updating.

clientToken

: Type: string

A token that ensures that the operation is called only once with the specified details.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
ConflictException:: Updating or deleting a resource causes an inconsistent state.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

UpdateResponsePlan

$result = $client->updateResponsePlan([/* ... */]);
$promise = $client->updateResponsePlanAsync([/* ... */]);

Updates the specified response plan.

Parameter Syntax

$result = $client->updateResponsePlan([
    'actions' => [
        [
            'ssmAutomation' => [
                'documentName' => '<string>', // REQUIRED
                'documentVersion' => '<string>',
                'dynamicParameters' => [
                    '<DynamicSsmParametersKeyString>' => [
                        'variable' => 'INCIDENT_RECORD_ARN|INVOLVED_RESOURCES',
                    ],
                    // ...
                ],
                'parameters' => [
                    '<SsmParametersKeyString>' => ['<string>', ...],
                    // ...
                ],
                'roleArn' => '<string>', // REQUIRED
                'targetAccount' => 'RESPONSE_PLAN_OWNER_ACCOUNT|IMPACTED_ACCOUNT',
            ],
        ],
        // ...
    ],
    'arn' => '<string>', // REQUIRED
    'chatChannel' => [
        'chatbotSns' => ['<string>', ...],
        'empty' => [
        ],
    ],
    'clientToken' => '<string>',
    'displayName' => '<string>',
    'engagements' => ['<string>', ...],
    'incidentTemplateDedupeString' => '<string>',
    'incidentTemplateImpact' => <integer>,
    'incidentTemplateNotificationTargets' => [
        [
            'snsTopicArn' => '<string>',
        ],
        // ...
    ],
    'incidentTemplateSummary' => '<string>',
    'incidentTemplateTags' => ['<string>', ...],
    'incidentTemplateTitle' => '<string>',
    'integrations' => [
        [
            'pagerDutyConfiguration' => [
                'name' => '<string>', // REQUIRED
                'pagerDutyIncidentConfiguration' => [ // REQUIRED
                    'serviceId' => '<string>', // REQUIRED
                ],
                'secretId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members

actions

: Type: Array of Action structures

The actions that this response plan takes at the beginning of an incident.

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the response plan.

chatChannel

: Type: ChatChannel structure

The Chatbot chat channel used for collaboration during an incident.

Use the empty structure to remove the chat channel from the response plan.

clientToken

: Type: string

A token ensuring that the operation is called only once with the specified details.

displayName

: Type: string

The long format name of the response plan. The display name can't contain spaces.

engagements

: Type: Array of strings

The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

incidentTemplateDedupeString

: Type: string

The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.

incidentTemplateImpact

: Type: int

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

Supported impact codes

1 - Critical
2 - High
3 - Medium
4 - Low
5 - No Impact

incidentTemplateNotificationTargets

: Type: Array of NotificationTargetItem structures

The Amazon SNS targets that are notified when updates are made to an incident.

incidentTemplateSummary

: Type: string

A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.

incidentTemplateTags

: Type: Associative array of custom strings keys (TagKey) to strings

Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident. To call this action, you must also have permission to call the TagResource API action for the incident record resource.

incidentTemplateTitle

: Type: string

The short format name of the incident. The title can't contain spaces.

integrations

: Type: Array of Integration structures

Information about third-party services integrated into the response plan.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
ConflictException:: Updating or deleting a resource causes an inconsistent state.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

UpdateTimelineEvent

$result = $client->updateTimelineEvent([/* ... */]);
$promise = $client->updateTimelineEventAsync([/* ... */]);

Updates a timeline event. You can update events of type Custom Event.

Parameter Syntax

$result = $client->updateTimelineEvent([
    'clientToken' => '<string>',
    'eventData' => '<string>',
    'eventId' => '<string>', // REQUIRED
    'eventReferences' => [
        [
            'relatedItemId' => '<string>',
            'resource' => '<string>',
        ],
        // ...
    ],
    'eventTime' => <integer || string || DateTime>,
    'eventType' => '<string>',
    'incidentRecordArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

clientToken

: Type: string

A token that ensures that a client calls the operation only once with the specified details.

eventData

: Type: string

A short description of the event.

eventId

: Required: Yes
: Type: string

The ID of the event to update. You can use ListTimelineEvents to find an event's ID.

eventReferences

: Type: Array of EventReference structures

Updates all existing references in a TimelineEvent. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.

eventTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the event occurred.

eventType

: Type: string

The type of event. You can update events of type Custom Event and Note.

incidentRecordArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident that includes the timeline event.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which doesn't exist.
AccessDeniedException:: You don't have sufficient access to perform this operation.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
ConflictException:: Updating or deleting a resource causes an inconsistent state.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.

Shapes

AccessDeniedException

Description

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

Members

message

: Required: Yes
: Type: string

Action

Description

The action that starts at the beginning of an incident. The response plan defines the action.

Members

ssmAutomation

: Type: SsmAutomation structure

The Systems Manager automation document to start as the runbook at the beginning of the incident.

AddRegionAction

Description

Defines the Amazon Web Services Region and KMS key to add to the replication set.

Members

regionName

: Required: Yes
: Type: string

The Amazon Web Services Region name to add to the replication set.

sseKmsKeyId

: Type: string

The KMS key ID to use to encrypt your replication set.

AttributeValueList

Description

Use the AttributeValueList to filter by string or integer values.

Members

integerValues

: Type: Array of ints

The list of integer values that the filter matches.

stringValues

: Type: Array of strings

The list of string values that the filter matches.

AutomationExecution

Description

The Systems Manager automation document process to start as the runbook at the beginning of the incident.

Members

ssmExecutionArn

: Type: string

The Amazon Resource Name (ARN) of the automation process.

BatchGetIncidentFindingsError

Description

Details about an error returned for a BatchGetIncidentFindings operation.

Members

code

: Required: Yes
: Type: string

The code associated with an error that was returned for a BatchGetIncidentFindings operation.

findingId

: Required: Yes
: Type: string

The ID of a specified finding for which an error was returned for a BatchGetIncidentFindings operation.

message

: Required: Yes
: Type: string

The description for an error that was returned for a BatchGetIncidentFindings operation.

ChatChannel

Description

The Chatbot chat channel used for collaboration during an incident.

Members

chatbotSns

: Type: Array of strings

The Amazon SNS targets that Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the Amazon SNS topics.

empty

: Type: EmptyChatChannel structure

Used to remove the chat channel from an incident record or response plan.

CloudFormationStackUpdate

Description

Information about an CloudFormation stack creation or update that occurred around the time of an incident and could be a potential cause of the incident.

Members

endTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the CloudFormation stack creation or update ended. Not reported for deployments that are still in progress.

stackArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the CloudFormation stack involved in the update.

startTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the CloudFormation stack creation or update began.

CodeDeployDeployment

Description

Information about a CodeDeploy deployment that occurred around the time of an incident and could be a possible cause of the incident.

Members

deploymentGroupArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the CodeDeploy deployment group associated with the deployment.

deploymentId

: Required: Yes
: Type: string

The ID of the CodeDeploy deployment.

endTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the CodeDeploy deployment ended. Not reported for deployments that are still in progress.

startTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the CodeDeploy deployment began.

Condition

Description

A conditional statement with which to compare a value, after a timestamp, before a timestamp, or equal to a string or integer. If multiple conditions are specified, the conditionals become an ANDed statement. If multiple values are specified for a conditional, the values are ORd.

Members

after

: Type: timestamp (string|DateTime or anything parsable by strtotime)

After the specified timestamp.

before

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Before the specified timestamp

equals

: Type: AttributeValueList structure

The value is equal to the provided string or integer.

ConflictException

Description

Updating or deleting a resource causes an inconsistent state.

Members

message

: Required: Yes
: Type: string

resourceIdentifier

: Type: string

The identifier of the requested resource

resourceType

: Type: string

The resource type

retryAfter

: Type: timestamp (string|DateTime or anything parsable by strtotime)

If present in the output, the operation can be retried after this time

DeleteRegionAction

Description

Defines the information about the Amazon Web Services Region you're deleting from your replication set.

Members

regionName

: Required: Yes
: Type: string

The name of the Amazon Web Services Region you're deleting from the replication set.

DynamicSsmParameterValue

Description

The dynamic SSM parameter value.

Members

variable

: Type: string

Variable dynamic parameters. A parameter value is determined when an incident is created.

EmptyChatChannel

Description

Used to remove the chat channel from an incident record or response plan.

Members

EventReference

Description

An item referenced in a TimelineEvent that is involved in or somehow associated with an incident. You can specify an Amazon Resource Name (ARN) for an Amazon Web Services resource or a RelatedItem ID.

Members

relatedItemId

: Type: string

The ID of a RelatedItem referenced in a TimelineEvent.

resource

: Type: string

The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a TimelineEvent.

EventSummary

Description

Details about a timeline event during an incident.

Members

eventId

: Required: Yes
: Type: string

The timeline event ID.

eventReferences

: Type: Array of EventReference structures

A list of references in a TimelineEvent.

eventTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the event occurred.

eventType

: Required: Yes
: Type: string

The type of event. The timeline event must be Custom Event or Note.

eventUpdatedTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the timeline event was last updated.

incidentRecordArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident that the event happened during.

Filter

Description

Filter the selection by using a condition.

Members

condition

: Required: Yes
: Type: Condition structure

The condition accepts before or after a specified time, equal to a string, or equal to an integer.

key

: Required: Yes
: Type: string

The key that you're filtering on.

Finding

Description

Information about a specific CodeDeploy deployment or CloudFormation stack creation or update that occurred around the time of a reported incident. These activities can be investigated as a potential cause of the incident.

Members

creationTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when a finding was created.

details

: Type: FindingDetails structure

Details about the finding.

id

: Required: Yes
: Type: string

The ID assigned to the finding.

lastModifiedTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the finding was most recently updated with additional information.

FindingDetails

Description

Extended textual information about the finding.

Members

cloudFormationStackUpdate

: Type: CloudFormationStackUpdate structure

Information about the CloudFormation stack creation or update associated with the finding.

codeDeployDeployment

: Type: CodeDeployDeployment structure

Information about the CodeDeploy deployment associated with the finding.

FindingSummary

Description

Identifying information about the finding.

Members

id

: Required: Yes
: Type: string

The ID of the finding.

lastModifiedTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the finding was last updated.

IncidentRecord

Description

The record of the incident that's created when an incident occurs.

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident record.

automationExecutions

: Type: Array of AutomationExecution structures

The runbook, or automation document, that's run at the beginning of the incident.

chatChannel

: Type: ChatChannel structure

The chat channel used for collaboration during an incident.

creationTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when Incident Manager created the incident record.

dedupeString

: Required: Yes
: Type: string

The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.

impact

: Required: Yes
: Type: int

The impact of the incident on customers and applications.

Supported impact codes

1 - Critical
2 - High
3 - Medium
4 - Low
5 - No Impact

incidentRecordSource

: Required: Yes
: Type: IncidentRecordSource structure

Details about the action that started the incident.

lastModifiedBy

: Required: Yes
: Type: string

Who modified the incident most recently.

lastModifiedTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the incident was most recently modified.

notificationTargets

: Type: Array of NotificationTargetItem structures

The Amazon SNS targets that are notified when updates are made to an incident.

resolvedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the incident was resolved. This appears as a timeline event.

status

: Required: Yes
: Type: string

The current status of the incident.

summary

: Type: string

The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context of the incident.

title

: Required: Yes
: Type: string

The title of the incident.

IncidentRecordSource

Description

Details about what created the incident record and when it was created.

Members

createdBy

: Required: Yes
: Type: string

The principal that started the incident.

invokedBy

: Type: string

The service principal that assumed the role specified in createdBy. If no service principal assumed the role this will be left blank.

resourceArn

: Type: string

The resource that caused the incident to be created.

source

: Required: Yes
: Type: string

The service that started the incident. This can be manually created from Incident Manager, automatically created using an Amazon CloudWatch alarm, or Amazon EventBridge event.

IncidentRecordSummary

Description

Details describing an incident record.

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident.

creationTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the incident was created.

impact

: Required: Yes
: Type: int

Defines the impact to customers and applications.

incidentRecordSource

: Required: Yes
: Type: IncidentRecordSource structure

What caused Incident Manager to create the incident.

resolvedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the incident was resolved.

status

: Required: Yes
: Type: string

The current status of the incident.

title

: Required: Yes
: Type: string

The title of the incident. This value is either provided by the response plan or overwritten on creation.

IncidentTemplate

Description

Basic details used in creating a response plan. The response plan is then used to create an incident record.

Members

dedupeString

: Type: string

The string Incident Manager uses to prevent the same root cause from creating multiple incidents in the same account.

A deduplication string is a term or phrase the system uses to check for duplicate incidents. If you specify a deduplication string, Incident Manager searches for open incidents that contain the same string in the dedupeString field when it creates the incident. If a duplicate is detected, Incident Manager deduplicates the newer incident into the existing incident.

By default, Incident Manager automatically deduplicates multiple incidents created by the same Amazon CloudWatch alarm or Amazon EventBridge event. You don't have to enter your own deduplication string to prevent duplication for these resource types.

impact

: Required: Yes
: Type: int

The impact of the incident on your customers and applications.

Supported impact codes

1 - Critical
2 - High
3 - Medium
4 - Low
5 - No Impact

incidentTags

: Type: Associative array of custom strings keys (TagKey) to strings

Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident.

notificationTargets

: Type: Array of NotificationTargetItem structures

The Amazon SNS targets that are notified when updates are made to an incident.

summary

: Type: string

The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.

title

: Required: Yes
: Type: string

The title of the incident.

Integration

Description

Information about third-party services integrated into a response plan.

Members

pagerDutyConfiguration

: Type: PagerDutyConfiguration structure

Information about the PagerDuty service where the response plan creates an incident.

InternalServerException

Description

The request processing has failed because of an unknown error, exception or failure.

Members

message

: Required: Yes
: Type: string

ItemIdentifier

Description

Details and type of a related item.

Members

type

: Required: Yes
: Type: string

The type of related item.

value

: Required: Yes
: Type: ItemValue structure

Details about the related item.

ItemValue

Description

Describes a related item.

Members

arn

: Type: string

The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.

metricDefinition

: Type: string

The metric definition, if the related item is a metric in Amazon CloudWatch.

pagerDutyIncidentDetail

: Type: PagerDutyIncidentDetail structure

Details about an incident that is associated with a PagerDuty incident.

url

: Type: string

The URL, if the related item is a non-Amazon Web Services resource.

NotificationTargetItem

Description

The SNS targets that are notified when updates are made to an incident.

Members

snsTopicArn

: Type: string

The Amazon Resource Name (ARN) of the SNS topic.

PagerDutyConfiguration

Description

Details about the PagerDuty configuration for a response plan.

Members

name

: Required: Yes
: Type: string

The name of the PagerDuty configuration.

pagerDutyIncidentConfiguration

: Required: Yes
: Type: PagerDutyIncidentConfiguration structure

Details about the PagerDuty service associated with the configuration.

secretId

: Required: Yes
: Type: string

The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.

PagerDutyIncidentConfiguration

Description

Details about the PagerDuty service where the response plan creates an incident.

Members

serviceId

: Required: Yes
: Type: string

The ID of the PagerDuty service that the response plan associates with an incident when it launches.

PagerDutyIncidentDetail

Description

Details about the PagerDuty incident associated with an incident created by an Incident Manager response plan.

Members

autoResolve

: Type: boolean

Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident.

id

: Required: Yes
: Type: string

The ID of the incident associated with the PagerDuty service for the response plan.

secretId

: Type: string

The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.

RegionInfo

Description

Information about a Amazon Web Services Region in your replication set.

Members

sseKmsKeyId

: Type: string

The ID of the KMS key used to encrypt the data in this Amazon Web Services Region.

status

: Required: Yes
: Type: string

The status of the Amazon Web Services Region in the replication set.

statusMessage

: Type: string

Information displayed about the status of the Amazon Web Services Region.

statusUpdateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when Incident Manager updated the status of the Amazon Web Services Region.

RegionMapInputValue

Description

The mapping between a Amazon Web Services Region and the key that's used to encrypt the data.

Members

sseKmsKeyId

: Type: string

The KMS key used to encrypt the data in your replication set.

RelatedItem

Description

Resources that responders use to triage and mitigate the incident.

Members

generatedId

: Type: string

A unique ID for a RelatedItem.

Don't specify this parameter when you add a RelatedItem by using the UpdateRelatedItems API action.

identifier

: Required: Yes
: Type: ItemIdentifier structure

Details about the related item.

title

: Type: string

The title of the related item.

RelatedItemsUpdate

Description

Details about the related item you're adding.

Members

itemToAdd

: Type: RelatedItem structure

Details about the related item you're adding.

itemToRemove

: Type: ItemIdentifier structure

Details about the related item you're deleting.

ReplicationSet

Description

The set of Amazon Web Services Region that your Incident Manager data will be replicated to and the KMS key used to encrypt the data.

Members

arn

: Type: string

The Amazon Resource Name (ARN) of the replication set.

createdBy

: Required: Yes
: Type: string

Details about who created the replication set.

createdTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

When the replication set was created.

deletionProtected

: Required: Yes
: Type: boolean

Determines if the replication set deletion protection is enabled or not. If deletion protection is enabled, you can't delete the last Amazon Web Services Region in the replication set.

lastModifiedBy

: Required: Yes
: Type: string

Who last modified the replication set.

lastModifiedTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

When the replication set was last updated.

regionMap

: Required: Yes
: Type: Associative array of custom strings keys (RegionName) to RegionInfo structures

The map between each Amazon Web Services Region in your replication set and the KMS key that's used to encrypt the data in that Region.

status

: Required: Yes
: Type: string

The status of the replication set. If the replication set is still pending, you can't use Incident Manager functionality.

ResourceNotFoundException

Description

Request references a resource which doesn't exist.

Members

message

: Required: Yes
: Type: string

resourceIdentifier

: Type: string

The identifier for the requested resource

resourceType

: Type: string

The resource type

ResourcePolicy

Description

The resource policy that allows Incident Manager to perform actions on resources on your behalf.

Members

policyDocument

: Required: Yes
: Type: string

The JSON blob that describes the policy.

policyId

: Required: Yes
: Type: string

The ID of the resource policy.

ramResourceShareRegion

: Required: Yes
: Type: string

The Amazon Web Services Region that policy allows resources to be used in.

ResponsePlanSummary

Description

Details of the response plan that are used when creating an incident.

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the response plan.

displayName

: Type: string

The human readable name of the response plan. This can include spaces.

name

: Required: Yes
: Type: string

The name of the response plan. This can't include spaces.

ServiceQuotaExceededException

Description

Request would cause a service quota to be exceeded.

Members

message

: Required: Yes
: Type: string

quotaCode

: Required: Yes
: Type: string

Originating quota code

resourceIdentifier

: Type: string

The identifier for the requested resource

resourceType

: Type: string

The resource type

serviceCode

: Required: Yes
: Type: string

Originating service code

SsmAutomation

Description

Details about the Systems Manager automation document that will be used as a runbook during an incident.

Members

documentName

: Required: Yes
: Type: string

The automation document's name.

documentVersion

: Type: string

The automation document's version to use when running.

dynamicParameters

: Type: Associative array of custom strings keys (DynamicSsmParametersKeyString) to DynamicSsmParameterValue structures

The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

parameters

: Type: Associative array of custom strings keys (SsmParametersKeyString) to stringss

The key-value pair parameters to use when running the automation document.

roleArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

targetAccount

: Type: string

The account that the automation document will be run in. This can be in either the management account or an application account.

ThrottlingException

Description

The request was denied due to request throttling.

Members

message

: Required: Yes
: Type: string

quotaCode

: Required: Yes
: Type: string

Originating quota code

serviceCode

: Required: Yes
: Type: string

Originating service code

TimelineEvent

Description

A significant event that happened during the incident.

Members

eventData

: Required: Yes
: Type: string

A short description of the event.

eventId

: Required: Yes
: Type: string

The ID of the timeline event.

eventReferences

: Type: Array of EventReference structures

A list of references in a TimelineEvent.

eventTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the event occurred.

eventType

: Required: Yes
: Type: string

The type of event that occurred. Currently Incident Manager supports only the Custom Event and Note types.

eventUpdatedTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the timeline event was last updated.

incidentRecordArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the incident that the event occurred during.

TriggerDetails

Description

Details about what caused the incident to be created in Incident Manager.

Members

rawData

: Type: string

Raw data passed from either Amazon EventBridge, Amazon CloudWatch, or Incident Manager when an incident is created.

source

: Required: Yes
: Type: string

Identifies the service that sourced the event. All events sourced from within Amazon Web Services begin with "aws." Customer-generated events can have any value here, as long as it doesn't begin with "aws." We recommend the use of Java package-name style reverse domain-name strings.

timestamp

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp for when the incident was detected.

triggerArn

: Type: string

The Amazon Resource Name (ARN) of the source that detected the incident.

UpdateReplicationSetAction

Description

Details used when updating the replication set.

Members

addRegionAction

: Type: AddRegionAction structure

Details about the Amazon Web Services Region that you're adding to the replication set.

deleteRegionAction

: Type: DeleteRegionAction structure

Details about the Amazon Web Services Region that you're deleting to the replication set.

ValidationException

Description

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Members

message

: Required: Yes
: Type: string

AWS Systems Manager Incident Manager 2018-05-10

Operation Summary

Paginators

Waiters

Operations

BatchGetIncidentFindings

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateReplicationSet

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateResponsePlan

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateTimelineEvent

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteIncidentRecord

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteReplicationSet

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteResourcePolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteResponsePlan

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteTimelineEvent

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetIncidentRecord

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors