GetProfileObjectTypeTemplate - Amazon Connect Customer Profiles

GetProfileObjectTypeTemplate

Returns the template information for a specific object type.

A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.

Request Syntax

GET /templates/TemplateId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

TemplateId

A unique identifier for the object template.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AllowProfileCreation": boolean, "Fields": { "string" : { "ContentType": "string", "Source": "string", "Target": "string" } }, "Keys": { "string" : [ { "FieldNames": [ "string" ], "StandardIdentifiers": [ "string" ] } ] }, "SourceName": "string", "SourceObject": "string", "TemplateId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AllowProfileCreation

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

Type: Boolean

Fields

A map of the name and ObjectType field.

Type: String to ObjectTypeField object map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: ^[a-zA-Z0-9_-]+$

Keys

A list of unique keys that can be used to map data to the profile.

Type: String to array of ObjectTypeKey objects map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: ^[a-zA-Z0-9_-]+$

SourceName

The name of the source of the object template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

SourceObject

The source of the object template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

TemplateId

A unique identifier for the object template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429

Examples

Example

This example illustrates one usage of GetProfileObjectTypeTemplate.

Sample Request

GET /templates/{TemplateId} HTTP/1.1

Sample Response

Content-type: application/json { "AllowProfileCreätion": "FALSE", "Fields": { "email" : { "ContentType": "EMAIL_ADDRESS", "Source": "_source.email", "Target": "_profile.BusinessEmailAddress" }, "phone" : { "ContentType": "PHONE_NUMBER", "Source": "_source.phone", "Target": "_profile.Businessphonenumber" } }, "Keys": { "_email" : [ { "FieldNames": [ "email" ], "StandardIdentifiers": [ "PROFILE", "UNIQUE" ] } ] }, "SourceName": "Saleforce-Account", "SourceObject": "Account", "TemplateId": "Saleforce-Account" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: