{ "smithy": "2.0", "shapes": { "com.amazonaws.securityir#AWSAccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.securityir#AWSAccountIds": { "type": "list", "member": { "target": "com.amazonaws.securityir#AWSAccountId" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.securityir#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "
The ID of the resource which lead to the access denial.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.securityir#ActionType": { "type": "enum", "members": { "EVIDENCE_COLLECTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Evidence" } }, "INVESTIGATION_ANALYSIS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Investigation" } }, "SUMMARIZATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Summarization" } } } }, "com.amazonaws.securityir#Arn": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 1010 }, "smithy.api#pattern": "^arn:aws:security-ir:\\w+?-\\w+?-\\d+:[0-9]{12}:(membership/m-[a-z0-9]{10,32}|case/[0-9]{10})$" } }, "com.amazonaws.securityir#AttachmentId": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" } }, "com.amazonaws.securityir#AwsRegion": { "type": "enum", "members": { "AF_SOUTH_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "af-south-1" } }, "AP_EAST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-east-1" } }, "AP_EAST_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-east-2" } }, "AP_NORTHEAST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-northeast-1" } }, "AP_NORTHEAST_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-northeast-2" } }, "AP_NORTHEAST_3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-northeast-3" } }, "AP_SOUTH_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-south-1" } }, "AP_SOUTH_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-south-2" } }, "AP_SOUTHEAST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-southeast-1" } }, "AP_SOUTHEAST_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-southeast-2" } }, "AP_SOUTHEAST_3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-southeast-3" } }, "AP_SOUTHEAST_4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-southeast-4" } }, "AP_SOUTHEAST_5": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-southeast-5" } }, "AP_SOUTHEAST_6": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-southeast-6" } }, "AP_SOUTHEAST_7": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-southeast-7" } }, "CA_CENTRAL_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ca-central-1" } }, "CA_WEST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ca-west-1" } }, "CN_NORTH_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cn-north-1" } }, "CN_NORTHWEST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cn-northwest-1" } }, "EU_CENTRAL_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-central-1" } }, "EU_CENTRAL_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-central-2" } }, "EU_NORTH_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-north-1" } }, "EU_SOUTH_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-south-1" } }, "EU_SOUTH_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-south-2" } }, "EU_WEST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-west-1" } }, "EU_WEST_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-west-2" } }, "EU_WEST_3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-west-3" } }, "IL_CENTRAL_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "il-central-1" } }, "ME_CENTRAL_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "me-central-1" } }, "ME_SOUTH_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "me-south-1" } }, "MX_CENTRAL_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "mx-central-1" } }, "SA_EAST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "sa-east-1" } }, "US_EAST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "us-east-1" } }, "US_EAST_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "us-east-2" } }, "US_WEST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "us-west-1" } }, "US_WEST_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "us-west-2" } } } }, "com.amazonaws.securityir#AwsService": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 50 }, "smithy.api#pattern": "^[a-zA-Z0-9 -.():]+$" } }, "com.amazonaws.securityir#BatchGetMemberAccountDetails": { "type": "operation", "input": { "target": "com.amazonaws.securityir#BatchGetMemberAccountDetailsRequest" }, "output": { "target": "com.amazonaws.securityir#BatchGetMemberAccountDetailsResponse" }, "traits": { "aws.iam#iamAction": { "name": "BatchGetMemberAccountDetails", "documentation": "Grants permission to get member account details in batch" }, "smithy.api#documentation": "Provides information on whether the supplied account IDs are associated with a membership.
AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.
Required element used in combination with BatchGetMemberAccountDetails to identify the membership ID to query.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_BatchGetMemberAccountDetails.html#securityir-BatchGetMemberAccountDetails-request-uri-membershipId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "accountIds": { "target": "com.amazonaws.securityir#AWSAccountIds", "traits": { "smithy.api#documentation": "Optional element to query the membership relationship status to a provided list of account IDs.
AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.
The response element providing responses for requests to GetMembershipAccountDetails.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_BatchGetMemberAccountDetails.html#securityir-BatchGetMemberAccountDetails-response-items" }, "smithy.api#notProperty": {} } }, "errors": { "target": "com.amazonaws.securityir#GetMembershipAccountDetailErrors", "traits": { "smithy.api#documentation": "The response element providing error messages for requests to GetMembershipAccountDetails.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_BatchGetMemberAccountDetails.html#securityir-BatchGetMemberAccountDetails-response-errors" }, "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_BatchGetMemberAccountDetails.html#API_BatchGetMemberAccountDetails_ResponseSyntax" }, "smithy.api#output": {} } }, "com.amazonaws.securityir#CancelMembership": { "type": "operation", "input": { "target": "com.amazonaws.securityir#CancelMembershipRequest" }, "output": { "target": "com.amazonaws.securityir#CancelMembershipResponse" }, "traits": { "aws.iam#iamAction": { "name": "CancelMembership", "documentation": "Grants permission to cancel a membership" }, "smithy.api#documentation": "Cancels an existing membership.
", "smithy.api#examples": [ { "title": "Invoke CancelMembership", "input": { "membershipId": "m-abcd1234efgh" }, "output": { "membershipId": "m-abcd1234efgh" } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CancelMembership.html" }, "smithy.api#http": { "code": 200, "method": "PUT", "uri": "/v1/membership/{membershipId}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.securityir#CancelMembershipRequest": { "type": "structure", "members": { "membershipId": { "target": "com.amazonaws.securityir#MembershipId", "traits": { "smithy.api#documentation": "Required element used in combination with CancelMembershipRequest to identify the membership ID to cancel.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CancelMembership.html#securityir-CancelMembership-request-uri-membershipId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CancelMembership.html#API_CancelMembership_RequestSyntax" }, "smithy.api#input": {} } }, "com.amazonaws.securityir#CancelMembershipResponse": { "type": "structure", "members": { "membershipId": { "target": "com.amazonaws.securityir#MembershipId", "traits": { "smithy.api#documentation": "The response element providing responses for requests to CancelMembershipRequest.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CancelMembership.html#securityir-CancelMembership-response-membershipId" }, "smithy.api#required": {} } } }, "traits": { "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CancelMembership.html#API_CancelMembership_ResponseSyntax" }, "smithy.api#output": {} } }, "com.amazonaws.securityir#Case": { "type": "resource", "identifiers": { "caseId": { "target": "com.amazonaws.securityir#CaseId" } }, "create": { "target": "com.amazonaws.securityir#CreateCase" }, "read": { "target": "com.amazonaws.securityir#GetCase" }, "update": { "target": "com.amazonaws.securityir#UpdateCase" }, "list": { "target": "com.amazonaws.securityir#ListCases" }, "operations": [ { "target": "com.amazonaws.securityir#CloseCase" }, { "target": "com.amazonaws.securityir#CreateCaseComment" }, { "target": "com.amazonaws.securityir#GetCaseAttachmentDownloadUrl" }, { "target": "com.amazonaws.securityir#GetCaseAttachmentUploadUrl" }, { "target": "com.amazonaws.securityir#ListCaseEdits" }, { "target": "com.amazonaws.securityir#ListComments" }, { "target": "com.amazonaws.securityir#ListInvestigations" }, { "target": "com.amazonaws.securityir#SendFeedback" }, { "target": "com.amazonaws.securityir#UpdateCaseComment" }, { "target": "com.amazonaws.securityir#UpdateCaseStatus" }, { "target": "com.amazonaws.securityir#UpdateResolverType" } ], "traits": { "aws.api#arn": { "template": "case/{caseId}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#iamResource": { "name": "case", "relativeDocumentation": "cases.html" }, "smithy.api#documentation": "Represents a case that is used to track the incident response lifecycle" } }, "com.amazonaws.securityir#CaseArn": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 80 }, "smithy.api#pattern": "^arn:aws:security-ir:\\w+?-\\w+?-\\d+:[0-9]{12}:case/[0-9]{10}$" } }, "com.amazonaws.securityir#CaseAttachmentAttributes": { "type": "structure", "members": { "attachmentId": { "target": "com.amazonaws.securityir#AttachmentId", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CaseAttachmentAttributes.html#securityir-Type-CaseAttachmentAttributes-attachmentId" }, "smithy.api#required": {} } }, "fileName": { "target": "com.amazonaws.securityir#FileName", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CaseAttachmentAttributes.html#securityir-Type-CaseAttachmentAttributes-fileName" }, "smithy.api#required": {} } }, "attachmentStatus": { "target": "com.amazonaws.securityir#CaseAttachmentStatus", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CaseAttachmentAttributes.html#securityir-Type-CaseAttachmentAttributes-attachmentStatus" }, "smithy.api#required": {} } }, "creator": { "target": "com.amazonaws.securityir#PrincipalId", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CaseAttachmentAttributes.html#securityir-Type-CaseAttachmentAttributes-creator" }, "smithy.api#required": {} } }, "createdDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CaseAttachmentAttributes.html#securityir-Type-CaseAttachmentAttributes-createdDate" }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CaseAttachmentAttributes.html" } } }, "com.amazonaws.securityir#CaseAttachmentStatus": { "type": "enum", "members": { "VERIFIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Verified" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Pending" } } } }, "com.amazonaws.securityir#CaseAttachmentsList": { "type": "list", "member": { "target": "com.amazonaws.securityir#CaseAttachmentAttributes" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.securityir#CaseDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 8000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.securityir#CaseEditAction": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.securityir#CaseEditItem": { "type": "structure", "members": { "eventTimestamp": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CaseEditItem.html#securityir-Type-CaseEditItem-eventTimestamp" } } }, "principal": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CaseEditItem.html#securityir-Type-CaseEditItem-principal" } } }, "action": { "target": "com.amazonaws.securityir#CaseEditAction", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CaseEditItem.html#securityir-Type-CaseEditItem-action" } } }, "message": { "target": "com.amazonaws.securityir#CaseEditMessage", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CaseEditItem.html#securityir-Type-CaseEditItem-message" } } } }, "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CaseEditItem.html" } } }, "com.amazonaws.securityir#CaseEditItems": { "type": "list", "member": { "target": "com.amazonaws.securityir#CaseEditItem" } }, "com.amazonaws.securityir#CaseEditMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 4096 } } }, "com.amazonaws.securityir#CaseId": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 32 }, "smithy.api#pattern": "^\\d{10,32}" } }, "com.amazonaws.securityir#CaseMetadata": { "type": "list", "member": { "target": "com.amazonaws.securityir#CaseMetadataEntry" }, "traits": { "smithy.api#length": { "min": 1, "max": 30 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.securityir#CaseMetadataEntry": { "type": "structure", "members": { "key": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier for the metadata field. This key uniquely identifies the type of metadata being stored, such as \"severity\", \"category\", or \"assignee\".
", "smithy.api#length": { "min": 1, "max": 500 }, "smithy.api#required": {} } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The value associated with the metadata key. This contains the actual data for the metadata field identified by the key.
", "smithy.api#length": { "min": 1, "max": 2000 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents a single metadata entry associated with a case. Each entry consists of a key-value pair that provides additional contextual information about the case, such as classification tags, custom attributes, or system-generated properties.
" } }, "com.amazonaws.securityir#CaseStatus": { "type": "enum", "members": { "SUBMITTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Submitted" } }, "ACKNOWLEDGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Acknowledged" } }, "DETECTION_AND_ANALYSIS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Detection and Analysis" } }, "CONTAINMENT_ERADICATION_AND_RECOVERY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Containment, Eradication and Recovery" } }, "POST_INCIDENT_ACTIVITIES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Post-incident Activities" } }, "READY_TO_CLOSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Ready to Close" } }, "CLOSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Closed" } } } }, "com.amazonaws.securityir#CaseTitle": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 300 }, "smithy.api#sensitive": {} } }, "com.amazonaws.securityir#CloseCase": { "type": "operation", "input": { "target": "com.amazonaws.securityir#CloseCaseRequest" }, "output": { "target": "com.amazonaws.securityir#CloseCaseResponse" }, "traits": { "aws.iam#iamAction": { "name": "CloseCase", "documentation": "Grants permission to close a case" }, "smithy.api#documentation": "Closes an existing case.
", "smithy.api#examples": [ { "title": "Invoke CloseCase", "input": { "caseId": "8403556009" }, "output": { "caseStatus": "Closed", "closedDate": "2024-02-27T17:01:33.000Z" } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CloseCase.html" }, "smithy.api#http": { "code": 200, "method": "POST", "uri": "/v1/cases/{caseId}/close-case" } } }, "com.amazonaws.securityir#CloseCaseRequest": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.securityir#CaseId", "traits": { "smithy.api#documentation": "Required element used in combination with CloseCase to identify the case ID to close.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CloseCase.html#securityir-CloseCase-request-uri-caseId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#CloseCaseResponse": { "type": "structure", "members": { "caseStatus": { "target": "com.amazonaws.securityir#CaseStatus", "traits": { "smithy.api#documentation": "A response element providing responses for requests to CloseCase. This element responds Closed if successful.
A response element providing responses for requests to CloseCase. This element responds with the ISO-8601 formatted timestamp of the moment when the case was closed.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CloseCase.html#securityir-CloseCase-response-closedDate" } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.securityir#ClosureCode": { "type": "enum", "members": { "INVESTIGATION_COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Investigation Completed" } }, "NOT_RESOLVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Not Resolved" } }, "FALSE_POSITIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "False Positive" } }, "DUPLICATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Duplicate" } } } }, "com.amazonaws.securityir#CommentBody": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 12000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.securityir#CommentId": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 6 }, "smithy.api#pattern": "^\\d{6}$" } }, "com.amazonaws.securityir#CommunicationPreferences": { "type": "list", "member": { "target": "com.amazonaws.securityir#CommunicationType" }, "traits": { "smithy.api#uniqueItems": {} } }, "com.amazonaws.securityir#CommunicationType": { "type": "enum", "members": { "CASE_CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Case Created" } }, "CASE_UPDATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Case Updated" } }, "CASE_ACKNOWLEDGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Case Acknowledged" } }, "CASE_CLOSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Case Closed" } }, "CASE_UPDATED_TO_SERVICE_MANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Case Updated To Service Managed" } }, "CASE_UPDATE_CASE_STATUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Case Status Updated" } }, "CASE_PENDING_CUSTOMER_ACTION_REMINDER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Case Pending Customer Action Reminder" } }, "CASE_ATTACHMENT_URL_UPLOADED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Case Attachment Url Uploaded" } }, "CASE_COMMENT_ADDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Case Comment Added" } }, "CASE_COMMENT_UPDATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Case Comment Updated" } }, "MEMBERSHIP_CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Membership Created" } }, "MEMBERSHIP_UPDATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Membership Updated" } }, "MEMBERSHIP_CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Membership Cancelled" } }, "REGISTER_DELEGATED_ADMINISTRATOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Register Delegated Administrator" } }, "DEREGISTER_DELEGATED_ADMINISTRATOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Deregister Delegated Administrator" } }, "DISABLE_AWS_SERVICE_ACCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disable AWS Service Access" } } } }, "com.amazonaws.securityir#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The exception message.
", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the conflicting resource.
", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the conflicting resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.securityir#ContentLength": { "type": "long", "traits": { "smithy.api#range": { "min": 1, "max": 104857600 } } }, "com.amazonaws.securityir#CreateCase": { "type": "operation", "input": { "target": "com.amazonaws.securityir#CreateCaseRequest" }, "output": { "target": "com.amazonaws.securityir#CreateCaseResponse" }, "traits": { "aws.iam#conditionKeys": [ "aws:TagKeys", "aws:RequestTag/${TagKey}" ], "aws.iam#iamAction": { "name": "CreateCase", "documentation": "Grants permission to create a case" }, "smithy.api#documentation": "Creates a new case.
", "smithy.api#examples": [ { "title": "Invoke CreateCase", "input": { "resolverType": "Self", "title": "My sample case", "description": "Case description", "reportedIncidentStartDate": "2023-03-27T15:32:01.789Z", "engagementType": "Investigation", "watchers": [ { "email": "alice@example.com", "name": "Alice", "jobTitle": "CEO" }, { "email": "bob@example.com", "name": "Bob", "jobTitle": "CFO" } ], "impactedAccounts": [ "000000000000", "111111111111" ], "impactedServices": [ "Amazon EC2", "Amazon EKS" ], "impactedAwsRegions": [ { "region": "ap-southeast-1" } ], "threatActorIpAddresses": [ { "ipAddress": "192.168.192.168", "userAgent": "Browser" } ] } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html" }, "smithy.api#http": { "code": 201, "method": "POST", "uri": "/v1/create-case" }, "smithy.api#idempotent": {} } }, "com.amazonaws.securityir#CreateCaseComment": { "type": "operation", "input": { "target": "com.amazonaws.securityir#CreateCaseCommentRequest" }, "output": { "target": "com.amazonaws.securityir#CreateCaseCommentResponse" }, "traits": { "aws.iam#iamAction": { "name": "CreateCaseComment", "documentation": "Grants permission to create a case comment" }, "smithy.api#documentation": "Adds a comment to an existing case.
", "smithy.api#examples": [ { "title": "Invoke CreateCaseComment", "input": { "caseId": "8403556009", "body": "Case comment body." }, "output": { "commentId": "000000" } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCaseComment.html" }, "smithy.api#http": { "code": 201, "method": "POST", "uri": "/v1/cases/{caseId}/create-comment" }, "smithy.api#idempotent": {} } }, "com.amazonaws.securityir#CreateCaseCommentRequest": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.securityir#CaseId", "traits": { "smithy.api#documentation": "Required element used in combination with CreateCaseComment to specify a case ID.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCaseComment.html#securityir-CreateCaseComment-request-uri-caseId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.
Required element used in combination with CreateCaseComment to add content for the new comment.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCaseComment.html#securityir-CreateCaseComment-request-body" }, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#CreateCaseCommentResponse": { "type": "structure", "members": { "commentId": { "target": "com.amazonaws.securityir#CommentId", "traits": { "smithy.api#documentation": "Response element indicating the new comment ID.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCaseComment.html#securityir-CreateCaseComment-response-commentId" }, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.securityir#CreateCaseRequest": { "type": "structure", "members": { "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.
Required element used in combination with CreateCase to identify the resolver type.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#securityir-CreateCase-request-resolverType" }, "smithy.api#required": {} } }, "title": { "target": "com.amazonaws.securityir#CaseTitle", "traits": { "smithy.api#documentation": "Required element used in combination with CreateCase to provide a title for the new case.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#securityir-CreateCase-request-title" }, "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.securityir#CaseDescription", "traits": { "smithy.api#documentation": "Required element used in combination with CreateCase
to provide a description for the new case.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#securityir-CreateCase-request-description" }, "smithy.api#required": {} } }, "engagementType": { "target": "com.amazonaws.securityir#EngagementType", "traits": { "smithy.api#documentation": "Required element used in combination with CreateCase to provide an engagement type for the new cases. Available engagement types include Security Incident | Investigation
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#securityir-CreateCase-request-engagementType" }, "smithy.api#required": {} } }, "reportedIncidentStartDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Required element used in combination with CreateCase to provide an initial start date for the unauthorized activity.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#securityir-CreateCase-request-reportedIncidentStartDate" }, "smithy.api#required": {} } }, "impactedAccounts": { "target": "com.amazonaws.securityir#ImpactedAccounts", "traits": { "smithy.api#documentation": "Required element used in combination with CreateCase to provide a list of impacted accounts.
AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.
Required element used in combination with CreateCase to provide a list of entities to receive notifications for case updates.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#securityir-CreateCase-request-watchers" }, "smithy.api#required": {} } }, "threatActorIpAddresses": { "target": "com.amazonaws.securityir#ThreatActorIpList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": [], "smithy.api#documentation": "An optional element used in combination with CreateCase to provide a list of suspicious internet protocol addresses associated with unauthorized activity.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#securityir-CreateCase-request-threatActorIpAddresses" } } }, "impactedServices": { "target": "com.amazonaws.securityir#ImpactedServicesList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": [], "smithy.api#documentation": "An optional element used in combination with CreateCase to provide a list of services impacted.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#securityir-CreateCase-request-impactedServices" } } }, "impactedAwsRegions": { "target": "com.amazonaws.securityir#ImpactedAwsRegionList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": [], "smithy.api#documentation": "An optional element used in combination with CreateCase to provide a list of impacted regions.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#securityir-CreateCase-request-impactedAwsRegions" } } }, "tags": { "target": "com.amazonaws.securityir#TagMap", "traits": { "smithy.api#documentation": "An optional element used in combination with CreateCase to add customer specified tags to a case.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#securityir-CreateCase-request-tags" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#CreateCaseResponse": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.securityir#CaseId", "traits": { "smithy.api#documentation": "A response element providing responses for requests to CreateCase. This element responds with the case ID.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#securityir-CreateCase-response-caseId" }, "smithy.api#required": {} } } }, "traits": { "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#API_CreateCase_ResponseSyntax" }, "smithy.api#output": {} } }, "com.amazonaws.securityir#CreateMembership": { "type": "operation", "input": { "target": "com.amazonaws.securityir#CreateMembershipRequest" }, "output": { "target": "com.amazonaws.securityir#CreateMembershipResponse" }, "traits": { "aws.iam#conditionKeys": [ "aws:TagKeys", "aws:RequestTag/${TagKey}" ], "aws.iam#iamAction": { "name": "CreateMembership", "documentation": "Grants permission to create a membership", "requiredActions": [ "iam:CreateServiceLinkedRole", "organizations:ListDelegatedAdministrators", "organizations:DescribeOrganization" ] }, "smithy.api#documentation": "Creates a new membership.
", "smithy.api#examples": [ { "title": "Invoke CreateMembership", "input": { "membershipName": "Example Membership Name.", "incidentResponseTeam": [ { "name": "Bob Jones", "jobTitle": "Security Responder", "email": "bob.jones@gmail.com" }, { "email": "alice@example.com", "name": "Alice", "jobTitle": "CEO" } ], "optInFeatures": [ { "featureName": "Triage", "isEnabled": true } ] }, "output": { "membershipId": "m-abcd1234efgh" } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateMembership.html" }, "smithy.api#http": { "code": 201, "method": "POST", "uri": "/v1/membership" }, "smithy.api#idempotent": {} } }, "com.amazonaws.securityir#CreateMembershipRequest": { "type": "structure", "members": { "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.
Required element used in combination with CreateMembership to create a name for the membership.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateMembership.html#securityir-CreateMembership-request-membershipName" }, "smithy.api#required": {} } }, "incidentResponseTeam": { "target": "com.amazonaws.securityir#IncidentResponseTeam", "traits": { "smithy.api#documentation": "Required element used in combination with CreateMembership to add customer incident response team members and trusted partners to the membership.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateMembership.html#securityir-CreateMembership-request-incidentResponseTeam" }, "smithy.api#required": {} } }, "optInFeatures": { "target": "com.amazonaws.securityir#OptInFeatures", "traits": { "smithy.api#documentation": "Optional element to enable the monitoring and investigation opt-in features for the service.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateMembership.html#securityir-CreateMembership-request-optInFeatures" } } }, "tags": { "target": "com.amazonaws.securityir#TagMap", "traits": { "smithy.api#documentation": "Optional element for customer configured tags.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateMembership.html#securityir-CreateMembership-request-tags" } } }, "coverEntireOrganization": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": true, "smithy.api#documentation": "The coverEntireOrganization parameter is a boolean flag that determines whether the membership should be applied to the entire Amazon Web Services Organization. When set to true, the membership will be created for all accounts within the organization. When set to false, the membership will only be created for specified accounts.
This parameter is optional. If not specified, the default value is false.
If set to true: The membership will automatically include all existing and future accounts in the Amazon Web Services Organization.
If set to false: The membership will only apply to explicitly specified accounts.
Response element for CreateMembership providing the newly created membership ID.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateMembership.html#securityir-CreateMembership-response-membershipId" }, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.securityir#CustomerType": { "type": "enum", "members": { "STANDALONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Standalone" } }, "ORGANIZATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Organization" } } } }, "com.amazonaws.securityir#EmailAddress": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 254 }, "smithy.api#pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$", "smithy.api#sensitive": {} } }, "com.amazonaws.securityir#EngagementType": { "type": "enum", "members": { "SECURITY_INCIDENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Security Incident" } }, "INVESTIGATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Investigation" } } } }, "com.amazonaws.securityir#ExecutionStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Pending" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InProgress" } }, "WAITING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Waiting" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Completed" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Cancelled" } } } }, "com.amazonaws.securityir#FeedbackComment": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.securityir#FileName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9._-]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.securityir#GetCase": { "type": "operation", "input": { "target": "com.amazonaws.securityir#GetCaseRequest" }, "output": { "target": "com.amazonaws.securityir#GetCaseResponse" }, "traits": { "aws.iam#iamAction": { "name": "GetCase", "documentation": "Grants permission to get a case" }, "smithy.api#documentation": "Returns the attributes of a case.
", "smithy.api#examples": [ { "title": "Invoke GetCase", "input": { "caseId": "8403556009" }, "output": { "title": "My sample case", "caseArn": "arn:aws:security-ir:us-west-1:123456789012:case/1234567890", "description": "Case description", "caseStatus": "Submitted", "engagementType": "Investigation", "reportedIncidentStartDate": "2023-03-27T15:32:01.789Z", "actualIncidentStartDate": "2023-03-27T15:32:01.789Z", "impactedAwsRegions": [ { "region": "ap-southeast-1" } ], "threatActorIpAddresses": [ { "ipAddress": "192.168.192.168", "userAgent": "Browser" } ], "pendingAction": "Customer", "impactedAccounts": [ "000000000000", "111111111111" ], "watchers": [ { "email": "alice@example.com", "name": "Alice", "jobTitle": "CEO" }, { "email": "bob@example.com", "name": "Bob", "jobTitle": "CFO" } ], "createdDate": "2023-01-27T15:32:01.789Z", "lastUpdatedDate": "2023-02-27T15:32:01.789Z", "resolverType": "Self", "impactedServices": [ "Amazon EC2", "Amazon EKS" ] } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html" }, "smithy.api#http": { "code": 200, "method": "GET", "uri": "/v1/cases/{caseId}/get-case" }, "smithy.api#readonly": {} } }, "com.amazonaws.securityir#GetCaseAttachmentDownloadUrl": { "type": "operation", "input": { "target": "com.amazonaws.securityir#GetCaseAttachmentDownloadUrlRequest" }, "output": { "target": "com.amazonaws.securityir#GetCaseAttachmentDownloadUrlResponse" }, "traits": { "aws.iam#iamAction": { "name": "GetCaseAttachmentDownloadUrl", "documentation": "Grants permission to get a case attachment download URL" }, "smithy.api#documentation": "Returns a Pre-Signed URL for uploading attachments into a case.
", "smithy.api#examples": [ { "title": "Invoke GetCaseAttachmentDownloadUrl", "input": { "caseId": "8403556009", "attachmentId": "3C5A6B89-1DEF-4C2D-A5B6-123456789ABC" }, "output": { "attachmentPresignedUrl": "https://presignedurl.com" } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCaseAttachmentDownloadUrl.html" }, "smithy.api#http": { "code": 201, "method": "GET", "uri": "/v1/cases/{caseId}/get-presigned-url/{attachmentId}" }, "smithy.api#readonly": {} } }, "com.amazonaws.securityir#GetCaseAttachmentDownloadUrlRequest": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.securityir#CaseId", "traits": { "smithy.api#documentation": "Required element for GetCaseAttachmentDownloadUrl to identify the case ID for downloading an attachment from.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCaseAttachmentDownloadUrl.html#securityir-GetCaseAttachmentDownloadUrl-request-uri-caseId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "attachmentId": { "target": "com.amazonaws.securityir#AttachmentId", "traits": { "smithy.api#documentation": "Required element for GetCaseAttachmentDownloadUrl to identify the attachment ID for downloading an attachment.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCaseAttachmentDownloadUrl.html#securityir-GetCaseAttachmentDownloadUrl-request-uri-attachmentId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#GetCaseAttachmentDownloadUrlResponse": { "type": "structure", "members": { "attachmentPresignedUrl": { "target": "com.amazonaws.securityir#Url", "traits": { "smithy.api#documentation": "Response element providing the Amazon S3 presigned URL to download an attachment.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCaseAttachmentDownloadUrl.html#securityir-GetCaseAttachmentDownloadUrl-response-attachmentPresignedUrl" }, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.securityir#GetCaseAttachmentUploadUrl": { "type": "operation", "input": { "target": "com.amazonaws.securityir#GetCaseAttachmentUploadUrlRequest" }, "output": { "target": "com.amazonaws.securityir#GetCaseAttachmentUploadUrlResponse" }, "traits": { "aws.iam#iamAction": { "name": "GetCaseAttachmentUploadUrl", "documentation": "Grants permission to get a case attachment upload URL" }, "smithy.api#documentation": "Uploads an attachment to a case.
", "smithy.api#examples": [ { "title": "Invoke GetCaseAttachmentUploadUrl", "input": { "caseId": "8403556009", "fileName": "TestFileName", "contentLength": 1500 }, "output": { "attachmentPresignedUrl": "https://presignedurl.com" } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCaseAttachmentUploadUrl.html" }, "smithy.api#http": { "code": 201, "method": "POST", "uri": "/v1/cases/{caseId}/get-presigned-url" }, "smithy.api#idempotent": {} } }, "com.amazonaws.securityir#GetCaseAttachmentUploadUrlRequest": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.securityir#CaseId", "traits": { "smithy.api#documentation": "Required element for GetCaseAttachmentUploadUrl to identify the case ID for uploading an attachment.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCaseAttachmentUploadUrl.html#securityir-GetCaseAttachmentUploadUrl-request-uri-caseId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "fileName": { "target": "com.amazonaws.securityir#FileName", "traits": { "smithy.api#documentation": "Required element for GetCaseAttachmentUploadUrl to identify the file name of the attachment to upload.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCaseAttachmentUploadUrl.html#securityir-GetCaseAttachmentUploadUrl-request-contentLength" }, "smithy.api#required": {} } }, "contentLength": { "target": "com.amazonaws.securityir#ContentLength", "traits": { "smithy.api#documentation": "Required element for GetCaseAttachmentUploadUrl to identify the size of the file attachment.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCaseAttachmentUploadUrl.html#securityir-GetCaseAttachmentUploadUrl-request-fileName" }, "smithy.api#required": {} } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.
Response element providing the Amazon S3 presigned URL to upload the attachment.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCaseAttachmentUploadUrl.html#securityir-GetCaseAttachmentUploadUrl-response-attachmentPresignedUrl" }, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.securityir#GetCaseRequest": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.securityir#CaseId", "traits": { "smithy.api#documentation": "Required element for GetCase to identify the requested case ID.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-request-uri-caseId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#GetCaseResponse": { "type": "structure", "members": { "title": { "target": "com.amazonaws.securityir#CaseTitle", "traits": { "smithy.api#documentation": "Response element for GetCase that provides the case title.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-title" } } }, "caseArn": { "target": "com.amazonaws.securityir#CaseArn", "traits": { "smithy.api#documentation": "Response element for GetCase that provides the case ARN
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-caseArn" } } }, "description": { "target": "com.amazonaws.securityir#CaseDescription", "traits": { "smithy.api#documentation": "Response element for GetCase that provides contents of the case description.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-description" } } }, "caseStatus": { "target": "com.amazonaws.securityir#CaseStatus", "traits": { "smithy.api#documentation": "Response element for GetCase that provides the case status. Options for statuses include Submitted | Detection and Analysis | Eradication, Containment and Recovery | Post-Incident Activities | Closed
Response element for GetCase that provides the engagement type. Options for engagement type include Active Security Event | Investigations
Response element for GetCase that provides the customer provided incident start date.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-reportedIncidentStartDate" } } }, "actualIncidentStartDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Response element for GetCase that provides the actual incident start date as identified by data analysis during the investigation.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-actualIncidentStartDate" } } }, "impactedAwsRegions": { "target": "com.amazonaws.securityir#ImpactedAwsRegionList", "traits": { "smithy.api#documentation": "Response element for GetCase that provides the impacted regions.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-impactedAwsRegions" } } }, "threatActorIpAddresses": { "target": "com.amazonaws.securityir#ThreatActorIpList", "traits": { "smithy.api#documentation": "Response element for GetCase that provides a list of suspicious IP addresses associated with unauthorized activity.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-threatActorIpAddresses" } } }, "pendingAction": { "target": "com.amazonaws.securityir#PendingAction", "traits": { "smithy.api#documentation": "Response element for GetCase that identifies the case is waiting on customer input.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-pendingAction" } } }, "impactedAccounts": { "target": "com.amazonaws.securityir#ImpactedAccounts", "traits": { "smithy.api#documentation": "Response element for GetCase that provides a list of impacted accounts.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-impactedAccounts" } } }, "watchers": { "target": "com.amazonaws.securityir#Watchers", "traits": { "smithy.api#documentation": "Response element for GetCase that provides a list of Watchers added to the case.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-watchers" } } }, "createdDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Response element for GetCase that provides the date the case was created.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-createdDate" } } }, "lastUpdatedDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Response element for GetCase that provides the date a case was last modified.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-lastUpdatedDate" } } }, "closureCode": { "target": "com.amazonaws.securityir#ClosureCode", "traits": { "smithy.api#documentation": "Response element for GetCase that provides the summary code for why a case was closed.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-closureCode" } } }, "resolverType": { "target": "com.amazonaws.securityir#ResolverType", "traits": { "smithy.api#documentation": "Response element for GetCase that provides the current resolver types.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-resolverType" } } }, "impactedServices": { "target": "com.amazonaws.securityir#ImpactedServicesList", "traits": { "smithy.api#documentation": "Response element for GetCase that provides a list of impacted services.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-impactedServices" } } }, "caseAttachments": { "target": "com.amazonaws.securityir#CaseAttachmentsList", "traits": { "smithy.api#documentation": "Response element for GetCase that provides a list of current case attachments.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-caseAttachments" } } }, "closedDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Response element for GetCase that provides the date a specified case was closed.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-closedDate" } } }, "caseMetadata": { "target": "com.amazonaws.securityir#CaseMetadata", "traits": { "smithy.api#documentation": "Case response metadata
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-caseMetadata" } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.securityir#GetFindingMetrics": { "type": "operation", "input": { "target": "com.amazonaws.securityir#GetFindingMetricsRequest" }, "output": { "target": "com.amazonaws.securityir#GetFindingMetricsResponse" }, "traits": { "aws.iam#iamAction": { "name": "GetFindingMetrics", "documentation": "Grants permission to retrieve finding-lifecycle metrics for a membership over a date range" }, "smithy.api#documentation": "Returns finding-lifecycle metrics for a membership over a date range.", "smithy.api#examples": [ { "title": "Retrieve finding-lifecycle metrics for a membership", "input": { "membershipId": "m-a1b2c3d4e5f", "startDate": "2026-08-01T00:00:00Z", "endDate": "2026-08-18T00:00:00Z" }, "output": { "findingsIngestedSecurityHub": 120, "findingsIngestedGuardDuty": 45, "findingsTriaged": 165, "findingsTriagedFalsePositive": 30, "findingsInvestigated": 60, "findingsInvestigatedFalsePositive": 12, "findingsEscalated": 8, "findingsEscalatedFalsePositive": 2, "findingsTruePositive": 6, "findingsInvestigatedInProgress": 40, "findingsEscalatedInProgress": 0 } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/v1/membership/{membershipId}/finding-metrics" }, "smithy.api#readonly": {} } }, "com.amazonaws.securityir#GetFindingMetricsRequest": { "type": "structure", "members": { "membershipId": { "target": "com.amazonaws.securityir#MembershipId", "traits": { "smithy.api#documentation": "The membership ID to retrieve metrics for.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "startDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The start of the day-aligned UTC window, inclusive.", "smithy.api#httpQuery": "startDate", "smithy.api#required": {} } }, "endDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The end of the day-aligned UTC window, inclusive.", "smithy.api#httpQuery": "endDate", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#GetFindingMetricsResponse": { "type": "structure", "members": { "findingsIngestedSecurityHub": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of findings ingested from AWS Security Hub during the requested date range.", "smithy.api#required": {} } }, "findingsIngestedGuardDuty": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of findings ingested from Amazon GuardDuty during the requested date range.", "smithy.api#required": {} } }, "findingsTriaged": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of findings triaged during the requested date range.", "smithy.api#required": {} } }, "findingsTriagedFalsePositive": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of triaged findings that were closed as false positives during the requested date range.", "smithy.api#required": {} } }, "findingsInvestigated": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of findings investigated during the requested date range.", "smithy.api#required": {} } }, "findingsInvestigatedFalsePositive": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of investigated findings that were closed as false positives during the requested date range.", "smithy.api#required": {} } }, "findingsEscalated": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of findings escalated during the requested date range.", "smithy.api#required": {} } }, "findingsEscalatedFalsePositive": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of escalated findings that were closed as false positives during the requested date range.", "smithy.api#required": {} } }, "findingsTruePositive": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of findings confirmed as true positives during the requested date range.", "smithy.api#required": {} } }, "findingsInvestigatedInProgress": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of findings whose investigation was in progress during the requested date range.", "smithy.api#required": {} } }, "findingsEscalatedInProgress": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The number of findings whose escalation was in progress during the requested date range.", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Finding-lifecycle metrics for a membership over the requested date range.", "smithy.api#output": {} } }, "com.amazonaws.securityir#GetMembership": { "type": "operation", "input": { "target": "com.amazonaws.securityir#GetMembershipRequest" }, "output": { "target": "com.amazonaws.securityir#GetMembershipResponse" }, "traits": { "aws.iam#iamAction": { "name": "GetMembership", "documentation": "Grants permission to get a membership" }, "smithy.api#documentation": "Returns the attributes of a membership.
", "smithy.api#examples": [ { "title": "Invoke GetMembership", "input": { "membershipId": "m-abcd1234efgh" }, "output": { "membershipId": "m-abcd1234efgh", "accountId": "123412341234", "region": "af-south-1", "membershipName": "Example Membership", "membershipArn": "arn:aws:security-ir:us-west-1:123456789012:membership/m-abcd1234efgh", "membershipStatus": "Active", "membershipActivationTimestamp": "2023-03-27T15:32:01.789Z", "membershipDeactivationTimestamp": "2023-04-27T15:32:01.789Z", "customerType": "Standalone", "numberOfAccountsCovered": 50, "incidentResponseTeam": [ { "name": "Bob Jones", "jobTitle": "Security Responder", "email": "bob.jones@gmail.com" }, { "email": "alice@example.com", "name": "Alice", "jobTitle": "CEO" } ], "optInFeatures": [ { "featureName": "Triage", "isEnabled": true } ] } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html" }, "smithy.api#http": { "code": 200, "method": "GET", "uri": "/v1/membership/{membershipId}" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetMembershipFailure", "params": { "membershipId": "m-aaaaaaaaaaaaaaaaaaaa" }, "expect": { "failure": { "errorId": "com.amazonaws.securityir#AccessDeniedException" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.securityir#GetMembershipAccountDetailError": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.securityir#AWSAccountId", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembershipAccountDetailError.html#securityir-Type-GetMembershipAccountDetailError-accountId" }, "smithy.api#required": {} } }, "error": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembershipAccountDetailItem.html#securityir-Type-GetMembershipAccountDetailItem-relationshipStatus" }, "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembershipAccountDetailItem.html#securityir-Type-GetMembershipAccountDetailItem-relationshipType" }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembershipAccountDetailError.html" } } }, "com.amazonaws.securityir#GetMembershipAccountDetailErrors": { "type": "list", "member": { "target": "com.amazonaws.securityir#GetMembershipAccountDetailError" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.securityir#GetMembershipAccountDetailItem": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.securityir#AWSAccountId", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembershipAccountDetailItem.html#securityir-Type-GetMembershipAccountDetailItem-accountId" } } }, "relationshipStatus": { "target": "com.amazonaws.securityir#MembershipAccountRelationshipStatus", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembershipAccountDetailItem.html#securityir-Type-GetMembershipAccountDetailItem-relationshipStatus" } } }, "relationshipType": { "target": "com.amazonaws.securityir#MembershipAccountRelationshipType", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembershipAccountDetailItem.html#securityir-Type-GetMembershipAccountDetailItem-relationshipType" } } } }, "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembershipAccountDetailItem.html" } } }, "com.amazonaws.securityir#GetMembershipAccountDetailItems": { "type": "list", "member": { "target": "com.amazonaws.securityir#GetMembershipAccountDetailItem" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.securityir#GetMembershipRequest": { "type": "structure", "members": { "membershipId": { "target": "com.amazonaws.securityir#MembershipId", "traits": { "smithy.api#documentation": "Required element for GetMembership to identify the membership ID to query.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html#securityir-GetMembership-request-uri-membershipId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#GetMembershipResponse": { "type": "structure", "members": { "membershipId": { "target": "com.amazonaws.securityir#MembershipId", "traits": { "smithy.api#documentation": "Response element for GetMembership that provides the queried membership ID.
", "smithy.api#required": {} } }, "accountId": { "target": "com.amazonaws.securityir#AWSAccountId", "traits": { "smithy.api#documentation": "Response element for GetMembership that provides the account configured to manage the membership.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html#securityir-GetMembership-response-accountId" } } }, "region": { "target": "com.amazonaws.securityir#AwsRegion", "traits": { "smithy.api#documentation": "Response element for GetMembership that provides the region configured to manage the membership.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html#securityir-GetMembership-response-region" } } }, "membershipName": { "target": "com.amazonaws.securityir#MembershipName", "traits": { "smithy.api#documentation": "Response element for GetMembership that provides the configured membership name.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html#securityir-GetMembership-response-membershipName" } } }, "membershipArn": { "target": "com.amazonaws.securityir#MembershipArn", "traits": { "smithy.api#documentation": "Response element for GetMembership that provides the membership ARN.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html#securityir-GetMembership-response-membershipArn" } } }, "membershipStatus": { "target": "com.amazonaws.securityir#MembershipStatus", "traits": { "smithy.api#documentation": "Response element for GetMembership that provides the current membership status.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html#securityir-GetMembership-response-membershipStatus" } } }, "membershipActivationTimestamp": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Response element for GetMembership that provides the configured membership activation timestamp.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html#securityir-GetMembership-response-membershipActivationTimestamp" } } }, "membershipDeactivationTimestamp": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Response element for GetMembership that provides the configured membership name deactivation timestamp.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html#securityir-GetMembership-response-membershipDeactivationTimestamp" } } }, "customerType": { "target": "com.amazonaws.securityir#CustomerType", "traits": { "smithy.api#documentation": "Response element for GetMembership that provides the configured membership type. Options include Standalone | Organizations.
Response element for GetMembership that provides the number of accounts in the membership.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html#securityir-GetMembership-response-numberOfAccountsCovered" } } }, "incidentResponseTeam": { "target": "com.amazonaws.securityir#IncidentResponseTeam", "traits": { "smithy.api#documentation": "Response element for GetMembership that provides the configured membership incident response team members.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html#securityir-GetMembership-response-incidentResponseTeam" } } }, "optInFeatures": { "target": "com.amazonaws.securityir#OptInFeatures", "traits": { "smithy.api#documentation": "Response element for GetMembership that provides the if opt-in features have been enabled.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html#securityir-GetMembership-response-optInFeatures" } } }, "membershipAccountsConfigurations": { "target": "com.amazonaws.securityir#MembershipAccountsConfigurations", "traits": { "smithy.api#documentation": "The membershipAccountsConfigurations field contains the configuration details for member accounts within the Amazon Web Services Organizations membership structure.
This field returns a structure containing information about:
Account configurations for member accounts
Membership settings and preferences
Account-level permissions and roles
The exception message.
", "smithy.api#required": {} } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of seconds after which to retry the request.
", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.securityir#InvalidTokenException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The exception message.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client", "smithy.api#httpError": 423, "smithy.api#retryable": {} } }, "com.amazonaws.securityir#InvestigationAction": { "type": "structure", "members": { "investigationId": { "target": "com.amazonaws.securityir#InvestigationId", "traits": { "smithy.api#documentation": "The unique identifier for this investigation action. This ID is used to track and reference the specific investigation throughout its lifecycle.
", "smithy.api#required": {} } }, "actionType": { "target": "com.amazonaws.securityir#ActionType", "traits": { "smithy.api#documentation": "The type of investigation action being performed. This categorizes the investigation method or approach used in the case.
", "smithy.api#required": {} } }, "title": { "target": "com.amazonaws.securityir#InvestigationTitle", "traits": { "smithy.api#documentation": "Human-readable summary of the investigation focus. This provides a brief description of what the investigation is examining or analyzing.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.securityir#InvestigationContent", "traits": { "smithy.api#documentation": "Detailed investigation results in rich markdown format. This field contains the comprehensive findings, analysis, and conclusions from the investigation.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.securityir#ExecutionStatus", "traits": { "smithy.api#documentation": "The current execution status of the investigation. This indicates whether the investigation is pending, in progress, completed, or failed.
", "smithy.api#required": {} } }, "lastUpdated": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "ISO 8601 timestamp of the most recent status update. This indicates when the investigation was last modified or when its status last changed.
", "smithy.api#required": {} } }, "feedback": { "target": "com.amazonaws.securityir#InvestigationFeedback", "traits": { "smithy.api#documentation": "User feedback for this investigation result. This contains the user's assessment and comments about the quality and usefulness of the investigation findings.
" } } }, "traits": { "smithy.api#documentation": "Represents an investigation action performed within a case. This structure captures the details of an automated or manual investigation, including its status, results, and user feedback.
" } }, "com.amazonaws.securityir#InvestigationActionList": { "type": "list", "member": { "target": "com.amazonaws.securityir#InvestigationAction" } }, "com.amazonaws.securityir#InvestigationContent": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 5000 } } }, "com.amazonaws.securityir#InvestigationFeedback": { "type": "structure", "members": { "usefulness": { "target": "com.amazonaws.securityir#UsefulnessRating", "traits": { "smithy.api#documentation": "User assessment of the investigation result's quality and helpfulness. This rating indicates how valuable the investigation findings were in addressing the case.
" } }, "comment": { "target": "com.amazonaws.securityir#FeedbackComment", "traits": { "smithy.api#documentation": "Optional user comments providing additional context about the investigation feedback. This allows users to explain their rating or provide suggestions for improvement.
" } }, "submittedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "ISO 8601 timestamp when the feedback was submitted. This records when the user provided their assessment of the investigation results.
" } } }, "traits": { "smithy.api#documentation": "Represents user feedback for an investigation result. This structure captures the user's evaluation of the investigation's quality, usefulness, and any additional comments.
" } }, "com.amazonaws.securityir#InvestigationId": { "type": "string", "traits": { "smithy.api#pattern": "^inv-[a-z0-9]{10,32}$" } }, "com.amazonaws.securityir#InvestigationTitle": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.securityir#JobTitle": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#sensitive": {} } }, "com.amazonaws.securityir#ListCaseEdits": { "type": "operation", "input": { "target": "com.amazonaws.securityir#ListCaseEditsRequest" }, "output": { "target": "com.amazonaws.securityir#ListCaseEditsResponse" }, "traits": { "aws.iam#iamAction": { "name": "ListCaseEdits", "documentation": "Grants permission to list case edits" }, "smithy.api#documentation": "Views the case history for edits made to a designated case.
", "smithy.api#examples": [ { "title": "Invoke ListCaseEdits", "input": { "caseId": "8403556009" }, "output": { "items": [ { "eventTimestamp": "2023-03-27T15:32:01.789Z", "principal": "00000000000", "action": "Add comment", "message": "Added comment to ask question to responder." } ], "total": 1 } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCaseEdits.html" }, "smithy.api#http": { "code": 200, "method": "POST", "uri": "/v1/cases/{caseId}/list-case-edits" }, "smithy.api#paginated": { "items": "items", "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.securityir#ListCaseEditsRequest": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "An optional string that, if supplied, must be copied from the output of a previous call to ListCaseEdits. When provided in this manner, the API fetches the next page of results.
", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCaseEdits.html#securityir-ListCaseEdits-request-nextToken" }, "smithy.api#length": { "max": 2000 } } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 25, "smithy.api#documentation": "Optional element to identify how many results to obtain. There is a maximum value of 25.
", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCaseEdits.html#securityir-ListCaseEdits-request-maxResults" }, "smithy.api#range": { "min": 1, "max": 25 } } }, "caseId": { "target": "com.amazonaws.securityir#CaseId", "traits": { "smithy.api#documentation": "Required element used with ListCaseEdits to identify the case to query.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCaseEdits.html#securityir-ListCaseEdits-request-uri-caseId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#ListCaseEditsResponse": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "An optional string that, if supplied on subsequent calls to ListCaseEdits, allows the API to fetch the next page of results.
", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCaseEdits.html#securityir-ListCaseEdits-response-nextToken" } } }, "items": { "target": "com.amazonaws.securityir#CaseEditItems", "traits": { "smithy.api#documentation": "Response element for ListCaseEdits that includes the action, event timestamp, message, and principal for the response.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCaseEdits.html#securityir-ListCaseEdits-response-items" } } }, "total": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Response element for ListCaseEdits that identifies the total number of edits.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCaseEdits.html#securityir-ListCaseEdits-response-total" } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.securityir#ListCases": { "type": "operation", "input": { "target": "com.amazonaws.securityir#ListCasesRequest" }, "output": { "target": "com.amazonaws.securityir#ListCasesResponse" }, "traits": { "aws.iam#iamAction": { "name": "ListCases", "documentation": "Grants permission to list cases" }, "smithy.api#documentation": "Lists all cases the requester has access to.
", "smithy.api#examples": [ { "title": "Invoke ListCases", "input": { "maxResults": 10 }, "output": { "items": [ { "caseId": "8403556009", "lastUpdatedDate": "2023-03-27T15:32:01.789Z", "title": "Example case title", "caseArn": "arn:aws:security-ir:us-west-1:123456789012:case/1234567890", "engagementType": "Security Incident", "caseStatus": "Acknowledged", "createdDate": "2023-01-27T15:32:01.789Z", "resolverType": "Self", "pendingAction": "None" } ], "total": 1 } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCases.html" }, "smithy.api#http": { "code": 200, "method": "POST", "uri": "/v1/list-cases" }, "smithy.api#paginated": { "items": "items", "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.securityir#ListCasesItem": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.securityir#CaseId", "traits": { "smithy.api#documentation": "", "smithy.api#required": {} } }, "lastUpdatedDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCasesItem.html#securityir-Type-ListCasesItem-lastUpdatedDate" } } }, "title": { "target": "com.amazonaws.securityir#CaseTitle", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCasesItem.html#securityir-Type-ListCasesItem-title" } } }, "caseArn": { "target": "com.amazonaws.securityir#CaseArn", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCasesItem.html#securityir-Type-ListCasesItem-caseArn" } } }, "engagementType": { "target": "com.amazonaws.securityir#EngagementType", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCasesItem.html#securityir-Type-ListCasesItem-engagementType" } } }, "caseStatus": { "target": "com.amazonaws.securityir#CaseStatus", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCasesItem.html#securityir-Type-ListCasesItem-caseStatus" } } }, "createdDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCasesItem.html#securityir-Type-ListCasesItem-createdDate" } } }, "closedDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCasesItem.html#securityir-Type-ListCasesItem-closedDate" } } }, "resolverType": { "target": "com.amazonaws.securityir#ResolverType", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCasesItem.html#securityir-Type-ListCasesItem-resolverType" } } }, "pendingAction": { "target": "com.amazonaws.securityir#PendingAction", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCasesItem.html#securityir-Type-ListCasesItem-pendingAction" } } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.securityir#ListCasesItems": { "type": "list", "member": { "target": "com.amazonaws.securityir#ListCasesItem" } }, "com.amazonaws.securityir#ListCasesRequest": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "An optional string that, if supplied, must be copied from the output of a previous call to ListCases. When provided in this manner, the API fetches the next page of results.
", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCases.html#securityir-ListCases-request-nextToken" }, "smithy.api#length": { "max": 2000 } } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 25, "smithy.api#documentation": "Optional element for ListCases to limit the number of responses.
", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCases.html#securityir-ListCases-request-maxResults" }, "smithy.api#range": { "min": 1, "max": 25 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#ListCasesResponse": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "An optional string that, if supplied on subsequent calls to ListCases, allows the API to fetch the next page of results.
", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCaseEdits.html#securityir-ListCaseEdits-response-nextToken" } } }, "items": { "target": "com.amazonaws.securityir#ListCasesItems", "traits": { "smithy.api#documentation": "Response element for ListCases that includes caseARN, caseID, caseStatus, closedDate, createdDate, engagementType, lastUpdatedDate, pendingAction, resolverType, and title for each response.
", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCases.html#securityir-ListCases-response-items" } } }, "total": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "Response element for ListCases providing the total number of responses.
", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCases.html#securityir-ListCases-response-total" } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.securityir#ListComments": { "type": "operation", "input": { "target": "com.amazonaws.securityir#ListCommentsRequest" }, "output": { "target": "com.amazonaws.securityir#ListCommentsResponse" }, "traits": { "aws.iam#iamAction": { "name": "ListComments", "documentation": "Grants permission to list case comments" }, "smithy.api#documentation": "Returns comments for a designated case.
", "smithy.api#examples": [ { "title": "Invoke ListComments", "input": { "caseId": "8403556009" }, "output": { "items": [ { "commentId": "000000", "body": "Case comment body." } ], "total": 1 } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListComments.html" }, "smithy.api#http": { "code": 200, "method": "POST", "uri": "/v1/cases/{caseId}/list-comments" }, "smithy.api#paginated": { "items": "items", "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.securityir#ListCommentsItem": { "type": "structure", "members": { "commentId": { "target": "com.amazonaws.securityir#CommentId", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCommentsItem.html#securityir-Type-ListCommentsItem-commentId" }, "smithy.api#required": {} } }, "createdDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "" } }, "lastUpdatedDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "" } }, "creator": { "target": "com.amazonaws.securityir#PrincipalId", "traits": { "smithy.api#documentation": "" } }, "lastUpdatedBy": { "target": "com.amazonaws.securityir#PrincipalId", "traits": { "smithy.api#documentation": "" } }, "body": { "target": "com.amazonaws.securityir#CommentBody", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCommentsItem.html#securityir-Type-ListCommentsItem-body" } } } }, "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCommentsItem.html#securityir-Type-ListCommentsItem-commentId" } } }, "com.amazonaws.securityir#ListCommentsItems": { "type": "list", "member": { "target": "com.amazonaws.securityir#ListCommentsItem" } }, "com.amazonaws.securityir#ListCommentsRequest": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "An optional string that, if supplied, must be copied from the output of a previous call to ListComments. When provided in this manner, the API fetches the next page of results.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListComments.html#securityir-ListComments-request-nextToken" }, "smithy.api#length": { "max": 2000 } } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 25, "smithy.api#documentation": "Optional element for ListComments to limit the number of responses.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListComments.html#securityir-ListComments-request-maxResults" }, "smithy.api#range": { "min": 1, "max": 25 } } }, "caseId": { "target": "com.amazonaws.securityir#CaseId", "traits": { "smithy.api#documentation": "Required element for ListComments to designate the case to query.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListComments.html#securityir-ListComments-request-uri-caseId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#ListCommentsResponse": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "An optional string that, if supplied on subsequent calls to ListComments, allows the API to fetch the next page of results.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListComments.html#securityir-ListComments-response-nextToken" } } }, "items": { "target": "com.amazonaws.securityir#ListCommentsItems", "traits": { "smithy.api#documentation": "Response element for ListComments providing the body, commentID, createDate, creator, lastUpdatedBy and lastUpdatedDate for each response.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListComments.html#securityir-ListComments-response-items" } } }, "total": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Response element for ListComments identifying the number of responses.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListComments.html#securityir-ListComments-response-total" } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.securityir#ListInvestigations": { "type": "operation", "input": { "target": "com.amazonaws.securityir#ListInvestigationsRequest" }, "output": { "target": "com.amazonaws.securityir#ListInvestigationsResponse" }, "traits": { "aws.iam#iamAction": { "name": "ListInvestigations", "documentation": "Grants permission to list investigations for a case" }, "smithy.api#documentation": "Investigation performed by an agent for a security incident...
", "smithy.api#examples": [ { "title": "Invoke ListInvestigations with feedback examples", "input": { "caseId": "8403556009", "maxResults": 10 }, "output": { "investigationActions": [ { "investigationId": "inv-hgyuiuytrt", "actionType": "Evidence", "title": "Collected CloudTrail logs for suspicious activity", "content": "## Evidence Collection Results\n\nAnalyzed CloudTrail logs from 2024-01-15 to 2024-01-16 and found:\n\n- 15 failed login attempts from IP 192.168.1.100\n- Unusual API calls to S3 buckets\n- Privilege escalation attempts detected\n\n### Recommendations\n\n1. Block the suspicious IP address\n2. Review S3 bucket permissions\n3. Audit user privileges", "status": "Completed", "lastUpdated": "2024-01-16T10:30:00Z", "feedback": { "usefulness": "USEFUL", "comment": "The CloudTrail analysis was very helpful in identifying the root cause of the security incident. The recommendations were actionable and led to immediate remediation.", "submittedAt": "2024-01-16T11:15:00Z" } } ], "nextToken": "eyJsYXN0RXZhbHVhdGVkS2V5Ijp7InBhcnRpdGlvbktleSI6eyJTIjoiQ0FTRV8xMjM0NTY3ODkwIn0sInNvcnRLZXkiOnsiUyI6IjIwMjQtMDEtMTZUMTA6MzA6MDBaIn19fQ==" } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListInvestigations.html" }, "smithy.api#http": { "code": 200, "method": "GET", "uri": "/v1/cases/{caseId}/list-investigations" }, "smithy.api#paginated": { "items": "investigationActions", "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.securityir#ListInvestigationsRequest": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Investigation performed by an agent for a security incident request
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListInvestigations.html#securityir-ListInvestigations-request-nextToken" }, "smithy.api#httpQuery": "nextToken", "smithy.api#length": { "max": 2000 } } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 20, "smithy.api#documentation": "Investigation performed by an agent for a security incident request, returning max results
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListInvestigations.html#securityir-ListInvestigations-request-maxResults" }, "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 25 } } }, "caseId": { "target": "com.amazonaws.securityir#CaseId", "traits": { "smithy.api#documentation": "Investigation performed by an agent for a security incident per caseID
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListInvestigations.html#securityir-ListInvestigations-request-uri-caseId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#ListInvestigationsResponse": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Investigation performed by an agent for a security incident for next Token
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListInvestigations.html#securityir-ListInvestigations-response-nextToken" } } }, "investigationActions": { "target": "com.amazonaws.securityir#InvestigationActionList", "traits": { "smithy.api#documentation": "Investigation performed by an agent for a security incid\u2026Unique identifier for the specific investigation>
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListInvestigations.html#securityir-ListInvestigations-response-investigationActions" }, "smithy.api#required": {} } } }, "traits": { "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListInvestigations.html#API_ListInvestigations_ResponseSyntax" }, "smithy.api#output": {} } }, "com.amazonaws.securityir#ListMembershipItem": { "type": "structure", "members": { "membershipId": { "target": "com.amazonaws.securityir#MembershipId", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListMembershipItem.html#securityir-Type-ListMembershipItem-membershipId" }, "smithy.api#required": {} } }, "accountId": { "target": "com.amazonaws.securityir#AWSAccountId", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListMemberships.html#securityir-ListMemberships-response-accountId" } } }, "region": { "target": "com.amazonaws.securityir#AwsRegion", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListMemberships.html#securityir-ListMemberships-response-region" } } }, "membershipArn": { "target": "com.amazonaws.securityir#MembershipArn", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListMemberships.html#securityir-ListMemberships-response-membershipArn" } } }, "membershipStatus": { "target": "com.amazonaws.securityir#MembershipStatus", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListMemberships.html#securityir-ListMemberships-response-membershipStatus" } } } }, "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListMemberships.html#securityir-ListMemberships-response-items" } } }, "com.amazonaws.securityir#ListMembershipItems": { "type": "list", "member": { "target": "com.amazonaws.securityir#ListMembershipItem" } }, "com.amazonaws.securityir#ListMemberships": { "type": "operation", "input": { "target": "com.amazonaws.securityir#ListMembershipsRequest" }, "output": { "target": "com.amazonaws.securityir#ListMembershipsResponse" }, "traits": { "aws.iam#iamAction": { "name": "ListMemberships", "documentation": "Grants permission to list memberships" }, "smithy.api#documentation": "Returns the memberships that the calling principal can access.
", "smithy.api#examples": [ { "title": "Invoke ListMemberships", "input": { "maxResults": 10 }, "output": { "items": [ { "membershipId": "m-abcd1234efgh", "accountId": "123123123123", "region": "af-south-1", "membershipArn": "arn:aws:security-ir:us-west-1:123456789012:membership/m-abcd1234efgh", "membershipStatus": "Cancelled" } ] } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListMemberships.html" }, "smithy.api#http": { "code": 200, "method": "POST", "uri": "/v1/memberships" }, "smithy.api#paginated": { "items": "items", "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.securityir#ListMembershipsRequest": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "An optional string that, if supplied, must be copied from the output of a previous call to ListMemberships. When provided in this manner, the API fetches the next page of results.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListMemberships.html#securityir-ListMemberships-request-nextToken" }, "smithy.api#length": { "max": 2000 } } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 25, "smithy.api#documentation": "Request element for ListMemberships to limit the number of responses.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListMemberships.html#securityir-ListMemberships-request-maxResults" }, "smithy.api#range": { "min": 1, "max": 25 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#ListMembershipsResponse": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "An optional string that, if supplied on subsequent calls to ListMemberships, allows the API to fetch the next page of results.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListMemberships.html#securityir-ListMemberships-response-nextToken" } } }, "items": { "target": "com.amazonaws.securityir#ListMembershipItems", "traits": { "smithy.api#documentation": "Request element for ListMemberships including the accountID, membershipARN, membershipID, membershipStatus, and region for each response.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListMemberships.html#securityir-ListMemberships-response-items" } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.securityir#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.securityir#ListTagsForResourceInput" }, "output": { "target": "com.amazonaws.securityir#ListTagsForResourceOutput" }, "errors": [ { "target": "com.amazonaws.securityir#AccessDeniedException" }, { "target": "com.amazonaws.securityir#ResourceNotFoundException" }, { "target": "com.amazonaws.securityir#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "name": "ListTagsForResource", "documentation": "Grants permission to list the tags attached to the specified resource" }, "smithy.api#documentation": "Returns currently configured tags on a resource.
", "smithy.api#examples": [ { "title": "Invoke ListTagsForResource", "input": { "resourceArn": "arn:aws:security-ir:us-west-1:123456789012:membership/m-abcd1234efgh" }, "output": { "tags": { "key": "example-tag-key", "value": "example-tag-value" } } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListTagsForResource.html" }, "smithy.api#http": { "method": "GET", "uri": "/v1/tags/{resourceArn}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.securityir#ListTagsForResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.securityir#Arn", "traits": { "smithy.api#documentation": "Required element for ListTagsForResource to provide the ARN to identify a specific resource.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListTagsForResource.html#securityir-ListTagsForResource-request-uri-resourceArn" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.securityir#Membership", "ids": { "membershipId": "resourceArn" } }, { "resource": "com.amazonaws.securityir#Case", "ids": { "caseId": "resourceArn" } } ] } }, "com.amazonaws.securityir#ListTagsForResourceOutput": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.securityir#TagMap", "traits": { "aws.api#data": "tagging", "smithy.api#documentation": "Response element for ListTagsForResource providing content for each configured tag.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListTagsForResource.html#securityir-ListTagsForResource-response-tags" }, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.securityir#Membership": { "type": "resource", "identifiers": { "membershipId": { "target": "com.amazonaws.securityir#MembershipId" } }, "create": { "target": "com.amazonaws.securityir#CreateMembership" }, "read": { "target": "com.amazonaws.securityir#GetMembership" }, "update": { "target": "com.amazonaws.securityir#UpdateMembership" }, "list": { "target": "com.amazonaws.securityir#ListMemberships" }, "operations": [ { "target": "com.amazonaws.securityir#BatchGetMemberAccountDetails" }, { "target": "com.amazonaws.securityir#CancelMembership" }, { "target": "com.amazonaws.securityir#GetFindingMetrics" } ], "traits": { "aws.api#arn": { "template": "membership/{membershipId}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#iamResource": { "name": "membership", "relativeDocumentation": "select-a-membership-account.html" }, "smithy.api#documentation": "Represents a membership that is used to manage service level preferences" } }, "com.amazonaws.securityir#MembershipAccountRelationshipStatus": { "type": "enum", "members": { "ASSOCIATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Associated" } }, "DISASSOCIATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disassociated" } }, "UNASSOCIATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Unassociated" } } } }, "com.amazonaws.securityir#MembershipAccountRelationshipType": { "type": "enum", "members": { "ORGANIZATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Organization" } }, "UNRELATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Unrelated" } } } }, "com.amazonaws.securityir#MembershipAccountsConfigurations": { "type": "structure", "members": { "coverEntireOrganization": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "The coverEntireOrganization field is a boolean value that determines whether the membership configuration applies to all accounts within an Amazon Web Services Organization.
When set to true, the configuration will be applied across all accounts in the organization. When set to false, the configuration will only apply to specifically designated accounts under the AWS Organizational Units specificied.
A list of organizational unit IDs that follow the pattern ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}. These IDs represent the organizational units within an Amazon Web Services Organizations structure that are covered by the membership.
Each organizational unit ID in the list must:
Begin with the prefix 'ou-'
Contain between 4 and 32 alphanumeric characters in the first segment
Contain between 8 and 32 alphanumeric characters in the second segment
The MembershipAccountsConfigurations structure defines the configuration settings for managing membership accounts withinAmazon Web Services.
This structure contains settings that determine how member accounts are configured and managed within your organization, including:
Account configuration preferences
Membership validation rules
Account access settings
You can use this structure to define and maintain standardized configurations across multiple member accounts in your organization.
" } }, "com.amazonaws.securityir#MembershipAccountsConfigurationsUpdate": { "type": "structure", "members": { "coverEntireOrganization": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "The coverEntireOrganization field is a boolean value that determines whether the membership configuration should be applied across the entire Amazon Web Services Organization.
When set to true, the configuration will be applied to all accounts within the organization. When set to false, the configuration will only apply to specifically designated accounts.
A list of organizational unit IDs to add to the membership configuration. Each organizational unit ID must match the pattern ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}.
The list must contain between 1 and 5 organizational unit IDs.
", "smithy.api#length": { "min": 1, "max": 5 } } }, "organizationalUnitsToRemove": { "target": "com.amazonaws.securityir#OrganizationalUnits", "traits": { "smithy.api#documentation": "A list of organizational unit IDs to remove from the membership configuration. Each organizational unit ID must match the pattern ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}.
The list must contain between 1 and 5 organizational unit IDs per invocation of the API request.
", "smithy.api#length": { "min": 1, "max": 5 } } } }, "traits": { "smithy.api#documentation": "The MembershipAccountsConfigurationsUpdatestructure represents the configuration updates for member accounts within an Amazon Web Services organization.
This structure is used to modify existing account configurations and settings for members in the organization. When applying updates, ensure all required fields are properly specified to maintain account consistency.
Key considerations when using this structure:
All configuration changes are validated before being applied
Updates are processed asynchronously in the background
Configuration changes may take several minutes to propagate across all affected accounts
The exception message.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.securityir#ResultId": { "type": "string", "traits": { "smithy.api#pattern": "^inv-[a-z0-9]{10,32}$" } }, "com.amazonaws.securityir#SecurityIncidentResponse": { "type": "service", "version": "2018-05-10", "operations": [ { "target": "com.amazonaws.securityir#ListTagsForResource" }, { "target": "com.amazonaws.securityir#TagResource" }, { "target": "com.amazonaws.securityir#UntagResource" } ], "resources": [ { "target": "com.amazonaws.securityir#Case" }, { "target": "com.amazonaws.securityir#Membership" } ], "errors": [ { "target": "com.amazonaws.securityir#AccessDeniedException" }, { "target": "com.amazonaws.securityir#ConflictException" }, { "target": "com.amazonaws.securityir#InternalServerException" }, { "target": "com.amazonaws.securityir#InvalidTokenException" }, { "target": "com.amazonaws.securityir#ResourceNotFoundException" }, { "target": "com.amazonaws.securityir#SecurityIncidentResponseNotActiveException" }, { "target": "com.amazonaws.securityir#ServiceQuotaExceededException" }, { "target": "com.amazonaws.securityir#ThrottlingException" }, { "target": "com.amazonaws.securityir#ValidationException" } ], "traits": { "aws.api#service": { "sdkId": "Security IR", "arnNamespace": "security-ir", "cloudTrailEventSource": "security-ir.amazonaws.com" }, "aws.auth#sigv4": { "name": "security-ir" }, "aws.endpoints#dualStackOnlyEndpoints": {}, "aws.endpoints#standardRegionalEndpoints": {}, "aws.iam#defineConditionKeys": { "aws:RequestTag/${TagKey}": { "type": "String", "documentation": "Filters access by the tags that are passed in the request", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" }, "aws:ResourceTag/${TagKey}": { "type": "String", "documentation": "Filters access by the tags associated with the resource", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" }, "aws:TagKeys": { "type": "ArrayOfString", "documentation": "Filters access by the tag keys that are passed in the request", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" } }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#supportedPrincipalTypes": [ "Root", "IAMUser", "IAMRole", "FederatedUser" ], "aws.protocols#restJson1": {}, "smithy.api#cors": {}, "smithy.api#documentation": "This guide documents the action and response elements for use of the service.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" }, "smithy.api#title": "Security Incident Response", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "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" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the 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 ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://security-ir-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://security-ir.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 6, "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAQAAAAQF9eEFAAAAAgAAAAUF9eEFAAAAAwX14QMF9eEEAAAAAwX14QEF9eEC" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "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" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the 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": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://security-ir-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://security-ir.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://security-ir-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://security-ir.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://security-ir-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://security-ir.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://security-ir-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://security-ir.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.securityir#SecurityIncidentResponseNotActiveException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The exception message.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/CommonErrors.html" }, "smithy.api#httpError": 400 } }, "com.amazonaws.securityir#SelfManagedCaseStatus": { "type": "enum", "members": { "SUBMITTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Submitted" } }, "DETECTION_AND_ANALYSIS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Detection and Analysis" } }, "CONTAINMENT_ERADICATION_AND_RECOVERY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Containment, Eradication and Recovery" } }, "POST_INCIDENT_ACTIVITIES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Post-incident Activities" } } } }, "com.amazonaws.securityir#SendFeedback": { "type": "operation", "input": { "target": "com.amazonaws.securityir#SendFeedbackRequest" }, "output": { "target": "com.amazonaws.securityir#SendFeedbackResponse" }, "traits": { "aws.iam#iamAction": { "name": "SendFeedback", "documentation": "Grants permission to send feedback for investigation results" }, "smithy.api#documentation": "Send feedback based on response investigation action
", "smithy.api#examples": [ { "title": "Send positive feedback for investigation result", "input": { "caseId": "8403556009", "resultId": "inv-polkjhyuty", "usefulness": "USEFUL", "comment": "The CloudTrail analysis was very helpful in identifying the root cause of the security incident." }, "output": {} }, { "title": "Send negative feedback with detailed comment", "input": { "caseId": "8403556009", "resultId": "inv-irutjfhgjk", "usefulness": "NOT_USEFUL", "comment": "The investigation results were too generic and didn't provide actionable insights for our specific incident." }, "output": {} } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_SendFeedback.html" }, "smithy.api#http": { "code": 200, "method": "POST", "uri": "/v1/cases/{caseId}/feedback/{resultId}/send-feedback" } } }, "com.amazonaws.securityir#SendFeedbackRequest": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.securityir#CaseId", "traits": { "smithy.api#documentation": "Send feedback based on request caseID
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_SendFeedback.html#securityir-SendFeedback-request-uri-caseId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "resultId": { "target": "com.amazonaws.securityir#ResultId", "traits": { "smithy.api#documentation": "Send feedback based on request result ID
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_SendFeedback.html#securityir-SendFeedback-request-uri-resultId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "usefulness": { "target": "com.amazonaws.securityir#UsefulnessRating", "traits": { "smithy.api#documentation": "Required enum value indicating user assessment of result q.....
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_SendFeedback.html#securityir-SendFeedback-request-usefulness" }, "smithy.api#required": {} } }, "comment": { "target": "com.amazonaws.securityir#FeedbackComment", "traits": { "smithy.api#documentation": "Send feedback based on request comments
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_SendFeedback.html#securityir-SendFeedback-request-comment" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#SendFeedbackResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_SendFeedback.html#API_SendFeedback_ResponseSyntax" }, "smithy.api#output": {} } }, "com.amazonaws.securityir#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The exception message.
", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the requested resource which lead to the service quota exception.
", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the requested resource which lead to the service quota exception.
", "smithy.api#required": {} } }, "serviceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The service code of the quota.
", "smithy.api#required": {} } }, "quotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The code of the quota.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.securityir#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.securityir#TagKeys": { "type": "list", "member": { "target": "com.amazonaws.securityir#TagKey" } }, "com.amazonaws.securityir#TagMap": { "type": "map", "key": { "target": "com.amazonaws.securityir#TagKey" }, "value": { "target": "com.amazonaws.securityir#TagValue" }, "traits": { "smithy.api#length": { "max": 200 } } }, "com.amazonaws.securityir#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.securityir#TagResourceInput" }, "output": { "target": "com.amazonaws.securityir#TagResourceOutput" }, "errors": [ { "target": "com.amazonaws.securityir#AccessDeniedException" }, { "target": "com.amazonaws.securityir#ResourceNotFoundException" }, { "target": "com.amazonaws.securityir#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}", "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "name": "TagResource", "documentation": "Grants permission to add tags to the specified resource" }, "smithy.api#documentation": "Adds a tag(s) to a designated resource.
", "smithy.api#examples": [ { "title": "Invoke TagResource", "input": { "resourceArn": "arn:aws:security-ir:us-west-1:123456789012:membership/m-abcd1234efgh", "tags": { "key": "example-tag-key", "value": "example-tag-value" } }, "output": {} } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_TagResource.html" }, "smithy.api#http": { "method": "POST", "uri": "/v1/tags/{resourceArn}", "code": 204 } } }, "com.amazonaws.securityir#TagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.securityir#Arn", "traits": { "smithy.api#documentation": "Required element for TagResource to identify the ARN for the resource to add a tag to.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_TagResource.html#securityir-TagResource-request-uri-resourceArn" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.securityir#TagMap", "traits": { "aws.api#data": "tagging", "smithy.api#documentation": "Required element for ListTagsForResource to provide the content for a tag.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_TagResource.html#securityir-TagResource-request-tags" }, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.securityir#Membership", "ids": { "membershipId": "resourceArn" } }, { "resource": "com.amazonaws.securityir#Case", "ids": { "caseId": "resourceArn" } } ] } }, "com.amazonaws.securityir#TagResourceOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_TagResource.html#API_TagResource_ResponseSyntax" }, "smithy.api#output": {} } }, "com.amazonaws.securityir#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.securityir#ThreatActorIp": { "type": "structure", "members": { "ipAddress": { "target": "com.amazonaws.securityir#IPAddress", "traits": { "smithy.api#documentation": "", "smithy.api#required": {} } }, "userAgent": { "target": "com.amazonaws.securityir#UserAgent", "traits": { "smithy.api#documentation": "" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.securityir#ThreatActorIpList": { "type": "list", "member": { "target": "com.amazonaws.securityir#ThreatActorIp" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.securityir#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The exception message.
", "smithy.api#required": {} } }, "serviceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The service code of the exception.
" } }, "quotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The quota code of the exception.
" } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of seconds after which to retry the request.
", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.securityir#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.securityir#UntagResourceInput" }, "output": { "target": "com.amazonaws.securityir#UntagResourceOutput" }, "errors": [ { "target": "com.amazonaws.securityir#AccessDeniedException" }, { "target": "com.amazonaws.securityir#ResourceNotFoundException" }, { "target": "com.amazonaws.securityir#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "name": "UntagResource", "documentation": "Grants permission to remove tags from the specified resource" }, "smithy.api#documentation": "Removes a tag(s) from a designate resource.
", "smithy.api#examples": [ { "title": "Invoke UntagResource", "input": { "resourceArn": "arn:aws:security-ir:us-west-1:123456789012:membership/m-abcd1234efgh", "tagKeys": [ "example-tag-key" ] } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UntagResource.html" }, "smithy.api#http": { "method": "DELETE", "uri": "/v1/tags/{resourceArn}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.securityir#UntagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.securityir#Arn", "traits": { "smithy.api#documentation": "Required element for UnTagResource to identify the ARN for the resource to remove a tag from.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UntagResource.html#securityir-UntagResource-request-uri-resourceArn" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.securityir#TagKeys", "traits": { "aws.api#data": "tagging", "smithy.api#documentation": "Required element for UnTagResource to identify tag to remove.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UntagResource.html#securityir-UntagResource-request-uri-resourceArn" }, "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.securityir#Membership", "ids": { "membershipId": "resourceArn" } }, { "resource": "com.amazonaws.securityir#Case", "ids": { "caseId": "resourceArn" } } ] } }, "com.amazonaws.securityir#UntagResourceOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UntagResource.html#API_UntagResource_ResponseSyntax" }, "smithy.api#output": {} } }, "com.amazonaws.securityir#UpdateCase": { "type": "operation", "input": { "target": "com.amazonaws.securityir#UpdateCaseRequest" }, "output": { "target": "com.amazonaws.securityir#UpdateCaseResponse" }, "traits": { "aws.iam#iamAction": { "name": "UpdateCase", "documentation": "Grants permission to update a case" }, "smithy.api#documentation": "Updates an existing case.
", "smithy.api#examples": [ { "title": "Invoke UpdateCase", "input": { "caseId": "8403556009", "title": "My sample case", "description": "Case description", "reportedIncidentStartDate": "2023-03-27T15:32:01.789Z", "actualIncidentStartDate": "2023-03-25T15:32:01.789Z", "engagementType": "Investigation", "watchersToAdd": [ { "email": "Sam@example.com", "name": "Same", "jobTitle": "CEO" } ], "watchersToDelete": [ { "email": "bob@example.com", "name": "Bob", "jobTitle": "CFO" } ], "threatActorIpAddressesToAdd": [ { "ipAddress": "190.160.190.160", "userAgent": "Browser" } ], "threatActorIpAddressesToDelete": [ { "ipAddress": "192.168.192.168", "userAgent": "Browser" } ], "impactedServicesToAdd": [ "Amazon EC2" ], "impactedServicesToDelete": [ "Amazon EKS" ], "impactedAwsRegionsToAdd": [ { "region": "ap-southeast-1" } ], "impactedAwsRegionsToDelete": [ { "region": "us-east-1" } ], "impactedAccountsToAdd": [ "000000000000" ], "impactedAccountsToDelete": [ "111111111111" ] }, "output": {} } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html" }, "smithy.api#http": { "code": 200, "method": "POST", "uri": "/v1/cases/{caseId}/update-case" } } }, "com.amazonaws.securityir#UpdateCaseComment": { "type": "operation", "input": { "target": "com.amazonaws.securityir#UpdateCaseCommentRequest" }, "output": { "target": "com.amazonaws.securityir#UpdateCaseCommentResponse" }, "traits": { "aws.iam#iamAction": { "name": "UpdateCaseComment", "documentation": "Grants permission to update a case comment" }, "smithy.api#documentation": "Updates an existing case comment.
", "smithy.api#examples": [ { "title": "Invoke UpdateCaseComment", "input": { "caseId": "8403556009", "commentId": "000000", "body": "Updated case comment." }, "output": { "body": "Updated case comment.", "commentId": "000000" } } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCaseComment.html" }, "smithy.api#http": { "code": 200, "method": "PUT", "uri": "/v1/cases/{caseId}/update-case-comment/{commentId}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.securityir#UpdateCaseCommentRequest": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.securityir#CaseId", "traits": { "smithy.api#documentation": "Required element for UpdateCaseComment to identify the case ID containing the comment to be updated.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCaseComment.html#securityir-UpdateCaseComment-request-uri-caseId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "commentId": { "target": "com.amazonaws.securityir#CommentId", "traits": { "smithy.api#documentation": "Required element for UpdateCaseComment to identify the case ID to be updated.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCaseComment.html#securityir-UpdateCaseComment-request-uri-commentId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "body": { "target": "com.amazonaws.securityir#CommentBody", "traits": { "smithy.api#documentation": "Required element for UpdateCaseComment to identify the content for the comment to be updated.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCaseComment.html#securityir-UpdateCaseComment-request-body" }, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#UpdateCaseCommentResponse": { "type": "structure", "members": { "commentId": { "target": "com.amazonaws.securityir#CommentId", "traits": { "smithy.api#documentation": "Response element for UpdateCaseComment providing the updated comment ID.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCaseComment.html#securityir-UpdateCaseComment-response-commentId" }, "smithy.api#required": {} } }, "body": { "target": "com.amazonaws.securityir#CommentBody", "traits": { "smithy.api#documentation": "Response element for UpdateCaseComment providing the updated comment content.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCaseComment.html#securityir-UpdateCaseComment-response-body" } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.securityir#UpdateCaseRequest": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.securityir#CaseId", "traits": { "smithy.api#documentation": "Required element for UpdateCase to identify the case ID for updates.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html#securityir-UpdateCase-request-uri-caseId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "title": { "target": "com.amazonaws.securityir#CaseTitle", "traits": { "smithy.api#documentation": "Optional element for UpdateCase to provide content for the title field.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html#securityir-UpdateCase-request-title" } } }, "description": { "target": "com.amazonaws.securityir#CaseDescription", "traits": { "smithy.api#documentation": "Optional element for UpdateCase to provide content for the description field.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html#securityir-UpdateCase-request-description" } } }, "reportedIncidentStartDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Optional element for UpdateCase to provide content for the customer reported incident start date field.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html#securityir-UpdateCase-request-reportedIncidentStartDate" } } }, "actualIncidentStartDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "Optional element for UpdateCase to provide content for the incident start date field.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html#securityir-UpdateCase-request-actualIncidentStartDate" } } }, "engagementType": { "target": "com.amazonaws.securityir#EngagementType", "traits": { "smithy.api#documentation": "Optional element for UpdateCase to provide content for the engagement type field. Available engagement types include Security Incident | Investigation.
Optional element for UpdateCase to provide content to add additional watchers to a case.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html#securityir-UpdateCase-request-watchersToAdd" } } }, "watchersToDelete": { "target": "com.amazonaws.securityir#Watchers", "traits": { "smithy.api#documentation": "Optional element for UpdateCase to provide content to remove existing watchers from a case.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html#securityir-UpdateCase-request-watchersToDelete" } } }, "threatActorIpAddressesToAdd": { "target": "com.amazonaws.securityir#ThreatActorIpList", "traits": { "smithy.api#documentation": "Optional element for UpdateCase to provide content to add additional suspicious IP addresses related to a case.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html#securityir-UpdateCase-request-threatActorIpAddressesToAdd" } } }, "threatActorIpAddressesToDelete": { "target": "com.amazonaws.securityir#ThreatActorIpList", "traits": { "smithy.api#documentation": "Optional element for UpdateCase to provide content to remove suspicious IP addresses from a case.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html#securityir-UpdateCase-request-threatActorIpAddressesToDelete" } } }, "impactedServicesToAdd": { "target": "com.amazonaws.securityir#ImpactedServicesList", "traits": { "smithy.api#documentation": "Optional element for UpdateCase to provide content to add services impacted.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html#securityir-UpdateCase-request-impactedServicesToAdd" } } }, "impactedServicesToDelete": { "target": "com.amazonaws.securityir#ImpactedServicesList", "traits": { "smithy.api#documentation": "Optional element for UpdateCase to provide content to remove services impacted.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html#securityir-UpdateCase-request-impactedServicesToDelete" } } }, "impactedAwsRegionsToAdd": { "target": "com.amazonaws.securityir#ImpactedAwsRegionList", "traits": { "smithy.api#documentation": "Optional element for UpdateCase to provide content to add regions impacted.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html#securityir-UpdateCase-request-impactedAwsRegionsToAdd" } } }, "impactedAwsRegionsToDelete": { "target": "com.amazonaws.securityir#ImpactedAwsRegionList", "traits": { "smithy.api#documentation": "Optional element for UpdateCase to provide content to remove regions impacted.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html#securityir-UpdateCase-request-impactedAwsRegionsToDelete" } } }, "impactedAccountsToAdd": { "target": "com.amazonaws.securityir#ImpactedAccounts", "traits": { "smithy.api#documentation": "Optional element for UpdateCase to provide content to add accounts impacted.
AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.
Optional element for UpdateCase to provide content to add accounts impacted.
AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.
Update the case request with case metadata
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-caseMetadata" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#UpdateCaseResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.securityir#UpdateCaseStatus": { "type": "operation", "input": { "target": "com.amazonaws.securityir#UpdateCaseStatusRequest" }, "output": { "target": "com.amazonaws.securityir#UpdateCaseStatusResponse" }, "traits": { "aws.iam#iamAction": { "name": "UpdateCaseStatus", "documentation": "Grants permission to update a case status" }, "smithy.api#documentation": "Updates the state transitions for a designated cases.
Self-managed: the following states are available for self-managed cases.
Submitted \u2192 Detection and Analysis
Detection and Analysis \u2192 Containment, Eradication, and Recovery
Detection and Analysis \u2192 Post-incident Activities
Containment, Eradication, and Recovery \u2192 Detection and Analysis
Containment, Eradication, and Recovery \u2192 Post-incident Activities
Post-incident Activities \u2192 Containment, Eradication, and Recovery
Post-incident Activities \u2192 Detection and Analysis
Any \u2192 Closed
AWS supported: You must use the CloseCase API to close.
Required element for UpdateCaseStatus to identify the case to update.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCaseStatus.html#securityir-UpdateCaseStatus-request-uri-caseId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "caseStatus": { "target": "com.amazonaws.securityir#SelfManagedCaseStatus", "traits": { "smithy.api#documentation": "Required element for UpdateCaseStatus to identify the status for a case. Options include Submitted | Detection and Analysis | Containment, Eradication and Recovery | Post-incident Activities.
Response element for UpdateCaseStatus showing the newly configured status.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCaseStatus.html#securityir-UpdateCaseStatus-response-caseStatus" } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.securityir#UpdateMembership": { "type": "operation", "input": { "target": "com.amazonaws.securityir#UpdateMembershipRequest" }, "output": { "target": "com.amazonaws.securityir#UpdateMembershipResponse" }, "traits": { "aws.iam#iamAction": { "name": "UpdateMembership", "requiredActions": [ "iam:CreateServiceLinkedRole", "organizations:DescribeOrganizationalUnit" ], "documentation": "Grants permission to update memberships" }, "smithy.api#documentation": "Updates membership configuration.
", "smithy.api#examples": [ { "title": "Invoke UpdateMembership", "input": { "membershipId": "m-abcd1234efgh", "membershipName": "New membership name", "incidentResponseTeam": [ { "name": "Bob Jones", "jobTitle": "Security Responder", "email": "bob.jones@gmail.com" }, { "email": "alice@example.com", "name": "Alice", "jobTitle": "CEO" } ], "optInFeatures": [ { "featureName": "Triage", "isEnabled": true } ] }, "output": {} } ], "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateMembership.html" }, "smithy.api#http": { "code": 200, "method": "PUT", "uri": "/v1/membership/{membershipId}/update-membership" }, "smithy.api#idempotent": {} } }, "com.amazonaws.securityir#UpdateMembershipRequest": { "type": "structure", "members": { "membershipId": { "target": "com.amazonaws.securityir#MembershipId", "traits": { "smithy.api#documentation": "Required element for UpdateMembership to identify the membership to update.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateMembership.html#securityir-UpdateMembership-request-uri-membershipId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "membershipName": { "target": "com.amazonaws.securityir#MembershipName", "traits": { "smithy.api#documentation": "Optional element for UpdateMembership to update the membership name.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateMembership.html#securityir-UpdateMembership-request-membershipName" } } }, "incidentResponseTeam": { "target": "com.amazonaws.securityir#IncidentResponseTeam", "traits": { "smithy.api#documentation": "Optional element for UpdateMembership to update the membership name.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateMembership.html#securityir-UpdateMembership-request-incidentResponseTeam" } } }, "optInFeatures": { "target": "com.amazonaws.securityir#OptInFeatures", "traits": { "smithy.api#documentation": "Optional element for UpdateMembership to enable or disable opt-in features for the service.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateMembership.html#securityir-UpdateMembership-request-optInFeatures" } } }, "membershipAccountsConfigurationsUpdate": { "target": "com.amazonaws.securityir#MembershipAccountsConfigurationsUpdate", "traits": { "smithy.api#documentation": "The membershipAccountsConfigurationsUpdate field in the UpdateMembershipRequest structure allows you to update the configuration settings for accounts within a membership.
This field is optional and contains a structure of type MembershipAccountsConfigurationsUpdate that specifies the updated account configurations for the membership.
The undoMembershipCancellation parameter is a boolean flag that indicates whether to reverse a previously requested membership cancellation. When set to true, this will revoke the cancellation request and maintain the membership status.
This parameter is optional and can be used in scenarios where you need to restore a membership that was marked for cancellation but hasn't been fully terminated yet.
If set to true, the cancellation request will be revoked
If set to false the service will throw a ValidationException.
Updates the resolver type for a case.
This is a one-way action and cannot be reversed.
Required element for UpdateResolverType to identify the case to update.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateResolverType.html#securityir-UpdateResolverType-request-uri-caseId" }, "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "resolverType": { "target": "com.amazonaws.securityir#ResolverType", "traits": { "smithy.api#documentation": "Required element for UpdateResolverType to identify the new resolver.
", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateResolverType.html#securityir-UpdateResolverType-request-resolverType" }, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.securityir#UpdateResolverTypeResponse": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.securityir#CaseId", "traits": { "smithy.api#documentation": "Response element for UpdateResolver identifying the case ID being updated.
", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateResolverType.html#securityir-UpdateResolverType-response-caseId" }, "smithy.api#required": {} } }, "caseStatus": { "target": "com.amazonaws.securityir#CaseStatus", "traits": { "smithy.api#documentation": "Response element for UpdateResolver identifying the current status of the case.
", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateResolverType.html#securityir-UpdateResolverType-response-caseStatus" } } }, "resolverType": { "target": "com.amazonaws.securityir#ResolverType", "traits": { "smithy.api#documentation": "Response element for UpdateResolver identifying the current resolver of the case.
", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateResolverType.html#securityir-UpdateResolverType-response-resolverType" } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.securityir#Url": { "type": "string", "traits": { "smithy.api#pattern": "^https?://(?:www.)?[a-zA-Z0-9@:._+~#=-]{2,256}\\.[a-z]{2,6}\\b(?:[-a-zA-Z0-9@:%_+.~#?&/=]{0,2048})$", "smithy.api#sensitive": {} } }, "com.amazonaws.securityir#UsefulnessRating": { "type": "enum", "members": { "USEFUL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USEFUL" } }, "NOT_USEFUL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_USEFUL" } } } }, "com.amazonaws.securityir#UserAgent": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.securityir#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The exception message.
", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.securityir#ValidationExceptionReason", "traits": { "smithy.api#documentation": "The reason for the exception.
", "smithy.api#required": {} } }, "fieldList": { "target": "com.amazonaws.securityir#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "The fields which lead to the exception.
" } } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.securityir#ValidationExceptionField": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.securityir#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.securityir#ValidationExceptionField" } }, "com.amazonaws.securityir#ValidationExceptionReason": { "type": "enum", "members": { "UNKNOWN_OPERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN_OPERATION" } }, "CANNOT_PARSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANNOT_PARSE" } }, "FIELD_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FIELD_VALIDATION_FAILED" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } } } }, "com.amazonaws.securityir#Watcher": { "type": "structure", "members": { "email": { "target": "com.amazonaws.securityir#EmailAddress", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_Watcher.html#securityir-Type-Watcher-email" }, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.securityir#PersonName", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_Watcher.html#securityir-Type-Watcher-name" } } }, "jobTitle": { "target": "com.amazonaws.securityir#JobTitle", "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_Watcher.html#securityir-Type-Watcher-jobTitle" } } } }, "traits": { "smithy.api#documentation": "", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_Watcher.html" } } }, "com.amazonaws.securityir#Watchers": { "type": "list", "member": { "target": "com.amazonaws.securityir#Watcher" }, "traits": { "smithy.api#length": { "min": 0, "max": 30 }, "smithy.api#uniqueItems": {} } } } }