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

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

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi

aws-native.customerprofiles.getSegmentDefinition

Explore with Pulumi AI

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

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi

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>
Copy
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: Optional[pulumi.Input[str]] = None,
                           segment_definition_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSegmentDefinitionResult]
Copy
func LookupSegmentDefinition(ctx *Context, args *LookupSegmentDefinitionArgs, opts ...InvokeOption) (*LookupSegmentDefinitionResult, error)
func LookupSegmentDefinitionOutput(ctx *Context, args *LookupSegmentDefinitionOutputArgs, opts ...InvokeOption) LookupSegmentDefinitionResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetSegmentDefinitionResult> getSegmentDefinition(GetSegmentDefinitionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Copy
fn::invoke:
  function: aws-native:customerprofiles:getSegmentDefinition
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DomainName This property is required. string
The unique name of the domain.
SegmentDefinitionName This property is required. string
The unique name of the segment definition.
DomainName This property is required. string
The unique name of the domain.
SegmentDefinitionName This property is required. string
The unique name of the segment definition.
domainName This property is required. String
The unique name of the domain.
segmentDefinitionName This property is required. String
The unique name of the segment definition.
domainName This property is required. string
The unique name of the domain.
segmentDefinitionName This property is required. string
The unique name of the segment definition.
domain_name This property is required. str
The unique name of the domain.
segment_definition_name This property is required. str
The unique name of the segment definition.
domainName This property is required. String
The unique name of the domain.
segmentDefinitionName This property is required. 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.
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.
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.
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.
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.
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.
tags List<Property Map>
The tags used to organize, track, or control access for this resource.

Supporting Types

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

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.24.0 published on Wednesday, Jan 15, 2025 by Pulumi