AWS Cloud Control v1.27.0, Apr 14 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.customerprofiles.getObjectType

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Using getObjectType

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getObjectType(args: GetObjectTypeArgs, opts?: InvokeOptions): Promise<GetObjectTypeResult>
function getObjectTypeOutput(args: GetObjectTypeOutputArgs, opts?: InvokeOptions): Output<GetObjectTypeResult>

def get_object_type(domain_name: Optional[str] = None,
                    object_type_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetObjectTypeResult
def get_object_type_output(domain_name: Optional[pulumi.Input[str]] = None,
                    object_type_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetObjectTypeResult]

func LookupObjectType(ctx *Context, args *LookupObjectTypeArgs, opts ...InvokeOption) (*LookupObjectTypeResult, error)
func LookupObjectTypeOutput(ctx *Context, args *LookupObjectTypeOutputArgs, opts ...InvokeOption) LookupObjectTypeResultOutput

> Note: This function is named LookupObjectType in the Go SDK.

public static class GetObjectType 
{
    public static Task<GetObjectTypeResult> InvokeAsync(GetObjectTypeArgs args, InvokeOptions? opts = null)
    public static Output<GetObjectTypeResult> Invoke(GetObjectTypeInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetObjectTypeResult> getObjectType(GetObjectTypeArgs args, InvokeOptions options)
public static Output<GetObjectTypeResult> getObjectType(GetObjectTypeArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:customerprofiles:getObjectType
  arguments:
    # arguments dictionary

The following arguments are supported:

DomainName string: The unique name of the domain.
ObjectTypeName string: The name of the profile object type.

DomainName string: The unique name of the domain.
ObjectTypeName string: The name of the profile object type.

domainName String: The unique name of the domain.
objectTypeName String: The name of the profile object type.

domainName string: The unique name of the domain.
objectTypeName string: The name of the profile object type.

domain_name str: The unique name of the domain.
object_type_name str: The name of the profile object type.

domainName String: The unique name of the domain.
objectTypeName String: The name of the profile object type.

getObjectType Result

The following output properties are available:

AllowProfileCreation bool: Indicates whether a profile should be created when data is received.
CreatedAt string: The time of this integration got created.
Description string: Description of the profile object type.
EncryptionKey string: The default encryption key
ExpirationDays int: The default number of days until the data within the domain expires.
Fields List<Pulumi.AwsNative.CustomerProfiles.Outputs.ObjectTypeFieldMap>: A list of the name and ObjectType field.
Keys List<Pulumi.AwsNative.CustomerProfiles.Outputs.ObjectTypeKeyMap>: A list of unique keys that can be used to map data to the profile.
LastUpdatedAt string: The time of this integration got last updated at.
SourceLastUpdatedTimestampFormat string: The format of your sourceLastUpdatedTimestamp that was previously set up.
Tags List<Pulumi.AwsNative.Outputs.Tag>: The tags (keys and values) associated with the integration.
TemplateId string: A unique identifier for the object template.

AllowProfileCreation bool: Indicates whether a profile should be created when data is received.
CreatedAt string: The time of this integration got created.
Description string: Description of the profile object type.
EncryptionKey string: The default encryption key
ExpirationDays int: The default number of days until the data within the domain expires.
Fields []ObjectTypeFieldMap: A list of the name and ObjectType field.
Keys []ObjectTypeKeyMap: A list of unique keys that can be used to map data to the profile.
LastUpdatedAt string: The time of this integration got last updated at.
SourceLastUpdatedTimestampFormat string: The format of your sourceLastUpdatedTimestamp that was previously set up.
Tags Tag: The tags (keys and values) associated with the integration.
TemplateId string: A unique identifier for the object template.

allowProfileCreation Boolean: Indicates whether a profile should be created when data is received.
createdAt String: The time of this integration got created.
description String: Description of the profile object type.
encryptionKey String: The default encryption key
expirationDays Integer: The default number of days until the data within the domain expires.
fields List<ObjectTypeFieldMap>: A list of the name and ObjectType field.
keys List<ObjectTypeKeyMap>: A list of unique keys that can be used to map data to the profile.
lastUpdatedAt String: The time of this integration got last updated at.
sourceLastUpdatedTimestampFormat String: The format of your sourceLastUpdatedTimestamp that was previously set up.
tags List<Tag>: The tags (keys and values) associated with the integration.
templateId String: A unique identifier for the object template.

allowProfileCreation boolean: Indicates whether a profile should be created when data is received.
createdAt string: The time of this integration got created.
description string: Description of the profile object type.
encryptionKey string: The default encryption key
expirationDays number: The default number of days until the data within the domain expires.
fields ObjectTypeFieldMap[]: A list of the name and ObjectType field.
keys ObjectTypeKeyMap[]: A list of unique keys that can be used to map data to the profile.
lastUpdatedAt string: The time of this integration got last updated at.
sourceLastUpdatedTimestampFormat string: The format of your sourceLastUpdatedTimestamp that was previously set up.
tags Tag[]: The tags (keys and values) associated with the integration.
templateId string: A unique identifier for the object template.

allow_profile_creation bool: Indicates whether a profile should be created when data is received.
created_at str: The time of this integration got created.
description str: Description of the profile object type.
encryption_key str: The default encryption key
expiration_days int: The default number of days until the data within the domain expires.
fields Sequence[ObjectTypeFieldMap]: A list of the name and ObjectType field.
keys Sequence[ObjectTypeKeyMap]: A list of unique keys that can be used to map data to the profile.
last_updated_at str: The time of this integration got last updated at.
source_last_updated_timestamp_format str: The format of your sourceLastUpdatedTimestamp that was previously set up.
tags Sequence[root_Tag]: The tags (keys and values) associated with the integration.
template_id str: A unique identifier for the object template.

allowProfileCreation Boolean: Indicates whether a profile should be created when data is received.
createdAt String: The time of this integration got created.
description String: Description of the profile object type.
encryptionKey String: The default encryption key
expirationDays Number: The default number of days until the data within the domain expires.
fields List<Property Map>: A list of the name and ObjectType field.
keys List<Property Map>: A list of unique keys that can be used to map data to the profile.
lastUpdatedAt String: The time of this integration got last updated at.
sourceLastUpdatedTimestampFormat String: The format of your sourceLastUpdatedTimestamp that was previously set up.
tags List<Property Map>: The tags (keys and values) associated with the integration.
templateId String: A unique identifier for the object template.

Supporting Types

ObjectTypeField

ContentType Pulumi.AwsNative.CustomerProfiles.ObjectTypeFieldContentType: The content type of the field. Used for determining equality when searching.
Source string: 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.
Target string: The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.

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

contentType ObjectTypeFieldContentType: The content type of the field. Used for determining equality when searching.
source String: 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.
target String: The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.

contentType ObjectTypeFieldContentType: The content type of the field. Used for determining equality when searching.
source string: 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.
target string: The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.

content_type ObjectTypeFieldContentType: The content type of the field. Used for determining equality when searching.
source str: 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.
target str: The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.

contentType "STRING" | "NUMBER" | "PHONE_NUMBER" | "EMAIL_ADDRESS" | "NAME": The content type of the field. Used for determining equality when searching.
source String: 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.
target String: The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.

ObjectTypeFieldContentType

ObjectTypeFieldMap

Name string: Name of the field.
ObjectTypeField Pulumi.AwsNative.CustomerProfiles.Inputs.ObjectTypeField: Represents a field in a ProfileObjectType.

Name string: Name of the field.
ObjectTypeField ObjectTypeField: Represents a field in a ProfileObjectType.

name String: Name of the field.
objectTypeField ObjectTypeField: Represents a field in a ProfileObjectType.

name string: Name of the field.
objectTypeField ObjectTypeField: Represents a field in a ProfileObjectType.

name str: Name of the field.
object_type_field ObjectTypeField: Represents a field in a ProfileObjectType.

name String: Name of the field.
objectTypeField Property Map: Represents a field in a ProfileObjectType.

ObjectTypeKey

FieldNames List<string>: The reference for the key name of the fields map.
StandardIdentifiers List<Pulumi.AwsNative.CustomerProfiles.ObjectTypeKeyStandardIdentifiersItem>: 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.

FieldNames []string: The reference for the key name of the fields map.
StandardIdentifiers []ObjectTypeKeyStandardIdentifiersItem: 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.

fieldNames List<String>: The reference for the key name of the fields map.
standardIdentifiers List<ObjectTypeKeyStandardIdentifiersItem>: 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.

fieldNames string[]: The reference for the key name of the fields map.
standardIdentifiers ObjectTypeKeyStandardIdentifiersItem[]: 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.

field_names Sequence[str]: The reference for the key name of the fields map.
standard_identifiers Sequence[ObjectTypeKeyStandardIdentifiersItem]: 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.

fieldNames List<String>: The reference for the key name of the fields map.
standardIdentifiers List<"PROFILE" | "UNIQUE" | "SECONDARY" | "LOOKUP_ONLY" | "NEW_ONLY" | "ASSET" | "CASE" | "ORDER">: 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.

ObjectTypeKeyMap

Name string: Name of the key.
ObjectTypeKeyList List<Pulumi.AwsNative.CustomerProfiles.Inputs.ObjectTypeKey>: A list of ObjectTypeKey.

Name string: Name of the key.
ObjectTypeKeyList []ObjectTypeKey: A list of ObjectTypeKey.

name String: Name of the key.
objectTypeKeyList List<ObjectTypeKey>: A list of ObjectTypeKey.

name string: Name of the key.
objectTypeKeyList ObjectTypeKey[]: A list of ObjectTypeKey.

name str: Name of the key.
object_type_key_list Sequence[ObjectTypeKey]: A list of ObjectTypeKey.

name String: Name of the key.
objectTypeKeyList List<Property Map>: A list of ObjectTypeKey.

ObjectTypeKeyStandardIdentifiersItem

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.customerprofiles.getObjectType

On this page

On this page

Using getObjectType

getObjectType Result

Supporting Types

ObjectTypeField

ObjectTypeFieldContentType

ObjectTypeFieldMap

ObjectTypeKey

ObjectTypeKeyMap

ObjectTypeKeyStandardIdentifiersItem

Tag

Package Details

On this page

On this page