ResilienceHubV2 / Client / list_system_events

list_system_events

ResilienceHubV2.Client.list_system_events(**kwargs)

Lists events for a system.

See also: AWS API Documentation

Request Syntax

response = client.list_system_events(
    systemArn='string',
    eventTypes=[
        'SYSTEM_CREATED'|'SYSTEM_DELETED'|'SYSTEM_USER_JOURNEY_CREATED'|'SYSTEM_USER_JOURNEY_UPDATED'|'SYSTEM_USER_JOURNEY_DELETED'|'SYSTEM_SERVICE_ASSOCIATED'|'SYSTEM_SERVICE_DISASSOCIATED'|'SYSTEM_POLICY_ASSOCIATED'|'SYSTEM_POLICY_DISASSOCIATED',
    ],
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    maxResults=123,
    nextToken='string'
)

Parameters:

• systemArn (string) –

  [REQUIRED]

  ARN identifier.

• eventTypes (list) –

  Filter events by type.

  • (string) –

• startTime (datetime) – The start time for filtering events.

• endTime (datetime) – The end time for filtering events.

• maxResults (integer) – Pagination page size.

• nextToken (string) – Pagination token.

Return type:

dict

Returns:

Response Syntax

{
    'events': [
        {
            'eventId': 'string',
            'timestamp': datetime(2015, 1, 1),
            'eventType': 'SYSTEM_CREATED'|'SYSTEM_DELETED'|'SYSTEM_USER_JOURNEY_CREATED'|'SYSTEM_USER_JOURNEY_UPDATED'|'SYSTEM_USER_JOURNEY_DELETED'|'SYSTEM_SERVICE_ASSOCIATED'|'SYSTEM_SERVICE_DISASSOCIATED'|'SYSTEM_POLICY_ASSOCIATED'|'SYSTEM_POLICY_DISASSOCIATED',
            'systemArn': 'string',
            'actor': {
                'type': 'USER'|'SYSTEM',
                'principalId': 'string',
                'accountId': 'string',
                'userName': 'string'
            },
            'eventDetails': {
                'title': 'string',
                'description': 'string',
                'eventMetadata': {
                    'systemCreated': {},
                    'systemDeleted': {},
                    'systemUserJourneyCreated': {
                        'userJourneyName': 'string',
                        'associatedServices': [
                            {
                                'serviceId': 'string',
                                'serviceName': 'string'
                            },
                        ]
                    },
                    'systemUserJourneyUpdated': {
                        'userJourneyName': 'string',
                        'changes': {
                            'journeyDescription': {
                                'oldValue': 'string',
                                'newValue': 'string'
                            },
                            'associatedServices': {
                                'added': [
                                    {
                                        'serviceId': 'string',
                                        'serviceName': 'string'
                                    },
                                ],
                                'removed': [
                                    {
                                        'serviceId': 'string',
                                        'serviceName': 'string'
                                    },
                                ]
                            }
                        }
                    },
                    'systemUserJourneyDeleted': {
                        'userJourneyName': 'string',
                        'associatedServicesAtDeletion': [
                            {
                                'serviceId': 'string',
                                'serviceName': 'string'
                            },
                        ]
                    },
                    'systemServiceAssociated': {
                        'serviceName': 'string',
                        'serviceArn': 'string',
                        'userJourneys': [
                            'string',
                        ]
                    },
                    'systemServiceDisassociated': {
                        'serviceName': 'string',
                        'serviceArn': 'string',
                        'userJourneysAffected': [
                            'string',
                        ],
                        'comment': 'string'
                    },
                    'systemPolicyAssociated': {
                        'policyName': 'string',
                        'policyArn': 'string'
                    },
                    'systemPolicyDisassociated': {
                        'policyName': 'string',
                        'policyArn': 'string'
                    }
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • events (list) –

    The list of system events.

    • (dict) –

      Represents an event in the system event log.

      • eventId (string) –

        The unique identifier of the event.

      • timestamp (datetime) –

        The timestamp of the event.

      • eventType (string) –

        The type of the event.

      • systemArn (string) –

        ARN identifier.

      • actor (dict) –

        The actor that triggered the event.

        • type (string) –

          The type of actor, either USER or SYSTEM.

        • principalId (string) –

          The principal ID of the actor.

        • accountId (string) –

          The AWS account ID of the actor.

        • userName (string) –

          The user name of the actor.

      • eventDetails (dict) –

        The details of the event.

        • title (string) –

          The title of the event.

        • description (string) –

          The description of the event.

        • eventMetadata (dict) –

          Type-specific metadata for each system event type.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: systemCreated, systemDeleted, systemUserJourneyCreated, systemUserJourneyUpdated, systemUserJourneyDeleted, systemServiceAssociated, systemServiceDisassociated, systemPolicyAssociated, systemPolicyDisassociated. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          

          • systemCreated (dict) –

            Metadata for a system created event.

          • systemDeleted (dict) –

            Metadata for a system deleted event.

          • systemUserJourneyCreated (dict) –

            Metadata for a system user journey created event.

            • userJourneyName (string) –

              The name of the created user journey.

            • associatedServices (list) –

              The services associated with the created user journey.

              • (dict) –

                A reference to a service by ID and name.

                • serviceId (string) –

                  The identifier of the referenced service.

                • serviceName (string) –

                  The name of the referenced service.

          • systemUserJourneyUpdated (dict) –

            Metadata for a system user journey updated event.

            • userJourneyName (string) –

              The name of the updated user journey.

            • changes (dict) –

              The changes made to the user journey.

              • journeyDescription (dict) –

                Changes to the user journey description.

                • oldValue (string) –

                  The old value.

                • newValue (string) –

                  The new value.

              • associatedServices (dict) –

                Changes to the services associated with the user journey.

                • added (list) –

                  The list of service references that were added.

                  • (dict) –

                    A reference to a service by ID and name.

                    • serviceId (string) –

                      The identifier of the referenced service.

                    • serviceName (string) –

                      The name of the referenced service.

                • removed (list) –

                  The list of service references that were removed.

                  • (dict) –

                    A reference to a service by ID and name.

                    • serviceId (string) –

                      The identifier of the referenced service.

                    • serviceName (string) –

                      The name of the referenced service.

          • systemUserJourneyDeleted (dict) –

            Metadata for a system user journey deleted event.

            • userJourneyName (string) –

              The name of the deleted user journey.

            • associatedServicesAtDeletion (list) –

              The services that were associated at the time of deletion.

              • (dict) –

                A reference to a service by ID and name.

                • serviceId (string) –

                  The identifier of the referenced service.

                • serviceName (string) –

                  The name of the referenced service.

          • systemServiceAssociated (dict) –

            Metadata for a system service associated event.

            • serviceName (string) –

              The name of the associated service.

            • serviceArn (string) –

              ARN identifier.

            • userJourneys (list) –

              The user journeys linking the service to the system.

              • (string) –

          • systemServiceDisassociated (dict) –

            Metadata for a system service disassociated event.

            • serviceName (string) –

              The name of the disassociated service.

            • serviceArn (string) –

              ARN identifier.

            • userJourneysAffected (list) –

              The user journeys affected by the disassociation.

              • (string) –

            • comment (string) –

              A comment about the disassociation.

          • systemPolicyAssociated (dict) –

            Metadata for a system policy associated event.

            • policyName (string) –

              The name of the associated policy.

            • policyArn (string) –

              ARN identifier.

          • systemPolicyDisassociated (dict) –

            Metadata for a system policy disassociated event.

            • policyName (string) –

              The name of the disassociated policy.

            • policyArn (string) –

              ARN identifier.

  • nextToken (string) –

    Pagination token.

Exceptions

• ResilienceHubV2.Client.exceptions.InternalServerException

• ResilienceHubV2.Client.exceptions.ResourceNotFoundException

• ResilienceHubV2.Client.exceptions.ValidationException

• ResilienceHubV2.Client.exceptions.AccessDeniedException