CloudWatch Omni

{'agentCoreEvaluationRoleArn': 'string'}

Updates a space.

Only the provided fields are changed; omitted fields are left unchanged.

See also: AWS API Documentation

Request Syntax

client.update_space(
    spaceId='string',
    name='string',
    agentCoreEvaluationRoleArn='string',
    encryptionConfiguration={
        'encryptionStrategy': 'AWS_OWNED'|'CUSTOMER_MANAGED',
        'kmsKeyArn': 'string'
    }
)

type spaceId:

string

param spaceId:

[REQUIRED]

The unique ID of the space to update.

type name:

string

param name:

A new name for the space. Omit to leave unchanged. Must be 3-64 characters: lowercase letters, numbers, and hyphens. It must begin and end with a letter or number and cannot contain consecutive hyphens.

type agentCoreEvaluationRoleArn:

string

param agentCoreEvaluationRoleArn:

The ARN of the IAM role used by AgentCore online evaluation. Must be in the caller's account. Omit if the space does not use AgentCore online evaluation.

type encryptionConfiguration:

dict

param encryptionConfiguration:

How to encrypt the space's data at rest. Omit to leave encryption unchanged. Pass encryptionStrategy AWS_OWNED to stop using a customer managed key and revert to service owned encryption.

• encryptionStrategy (string) -- [REQUIRED]

  Which kind of key to use. Required.

• kmsKeyArn (string) --

  Customer managed KMS key ARN. Required when encryptionStrategy is CUSTOMER_MANAGED, and must be omitted when it is AWS_OWNED. Must be a symmetric ENCRYPT_DECRYPT key in the caller's account and region.

rtype:

dict

returns:

Response Syntax

{
    'space': {
        'spaceId': 'string',
        'name': 'string',
        'spaceArn': 'string',
        'domainArn': 'string',
        'region': 'string',
        'ownerAccountId': 'string',
        'dataAccessRoleArn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'agentCoreEvaluationRoleArn': 'string',
        'status': 'ACTIVE'|'SUSPENDED'|'MOVING',
        'statusReason': 'string',
        'encryptionConfiguration': {
            'encryptionStrategy': 'AWS_OWNED'|'CUSTOMER_MANAGED',
            'kmsKeyArn': 'string'
        }
    }
}

Response Structure

• (dict) --

  • space (dict) --

    The updated details of the space.

    • spaceId (string) --

      The unique ID of the space.

    • name (string) --

      A name that identifies the space.

    • spaceArn (string) --

      The Amazon Resource Name (ARN) of the space.

    • domainArn (string) --

      The Amazon Resource Name (ARN) of the domain the space belongs to. Absent when the space is not associated with a domain, so callers must tolerate its absence.

    • region (string) --

      The region where this space was created.

    • ownerAccountId (string) --

      AWS account ID that owns this space.

    • dataAccessRoleArn (string) --

      The ARN of the IAM role used for data access.

    • createdAt (datetime) --

      The timestamp when the space was created.

    • updatedAt (datetime) --

      The timestamp when the space was last updated.

    • agentCoreEvaluationRoleArn (string) --

      The ARN of the IAM role used by AgentCore online evaluation. Absent when the space was created without one.

    • status (string) --

      The status of the space.

    • statusReason (string) --

      Reason for the current space status.

    • encryptionConfiguration (dict) --

      How the space's data at rest is encrypted. Always populated: a space with no customer managed key reports encryptionStrategy AWS_OWNED and no kmsKeyArn.

      • encryptionStrategy (string) --

        Which kind of key to use. Required.

      • kmsKeyArn (string) --

        Customer managed KMS key ARN. Required when encryptionStrategy is CUSTOMER_MANAGED, and must be omitted when it is AWS_OWNED. Must be a symmetric ENCRYPT_DECRYPT key in the caller's account and region.