Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string
}

    You do not have sufficient access to perform this action.

    func (*AccessDeniedException) Error

    func (e *AccessDeniedException) Error() string

    func (*AccessDeniedException) ErrorCode

    func (e *AccessDeniedException) ErrorCode() string

    func (*AccessDeniedException) ErrorFault

    func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

    func (*AccessDeniedException) ErrorMessage

    func (e *AccessDeniedException) ErrorMessage() string

    type Address

    type Address struct {
    
    	// The first line of a customer address.
    	Address1 *string
    
    	// The second line of a customer address.
    	Address2 *string
    
    	// The third line of a customer address.
    	Address3 *string
    
    	// The fourth line of a customer address.
    	Address4 *string
    
    	// The city in which a customer lives.
    	City *string
    
    	// The country in which a customer lives.
    	Country *string
    
    	// The county in which a customer lives.
    	County *string
    
    	// The postal code of a customer address.
    	PostalCode *string
    
    	// The province in which a customer lives.
    	Province *string
    
    	// The state in which a customer lives.
    	State *string
    }

      A generic address associated with the customer that is not mailing, shipping, or billing.

      type BadRequestException

      type BadRequestException struct {
      	Message *string
      }

        The input you provided is invalid.

        func (*BadRequestException) Error

        func (e *BadRequestException) Error() string

        func (*BadRequestException) ErrorCode

        func (e *BadRequestException) ErrorCode() string

        func (*BadRequestException) ErrorFault

        func (e *BadRequestException) ErrorFault() smithy.ErrorFault

        func (*BadRequestException) ErrorMessage

        func (e *BadRequestException) ErrorMessage() string

        type DomainStats

        type DomainStats struct {
        
        	// The number of profiles that you are currently paying for in the domain. If you
        	// have more than 100 objects associated with a single profile, that profile counts
        	// as two profiles. If you have more than 200 objects, that profile counts as
        	// three, and so on.
        	MeteringProfileCount int64
        
        	// The total number of objects in domain.
        	ObjectCount int64
        
        	// The total number of profiles currently in the domain.
        	ProfileCount int64
        
        	// The total size, in bytes, of all objects in the domain.
        	TotalSize int64
        }

          Usage-specific statistics about the domain.

          type FieldContentType

          type FieldContentType string
          const (
          	FieldContentTypeString       FieldContentType = "STRING"
          	FieldContentTypeNumber       FieldContentType = "NUMBER"
          	FieldContentTypePhoneNumber  FieldContentType = "PHONE_NUMBER"
          	FieldContentTypeEmailAddress FieldContentType = "EMAIL_ADDRESS"
          	FieldContentTypeName         FieldContentType = "NAME"
          )

            Enum values for FieldContentType

            func (FieldContentType) Values

              Values returns all known values for FieldContentType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

              type Gender

              type Gender string
              const (
              	GenderMale        Gender = "MALE"
              	GenderFemale      Gender = "FEMALE"
              	GenderUnspecified Gender = "UNSPECIFIED"
              )

                Enum values for Gender

                func (Gender) Values

                func (Gender) Values() []Gender

                  Values returns all known values for Gender. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                  type InternalServerException

                  type InternalServerException struct {
                  	Message *string
                  }

                    An internal service error occurred.

                    func (*InternalServerException) Error

                    func (e *InternalServerException) Error() string

                    func (*InternalServerException) ErrorCode

                    func (e *InternalServerException) ErrorCode() string

                    func (*InternalServerException) ErrorFault

                    func (e *InternalServerException) ErrorFault() smithy.ErrorFault

                    func (*InternalServerException) ErrorMessage

                    func (e *InternalServerException) ErrorMessage() string

                    type ListDomainItem

                    type ListDomainItem struct {
                    
                    	// The timestamp of when the domain was created.
                    	//
                    	// This member is required.
                    	CreatedAt *time.Time
                    
                    	// The unique name of the domain.
                    	//
                    	// This member is required.
                    	DomainName *string
                    
                    	// The timestamp of when the domain was most recently edited.
                    	//
                    	// This member is required.
                    	LastUpdatedAt *time.Time
                    
                    	// The tags used to organize, track, or control access for this resource.
                    	Tags map[string]string
                    }

                      An object in a list that represents a domain.

                      type ListIntegrationItem

                      type ListIntegrationItem struct {
                      
                      	// The timestamp of when the domain was created.
                      	//
                      	// This member is required.
                      	CreatedAt *time.Time
                      
                      	// The unique name of the domain.
                      	//
                      	// This member is required.
                      	DomainName *string
                      
                      	// The timestamp of when the domain was most recently edited.
                      	//
                      	// This member is required.
                      	LastUpdatedAt *time.Time
                      
                      	// The name of the profile object type.
                      	//
                      	// This member is required.
                      	ObjectTypeName *string
                      
                      	// The URI of the S3 bucket or any other type of data source.
                      	//
                      	// This member is required.
                      	Uri *string
                      
                      	// The tags used to organize, track, or control access for this resource.
                      	Tags map[string]string
                      }

                        An integration in list of integrations.

                        type ListProfileObjectTypeItem

                        type ListProfileObjectTypeItem struct {
                        
                        	// Description of the profile object type.
                        	//
                        	// This member is required.
                        	Description *string
                        
                        	// The name of the profile object type.
                        	//
                        	// This member is required.
                        	ObjectTypeName *string
                        
                        	// The timestamp of when the domain was created.
                        	CreatedAt *time.Time
                        
                        	// The timestamp of when the domain was most recently edited.
                        	LastUpdatedAt *time.Time
                        
                        	// The tags used to organize, track, or control access for this resource.
                        	Tags map[string]string
                        }

                          A ProfileObjectType instance.

                          type ListProfileObjectTypeTemplateItem

                          type ListProfileObjectTypeTemplateItem struct {
                          
                          	// The name of the source of the object template.
                          	SourceName *string
                          
                          	// The source of the object template.
                          	SourceObject *string
                          
                          	// A unique identifier for the object template.
                          	TemplateId *string
                          }

                            A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.

                            type ListProfileObjectsItem

                            type ListProfileObjectsItem struct {
                            
                            	// A JSON representation of a ProfileObject that belongs to a profile.
                            	Object *string
                            
                            	// Specifies the kind of object being added to a profile, such as
                            	// "Salesforce-Account."
                            	ObjectTypeName *string
                            
                            	// The unique identifier of the ProfileObject generated by the service.
                            	ProfileObjectUniqueKey *string
                            }

                              A ProfileObject in a list of ProfileObjects.

                              type ObjectTypeField

                              type ObjectTypeField struct {
                              
                              	// The content type of the field. Used for determining equality when searching.
                              	ContentType FieldContentType
                              
                              	// 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.
                              	Source *string
                              
                              	// The location of the data in the standard ProfileObject model. For example:
                              	// _profile.Address.PostalCode.
                              	Target *string
                              }

                                Represents a field in a ProfileObjectType.

                                type ObjectTypeKey

                                type ObjectTypeKey struct {
                                
                                	// The reference for the key name of the fields map.
                                	FieldNames []string
                                
                                	// 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.
                                	StandardIdentifiers []StandardIdentifier
                                }

                                  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.

                                  type PartyType

                                  type PartyType string
                                  const (
                                  	PartyTypeIndividual PartyType = "INDIVIDUAL"
                                  	PartyTypeBusiness   PartyType = "BUSINESS"
                                  	PartyTypeOther      PartyType = "OTHER"
                                  )

                                    Enum values for PartyType

                                    func (PartyType) Values

                                    func (PartyType) Values() []PartyType

                                      Values returns all known values for PartyType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                      type Profile

                                      type Profile struct {
                                      
                                      	// A unique account number that you have given to the customer.
                                      	AccountNumber *string
                                      
                                      	// Any additional information relevant to the customer's profile.
                                      	AdditionalInformation *string
                                      
                                      	// A generic address associated with the customer that is not mailing, shipping, or
                                      	// billing.
                                      	Address *Address
                                      
                                      	// A key value pair of attributes of a customer profile.
                                      	Attributes map[string]string
                                      
                                      	// The customer’s billing address.
                                      	BillingAddress *Address
                                      
                                      	// The customer’s birth date.
                                      	BirthDate *string
                                      
                                      	// The customer’s business email address.
                                      	BusinessEmailAddress *string
                                      
                                      	// The name of the customer’s business.
                                      	BusinessName *string
                                      
                                      	// The customer’s home phone number.
                                      	BusinessPhoneNumber *string
                                      
                                      	// The customer's email address, which has not been specified as a personal or
                                      	// business address.
                                      	EmailAddress *string
                                      
                                      	// The customer’s first name.
                                      	FirstName *string
                                      
                                      	// The gender with which the customer identifies.
                                      	Gender Gender
                                      
                                      	// The customer’s home phone number.
                                      	HomePhoneNumber *string
                                      
                                      	// The customer’s last name.
                                      	LastName *string
                                      
                                      	// The customer’s mailing address.
                                      	MailingAddress *Address
                                      
                                      	// The customer’s middle name.
                                      	MiddleName *string
                                      
                                      	// The customer’s mobile phone number.
                                      	MobilePhoneNumber *string
                                      
                                      	// The type of profile used to describe the customer.
                                      	PartyType PartyType
                                      
                                      	// The customer’s personal email address.
                                      	PersonalEmailAddress *string
                                      
                                      	// The customer's phone number, which has not been specified as a mobile, home, or
                                      	// business number.
                                      	PhoneNumber *string
                                      
                                      	// The unique identifier of a customer profile.
                                      	ProfileId *string
                                      
                                      	// The customer’s shipping address.
                                      	ShippingAddress *Address
                                      }

                                        The standard profile of a customer.

                                        type ResourceNotFoundException

                                        type ResourceNotFoundException struct {
                                        	Message *string
                                        }

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

                                          func (*ResourceNotFoundException) Error

                                          func (e *ResourceNotFoundException) Error() string

                                          func (*ResourceNotFoundException) ErrorCode

                                          func (e *ResourceNotFoundException) ErrorCode() string

                                          func (*ResourceNotFoundException) ErrorFault

                                          func (*ResourceNotFoundException) ErrorMessage

                                          func (e *ResourceNotFoundException) ErrorMessage() string

                                          type StandardIdentifier

                                          type StandardIdentifier string
                                          const (
                                          	StandardIdentifierProfile    StandardIdentifier = "PROFILE"
                                          	StandardIdentifierUnique     StandardIdentifier = "UNIQUE"
                                          	StandardIdentifierSecondary  StandardIdentifier = "SECONDARY"
                                          	StandardIdentifierLookupOnly StandardIdentifier = "LOOKUP_ONLY"
                                          	StandardIdentifierNewOnly    StandardIdentifier = "NEW_ONLY"
                                          )

                                            Enum values for StandardIdentifier

                                            func (StandardIdentifier) Values

                                              Values returns all known values for StandardIdentifier. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                              type ThrottlingException

                                              type ThrottlingException struct {
                                              	Message *string
                                              }

                                                You exceeded the maximum number of requests.

                                                func (*ThrottlingException) Error

                                                func (e *ThrottlingException) Error() string

                                                func (*ThrottlingException) ErrorCode

                                                func (e *ThrottlingException) ErrorCode() string

                                                func (*ThrottlingException) ErrorFault

                                                func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

                                                func (*ThrottlingException) ErrorMessage

                                                func (e *ThrottlingException) ErrorMessage() string

                                                type UpdateAddress

                                                type UpdateAddress struct {
                                                
                                                	// The first line of a customer address.
                                                	Address1 *string
                                                
                                                	// The second line of a customer address.
                                                	Address2 *string
                                                
                                                	// The third line of a customer address.
                                                	Address3 *string
                                                
                                                	// The fourth line of a customer address.
                                                	Address4 *string
                                                
                                                	// The city in which a customer lives.
                                                	City *string
                                                
                                                	// The country in which a customer lives.
                                                	Country *string
                                                
                                                	// The county in which a customer lives.
                                                	County *string
                                                
                                                	// The postal code of a customer address.
                                                	PostalCode *string
                                                
                                                	// The province in which a customer lives.
                                                	Province *string
                                                
                                                	// The state in which a customer lives.
                                                	State *string
                                                }

                                                  Updates associated with the address properties of a customer profile.