{ "smithy": "2.0", "shapes": { "com.amazonaws.ssmincidents#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ssmincidents#ExceptionMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.ssmincidents#Action": { "type": "union", "members": { "ssmAutomation": { "target": "com.amazonaws.ssmincidents#SsmAutomation", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#ActionsList": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#Action" }, "traits": { "smithy.api#length": { "max": 1 } } }, "com.amazonaws.ssmincidents#AddRegionAction": { "type": "structure", "members": { "regionName": { "target": "com.amazonaws.ssmincidents#RegionName", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "sseKmsKeyId": { "target": "com.amazonaws.ssmincidents#SseKmsKey", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#Arn": { "type": "string", "traits": { "smithy.api#length": { "max": 1000 }, "smithy.api#pattern": "^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$" } }, "com.amazonaws.ssmincidents#AttributeValueList": { "type": "union", "members": { "stringValues": { "target": "com.amazonaws.ssmincidents#StringList", "traits": { "smithy.api#documentation": "

The list of string values that the filter matches.

" } }, "integerValues": { "target": "com.amazonaws.ssmincidents#IntegerList", "traits": { "smithy.api#documentation": "

The list of integer values that the filter matches.

" } } }, "traits": { "smithy.api#documentation": "

Use the AttributeValueList to filter by string or integer values.

" } }, "com.amazonaws.ssmincidents#AutomationExecution": { "type": "union", "members": { "ssmExecutionArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#AutomationExecutionSet": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#AutomationExecution" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.ssmincidents#BatchGetIncidentFindings": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#BatchGetIncidentFindingsInput" }, "output": { "target": "com.amazonaws.ssmincidents#BatchGetIncidentFindingsOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/batchGetIncidentFindings" }, "smithy.api#readonly": {} } }, "com.amazonaws.ssmincidents#BatchGetIncidentFindingsError": { "type": "structure", "members": { "findingId": { "target": "com.amazonaws.ssmincidents#FindingId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "code": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } } }, "traits": { "smithy.api#documentation": "

Details about an error returned for a BatchGetIncidentFindings\n operation.

" } }, "com.amazonaws.ssmincidents#BatchGetIncidentFindingsErrorList": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#BatchGetIncidentFindingsError" } }, "com.amazonaws.ssmincidents#BatchGetIncidentFindingsInput": { "type": "structure", "members": { "incidentRecordArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "findingIds": { "target": "com.amazonaws.ssmincidents#FindingIdList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ssmincidents#BatchGetIncidentFindingsOutput": { "type": "structure", "members": { "findings": { "target": "com.amazonaws.ssmincidents#FindingList", "traits": { "smithy.api#documentation": "

Information about the requested findings.

", "smithy.api#required": {} } }, "errors": { "target": "com.amazonaws.ssmincidents#BatchGetIncidentFindingsErrorList", "traits": { "smithy.api#documentation": "

A list of errors encountered during the operation.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ssmincidents#ChatChannel": { "type": "union", "members": { "empty": { "target": "com.amazonaws.ssmincidents#EmptyChatChannel", "traits": { "smithy.api#documentation": "

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

" } }, "chatbotSns": { "target": "com.amazonaws.ssmincidents#ChatbotSnsConfigurationSet", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

The Chatbot chat channel used for collaboration during an incident.

" } }, "com.amazonaws.ssmincidents#ChatbotSnsConfigurationSet": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#SnsArn", "traits": { "smithy.api#tags": [ "logs_investigations" ] } }, "traits": { "smithy.api#length": { "min": 1, "max": 5 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.ssmincidents#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "max": 128 } } }, "com.amazonaws.ssmincidents#CloudFormationStackUpdate": { "type": "structure", "members": { "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

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

" } }, "stackArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#CodeDeployDeployment": { "type": "structure", "members": { "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp for when the CodeDeploy deployment began.

", "smithy.api#required": {} } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

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

" } }, "deploymentGroupArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "deploymentId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ID of the CodeDeploy deployment.

", "smithy.api#length": { "max": 128 }, "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#Condition": { "type": "union", "members": { "before": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

Before the specified timestamp

", "smithy.api#tags": [ "logs_investigations" ] } }, "after": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

After the specified timestamp.

", "smithy.api#tags": [ "logs_investigations" ] } }, "equals": { "target": "com.amazonaws.ssmincidents#AttributeValueList", "traits": { "smithy.api#documentation": "

The value is equal to the provided string or integer.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#ConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ssmincidents#ExceptionMessage", "traits": { "smithy.api#required": {} } }, "resourceIdentifier": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the requested resource" } }, "resourceType": { "target": "com.amazonaws.ssmincidents#ResourceType", "traits": { "smithy.api#documentation": "The resource type" } }, "retryAfter": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "If present in the output, the operation can be retried after this time" } } }, "traits": { "smithy.api#documentation": "

Updating or deleting a resource causes an inconsistent state.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.ssmincidents#CreateReplicationSet": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#CreateReplicationSetInput" }, "output": { "target": "com.amazonaws.ssmincidents#CreateReplicationSetOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#ConflictException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ServiceQuotaExceededException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 201, "method": "POST", "uri": "/createReplicationSet" } } }, "com.amazonaws.ssmincidents#CreateReplicationSetInput": { "type": "structure", "members": { "regions": { "target": "com.amazonaws.ssmincidents#RegionMapInput", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.ssmincidents#ClientToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#idempotencyToken": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "tags": { "target": "com.amazonaws.ssmincidents#TagMap", "traits": { "smithy.api#documentation": "

A list of tags to add to the replication set.

" } } } }, "com.amazonaws.ssmincidents#CreateReplicationSetOutput": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } } }, "com.amazonaws.ssmincidents#CreateResponsePlan": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#CreateResponsePlanInput" }, "output": { "target": "com.amazonaws.ssmincidents#CreateResponsePlanOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#ConflictException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 201, "method": "POST", "uri": "/createResponsePlan" }, "smithy.api#idempotent": {} } }, "com.amazonaws.ssmincidents#CreateResponsePlanInput": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.ssmincidents#ClientToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#idempotencyToken": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "name": { "target": "com.amazonaws.ssmincidents#ResponsePlanName", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "displayName": { "target": "com.amazonaws.ssmincidents#ResponsePlanDisplayName", "traits": { "smithy.api#documentation": "

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

" } }, "incidentTemplate": { "target": "com.amazonaws.ssmincidents#IncidentTemplate", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "chatChannel": { "target": "com.amazonaws.ssmincidents#ChatChannel", "traits": { "smithy.api#documentation": "

The Chatbot chat channel used for collaboration during an incident.

" } }, "engagements": { "target": "com.amazonaws.ssmincidents#EngagementSet", "traits": { "smithy.api#documentation": "

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

" } }, "actions": { "target": "com.amazonaws.ssmincidents#ActionsList", "traits": { "smithy.api#documentation": "

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

" } }, "tags": { "target": "com.amazonaws.ssmincidents#TagMap", "traits": { "smithy.api#documentation": "

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

" } }, "integrations": { "target": "com.amazonaws.ssmincidents#Integrations", "traits": { "smithy.api#documentation": "

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

" } } } }, "com.amazonaws.ssmincidents#CreateResponsePlanOutput": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } } }, "com.amazonaws.ssmincidents#CreateTimelineEvent": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#CreateTimelineEventInput" }, "output": { "target": "com.amazonaws.ssmincidents#CreateTimelineEventOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#ConflictException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 201, "method": "POST", "uri": "/createTimelineEvent" }, "smithy.api#idempotent": {} } }, "com.amazonaws.ssmincidents#CreateTimelineEventInput": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.ssmincidents#ClientToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#idempotencyToken": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "incidentRecordArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "eventTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp for when the event occurred.

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "eventType": { "target": "com.amazonaws.ssmincidents#TimelineEventType", "traits": { "smithy.api#documentation": "

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

\n

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "eventData": { "target": "com.amazonaws.ssmincidents#EventData", "traits": { "smithy.api#documentation": "

A short description of the event.

", "smithy.api#required": {} } }, "eventReferences": { "target": "com.amazonaws.ssmincidents#EventReferenceList", "traits": { "smithy.api#documentation": "

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\n its Amazon Resource Name (ARN). You can also specify a related item associated with a\n resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a\n resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated\n with the DynamoDB table as a related item.

" } } } }, "com.amazonaws.ssmincidents#CreateTimelineEventOutput": { "type": "structure", "members": { "incidentRecordArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "eventId": { "target": "com.amazonaws.ssmincidents#UUID", "traits": { "smithy.api#documentation": "

The ID of the event for easy reference later.

", "smithy.api#required": {} } } } }, "com.amazonaws.ssmincidents#DedupeString": { "type": "string", "traits": { "smithy.api#length": { "max": 1000 } } }, "com.amazonaws.ssmincidents#DeleteIncidentRecord": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#DeleteIncidentRecordInput" }, "output": { "target": "com.amazonaws.ssmincidents#DeleteIncidentRecordOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

Delete an incident record from Incident Manager.

", "smithy.api#http": { "code": 204, "method": "POST", "uri": "/deleteIncidentRecord" }, "smithy.api#idempotent": {} } }, "com.amazonaws.ssmincidents#DeleteIncidentRecordInput": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } } } }, "com.amazonaws.ssmincidents#DeleteIncidentRecordOutput": { "type": "structure", "members": {} }, "com.amazonaws.ssmincidents#DeleteRegionAction": { "type": "structure", "members": { "regionName": { "target": "com.amazonaws.ssmincidents#RegionName", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#DeleteReplicationSet": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#DeleteReplicationSetInput" }, "output": { "target": "com.amazonaws.ssmincidents#DeleteReplicationSetOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 204, "method": "POST", "uri": "/deleteReplicationSet" } } }, "com.amazonaws.ssmincidents#DeleteReplicationSetInput": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "arn", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } } } }, "com.amazonaws.ssmincidents#DeleteReplicationSetOutput": { "type": "structure", "members": {} }, "com.amazonaws.ssmincidents#DeleteResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#DeleteResourcePolicyInput" }, "output": { "target": "com.amazonaws.ssmincidents#DeleteResourcePolicyOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/deleteResourcePolicy" } } }, "com.amazonaws.ssmincidents#DeleteResourcePolicyInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "policyId": { "target": "com.amazonaws.ssmincidents#PolicyId", "traits": { "smithy.api#documentation": "

The ID of the resource policy you're deleting.

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigation" ] } } } }, "com.amazonaws.ssmincidents#DeleteResourcePolicyOutput": { "type": "structure", "members": {} }, "com.amazonaws.ssmincidents#DeleteResponsePlan": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#DeleteResponsePlanInput" }, "output": { "target": "com.amazonaws.ssmincidents#DeleteResponsePlanOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 204, "method": "POST", "uri": "/deleteResponsePlan" }, "smithy.api#idempotent": {} } }, "com.amazonaws.ssmincidents#DeleteResponsePlanInput": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } } } }, "com.amazonaws.ssmincidents#DeleteResponsePlanOutput": { "type": "structure", "members": {} }, "com.amazonaws.ssmincidents#DeleteTimelineEvent": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#DeleteTimelineEventInput" }, "output": { "target": "com.amazonaws.ssmincidents#DeleteTimelineEventOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a timeline event from an incident.

", "smithy.api#http": { "code": 204, "method": "POST", "uri": "/deleteTimelineEvent" }, "smithy.api#idempotent": {} } }, "com.amazonaws.ssmincidents#DeleteTimelineEventInput": { "type": "structure", "members": { "incidentRecordArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "eventId": { "target": "com.amazonaws.ssmincidents#UUID", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } } } }, "com.amazonaws.ssmincidents#DeleteTimelineEventOutput": { "type": "structure", "members": {} }, "com.amazonaws.ssmincidents#DynamicSsmParameterValue": { "type": "union", "members": { "variable": { "target": "com.amazonaws.ssmincidents#VariableType", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } } }, "traits": { "smithy.api#documentation": "

The dynamic SSM parameter value.

" } }, "com.amazonaws.ssmincidents#DynamicSsmParameters": { "type": "map", "key": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "value": { "target": "com.amazonaws.ssmincidents#DynamicSsmParameterValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.ssmincidents#EmptyChatChannel": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#EngagementSet": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#SsmContactsArn", "traits": { "smithy.api#tags": [ "logs_investigations" ] } }, "traits": { "smithy.api#length": { "max": 5 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.ssmincidents#EventData": { "type": "string", "traits": { "smithy.api#length": { "max": 12000 } } }, "com.amazonaws.ssmincidents#EventReference": { "type": "union", "members": { "resource": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } }, "relatedItemId": { "target": "com.amazonaws.ssmincidents#GeneratedId", "traits": { "smithy.api#documentation": "

The ID of a RelatedItem referenced in a TimelineEvent.

", "smithy.api#tags": [ "logs_investigations" ] } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#EventReferenceList": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#EventReference" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.ssmincidents#EventSummary": { "type": "structure", "members": { "incidentRecordArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "eventId": { "target": "com.amazonaws.ssmincidents#UUID", "traits": { "smithy.api#documentation": "

The timeline event ID.

", "smithy.api#required": {} } }, "eventTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp for when the event occurred.

", "smithy.api#required": {} } }, "eventUpdatedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp for when the timeline event was last updated.

", "smithy.api#required": {} } }, "eventType": { "target": "com.amazonaws.ssmincidents#TimelineEventType", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "eventReferences": { "target": "com.amazonaws.ssmincidents#EventReferenceList", "traits": { "smithy.api#documentation": "

A list of references in a TimelineEvent.

" } } }, "traits": { "smithy.api#documentation": "

Details about a timeline event during an incident.

" } }, "com.amazonaws.ssmincidents#EventSummaryList": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#EventSummary" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.ssmincidents#ExceptionMessage": { "type": "string" }, "com.amazonaws.ssmincidents#Filter": { "type": "structure", "members": { "key": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The key that you're filtering on.

", "smithy.api#length": { "max": 50 }, "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "condition": { "target": "com.amazonaws.ssmincidents#Condition", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Filter the selection by using a condition.

" } }, "com.amazonaws.ssmincidents#FilterList": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#Filter" }, "traits": { "smithy.api#length": { "max": 5 } } }, "com.amazonaws.ssmincidents#Finding": { "type": "structure", "members": { "id": { "target": "com.amazonaws.ssmincidents#FindingId", "traits": { "smithy.api#documentation": "

The ID assigned to the finding.

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "creationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp for when a finding was created.

", "smithy.api#required": {} } }, "lastModifiedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "details": { "target": "com.amazonaws.ssmincidents#FindingDetails", "traits": { "smithy.api#documentation": "

Details about the finding.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#FindingDetails": { "type": "union", "members": { "codeDeployDeployment": { "target": "com.amazonaws.ssmincidents#CodeDeployDeployment", "traits": { "smithy.api#documentation": "

Information about the CodeDeploy deployment associated with the finding.

" } }, "cloudFormationStackUpdate": { "target": "com.amazonaws.ssmincidents#CloudFormationStackUpdate", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

Extended textual information about the finding.

" } }, "com.amazonaws.ssmincidents#FindingId": { "type": "string", "traits": { "smithy.api#length": { "max": 128 } } }, "com.amazonaws.ssmincidents#FindingIdList": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#FindingId" }, "traits": { "smithy.api#length": { "min": 0, "max": 20 } } }, "com.amazonaws.ssmincidents#FindingList": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#Finding" } }, "com.amazonaws.ssmincidents#FindingSummary": { "type": "structure", "members": { "id": { "target": "com.amazonaws.ssmincidents#FindingId", "traits": { "smithy.api#documentation": "

The ID of the finding.

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "lastModifiedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp for when the finding was last updated.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Identifying information about the finding.

" } }, "com.amazonaws.ssmincidents#FindingSummaryList": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#FindingSummary" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.ssmincidents#GeneratedId": { "type": "string", "traits": { "smithy.api#length": { "max": 200 }, "smithy.api#pattern": "^related-item/(ANALYSIS|INCIDENT|METRIC|PARENT|ATTACHMENT|OTHER|AUTOMATION|INVOLVED_RESOURCE|TASK)/([0-9]|[A-F]){32}$" } }, "com.amazonaws.ssmincidents#GetIncidentRecord": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#GetIncidentRecordInput" }, "output": { "target": "com.amazonaws.ssmincidents#GetIncidentRecordOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns the details for the specified incident record.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/getIncidentRecord" }, "smithy.api#readonly": {} } }, "com.amazonaws.ssmincidents#GetIncidentRecordInput": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "arn", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } } } }, "com.amazonaws.ssmincidents#GetIncidentRecordOutput": { "type": "structure", "members": { "incidentRecord": { "target": "com.amazonaws.ssmincidents#IncidentRecord", "traits": { "smithy.api#documentation": "

Details the structure of the incident record.

", "smithy.api#required": {} } } } }, "com.amazonaws.ssmincidents#GetReplicationSet": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#GetReplicationSetInput" }, "output": { "target": "com.amazonaws.ssmincidents#GetReplicationSetOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieve your Incident Manager replication set.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/getReplicationSet" }, "smithy.api#readonly": {}, "smithy.waiters#waitable": { "WaitForReplicationSetActive": { "documentation": "Wait for a replication set to become ACTIVE", "minDelay": 30, "maxDelay": 30, "acceptors": [ { "state": "success", "matcher": { "output": { "path": "replicationSet.status", "expected": "ACTIVE", "comparator": "stringEquals" } } }, { "state": "retry", "matcher": { "output": { "path": "replicationSet.status", "expected": "CREATING", "comparator": "stringEquals" } } }, { "state": "retry", "matcher": { "output": { "path": "replicationSet.status", "expected": "UPDATING", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "replicationSet.status", "expected": "FAILED", "comparator": "stringEquals" } } } ] }, "WaitForReplicationSetDeleted": { "documentation": "Wait for a replication set to be deleted", "minDelay": 30, "maxDelay": 30, "acceptors": [ { "state": "success", "matcher": { "errorType": "ResourceNotFoundException" } }, { "state": "retry", "matcher": { "output": { "path": "replicationSet.status", "expected": "DELETING", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "replicationSet.status", "expected": "FAILED", "comparator": "stringEquals" } } } ] } } } }, "com.amazonaws.ssmincidents#GetReplicationSetInput": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "arn", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } } } }, "com.amazonaws.ssmincidents#GetReplicationSetOutput": { "type": "structure", "members": { "replicationSet": { "target": "com.amazonaws.ssmincidents#ReplicationSet", "traits": { "smithy.api#documentation": "

Details of the replication set.

", "smithy.api#required": {} } } } }, "com.amazonaws.ssmincidents#GetResourcePolicies": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#GetResourcePoliciesInput" }, "output": { "target": "com.amazonaws.ssmincidents#GetResourcePoliciesOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves the resource policies attached to the specified response plan.

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/getResourcePolicies" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "resourcePolicies" }, "smithy.api#readonly": {} } }, "com.amazonaws.ssmincidents#GetResourcePoliciesInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "resourceArn", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "maxResults": { "target": "com.amazonaws.ssmincidents#MaxResults", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } }, "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } } } }, "com.amazonaws.ssmincidents#GetResourcePoliciesOutput": { "type": "structure", "members": { "resourcePolicies": { "target": "com.amazonaws.ssmincidents#ResourcePolicyList", "traits": { "smithy.api#documentation": "

Details about the resource policy attached to the response plan.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { "smithy.api#documentation": "

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

" } } } }, "com.amazonaws.ssmincidents#GetResponsePlan": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#GetResponsePlanInput" }, "output": { "target": "com.amazonaws.ssmincidents#GetResponsePlanOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves the details of the specified response plan.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/getResponsePlan" }, "smithy.api#readonly": {} } }, "com.amazonaws.ssmincidents#GetResponsePlanInput": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "arn", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } } } }, "com.amazonaws.ssmincidents#GetResponsePlanOutput": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

The ARN of the response plan.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.ssmincidents#ResponsePlanName", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.ssmincidents#ResponsePlanDisplayName", "traits": { "smithy.api#documentation": "

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

" } }, "incidentTemplate": { "target": "com.amazonaws.ssmincidents#IncidentTemplate", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "chatChannel": { "target": "com.amazonaws.ssmincidents#ChatChannel", "traits": { "smithy.api#documentation": "

The Chatbot chat channel used for collaboration during an incident.

" } }, "engagements": { "target": "com.amazonaws.ssmincidents#EngagementSet", "traits": { "smithy.api#documentation": "

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

" } }, "actions": { "target": "com.amazonaws.ssmincidents#ActionsList", "traits": { "smithy.api#documentation": "

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

" } }, "integrations": { "target": "com.amazonaws.ssmincidents#Integrations", "traits": { "smithy.api#documentation": "

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

" } } } }, "com.amazonaws.ssmincidents#GetTimelineEvent": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#GetTimelineEventInput" }, "output": { "target": "com.amazonaws.ssmincidents#GetTimelineEventOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/getTimelineEvent" }, "smithy.api#readonly": {} } }, "com.amazonaws.ssmincidents#GetTimelineEventInput": { "type": "structure", "members": { "incidentRecordArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "incidentRecordArn", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "eventId": { "target": "com.amazonaws.ssmincidents#UUID", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "eventId", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } } } }, "com.amazonaws.ssmincidents#GetTimelineEventOutput": { "type": "structure", "members": { "event": { "target": "com.amazonaws.ssmincidents#TimelineEvent", "traits": { "smithy.api#documentation": "

Details about the timeline event.

", "smithy.api#required": {} } } } }, "com.amazonaws.ssmincidents#Impact": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 5 } } }, "com.amazonaws.ssmincidents#IncidentRecord": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "title": { "target": "com.amazonaws.ssmincidents#IncidentTitle", "traits": { "smithy.api#documentation": "

The title of the incident.

", "smithy.api#required": {} } }, "summary": { "target": "com.amazonaws.ssmincidents#IncidentSummary", "traits": { "smithy.api#documentation": "

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

" } }, "status": { "target": "com.amazonaws.ssmincidents#IncidentRecordStatus", "traits": { "smithy.api#documentation": "

The current status of the incident.

", "smithy.api#required": {} } }, "impact": { "target": "com.amazonaws.ssmincidents#Impact", "traits": { "smithy.api#documentation": "

The impact of the incident on customers and applications.

\n

\n Supported impact codes\n

\n ", "smithy.api#required": {} } }, "creationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp for when Incident Manager created the incident record.

", "smithy.api#required": {} } }, "resolvedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

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

" } }, "lastModifiedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp for when the incident was most recently modified.

", "smithy.api#required": {} } }, "lastModifiedBy": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

Who modified the incident most recently.

", "smithy.api#required": {} } }, "automationExecutions": { "target": "com.amazonaws.ssmincidents#AutomationExecutionSet", "traits": { "smithy.api#documentation": "

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

" } }, "incidentRecordSource": { "target": "com.amazonaws.ssmincidents#IncidentRecordSource", "traits": { "smithy.api#documentation": "

Details about the action that started the incident.

", "smithy.api#required": {} } }, "dedupeString": { "target": "com.amazonaws.ssmincidents#DedupeString", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "chatChannel": { "target": "com.amazonaws.ssmincidents#ChatChannel", "traits": { "smithy.api#documentation": "

The chat channel used for collaboration during an incident.

" } }, "notificationTargets": { "target": "com.amazonaws.ssmincidents#NotificationTargetSet", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#IncidentRecordSource": { "type": "structure", "members": { "createdBy": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

The principal that started the incident.

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "invokedBy": { "target": "com.amazonaws.ssmincidents#ServicePrincipal", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } }, "resourceArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

The resource that caused the incident to be created.

", "smithy.api#tags": [ "logs_investigations" ] } }, "source": { "target": "com.amazonaws.ssmincidents#IncidentSource", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#IncidentRecordStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "OPEN", "name": "OPEN" }, { "value": "RESOLVED", "name": "RESOLVED" } ] } }, "com.amazonaws.ssmincidents#IncidentRecordSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the incident.

", "smithy.api#required": {} } }, "title": { "target": "com.amazonaws.ssmincidents#IncidentTitle", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.ssmincidents#IncidentRecordStatus", "traits": { "smithy.api#documentation": "

The current status of the incident.

", "smithy.api#required": {} } }, "impact": { "target": "com.amazonaws.ssmincidents#Impact", "traits": { "smithy.api#documentation": "

Defines the impact to customers and applications.

", "smithy.api#required": {} } }, "creationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp for when the incident was created.

", "smithy.api#required": {} } }, "resolvedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp for when the incident was resolved.

" } }, "incidentRecordSource": { "target": "com.amazonaws.ssmincidents#IncidentRecordSource", "traits": { "smithy.api#documentation": "

What caused Incident Manager to create the incident.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details describing an incident record.

" } }, "com.amazonaws.ssmincidents#IncidentRecordSummaryList": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#IncidentRecordSummary" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.ssmincidents#IncidentSource": { "type": "string", "traits": { "smithy.api#length": { "max": 50 } } }, "com.amazonaws.ssmincidents#IncidentSummary": { "type": "string", "traits": { "smithy.api#length": { "max": 8000 } } }, "com.amazonaws.ssmincidents#IncidentTemplate": { "type": "structure", "members": { "title": { "target": "com.amazonaws.ssmincidents#IncidentTitle", "traits": { "smithy.api#documentation": "

The title of the incident.

", "smithy.api#required": {} } }, "impact": { "target": "com.amazonaws.ssmincidents#Impact", "traits": { "smithy.api#documentation": "

The impact of the incident on your customers and applications.

\n

\n Supported impact codes\n

\n ", "smithy.api#required": {} } }, "summary": { "target": "com.amazonaws.ssmincidents#IncidentSummary", "traits": { "smithy.api#documentation": "

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

" } }, "dedupeString": { "target": "com.amazonaws.ssmincidents#DedupeString", "traits": { "smithy.api#documentation": "

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

\n

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

\n \n

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

\n
", "smithy.api#tags": [ "logs_investigations" ] } }, "notificationTargets": { "target": "com.amazonaws.ssmincidents#NotificationTargetSet", "traits": { "smithy.api#documentation": "

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

" } }, "incidentTags": { "target": "com.amazonaws.ssmincidents#TagMap", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#IncidentTitle": { "type": "string", "traits": { "smithy.api#length": { "max": 200 } } }, "com.amazonaws.ssmincidents#IntegerList": { "type": "list", "member": { "target": "smithy.api#Integer", "traits": { "smithy.api#tags": [ "logs_investigations" ] } }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.ssmincidents#Integration": { "type": "union", "members": { "pagerDutyConfiguration": { "target": "com.amazonaws.ssmincidents#PagerDutyConfiguration", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#Integrations": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#Integration" }, "traits": { "smithy.api#length": { "max": 1 } } }, "com.amazonaws.ssmincidents#InternalServerException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ssmincidents#ExceptionMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.ssmincidents#ItemIdentifier": { "type": "structure", "members": { "value": { "target": "com.amazonaws.ssmincidents#ItemValue", "traits": { "smithy.api#documentation": "

Details about the related item.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.ssmincidents#ItemType", "traits": { "smithy.api#documentation": "

The type of related item.

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } } }, "traits": { "smithy.api#documentation": "

Details and type of a related item.

" } }, "com.amazonaws.ssmincidents#ItemType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ANALYSIS", "name": "ANALYSIS" }, { "value": "INCIDENT", "name": "INCIDENT" }, { "value": "METRIC", "name": "METRIC" }, { "value": "PARENT", "name": "PARENT" }, { "value": "ATTACHMENT", "name": "ATTACHMENT" }, { "value": "OTHER", "name": "OTHER" }, { "value": "AUTOMATION", "name": "AUTOMATION" }, { "value": "INVOLVED_RESOURCE", "name": "INVOLVED_RESOURCE" }, { "value": "TASK", "name": "TASK" } ] } }, "com.amazonaws.ssmincidents#ItemValue": { "type": "union", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } }, "url": { "target": "com.amazonaws.ssmincidents#Url", "traits": { "smithy.api#documentation": "

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

" } }, "metricDefinition": { "target": "com.amazonaws.ssmincidents#MetricDefinition", "traits": { "smithy.api#documentation": "

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

" } }, "pagerDutyIncidentDetail": { "target": "com.amazonaws.ssmincidents#PagerDutyIncidentDetail", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

Describes a related item.

" } }, "com.amazonaws.ssmincidents#ListIncidentFindings": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#ListIncidentFindingsInput" }, "output": { "target": "com.amazonaws.ssmincidents#ListIncidentFindingsOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/listIncidentFindings" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "findings" }, "smithy.api#readonly": {} } }, "com.amazonaws.ssmincidents#ListIncidentFindingsInput": { "type": "structure", "members": { "incidentRecordArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The maximum number of findings to retrieve per call.

", "smithy.api#range": { "min": 1, "max": 20 }, "smithy.api#tags": [ "logs_investigations" ] } }, "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ssmincidents#ListIncidentFindingsOutput": { "type": "structure", "members": { "findings": { "target": "com.amazonaws.ssmincidents#FindingSummaryList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ssmincidents#ListIncidentRecords": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#ListIncidentRecordsInput" }, "output": { "target": "com.amazonaws.ssmincidents#ListIncidentRecordsOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/listIncidentRecords" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "incidentRecordSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.ssmincidents#ListIncidentRecordsInput": { "type": "structure", "members": { "filters": { "target": "com.amazonaws.ssmincidents#FilterList", "traits": { "smithy.api#documentation": "

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

\n \n

Note the following when when you use Filters:

\n " } }, "maxResults": { "target": "com.amazonaws.ssmincidents#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results per page.

", "smithy.api#tags": [ "logs_investigations" ] } }, "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } } } }, "com.amazonaws.ssmincidents#ListIncidentRecordsOutput": { "type": "structure", "members": { "incidentRecordSummaries": { "target": "com.amazonaws.ssmincidents#IncidentRecordSummaryList", "traits": { "smithy.api#documentation": "

The details of each listed incident record.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { "smithy.api#documentation": "

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

" } } } }, "com.amazonaws.ssmincidents#ListRelatedItems": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#ListRelatedItemsInput" }, "output": { "target": "com.amazonaws.ssmincidents#ListRelatedItemsOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

List all related items for an incident record.

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/listRelatedItems" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "relatedItems" }, "smithy.api#readonly": {} } }, "com.amazonaws.ssmincidents#ListRelatedItemsInput": { "type": "structure", "members": { "incidentRecordArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "maxResults": { "target": "com.amazonaws.ssmincidents#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of related items per page.

", "smithy.api#tags": [ "logs_investigations" ] } }, "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } } } }, "com.amazonaws.ssmincidents#ListRelatedItemsOutput": { "type": "structure", "members": { "relatedItems": { "target": "com.amazonaws.ssmincidents#RelatedItemList", "traits": { "smithy.api#documentation": "

Details about each related item.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { "smithy.api#documentation": "

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

" } } } }, "com.amazonaws.ssmincidents#ListReplicationSets": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#ListReplicationSetsInput" }, "output": { "target": "com.amazonaws.ssmincidents#ListReplicationSetsOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists details about the replication set configured in your account.

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/listReplicationSets" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "replicationSetArns" }, "smithy.api#readonly": {} } }, "com.amazonaws.ssmincidents#ListReplicationSetsInput": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.ssmincidents#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results per page.

", "smithy.api#tags": [ "logs_investigations" ] } }, "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } } } }, "com.amazonaws.ssmincidents#ListReplicationSetsOutput": { "type": "structure", "members": { "replicationSetArns": { "target": "com.amazonaws.ssmincidents#ReplicationSetArnList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { "smithy.api#documentation": "

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

" } } } }, "com.amazonaws.ssmincidents#ListResponsePlans": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#ListResponsePlansInput" }, "output": { "target": "com.amazonaws.ssmincidents#ListResponsePlansOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists all response plans in your account.

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/listResponsePlans" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "responsePlanSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.ssmincidents#ListResponsePlansInput": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.ssmincidents#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of response plans per page.

", "smithy.api#tags": [ "logs_investigations" ] } }, "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } } } }, "com.amazonaws.ssmincidents#ListResponsePlansOutput": { "type": "structure", "members": { "responsePlanSummaries": { "target": "com.amazonaws.ssmincidents#ResponsePlanSummaryList", "traits": { "smithy.api#documentation": "

Details of each response plan.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { "smithy.api#documentation": "

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

" } } } }, "com.amazonaws.ssmincidents#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.ssmincidents#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.ssmincidents#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } } } }, "com.amazonaws.ssmincidents#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.ssmincidents#TagMap", "traits": { "smithy.api#documentation": "

A list of tags for the response plan or incident.

", "smithy.api#required": {} } } } }, "com.amazonaws.ssmincidents#ListTimelineEvents": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#ListTimelineEventsInput" }, "output": { "target": "com.amazonaws.ssmincidents#ListTimelineEventsOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists timeline events for the specified incident record.

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/listTimelineEvents" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "eventSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.ssmincidents#ListTimelineEventsInput": { "type": "structure", "members": { "incidentRecordArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "filters": { "target": "com.amazonaws.ssmincidents#FilterList", "traits": { "smithy.api#documentation": "

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

\n \n

Note the following when deciding how to use Filters:

\n " } }, "sortBy": { "target": "com.amazonaws.ssmincidents#TimelineEventSort", "traits": { "smithy.api#documentation": "

Sort timeline events by the specified key value pair.

", "smithy.api#tags": [ "logs_investigations" ] } }, "sortOrder": { "target": "com.amazonaws.ssmincidents#SortOrder", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } }, "maxResults": { "target": "com.amazonaws.ssmincidents#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results per page.

", "smithy.api#tags": [ "logs_investigations" ] } }, "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } } } }, "com.amazonaws.ssmincidents#ListTimelineEventsOutput": { "type": "structure", "members": { "eventSummaries": { "target": "com.amazonaws.ssmincidents#EventSummaryList", "traits": { "smithy.api#documentation": "

Details about each event that occurred during the incident.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { "smithy.api#documentation": "

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

" } } } }, "com.amazonaws.ssmincidents#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.ssmincidents#MetricDefinition": { "type": "string", "traits": { "smithy.api#length": { "max": 4000 } } }, "com.amazonaws.ssmincidents#NextToken": { "type": "string", "traits": { "smithy.api#length": { "max": 2000 } } }, "com.amazonaws.ssmincidents#NotificationTargetItem": { "type": "union", "members": { "snsTopicArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#NotificationTargetSet": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#NotificationTargetItem" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.ssmincidents#PagerDutyConfiguration": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the PagerDuty configuration.

", "smithy.api#length": { "min": 1, "max": 200 }, "smithy.api#required": {} } }, "secretId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

", "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#required": {} } }, "pagerDutyIncidentConfiguration": { "target": "com.amazonaws.ssmincidents#PagerDutyIncidentConfiguration", "traits": { "smithy.api#documentation": "

Details about the PagerDuty service associated with the configuration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details about the PagerDuty configuration for a response plan.

" } }, "com.amazonaws.ssmincidents#PagerDutyIncidentConfiguration": { "type": "structure", "members": { "serviceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

", "smithy.api#length": { "min": 1, "max": 200 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#PagerDutyIncidentDetail": { "type": "structure", "members": { "id": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

", "smithy.api#length": { "min": 1, "max": 200 }, "smithy.api#required": {} } }, "autoResolve": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

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

" } }, "secretId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

", "smithy.api#length": { "min": 1, "max": 512 } } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#Policy": { "type": "string", "traits": { "smithy.api#length": { "max": 4000 } } }, "com.amazonaws.ssmincidents#PolicyId": { "type": "string", "traits": { "smithy.api#length": { "max": 256 } } }, "com.amazonaws.ssmincidents#PutResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#PutResourcePolicyInput" }, "output": { "target": "com.amazonaws.ssmincidents#PutResourcePolicyOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/putResourcePolicy" } } }, "com.amazonaws.ssmincidents#PutResourcePolicyInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "policy": { "target": "com.amazonaws.ssmincidents#Policy", "traits": { "smithy.api#documentation": "

Details of the resource policy.

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } } } }, "com.amazonaws.ssmincidents#PutResourcePolicyOutput": { "type": "structure", "members": { "policyId": { "target": "com.amazonaws.ssmincidents#PolicyId", "traits": { "smithy.api#documentation": "

The ID of the resource policy.

", "smithy.api#required": {} } } } }, "com.amazonaws.ssmincidents#RawData": { "type": "string", "traits": { "smithy.api#length": { "max": 10000 } } }, "com.amazonaws.ssmincidents#RegionInfo": { "type": "structure", "members": { "sseKmsKeyId": { "target": "com.amazonaws.ssmincidents#SseKmsKey", "traits": { "smithy.api#documentation": "

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

" } }, "status": { "target": "com.amazonaws.ssmincidents#RegionStatus", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "statusMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

" } }, "statusUpdateDateTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#RegionInfoMap": { "type": "map", "key": { "target": "com.amazonaws.ssmincidents#RegionName" }, "value": { "target": "com.amazonaws.ssmincidents#RegionInfo" } }, "com.amazonaws.ssmincidents#RegionMapInput": { "type": "map", "key": { "target": "com.amazonaws.ssmincidents#RegionName", "traits": { "smithy.api#tags": [ "logs_investigations" ] } }, "value": { "target": "com.amazonaws.ssmincidents#RegionMapInputValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 3 } } }, "com.amazonaws.ssmincidents#RegionMapInputValue": { "type": "structure", "members": { "sseKmsKeyId": { "target": "com.amazonaws.ssmincidents#SseKmsKey", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#RegionName": { "type": "string", "traits": { "smithy.api#length": { "max": 20 } } }, "com.amazonaws.ssmincidents#RegionStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE", "documentation": "All operations have completed successfully and the region is ready to use" }, { "value": "CREATING", "name": "CREATING", "documentation": "The region is in the process of being created." }, { "value": "DELETING", "name": "DELETING", "documentation": "The region is in the process of being deleted." }, { "value": "FAILED", "name": "FAILED", "documentation": "The region is not healthy and we cannot automatically fix it." } ] } }, "com.amazonaws.ssmincidents#RelatedItem": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.ssmincidents#ItemIdentifier", "traits": { "smithy.api#documentation": "

Details about the related item.

", "smithy.api#required": {} } }, "title": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The title of the related item.

", "smithy.api#length": { "max": 200 } } }, "generatedId": { "target": "com.amazonaws.ssmincidents#GeneratedId", "traits": { "smithy.api#documentation": "

A unique ID for a RelatedItem.

\n \n

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

\n
" } } }, "traits": { "smithy.api#documentation": "

Resources that responders use to triage and mitigate the incident.

" } }, "com.amazonaws.ssmincidents#RelatedItemList": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#RelatedItem" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.ssmincidents#RelatedItemsUpdate": { "type": "union", "members": { "itemToAdd": { "target": "com.amazonaws.ssmincidents#RelatedItem", "traits": { "smithy.api#documentation": "

Details about the related item you're adding.

" } }, "itemToRemove": { "target": "com.amazonaws.ssmincidents#ItemIdentifier", "traits": { "smithy.api#documentation": "

Details about the related item you're deleting.

" } } }, "traits": { "smithy.api#documentation": "

Details about the related item you're adding.

" } }, "com.amazonaws.ssmincidents#ReplicationSet": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

" } }, "regionMap": { "target": "com.amazonaws.ssmincidents#RegionInfoMap", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.ssmincidents#ReplicationSetStatus", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "deletionProtected": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "createdTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

When the replication set was created.

", "smithy.api#required": {} } }, "createdBy": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

Details about who created the replication set.

", "smithy.api#required": {} } }, "lastModifiedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

When the replication set was last updated.

", "smithy.api#required": {} } }, "lastModifiedBy": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

Who last modified the replication set.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#ReplicationSetArnList": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#Arn" } }, "com.amazonaws.ssmincidents#ReplicationSetStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE", "documentation": "All operations have completed successfully and the replication set is ready to use" }, { "value": "CREATING", "name": "CREATING", "documentation": "Replication set is in the process of being created." }, { "value": "UPDATING", "name": "UPDATING", "documentation": "Replication set is in the process of being updated." }, { "value": "DELETING", "name": "DELETING", "documentation": "Replication set is in the process of being deleted." }, { "value": "FAILED", "name": "FAILED", "documentation": "Replication set is not healthy and we cannot fix it." } ] } }, "com.amazonaws.ssmincidents#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ssmincidents#ExceptionMessage", "traits": { "smithy.api#required": {} } }, "resourceIdentifier": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the requested resource" } }, "resourceType": { "target": "com.amazonaws.ssmincidents#ResourceType", "traits": { "smithy.api#documentation": "The resource type" } } }, "traits": { "smithy.api#documentation": "

Request references a resource which doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.ssmincidents#ResourcePolicy": { "type": "structure", "members": { "policyDocument": { "target": "com.amazonaws.ssmincidents#Policy", "traits": { "smithy.api#documentation": "

The JSON blob that describes the policy.

", "smithy.api#required": {} } }, "policyId": { "target": "com.amazonaws.ssmincidents#PolicyId", "traits": { "smithy.api#documentation": "

The ID of the resource policy.

", "smithy.api#required": {} } }, "ramResourceShareRegion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#ResourcePolicyList": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#ResourcePolicy" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.ssmincidents#ResourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "RESPONSE_PLAN", "name": "RESPONSE_PLAN" }, { "value": "INCIDENT_RECORD", "name": "INCIDENT_RECORD" }, { "value": "TIMELINE_EVENT", "name": "TIMELINE_EVENT" }, { "value": "REPLICATION_SET", "name": "REPLICATION_SET" }, { "value": "RESOURCE_POLICY", "name": "RESOURCE_POLICY" } ] } }, "com.amazonaws.ssmincidents#ResponsePlanDisplayName": { "type": "string", "traits": { "smithy.api#length": { "max": 200 } } }, "com.amazonaws.ssmincidents#ResponsePlanName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 200 }, "smithy.api#pattern": "^[a-zA-Z0-9-_]*$" } }, "com.amazonaws.ssmincidents#ResponsePlanSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.ssmincidents#ResponsePlanName", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.ssmincidents#ResponsePlanDisplayName", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#ResponsePlanSummaryList": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#ResponsePlanSummary" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.ssmincidents#RoleArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::IAM::Role" }, "smithy.api#length": { "max": 1000 }, "smithy.api#pattern": "^arn:aws(-cn|-us-gov)?:iam::([0-9]{12})?:role/.+$" } }, "com.amazonaws.ssmincidents#SSMIncidents": { "type": "service", "version": "2018-05-10", "operations": [ { "target": "com.amazonaws.ssmincidents#BatchGetIncidentFindings" }, { "target": "com.amazonaws.ssmincidents#CreateReplicationSet" }, { "target": "com.amazonaws.ssmincidents#CreateResponsePlan" }, { "target": "com.amazonaws.ssmincidents#CreateTimelineEvent" }, { "target": "com.amazonaws.ssmincidents#DeleteIncidentRecord" }, { "target": "com.amazonaws.ssmincidents#DeleteReplicationSet" }, { "target": "com.amazonaws.ssmincidents#DeleteResourcePolicy" }, { "target": "com.amazonaws.ssmincidents#DeleteResponsePlan" }, { "target": "com.amazonaws.ssmincidents#DeleteTimelineEvent" }, { "target": "com.amazonaws.ssmincidents#GetIncidentRecord" }, { "target": "com.amazonaws.ssmincidents#GetReplicationSet" }, { "target": "com.amazonaws.ssmincidents#GetResourcePolicies" }, { "target": "com.amazonaws.ssmincidents#GetResponsePlan" }, { "target": "com.amazonaws.ssmincidents#GetTimelineEvent" }, { "target": "com.amazonaws.ssmincidents#ListIncidentFindings" }, { "target": "com.amazonaws.ssmincidents#ListIncidentRecords" }, { "target": "com.amazonaws.ssmincidents#ListRelatedItems" }, { "target": "com.amazonaws.ssmincidents#ListReplicationSets" }, { "target": "com.amazonaws.ssmincidents#ListResponsePlans" }, { "target": "com.amazonaws.ssmincidents#ListTagsForResource" }, { "target": "com.amazonaws.ssmincidents#ListTimelineEvents" }, { "target": "com.amazonaws.ssmincidents#PutResourcePolicy" }, { "target": "com.amazonaws.ssmincidents#StartIncident" }, { "target": "com.amazonaws.ssmincidents#TagResource" }, { "target": "com.amazonaws.ssmincidents#UntagResource" }, { "target": "com.amazonaws.ssmincidents#UpdateDeletionProtection" }, { "target": "com.amazonaws.ssmincidents#UpdateIncidentRecord" }, { "target": "com.amazonaws.ssmincidents#UpdateRelatedItems" }, { "target": "com.amazonaws.ssmincidents#UpdateReplicationSet" }, { "target": "com.amazonaws.ssmincidents#UpdateResponsePlan" }, { "target": "com.amazonaws.ssmincidents#UpdateTimelineEvent" } ], "traits": { "aws.api#service": { "sdkId": "SSM Incidents", "arnNamespace": "ssm-incidents", "awsProductName": "AWSSystemsManager", "cloudFormationName": "SSMIncidents" }, "aws.auth#sigv4": { "name": "ssm-incidents" }, "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ "content-type", "x-amz-content-sha256", "x-amz-user-agent", "x-amzn-platform-id" ] }, "smithy.api#documentation": "

Systems Manager Incident Manager is an incident management console designed to help users\n mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An\n incident is any unplanned interruption or reduction in quality of services.

\n

Incident Manager increases incident resolution by notifying responders of impact,\n highlighting relevant troubleshooting data, and providing collaboration tools to get services\n back up and running. To achieve the primary goal of reducing the time-to-resolution of\n critical incidents, Incident Manager automates response plans and enables responder\n team escalation.

", "smithy.api#title": "AWS Systems Manager Incident Manager", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://ssm-incidents-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://ssm-incidents-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://ssm-incidents.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://ssm-incidents.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://ssm-incidents-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://ssm-incidents-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://ssm-incidents.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://ssm-incidents.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ssm-incidents-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ssm-incidents.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ssm-incidents-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ssm-incidents.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ssm-incidents-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ssm-incidents.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ssm-incidents.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.ssmincidents#ServiceCode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ssm-incidents", "name": "SSM_INCIDENTS" } ] } }, "com.amazonaws.ssmincidents#ServicePrincipal": { "type": "string", "traits": { "smithy.api#length": { "max": 1000 } } }, "com.amazonaws.ssmincidents#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ssmincidents#ExceptionMessage", "traits": { "smithy.api#required": {} } }, "resourceIdentifier": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the requested resource" } }, "resourceType": { "target": "com.amazonaws.ssmincidents#ResourceType", "traits": { "smithy.api#documentation": "The resource type" } }, "serviceCode": { "target": "com.amazonaws.ssmincidents#ServiceCode", "traits": { "smithy.api#documentation": "Originating service code", "smithy.api#required": {} } }, "quotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Originating quota code", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Request would cause a service quota to be exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.ssmincidents#SnsArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::SNS::Topic" }, "smithy.api#length": { "max": 1000 } } }, "com.amazonaws.ssmincidents#SortOrder": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ASCENDING", "name": "ASCENDING" }, { "value": "DESCENDING", "name": "DESCENDING" } ] } }, "com.amazonaws.ssmincidents#SseKmsKey": { "type": "string", "traits": { "smithy.api#length": { "max": 2048 } } }, "com.amazonaws.ssmincidents#SsmAutomation": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.ssmincidents#RoleArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "documentName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The automation document's name.

", "smithy.api#pattern": "^[a-zA-Z0-9_\\-.:/]{3,128}$", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "documentVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The automation document's version to use when running.

", "smithy.api#length": { "max": 128 }, "smithy.api#tags": [ "logs_investigations" ] } }, "targetAccount": { "target": "com.amazonaws.ssmincidents#SsmTargetAccount", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } }, "parameters": { "target": "com.amazonaws.ssmincidents#SsmParameters", "traits": { "smithy.api#documentation": "

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

" } }, "dynamicParameters": { "target": "com.amazonaws.ssmincidents#DynamicSsmParameters", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#SsmContactsArn": { "type": "string", "traits": { "smithy.api#length": { "max": 2048 }, "smithy.api#pattern": "^arn:aws(-cn|-us-gov)?:ssm-contacts:[a-z0-9-]*:([0-9]{12}):contact/[a-z0-9_-]+$" } }, "com.amazonaws.ssmincidents#SsmParameterValues": { "type": "list", "member": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 0, "max": 512 } } }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.ssmincidents#SsmParameters": { "type": "map", "key": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "value": { "target": "com.amazonaws.ssmincidents#SsmParameterValues" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.ssmincidents#SsmTargetAccount": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "RESPONSE_PLAN_OWNER_ACCOUNT", "name": "RESPONSE_PLAN_OWNER_ACCOUNT" }, { "value": "IMPACTED_ACCOUNT", "name": "IMPACTED_ACCOUNT" } ] } }, "com.amazonaws.ssmincidents#StartIncident": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#StartIncidentInput" }, "output": { "target": "com.amazonaws.ssmincidents#StartIncidentOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#ConflictException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/startIncident" }, "smithy.api#idempotent": {} } }, "com.amazonaws.ssmincidents#StartIncidentInput": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.ssmincidents#ClientToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#idempotencyToken": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "responsePlanArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "title": { "target": "com.amazonaws.ssmincidents#IncidentTitle", "traits": { "smithy.api#documentation": "

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

" } }, "impact": { "target": "com.amazonaws.ssmincidents#Impact", "traits": { "smithy.api#documentation": "

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

\n

\n Supported impact codes\n

\n " } }, "triggerDetails": { "target": "com.amazonaws.ssmincidents#TriggerDetails", "traits": { "smithy.api#documentation": "

Details of what created the incident record in Incident Manager.

" } }, "relatedItems": { "target": "com.amazonaws.ssmincidents#RelatedItemList", "traits": { "smithy.api#documentation": "

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

" } } } }, "com.amazonaws.ssmincidents#StartIncidentOutput": { "type": "structure", "members": { "incidentRecordArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

The ARN of the newly created incident record.

", "smithy.api#required": {} } } } }, "com.amazonaws.ssmincidents#StringList": { "type": "list", "member": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "max": 1000 }, "smithy.api#tags": [ "logs_investigations" ] } }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.ssmincidents#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(?!aws:)[A-Za-z0-9 _=@:.+-/]+$" } }, "com.amazonaws.ssmincidents#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.ssmincidents#TagMap": { "type": "map", "key": { "target": "com.amazonaws.ssmincidents#TagKey", "traits": { "smithy.api#tags": [ "logs_investigations" ] } }, "value": { "target": "com.amazonaws.ssmincidents#TagValue", "traits": { "smithy.api#tags": [ "logs_investigations" ] } }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.ssmincidents#TagMapUpdate": { "type": "map", "key": { "target": "com.amazonaws.ssmincidents#TagKey", "traits": { "smithy.api#tags": [ "logs_investigations" ] } }, "value": { "target": "com.amazonaws.ssmincidents#TagValue", "traits": { "smithy.api#tags": [ "logs_investigations" ] } }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.ssmincidents#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#TagResourceRequest" }, "output": { "target": "com.amazonaws.ssmincidents#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#ConflictException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ServiceQuotaExceededException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

Adds a tag to a response plan.

", "smithy.api#http": { "code": 204, "method": "POST", "uri": "/tags/{resourceArn}" } } }, "com.amazonaws.ssmincidents#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "tags": { "target": "com.amazonaws.ssmincidents#TagMap", "traits": { "smithy.api#documentation": "

A list of tags to add to the response plan.

", "smithy.api#required": {} } } } }, "com.amazonaws.ssmincidents#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.ssmincidents#TagValue": { "type": "string", "traits": { "smithy.api#length": { "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9 _=@:.+-/]*$" } }, "com.amazonaws.ssmincidents#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ssmincidents#ExceptionMessage", "traits": { "smithy.api#required": {} } }, "serviceCode": { "target": "com.amazonaws.ssmincidents#ServiceCode", "traits": { "smithy.api#documentation": "Originating service code", "smithy.api#required": {} } }, "quotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Originating quota code", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request was denied due to request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.ssmincidents#TimelineEvent": { "type": "structure", "members": { "incidentRecordArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "eventId": { "target": "com.amazonaws.ssmincidents#UUID", "traits": { "smithy.api#documentation": "

The ID of the timeline event.

", "smithy.api#required": {} } }, "eventTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp for when the event occurred.

", "smithy.api#required": {} } }, "eventUpdatedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp for when the timeline event was last updated.

", "smithy.api#required": {} } }, "eventType": { "target": "com.amazonaws.ssmincidents#TimelineEventType", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "eventData": { "target": "com.amazonaws.ssmincidents#EventData", "traits": { "smithy.api#documentation": "

A short description of the event.

", "smithy.api#required": {} } }, "eventReferences": { "target": "com.amazonaws.ssmincidents#EventReferenceList", "traits": { "smithy.api#documentation": "

A list of references in a TimelineEvent.

" } } }, "traits": { "smithy.api#documentation": "

A significant event that happened during the incident.

" } }, "com.amazonaws.ssmincidents#TimelineEventSort": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "EVENT_TIME", "name": "EVENT_TIME" } ] } }, "com.amazonaws.ssmincidents#TimelineEventType": { "type": "string", "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.ssmincidents#TriggerDetails": { "type": "structure", "members": { "source": { "target": "com.amazonaws.ssmincidents#IncidentSource", "traits": { "smithy.api#documentation": "

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,\n as long as it doesn't begin with \"aws.\" We recommend the use of Java package-name\n style reverse domain-name strings.

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "triggerArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_required" ] } }, "timestamp": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp for when the incident was detected.

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "rawData": { "target": "com.amazonaws.ssmincidents#RawData", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.ssmincidents#UUID": { "type": "string", "traits": { "smithy.api#length": { "max": 50 } } }, "com.amazonaws.ssmincidents#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#UntagResourceRequest" }, "output": { "target": "com.amazonaws.ssmincidents#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#ConflictException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes a tag from a resource.

", "smithy.api#http": { "code": 204, "method": "DELETE", "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.ssmincidents#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "tagKeys": { "target": "com.amazonaws.ssmincidents#TagKeyList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } } }, "com.amazonaws.ssmincidents#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.ssmincidents#UpdateActionList": { "type": "list", "member": { "target": "com.amazonaws.ssmincidents#UpdateReplicationSetAction" } }, "com.amazonaws.ssmincidents#UpdateDeletionProtection": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#UpdateDeletionProtectionInput" }, "output": { "target": "com.amazonaws.ssmincidents#UpdateDeletionProtectionOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 204, "method": "POST", "uri": "/updateDeletionProtection" } } }, "com.amazonaws.ssmincidents#UpdateDeletionProtectionInput": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "deletionProtected": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "clientToken": { "target": "com.amazonaws.ssmincidents#ClientToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#idempotencyToken": {}, "smithy.api#tags": [ "logs_investigations" ] } } } }, "com.amazonaws.ssmincidents#UpdateDeletionProtectionOutput": { "type": "structure", "members": {} }, "com.amazonaws.ssmincidents#UpdateIncidentRecord": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#UpdateIncidentRecordInput" }, "output": { "target": "com.amazonaws.ssmincidents#UpdateIncidentRecordOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#ConflictException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 204, "method": "POST", "uri": "/updateIncidentRecord" }, "smithy.api#idempotent": {} } }, "com.amazonaws.ssmincidents#UpdateIncidentRecordInput": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.ssmincidents#ClientToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#idempotencyToken": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "title": { "target": "com.amazonaws.ssmincidents#IncidentTitle", "traits": { "smithy.api#documentation": "

A brief description of the incident.

" } }, "summary": { "target": "com.amazonaws.ssmincidents#IncidentSummary", "traits": { "smithy.api#documentation": "

A longer description of what occurred during the incident.

" } }, "impact": { "target": "com.amazonaws.ssmincidents#Impact", "traits": { "smithy.api#documentation": "

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

\n

\n Supported impact codes\n

\n " } }, "status": { "target": "com.amazonaws.ssmincidents#IncidentRecordStatus", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } }, "chatChannel": { "target": "com.amazonaws.ssmincidents#ChatChannel", "traits": { "smithy.api#documentation": "

The Chatbot chat channel where responders can collaborate.

" } }, "notificationTargets": { "target": "com.amazonaws.ssmincidents#NotificationTargetSet", "traits": { "smithy.api#documentation": "

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

\n

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

" } } } }, "com.amazonaws.ssmincidents#UpdateIncidentRecordOutput": { "type": "structure", "members": {} }, "com.amazonaws.ssmincidents#UpdateRelatedItems": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#UpdateRelatedItemsInput" }, "output": { "target": "com.amazonaws.ssmincidents#UpdateRelatedItemsOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#ConflictException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 204, "method": "POST", "uri": "/updateRelatedItems" }, "smithy.api#idempotent": {} } }, "com.amazonaws.ssmincidents#UpdateRelatedItemsInput": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.ssmincidents#ClientToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#idempotencyToken": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "incidentRecordArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "relatedItemsUpdate": { "target": "com.amazonaws.ssmincidents#RelatedItemsUpdate", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } } }, "com.amazonaws.ssmincidents#UpdateRelatedItemsOutput": { "type": "structure", "members": {} }, "com.amazonaws.ssmincidents#UpdateReplicationSet": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#UpdateReplicationSetInput" }, "output": { "target": "com.amazonaws.ssmincidents#UpdateReplicationSetOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#ConflictException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

Add or delete Regions from your replication set.

", "smithy.api#http": { "code": 204, "method": "POST", "uri": "/updateReplicationSet" } } }, "com.amazonaws.ssmincidents#UpdateReplicationSetAction": { "type": "union", "members": { "addRegionAction": { "target": "com.amazonaws.ssmincidents#AddRegionAction", "traits": { "smithy.api#documentation": "

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

" } }, "deleteRegionAction": { "target": "com.amazonaws.ssmincidents#DeleteRegionAction", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

Details used when updating the replication set.

" } }, "com.amazonaws.ssmincidents#UpdateReplicationSetInput": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "actions": { "target": "com.amazonaws.ssmincidents#UpdateActionList", "traits": { "smithy.api#documentation": "

An action to add or delete a Region.

", "smithy.api#length": { "min": 1, "max": 1 }, "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.ssmincidents#ClientToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#idempotencyToken": {}, "smithy.api#tags": [ "logs_investigations" ] } } } }, "com.amazonaws.ssmincidents#UpdateReplicationSetOutput": { "type": "structure", "members": {} }, "com.amazonaws.ssmincidents#UpdateResponsePlan": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#UpdateResponsePlanInput" }, "output": { "target": "com.amazonaws.ssmincidents#UpdateResponsePlanOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#ConflictException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the specified response plan.

", "smithy.api#http": { "code": 204, "method": "POST", "uri": "/updateResponsePlan" }, "smithy.api#idempotent": {} } }, "com.amazonaws.ssmincidents#UpdateResponsePlanInput": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.ssmincidents#ClientToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#idempotencyToken": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "arn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "displayName": { "target": "com.amazonaws.ssmincidents#ResponsePlanDisplayName", "traits": { "smithy.api#documentation": "

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

" } }, "incidentTemplateTitle": { "target": "com.amazonaws.ssmincidents#IncidentTitle", "traits": { "smithy.api#documentation": "

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

" } }, "incidentTemplateImpact": { "target": "com.amazonaws.ssmincidents#Impact", "traits": { "smithy.api#documentation": "

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

\n

\n Supported impact codes\n

\n " } }, "incidentTemplateSummary": { "target": "com.amazonaws.ssmincidents#IncidentSummary", "traits": { "smithy.api#documentation": "

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

" } }, "incidentTemplateDedupeString": { "target": "com.amazonaws.ssmincidents#DedupeString", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } }, "incidentTemplateNotificationTargets": { "target": "com.amazonaws.ssmincidents#NotificationTargetSet", "traits": { "smithy.api#documentation": "

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

" } }, "chatChannel": { "target": "com.amazonaws.ssmincidents#ChatChannel", "traits": { "smithy.api#documentation": "

The Chatbot chat channel used for collaboration during an incident.

\n

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

" } }, "engagements": { "target": "com.amazonaws.ssmincidents#EngagementSet", "traits": { "smithy.api#documentation": "

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

" } }, "actions": { "target": "com.amazonaws.ssmincidents#ActionsList", "traits": { "smithy.api#documentation": "

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

" } }, "incidentTemplateTags": { "target": "com.amazonaws.ssmincidents#TagMapUpdate", "traits": { "smithy.api#documentation": "

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

" } }, "integrations": { "target": "com.amazonaws.ssmincidents#Integrations", "traits": { "smithy.api#documentation": "

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

" } } } }, "com.amazonaws.ssmincidents#UpdateResponsePlanOutput": { "type": "structure", "members": {} }, "com.amazonaws.ssmincidents#UpdateTimelineEvent": { "type": "operation", "input": { "target": "com.amazonaws.ssmincidents#UpdateTimelineEventInput" }, "output": { "target": "com.amazonaws.ssmincidents#UpdateTimelineEventOutput" }, "errors": [ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, { "target": "com.amazonaws.ssmincidents#ConflictException" }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, { "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" }, { "target": "com.amazonaws.ssmincidents#ThrottlingException" }, { "target": "com.amazonaws.ssmincidents#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 204, "method": "POST", "uri": "/updateTimelineEvent" }, "smithy.api#idempotent": {} } }, "com.amazonaws.ssmincidents#UpdateTimelineEventInput": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.ssmincidents#ClientToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#idempotencyToken": {}, "smithy.api#tags": [ "logs_investigations" ] } }, "incidentRecordArn": { "target": "com.amazonaws.ssmincidents#Arn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "eventId": { "target": "com.amazonaws.ssmincidents#UUID", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#tags": [ "logs_required" ] } }, "eventTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp for when the event occurred.

", "smithy.api#tags": [ "logs_investigations" ] } }, "eventType": { "target": "com.amazonaws.ssmincidents#TimelineEventType", "traits": { "smithy.api#documentation": "

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

", "smithy.api#tags": [ "logs_investigations" ] } }, "eventData": { "target": "com.amazonaws.ssmincidents#EventData", "traits": { "smithy.api#documentation": "

A short description of the event.

" } }, "eventReferences": { "target": "com.amazonaws.ssmincidents#EventReferenceList", "traits": { "smithy.api#documentation": "

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\n its Amazon Resource Name (ARN). You can also specify a related item associated with that\n resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a\n resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with\n the DynamoDB table as a related item.

\n \n

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

\n
" } } } }, "com.amazonaws.ssmincidents#UpdateTimelineEventOutput": { "type": "structure", "members": {} }, "com.amazonaws.ssmincidents#Url": { "type": "string", "traits": { "smithy.api#length": { "max": 1000 } } }, "com.amazonaws.ssmincidents#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ssmincidents#ExceptionMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ssmincidents#VariableType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "INCIDENT_RECORD_ARN", "name": "INCIDENT_RECORD_ARN" }, { "value": "INVOLVED_RESOURCES", "name": "INVOLVED_RESOURCES" } ] } } } }