SecurityAgent / Paginator / ListActorMessages

ListActorMessages

class SecurityAgent.Paginator.ListActorMessages

paginator = client.get_paginator('list_actor_messages')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SecurityAgent.Client.list_actor_messages().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    agentSpaceId='string',
    pentestId='string',
    actorIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• agentSpaceId (string) –

  [REQUIRED]

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

• pentestId (string) –

  [REQUIRED]

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

• actorIdentifier (string) –

  [REQUIRED]

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

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