AWS CLI Command Reference

[ aws . ssm-incidents ]

batch-get-incident-findings

Description

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

See also: AWS API Documentation

Synopsis

  batch-get-incident-findings
--finding-ids <value>
--incident-record-arn <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

--finding-ids (list)

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

(string)

Syntax:

"string" "string" ...

--incident-record-arn (string)

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

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

errors -> (list)

A list of errors encountered during the operation.

(structure)

Details about an error returned for a BatchGetIncidentFindings operation.

code -> (string)

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

findingId -> (string)

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

message -> (string)

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

findings -> (list)

Information about the requested findings.

(structure)

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

creationTime -> (timestamp)

The timestamp for when a finding was created.

details -> (tagged union structure)

Details about the finding.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: cloudFormationStackUpdate, codeDeployDeployment.

cloudFormationStackUpdate -> (structure)

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

endTime -> (timestamp)

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

stackArn -> (string)

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

startTime -> (timestamp)

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

codeDeployDeployment -> (structure)

Information about the CodeDeploy deployment associated with the finding.

deploymentGroupArn -> (string)

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

deploymentId -> (string)

The ID of the CodeDeploy deployment.

endTime -> (timestamp)

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

startTime -> (timestamp)

The timestamp for when the CodeDeploy deployment began.

id -> (string)

The ID assigned to the finding.

lastModifiedTime -> (timestamp)

The timestamp for when the finding was most recently updated with additional information.
© Copyright 2018, Amazon Web Services. Created using Sphinx.