DevOpsAgentService / Client / get_agent_space

get_agent_space

DevOpsAgentService.Client.get_agent_space(**kwargs)

Retrieves detailed information about a specific AgentSpace.

See also: AWS API Documentation

Request Syntax

response = client.get_agent_space(
    agentSpaceId='string'
)
Parameters:

agentSpaceId (string) –

[REQUIRED]

The unique identifier of the AgentSpace

Return type:

dict

Returns:

Response Syntax

{
    'agentSpace': {
        'name': 'string',
        'description': 'string',
        'locale': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'kmsKeyArn': 'string',
        'agentSpaceId': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    Output containing the requested AgentSpace details.

    • agentSpace (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

    • tags (dict) –

      Tags associated with the AgentSpace.

      • (string) –

        Tag key string.

        • (string) –

          Tag value string.

Exceptions

  • DevOpsAgentService.Client.exceptions.ValidationException

  • DevOpsAgentService.Client.exceptions.ContentSizeExceededException

  • DevOpsAgentService.Client.exceptions.ServiceQuotaExceededException

  • DevOpsAgentService.Client.exceptions.ConflictException

  • DevOpsAgentService.Client.exceptions.InternalServerException

  • DevOpsAgentService.Client.exceptions.AccessDeniedException

  • DevOpsAgentService.Client.exceptions.ResourceNotFoundException

  • DevOpsAgentService.Client.exceptions.ThrottlingException

  • DevOpsAgentService.Client.exceptions.InvalidParameterException