AWS Systems Manager Incident Manager

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

Request Syntax

client.batch_get_incident_findings(
    findingIds=[
        'string',
    ],
    incidentRecordArn='string'
)

type findingIds:

list

param findingIds:

[REQUIRED]

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

• (string) --

type incidentRecordArn:

string

param incidentRecordArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'errors': [
        {
            'code': 'string',
            'findingId': 'string',
            'message': 'string'
        },
    ],
    'findings': [
        {
            'creationTime': datetime(2015, 1, 1),
            'details': {
                'cloudFormationStackUpdate': {
                    'endTime': datetime(2015, 1, 1),
                    'stackArn': 'string',
                    'startTime': datetime(2015, 1, 1)
                },
                'codeDeployDeployment': {
                    'deploymentGroupArn': 'string',
                    'deploymentId': 'string',
                    'endTime': datetime(2015, 1, 1),
                    'startTime': datetime(2015, 1, 1)
                }
            },
            'id': 'string',
            'lastModifiedTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) --

  • errors (list) --

    A list of errors encountered during the operation.

    • (dict) --

      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.

    • (dict) --

      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 (datetime) --

        The timestamp for when a finding was created.

      • details (dict) --

        Details about the finding.

        • cloudFormationStackUpdate (dict) --

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

          • endTime (datetime) --

            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 (datetime) --

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

        • codeDeployDeployment (dict) --

          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 (datetime) --

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

          • startTime (datetime) --

            The timestamp for when the CodeDeploy deployment began.

      • id (string) --

        The ID assigned to the finding.

      • lastModifiedTime (datetime) --

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

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

See also: AWS API Documentation

Request Syntax

client.list_incident_findings(
    incidentRecordArn='string',
    maxResults=123,
    nextToken='string'
)

type incidentRecordArn:

string

param incidentRecordArn:

[REQUIRED]

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

type maxResults:

integer

param maxResults:

The maximum number of findings to retrieve per call.

type nextToken:

string

param nextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'findings': [
        {
            'id': 'string',
            'lastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • findings (list) --

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

    • (dict) --

      Identifying information about the finding.

      • id (string) --

        The ID of the finding.

      • lastModifiedTime (datetime) --

        The timestamp for when the finding was last updated.

  • nextToken (string) --

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