get-case¶

Description¶

Returns the attributes of a case.

Synopsis¶

  get-case
--case-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--case-id (string) [required]

Required element for GetCase to identify the requested case ID.

Constraints:

min: 10

max: 32

pattern: \d{10,32}.*

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

title -> (string)

Response element for GetCase that provides the case title.

Constraints:

min: 1

max: 300

caseArn -> (string)

Response element for GetCase that provides the case ARN

Constraints:

min: 12

max: 80

pattern: arn:aws:security-ir:\w+?-\w+?-\d+:[0-9]{12}:case/[0-9]{10}

description -> (string)

Response element for GetCase that provides contents of the case description.

Constraints:

min: 1

max: 8000

caseStatus -> (string)

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

Possible values:

Submitted

Acknowledged

Detection and Analysis

Containment, Eradication and Recovery

Post-incident Activities

Ready to Close

Closed

engagementType -> (string)

Response element for GetCase that provides the engagement type. Options for engagement type include Active Security Event | Investigations

Possible values:

Security Incident

Investigation

reportedIncidentStartDate -> (timestamp)

Response element for GetCase that provides the customer provided incident start date.

actualIncidentStartDate -> (timestamp)

Response element for GetCase that provides the actual incident start date as identified by data analysis during the investigation.

impactedAwsRegions -> (list)

Response element for GetCase that provides the impacted regions.

Constraints:

min: 0

max: 50

(structure)

region -> (string) [required]

Possible values:

af-south-1

ap-east-1

ap-east-2

ap-northeast-1

ap-northeast-2

ap-northeast-3

ap-south-1

ap-south-2

ap-southeast-1

ap-southeast-2

ap-southeast-3

ap-southeast-4

ap-southeast-5

ap-southeast-7

ca-central-1

ca-west-1

cn-north-1

cn-northwest-1

eu-central-1

eu-central-2

eu-north-1

eu-south-1

eu-south-2

eu-west-1

eu-west-2

eu-west-3

il-central-1

me-central-1

me-south-1

mx-central-1

sa-east-1

us-east-1

us-east-2

us-west-1

us-west-2

threatActorIpAddresses -> (list)

Response element for GetCase that provides a list of suspicious IP addresses associated with unauthorized activity.

Constraints:

min: 0

max: 200

(structure)

ipAddress -> (string) [required]

Constraints:

pattern: (?:(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[A-F0-9]{1,4}:){7}[A-F0-9]{1,4})|(?:(?:[A-F0-9]{1,4}:){6}(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))

userAgent -> (string)

Constraints:

min: 1

max: 500

pendingAction -> (string)

Response element for GetCase that identifies the case is waiting on customer input.

Possible values:

Customer

None

impactedAccounts -> (list)

Response element for GetCase that provides a list of impacted accounts.

Constraints:

min: 0

max: 200

(string)

Constraints:

min: 12

max: 12

pattern: [0-9]{12}

watchers -> (list)

Response element for GetCase that provides a list of Watchers added to the case.

Constraints:

min: 0

max: 30

(structure)

email -> (string) [required]

Constraints:

min: 6

max: 254

pattern: [a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*

name -> (string)

Constraints:

min: 1

max: 50

jobTitle -> (string)

Constraints:

min: 1

max: 50

createdDate -> (timestamp)

Response element for GetCase that provides the date the case was created.

lastUpdatedDate -> (timestamp)

Response element for GetCase that provides the date a case was last modified.

closureCode -> (string)

Response element for GetCase that provides the summary code for why a case was closed.

Possible values:

Investigation Completed

Not Resolved

False Positive

Duplicate

resolverType -> (string)

Response element for GetCase that provides the current resolver types.

Possible values:

AWS

Self

impactedServices -> (list)

Response element for GetCase that provides a list of impacted services.

Constraints:

min: 0

max: 600

(string)

Constraints:

min: 2

max: 50

pattern: [a-zA-Z0-9 -.():]+

caseAttachments -> (list)

Response element for GetCase that provides a list of current case attachments.

Constraints:

min: 0

max: 50

(structure)

attachmentId -> (string) [required]

Constraints:

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}

fileName -> (string) [required]

Constraints:

min: 1

max: 255

pattern: [a-zA-Z0-9._-]+

attachmentStatus -> (string) [required]

Possible values:

Verified

Failed

Pending

creator -> (string) [required]

Constraints:

pattern: .*((^AWS Responder)|(^\d{12}$)|(^security-ir.amazonaws.com)).*

createdDate -> (timestamp) [required]

closedDate -> (timestamp)

Response element for GetCase that provides the date a specified case was closed.

Table of Contents

Feedback

User Guide