DevOpsAgentService / Paginator / ListAgentSpaces

ListAgentSpaces

class DevOpsAgentService.Paginator.ListAgentSpaces

paginator = client.get_paginator('list_agent_spaces')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DevOpsAgentService.Client.list_agent_spaces().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    includedData='METADATA_ONLY'|'ALL_DATA',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• includedData (string) – How much data to include in the response.

• 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

{
    'agentSpaces': [
        {
            'name': 'string',
            'description': 'string',
            'locale': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'kmsKeyArn': 'string',
            'agentSpaceId': 'string',
            'preferences': {
                'string': True|False
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Output containing a list of AgentSpaces and pagination token.

  • agentSpaces (list) –

    The list of AgentSpaces.

    • (dict) –

      Represents a complete AgentSpace with all its properties, timestamps, encryption settings, and unique identifier.

      • name (string) –

        The name of the AgentSpace.

      • description (string) –

        The description of the AgentSpace.

      • locale (string) –

        The locale for the AgentSpace, which determines the language used in agent responses.

      • createdAt (datetime) –

        The timestamp when the resource was created.

      • updatedAt (datetime) –

        The timestamp when the resource was last updated.

      • kmsKeyArn (string) –

        The ARN of the AWS Key Management Service (AWS KMS) customer managed key that’s used to encrypt resources.

      • agentSpaceId (string) –

        The unique identifier of the AgentSpace

      • preferences (dict) –

        The preferences configured on the agent space. Preferences that are not set take their default values.

        • (string) –

          The key of a preference that can be configured on an agent space. The elevatedActionsEnabled key controls whether elevated directed actions are permitted in the agent space. Elevated directed actions are mutating operations that also require per-action operator approval, and default to false when not set.

          • (boolean) –

  • NextToken (string) –

    A token to resume pagination.