DevOpsAgentService / Client / list_agent_spaces

list_agent_spaces

DevOpsAgentService.Client.list_agent_spaces(**kwargs)

Lists all AgentSpaces with optional pagination.

See also: AWS API Documentation

Request Syntax

response = client.list_agent_spaces(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • maxResults (integer) – Maximum number of results to return in a single call.

  • nextToken (string) – Token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    '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
            }
        },
    ]
}

Response Structure

  • (dict) –

    Output containing a list of AgentSpaces and pagination token.

    • nextToken (string) –

      Token to retrieve the next page of results, if there are more results.

    • 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) –

Exceptions