1. Packages
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. customerprofiles
  6. getSegmentDefinition

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

Viewing docs for AWS Cloud Control v1.63.0
published on Monday, May 4, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.customerprofiles.getSegmentDefinition

aws-native logo

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

Viewing docs for AWS Cloud Control v1.63.0
published on Monday, May 4, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    A segment definition resource of Amazon Connect Customer Profiles

    Using getSegmentDefinition

    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.

    function getSegmentDefinition(args: GetSegmentDefinitionArgs, opts?: InvokeOptions): Promise<GetSegmentDefinitionResult>
function getSegmentDefinitionOutput(args: GetSegmentDefinitionOutputArgs, opts?: InvokeOptions): Output<GetSegmentDefinitionResult>
    def get_segment_definition(domain_name: Optional[str] = None,
                           segment_definition_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSegmentDefinitionResult
def get_segment_definition_output(domain_name: pulumi.Input[Optional[str]] = None,
                           segment_definition_name: pulumi.Input[Optional[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSegmentDefinitionResult]
    func LookupSegmentDefinition(ctx *Context, args *LookupSegmentDefinitionArgs, opts ...InvokeOption) (*LookupSegmentDefinitionResult, error)
func LookupSegmentDefinitionOutput(ctx *Context, args *LookupSegmentDefinitionOutputArgs, opts ...InvokeOption) LookupSegmentDefinitionResultOutput

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

    public static class GetSegmentDefinition 
{
    public static Task<GetSegmentDefinitionResult> InvokeAsync(GetSegmentDefinitionArgs args, InvokeOptions? opts = null)
    public static Output<GetSegmentDefinitionResult> Invoke(GetSegmentDefinitionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSegmentDefinitionResult> getSegmentDefinition(GetSegmentDefinitionArgs args, InvokeOptions options)
public static Output<GetSegmentDefinitionResult> getSegmentDefinition(GetSegmentDefinitionArgs args, InvokeOptions options)

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

    The following arguments are supported:

    DomainName string
    The unique name of the domain.
    SegmentDefinitionName string
    The unique name of the segment definition.
    DomainName string
    The unique name of the domain.
    SegmentDefinitionName string
    The unique name of the segment definition.
    domainName String
    The unique name of the domain.
    segmentDefinitionName String
    The unique name of the segment definition.
    domainName string
    The unique name of the domain.
    segmentDefinitionName string
    The unique name of the segment definition.
    domain_name str
    The unique name of the domain.
    segment_definition_name str
    The unique name of the segment definition.
    domainName String
    The unique name of the domain.
    segmentDefinitionName String
    The unique name of the segment definition.

    getSegmentDefinition Result

    The following output properties are available:

    CreatedAt string
    The time of this segment definition got created.
    Description string
    The description of the segment definition.
    SegmentDefinitionArn string
    The Amazon Resource Name (ARN) of the segment definition.
    SegmentSort Pulumi.AwsNative.CustomerProfiles.Outputs.SegmentDefinitionSegmentSort
    The segment sort configuration for ordering segment results.
    SegmentType Pulumi.AwsNative.CustomerProfiles.SegmentDefinitionSegmentType
    The SQL query that defines the segment criteria.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags used to organize, track, or control access for this resource.
    CreatedAt string
    The time of this segment definition got created.
    Description string
    The description of the segment definition.
    SegmentDefinitionArn string
    The Amazon Resource Name (ARN) of the segment definition.
    SegmentSort SegmentDefinitionSegmentSort
    The segment sort configuration for ordering segment results.
    SegmentType SegmentDefinitionSegmentType
    The SQL query that defines the segment criteria.
    Tags Tag
    The tags used to organize, track, or control access for this resource.
    createdAt String
    The time of this segment definition got created.
    description String
    The description of the segment definition.
    segmentDefinitionArn String
    The Amazon Resource Name (ARN) of the segment definition.
    segmentSort SegmentDefinitionSegmentSort
    The segment sort configuration for ordering segment results.
    segmentType SegmentDefinitionSegmentType
    The SQL query that defines the segment criteria.
    tags List<Tag>
    The tags used to organize, track, or control access for this resource.
    createdAt string
    The time of this segment definition got created.
    description string
    The description of the segment definition.
    segmentDefinitionArn string
    The Amazon Resource Name (ARN) of the segment definition.
    segmentSort SegmentDefinitionSegmentSort
    The segment sort configuration for ordering segment results.
    segmentType SegmentDefinitionSegmentType
    The SQL query that defines the segment criteria.
    tags Tag[]
    The tags used to organize, track, or control access for this resource.
    created_at str
    The time of this segment definition got created.
    description str
    The description of the segment definition.
    segment_definition_arn str
    The Amazon Resource Name (ARN) of the segment definition.
    segment_sort SegmentDefinitionSegmentSort
    The segment sort configuration for ordering segment results.
    segment_type SegmentDefinitionSegmentType
    The SQL query that defines the segment criteria.
    tags Sequence[root_Tag]
    The tags used to organize, track, or control access for this resource.
    createdAt String
    The time of this segment definition got created.
    description String
    The description of the segment definition.
    segmentDefinitionArn String
    The Amazon Resource Name (ARN) of the segment definition.
    segmentSort Property Map
    The segment sort configuration for ordering segment results.
    segmentType "CLASSIC" | "ENHANCED"
    The SQL query that defines the segment criteria.
    tags List<Property Map>
    The tags used to organize, track, or control access for this resource.

    Supporting Types

    SegmentDefinitionSegmentSort

    Attributes List<Pulumi.AwsNative.CustomerProfiles.Inputs.SegmentDefinitionSortAttribute>
    A list of attributes used to sort the segments and their ordering preferences.
    Attributes []SegmentDefinitionSortAttribute
    A list of attributes used to sort the segments and their ordering preferences.
    attributes List<SegmentDefinitionSortAttribute>
    A list of attributes used to sort the segments and their ordering preferences.
    attributes SegmentDefinitionSortAttribute[]
    A list of attributes used to sort the segments and their ordering preferences.
    attributes Sequence[SegmentDefinitionSortAttribute]
    A list of attributes used to sort the segments and their ordering preferences.
    attributes List<Property Map>
    A list of attributes used to sort the segments and their ordering preferences.

    SegmentDefinitionSegmentSortDataType

    SegmentDefinitionSegmentSortOrder

    SegmentDefinitionSegmentType

    SegmentDefinitionSortAttribute

    SegmentDefinitionSortAttributeType

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

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

    Viewing docs for AWS Cloud Control v1.63.0
    published on Monday, May 4, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Try Pulumi Cloud free. Your team will thank you.