awscc.customerprofiles_objecttype

Filters

  • event

  • reduce

  • value

Actions

delete

Parent base class for filters and actions.

properties:
  type:
    enum:
    - delete
required:
- type

Permissions - profile:DeleteProfileObjectType

update

Parent base class for filters and actions.

definitions:
  FieldMap:
    additionalProperties: false
    properties:
      Name:
        maxLength: 64
        minLength: 1
        pattern: ^[a-zA-Z0-9_-]+$
        type: string
      ObjectTypeField:
        additionalProperties: false
        description: Represents a field in a ProfileObjectType.
        properties:
          ContentType:
            description: The content type of the field. Used for determining equality
              when searching.
            enum:
            - STRING
            - NUMBER
            - PHONE_NUMBER
            - EMAIL_ADDRESS
            - NAME
            type: string
          Source:
            description: 'A field of a ProfileObject. For example: _source.FirstName,
              where "_source" is a ProfileObjectType of a Zendesk user and "FirstName"
              is a field in that ObjectType.'
            maxLength: 1000
            minLength: 1
            type: string
          Target:
            description: 'The location of the data in the standard ProfileObject model.
              For example: _profile.Address.PostalCode.'
            maxLength: 1000
            minLength: 1
            type: string
        type: object
    type: object
  KeyMap:
    additionalProperties: false
    properties:
      Name:
        maxLength: 64
        minLength: 1
        pattern: ^[a-zA-Z0-9_-]+$
        type: string
      ObjectTypeKeyList:
        insertionOrder: false
        items:
          additionalProperties: false
          description: An object that defines the Key element of a ProfileObject.
            A Key is a special element that can be used to search for a customer profile.
          properties:
            FieldNames:
              description: 'The reference for the key name of the fields map. '
              items:
                maxLength: 64
                minLength: 1
                pattern: ^[a-zA-Z0-9_-]+$
                type: string
              type: array
            StandardIdentifiers:
              description: The types of keys that a ProfileObject can have. Each ProfileObject
                can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means
                that this key can be used to tie an object to a PROFILE. UNIQUE means
                that it can be used to uniquely identify an object. If a key a is
                marked as SECONDARY, it will be used to search for profiles after
                all other PROFILE keys have been searched. A LOOKUP_ONLY key is only
                used to match a profile but is not persisted to be used for searching
                of the profile. A NEW_ONLY key is only used if the profile does not
                already exist before the object is ingested, otherwise it is only
                used for matching objects to profiles.
              items:
                enum:
                - PROFILE
                - UNIQUE
                - SECONDARY
                - LOOKUP_ONLY
                - NEW_ONLY
                type: string
              type: array
          type: object
        type: array
    type: object
  ObjectTypeField:
    additionalProperties: false
    description: Represents a field in a ProfileObjectType.
    properties:
      ContentType:
        description: The content type of the field. Used for determining equality
          when searching.
        enum:
        - STRING
        - NUMBER
        - PHONE_NUMBER
        - EMAIL_ADDRESS
        - NAME
        type: string
      Source:
        description: 'A field of a ProfileObject. For example: _source.FirstName,
          where "_source" is a ProfileObjectType of a Zendesk user and "FirstName"
          is a field in that ObjectType.'
        maxLength: 1000
        minLength: 1
        type: string
      Target:
        description: 'The location of the data in the standard ProfileObject model.
          For example: _profile.Address.PostalCode.'
        maxLength: 1000
        minLength: 1
        type: string
    type: object
  ObjectTypeKey:
    additionalProperties: false
    description: An object that defines the Key element of a ProfileObject. A Key
      is a special element that can be used to search for a customer profile.
    properties:
      FieldNames:
        description: 'The reference for the key name of the fields map. '
        items:
          maxLength: 64
          minLength: 1
          pattern: ^[a-zA-Z0-9_-]+$
          type: string
        type: array
      StandardIdentifiers:
        description: The types of keys that a ProfileObject can have. Each ProfileObject
          can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that
          this key can be used to tie an object to a PROFILE. UNIQUE means that it
          can be used to uniquely identify an object. If a key a is marked as SECONDARY,
          it will be used to search for profiles after all other PROFILE keys have
          been searched. A LOOKUP_ONLY key is only used to match a profile but is
          not persisted to be used for searching of the profile. A NEW_ONLY key is
          only used if the profile does not already exist before the object is ingested,
          otherwise it is only used for matching objects to profiles.
        items:
          enum:
          - PROFILE
          - UNIQUE
          - SECONDARY
          - LOOKUP_ONLY
          - NEW_ONLY
          type: string
        type: array
    type: object
  Tag:
    additionalProperties: false
    properties:
      Key:
        maxLength: 128
        minLength: 1
        pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
        type: string
      Value:
        maxLength: 256
        minLength: 0
        type: string
    required:
    - Key
    - Value
    type: object
properties:
  AllowProfileCreation:
    description: Indicates whether a profile should be created when data is received.
    type: boolean
  Description:
    description: Description of the profile object type.
    maxLength: 1000
    minLength: 1
    type: string
  EncryptionKey:
    description: The default encryption key
    maxLength: 255
    minLength: 0
    type: string
  ExpirationDays:
    description: The default number of days until the data within the domain expires.
    maximum: 1098
    minimum: 1
    type: integer
  Fields:
    description: A list of the name and ObjectType field.
    insertionOrder: false
    items:
      additionalProperties: false
      properties:
        Name:
          maxLength: 64
          minLength: 1
          pattern: ^[a-zA-Z0-9_-]+$
          type: string
        ObjectTypeField:
          additionalProperties: false
          description: Represents a field in a ProfileObjectType.
          properties:
            ContentType:
              description: The content type of the field. Used for determining equality
                when searching.
              enum:
              - STRING
              - NUMBER
              - PHONE_NUMBER
              - EMAIL_ADDRESS
              - NAME
              type: string
            Source:
              description: 'A field of a ProfileObject. For example: _source.FirstName,
                where "_source" is a ProfileObjectType of a Zendesk user and "FirstName"
                is a field in that ObjectType.'
              maxLength: 1000
              minLength: 1
              type: string
            Target:
              description: 'The location of the data in the standard ProfileObject
                model. For example: _profile.Address.PostalCode.'
              maxLength: 1000
              minLength: 1
              type: string
          type: object
      type: object
    type: array
  Keys:
    description: A list of unique keys that can be used to map data to the profile.
    insertionOrder: false
    items:
      additionalProperties: false
      properties:
        Name:
          maxLength: 64
          minLength: 1
          pattern: ^[a-zA-Z0-9_-]+$
          type: string
        ObjectTypeKeyList:
          insertionOrder: false
          items:
            additionalProperties: false
            description: An object that defines the Key element of a ProfileObject.
              A Key is a special element that can be used to search for a customer
              profile.
            properties:
              FieldNames:
                description: 'The reference for the key name of the fields map. '
                items:
                  maxLength: 64
                  minLength: 1
                  pattern: ^[a-zA-Z0-9_-]+$
                  type: string
                type: array
              StandardIdentifiers:
                description: The types of keys that a ProfileObject can have. Each
                  ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys.
                  PROFILE means that this key can be used to tie an object to a PROFILE.
                  UNIQUE means that it can be used to uniquely identify an object.
                  If a key a is marked as SECONDARY, it will be used to search for
                  profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY
                  key is only used to match a profile but is not persisted to be used
                  for searching of the profile. A NEW_ONLY key is only used if the
                  profile does not already exist before the object is ingested, otherwise
                  it is only used for matching objects to profiles.
                items:
                  enum:
                  - PROFILE
                  - UNIQUE
                  - SECONDARY
                  - LOOKUP_ONLY
                  - NEW_ONLY
                  type: string
                type: array
            type: object
          type: array
      type: object
    type: array
  Tags:
    description: The tags (keys and values) associated with the integration.
    items:
      additionalProperties: false
      properties:
        Key:
          maxLength: 128
          minLength: 1
          pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
          type: string
        Value:
          maxLength: 256
          minLength: 0
          type: string
      required:
      - Key
      - Value
      type: object
    maxItems: 50
    minItems: 0
    type: array
  TemplateId:
    description: A unique identifier for the object template.
    maxLength: 64
    minLength: 1
    pattern: ^[a-zA-Z0-9_-]+$
    type: string
  type:
    enum:
    - update

Permissions - profile:GetProfileObjectType, profile:PutProfileObjectType, profile:UntagResource, profile:TagResource