

Amazon Cloud Directory is no longer be open to new customers. For alternatives to Cloud Directory, explore [Amazon DynamoDB](https://aws.amazon.com/dynamodb/) and [Amazon Neptune](https://aws.amazon.com/neptune/). If you need help choosing the right alternative for your use case, or for any other questions, contact [AWS Support](https://aws.amazon.com/support/). 

# Sample Schemas
<a name="schemas_sampleschemastopic"></a>

Cloud Directory comes ready with sample schemas for Organizations, Persons, and Devices. The following section lists the various sample schemas and lists the differences for each.

## Organizations
<a name="schemas_organizationsschema"></a>

The following tables list the facets that are included in the *Organizations* sample schema.

 


****  

| **"Organization" Facet ** | **Data Type ** | **Length ** | **Required Behavior? ** | **Description ** | 
| --- | --- | --- | --- | --- | 
| account\$1id  | String  | 1024  | N  | Unique id for Organization  | 
| account\$1name  | String  | 1024  | N  | Name of Organization  | 
| organization\$1status  | String  | 1024  | N  | Status such as 'active', 'suspended', 'inactive', 'closed'  | 
| mailing\$1address (street1)  | String  | 1024  | N  | A physical mailing address for this company/entity  | 
| mailing\$1address (street2)  | String  | 1024  | N  | A physical mailing address for this company/entity  | 
| mailing\$1address (city)  | String  | 1024  | N  | A physical mailing address for this company/entity  | 
| mailing\$1address (state)  | String  | 1024  | N  | A physical mailing address for this company/entity  | 
| mailing\$1address (country)  | String  | 1024  | N  | A physical mailing address for this company/entity  | 
| mailing\$1address (postal\$1code)  | String  | 1024 | N  | A physical mailing address for this company/entity  | 
| email  | String  | 1024  | N  | Email id for Organization  | 
| web\$1site  | String  | 1024  | N  | Website URL  | 
| telephone\$1number  | String  | 1024  | N  | Telephone number for Organization  | 
| description  | String  | 1024  | N  | Description for Organization  | 

 


****  

| **"Legal\$1Entity" Facet ** | **Data Type** | **Length**  | **Required Behavior?**  | **Description** | 
| --- | --- | --- | --- | --- | 
| registered\$1company\$1name  | String  | 1024  | N  | Legal entity name  | 
| mailing\$1address (street1)  | String  | 1024  | N  | A physical registered address for this company/entity  | 
| mailing\$1address (street2)  | String  | 1024  | N  | A physical registered address for this company/entity  | 
| mailing\$1address (city)  | String  | 1024  | N  | A physical registered address for this company/entity  | 
| mailing\$1address (state)  | String  | 1024  | N  | A physical registered address for this company/entity  | 
| mailing\$1address (country)  | String  | 1024  | N  | A physical registered address for this company/entity  | 
| mailing\$1address (postal\$1code)  | String  | 1024  | N  | A physical registered address for this company/entity  | 
| industry\$1vertical  | String  | 1024  | N  | Industry Segment  | 
| billing\$1currency  | String  | 1024  | N  | Billing currency  | 
| tax\$1id  | String  | 1024  | N  | Tax identification number  | 

## Person
<a name="schemas_personschema"></a>

The following tables list the facets that are included in the *Person* sample schema.

 


****  

| **"Person" Facet** | **Data Type** | **Length** | **Required Behavior?** | **Description** | 
| --- | --- | --- | --- | --- | 
| display\$1name | String | 1024 | N | The name of the user, suitable for display to end-users. | 
| first\$1name | String | 1024 | N | The given name of the User, or first name in most western languages | 
| last\$1name | String | 1024 | N | The family name of the User, or last name in most western languages | 
| middle\$1name | String | 1024 | N | The middle name(s) of the User | 
| nickname | String | 1024 | N | The casual way to address the user in real life, such as, "Bob" or "Bobby" instead of "Robert" | 
| email | String | 1024 | N | Email address for the user | 
| mobile\$1phone\$1number | String | 1024 | N | Phone number for the user | 
| home\$1phone\$1number | String | 1024 | N | Phone number for the user | 
| username | String | 1024 | Y | unique identifier for the user | 
| profile | String | 1024 | N | A URI that is a uniform resource locator and that points to a location representing the user's online profile (such as a webpage) | 
| picture | String | 1024 | N | A URI that is a uniform resource locator that points to a resource location representing the user's image. | 
| website | String | 1024 | N | URL | 
| timezone | String | 1024 | N | The User's time zone | 
| locale | String | 1024 | N | Used to indicate the User's default location for purposes of localizing such items as currency, date time format, or numerical representations. | 
| address (street1) | String | 1024 | N | A physical mailing address for this user. | 
| address (street2) | String | 1024 | N | A physical mailing address for this user. | 
| address (city) | String | 1024 | N | A physical mailing address for this user. | 
| address (state) | String | 1024 | N | A physical mailing address for this user. | 
| address (country) | String | 1024 | N | A physical mailing address for this user. | 
| address (postal\$1code) | String | 1024 | N | A physical mailing address for this user. | 
| user\$1status | String | 1024 | N | Value indicating the user's administrative status | 

 


****  

| **"Organization\$1Person" Facet** | **Data Type** | **Length** | **Required Behavior?** | **Description** | 
| --- | --- | --- | --- | --- | 
| title | String | 1024 | N | Title in organization | 
| preferred\$1language | String | 1024 | N | Indicates the user's preferred written or spoken languages and is generally used for selecting a localized user interface. | 
| employee\$1id | String | 1024 | N | A string identifier, typically numeric or alphanumeric, assigned to a person | 
| cost\$1center | Integer | 1024 | N | Identifies the cost center | 
| department | String | 1024 | N | Identifies the name of a department | 
| manager  | String | 1024 | N | The user's manager | 
| company\$1name | String | 1024 | N | Identifies the name of an organization | 
| company\$1address (street1) | String | 1024 | N | A physical mailing address for the organization | 
| company\$1address (street2) | String | 1024 | N | A physical mailing address for the organization | 
| company\$1address (city) | String | 1024 | N | A physical mailing address for the organization | 
| company\$1address (state) | String | 1024 | N | A physical mailing address for the organization | 
| company\$1address (country) | String | 1024 | N | A physical mailing address for the organization | 
| company\$1address (postalCode) | String | 1024 | N | A physical mailing address for the organization | 

## Device
<a name="schemas_deviceschema"></a>

The following table lists the facet that is included in the *Device* sample schema.

 


****  

| **"Device" Facet** | **Data Type** | **Length** | **Required Behavior?** | **Description** | 
| --- | --- | --- | --- | --- | 
| device\$1id | String | 1024 | N | Alpha-numeric unique device id | 
| name | String | 1024 | N | Friendly name for device | 
| description  | String | 1024 | N | Description for device  | 
| X.509\$1certificates | String | 1024 | N | X.509 Certificate | 
| device\$1version | String | 1024 | N | Device version  | 
| device\$1os\$1type | String | 1024 | N | Operating System on device | 
| device\$1os\$1version | String | 1024 | N | Operating System version number on device | 
| serial\$1number | String | 1024 | N | Serial number of device | 
| device\$1status | String | 1024 | N | Status for device (such as active, not\$1active, suspended, shutdown, off) | 