AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . security-ir ]

get-case

Description

Grant permission to view a designated case.

See also: AWS API Documentation

Synopsis

  get-case
--case-id <value>
[--cli-input-json <value>]
[--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>]

Options

--case-id (string)

Required element for GetCase to identify the requested case ID.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

Output

title -> (string)

Response element for GetCase that provides the case title.

caseArn -> (string)

Response element for GetCase that provides the case ARN

description -> (string)

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

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

engagementType -> (string)

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

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.

(structure)

region -> (string)

threatActorIpAddresses -> (list)

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

(structure)

ipAddress -> (string)

userAgent -> (string)

pendingAction -> (string)

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

impactedAccounts -> (list)

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

(string)

watchers -> (list)

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

(structure)

email -> (string)

name -> (string)

jobTitle -> (string)

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.

resolverType -> (string)

Response element for GetCase that provides the current resolver types. Options include self-supported | AWS-supported .

impactedServices -> (list)

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

(string)

caseAttachments -> (list)

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

(structure)

attachmentId -> (string)

fileName -> (string)

attachmentStatus -> (string)

creator -> (string)

createdDate -> (timestamp)

closedDate -> (timestamp)

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