AWS Security Agent

Returns a paginated list of the email MFA messages received for an actor at its server-generated email address, most recent first.

See also: AWS API Documentation

Request Syntax

client.list_actor_messages(
    maxResults=123,
    nextToken='string',
    agentSpaceId='string',
    pentestId='string',
    actorIdentifier='string'
)

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type nextToken:

string

param nextToken:

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

The unique identifier of the agent space that owns the pentest.

type pentestId:

string

param pentestId:

[REQUIRED]

The unique identifier of the pentest that the actor belongs to.

type actorIdentifier:

string

param actorIdentifier:

[REQUIRED]

The identifier of the actor whose messages to list. The identifier is case-insensitive.

rtype:

dict

returns:

Response Syntax

{
    'messages': [
        {
            'sender': 'string',
            'subject': 'string',
            'body': 'string',
            'receivedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • messages (list) --

    The list of messages received for the actor, most recent first.

    • (dict) --

      A message received at an actor's server-generated email MFA address.

      • sender (string) --

        The address the message was sent from.

      • subject (string) --

        The subject line of the message.

      • body (string) --

        The plain-text body of the message, containing the MFA code or verification link.

      • receivedAt (datetime) --

        The time the message was received.

  • nextToken (string) --

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.