Class: Anthropic::Models::Organization::WorkspaceCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/anthropic/models/organization/workspace_create_params.rb,
sig/anthropic/models/organization/workspace_create_params.rbs

Overview

See Also:

  • Anthropic::Resources::Organization::Workspaces#create

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Anthropic

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(name:, data_residency: nil, display_color: nil, external_key_id: nil, tags: nil, request_options: {}) ⇒ void

Some parameter documentations has been truncated, see Anthropic::Models::Organization::WorkspaceCreateParams for more details.

Parameters:

  • name (String) —

    Name of the Workspace.

  • data_residency (Anthropic::Models::Organization::DataResidencyCreateConfig, nil) (defaults to: nil) —

    Data residency configuration for the workspace. If omitted, defaults to `workspa

  • display_color (String, nil) (defaults to: nil) —

    Hex color code representing the Workspace in the Anthropic Console.

  • external_key_id (String, nil) (defaults to: nil) —

    ID of the customer-managed encryption key (CMEK) configuration to use for this

  • tags (Hash{Symbol=>String}, nil) (defaults to: nil) —

    User-defined tags as string key-value pairs. Keys may not begin with anthropic

  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/anthropic/models/organization/workspace_create_params.rb', line 54

Instance Attribute Details

#data_residency ⇒ Anthropic::Models::Organization::DataResidencyCreateConfig?

Data residency configuration for the workspace. If omitted, defaults to workspace_geo: "us", allowed_inference_geos: "unrestricted", and default_inference_geo: "global".

Parameters:

  • value (Anthropic::Organization::DataResidencyCreateConfig, nil)

Returns:



23
 
# File 'lib/anthropic/models/organization/workspace_create_params.rb', line 23

optional :data_residency, -> { Anthropic::Organization::DataResidencyCreateConfig }, nil?: true

#display_color ⇒ String?

Hex color code representing the Workspace in the Anthropic Console.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


29
 
# File 'lib/anthropic/models/organization/workspace_create_params.rb', line 29

optional :display_color, String, nil?: true

#external_key_id ⇒ String?

ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the external_key_id stays the same.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


45
 
# File 'lib/anthropic/models/organization/workspace_create_params.rb', line 45

optional :external_key_id, String, nil?: true

#name ⇒ String

Name of the Workspace.

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/anthropic/models/organization/workspace_create_params.rb', line 15

required :name, String

#tags ⇒ Hash{Symbol=>String}?

User-defined tags as string key-value pairs. Keys may not begin with anthropic.

Parameters:

  • value (::Hash[Symbol, String], nil)

Returns:

  • (Hash{Symbol=>String}, nil) 


52
 
# File 'lib/anthropic/models/organization/workspace_create_params.rb', line 52

optional :tags, Anthropic::Internal::Type::HashOf[String], nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


37
 
# File 'sig/anthropic/models/organization/workspace_create_params.rbs', line 37

def to_hash: -> {