1. Packages
  2. AWS Native
  3. API Docs
  4. evidently
  5. getLaunch

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.evidently.getLaunch

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    Resource Type definition for AWS::Evidently::Launch.

    Using getLaunch

    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 getLaunch(args: GetLaunchArgs, opts?: InvokeOptions): Promise<GetLaunchResult>
    function getLaunchOutput(args: GetLaunchOutputArgs, opts?: InvokeOptions): Output<GetLaunchResult>
    def get_launch(arn: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetLaunchResult
    def get_launch_output(arn: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetLaunchResult]
    func LookupLaunch(ctx *Context, args *LookupLaunchArgs, opts ...InvokeOption) (*LookupLaunchResult, error)
    func LookupLaunchOutput(ctx *Context, args *LookupLaunchOutputArgs, opts ...InvokeOption) LookupLaunchResultOutput

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

    public static class GetLaunch 
    {
        public static Task<GetLaunchResult> InvokeAsync(GetLaunchArgs args, InvokeOptions? opts = null)
        public static Output<GetLaunchResult> Invoke(GetLaunchInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLaunchResult> getLaunch(GetLaunchArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:evidently:getLaunch
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Arn string
    The ARN of the launch. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch
    Arn string
    The ARN of the launch. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch
    arn String
    The ARN of the launch. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch
    arn string
    The ARN of the launch. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch
    arn str
    The ARN of the launch. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch
    arn String
    The ARN of the launch. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch

    getLaunch Result

    The following output properties are available:

    Arn string
    The ARN of the launch. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch
    Description string
    An optional description for the launch.
    ExecutionStatus Pulumi.AwsNative.Evidently.Outputs.LaunchExecutionStatusObject
    Start or Stop Launch Launch. Default is not started.
    Groups List<Pulumi.AwsNative.Evidently.Outputs.LaunchGroupObject>
    An array of structures that contains the feature and variations that are to be used for the launch. You can up to five launch groups in a launch.
    MetricMonitors List<Pulumi.AwsNative.Evidently.Outputs.LaunchMetricDefinitionObject>
    An array of structures that define the metrics that will be used to monitor the launch performance. You can have up to three metric monitors in the array.
    RandomizationSalt string
    When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the launch name as the randomizationsSalt .
    ScheduledSplitsConfig List<Pulumi.AwsNative.Evidently.Outputs.LaunchStepConfig>
    An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    Arn string
    The ARN of the launch. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch
    Description string
    An optional description for the launch.
    ExecutionStatus LaunchExecutionStatusObject
    Start or Stop Launch Launch. Default is not started.
    Groups []LaunchGroupObject
    An array of structures that contains the feature and variations that are to be used for the launch. You can up to five launch groups in a launch.
    MetricMonitors []LaunchMetricDefinitionObject
    An array of structures that define the metrics that will be used to monitor the launch performance. You can have up to three metric monitors in the array.
    RandomizationSalt string
    When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the launch name as the randomizationsSalt .
    ScheduledSplitsConfig []LaunchStepConfig
    An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    arn String
    The ARN of the launch. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch
    description String
    An optional description for the launch.
    executionStatus LaunchExecutionStatusObject
    Start or Stop Launch Launch. Default is not started.
    groups List<LaunchGroupObject>
    An array of structures that contains the feature and variations that are to be used for the launch. You can up to five launch groups in a launch.
    metricMonitors List<LaunchMetricDefinitionObject>
    An array of structures that define the metrics that will be used to monitor the launch performance. You can have up to three metric monitors in the array.
    randomizationSalt String
    When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the launch name as the randomizationsSalt .
    scheduledSplitsConfig List<LaunchStepConfig>
    An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    arn string
    The ARN of the launch. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch
    description string
    An optional description for the launch.
    executionStatus LaunchExecutionStatusObject
    Start or Stop Launch Launch. Default is not started.
    groups LaunchGroupObject[]
    An array of structures that contains the feature and variations that are to be used for the launch. You can up to five launch groups in a launch.
    metricMonitors LaunchMetricDefinitionObject[]
    An array of structures that define the metrics that will be used to monitor the launch performance. You can have up to three metric monitors in the array.
    randomizationSalt string
    When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the launch name as the randomizationsSalt .
    scheduledSplitsConfig LaunchStepConfig[]
    An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    arn str
    The ARN of the launch. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch
    description str
    An optional description for the launch.
    execution_status LaunchExecutionStatusObject
    Start or Stop Launch Launch. Default is not started.
    groups Sequence[LaunchGroupObject]
    An array of structures that contains the feature and variations that are to be used for the launch. You can up to five launch groups in a launch.
    metric_monitors Sequence[LaunchMetricDefinitionObject]
    An array of structures that define the metrics that will be used to monitor the launch performance. You can have up to three metric monitors in the array.
    randomization_salt str
    When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the launch name as the randomizationsSalt .
    scheduled_splits_config Sequence[LaunchStepConfig]
    An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    arn String
    The ARN of the launch. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch
    description String
    An optional description for the launch.
    executionStatus Property Map
    Start or Stop Launch Launch. Default is not started.
    groups List<Property Map>
    An array of structures that contains the feature and variations that are to be used for the launch. You can up to five launch groups in a launch.
    metricMonitors List<Property Map>
    An array of structures that define the metrics that will be used to monitor the launch performance. You can have up to three metric monitors in the array.
    randomizationSalt String
    When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the launch name as the randomizationsSalt .
    scheduledSplitsConfig List<Property Map>
    An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    LaunchExecutionStatusObject

    Status string
    Provide START or STOP action to apply on a launch
    DesiredState string
    Provide CANCELLED or COMPLETED as the launch desired state. Defaults to Completed if not provided.
    Reason string
    Provide a reason for stopping the launch. Defaults to empty if not provided.
    Status string
    Provide START or STOP action to apply on a launch
    DesiredState string
    Provide CANCELLED or COMPLETED as the launch desired state. Defaults to Completed if not provided.
    Reason string
    Provide a reason for stopping the launch. Defaults to empty if not provided.
    status String
    Provide START or STOP action to apply on a launch
    desiredState String
    Provide CANCELLED or COMPLETED as the launch desired state. Defaults to Completed if not provided.
    reason String
    Provide a reason for stopping the launch. Defaults to empty if not provided.
    status string
    Provide START or STOP action to apply on a launch
    desiredState string
    Provide CANCELLED or COMPLETED as the launch desired state. Defaults to Completed if not provided.
    reason string
    Provide a reason for stopping the launch. Defaults to empty if not provided.
    status str
    Provide START or STOP action to apply on a launch
    desired_state str
    Provide CANCELLED or COMPLETED as the launch desired state. Defaults to Completed if not provided.
    reason str
    Provide a reason for stopping the launch. Defaults to empty if not provided.
    status String
    Provide START or STOP action to apply on a launch
    desiredState String
    Provide CANCELLED or COMPLETED as the launch desired state. Defaults to Completed if not provided.
    reason String
    Provide a reason for stopping the launch. Defaults to empty if not provided.

    LaunchGroupObject

    Feature string
    The feature that this launch is using.
    GroupName string
    A name for this launch group. It can include up to 127 characters.
    Variation string
    The feature variation to use for this launch group.
    Description string
    A description of the launch group.
    Feature string
    The feature that this launch is using.
    GroupName string
    A name for this launch group. It can include up to 127 characters.
    Variation string
    The feature variation to use for this launch group.
    Description string
    A description of the launch group.
    feature String
    The feature that this launch is using.
    groupName String
    A name for this launch group. It can include up to 127 characters.
    variation String
    The feature variation to use for this launch group.
    description String
    A description of the launch group.
    feature string
    The feature that this launch is using.
    groupName string
    A name for this launch group. It can include up to 127 characters.
    variation string
    The feature variation to use for this launch group.
    description string
    A description of the launch group.
    feature str
    The feature that this launch is using.
    group_name str
    A name for this launch group. It can include up to 127 characters.
    variation str
    The feature variation to use for this launch group.
    description str
    A description of the launch group.
    feature String
    The feature that this launch is using.
    groupName String
    A name for this launch group. It can include up to 127 characters.
    variation String
    The feature variation to use for this launch group.
    description String
    A description of the launch group.

    LaunchGroupToWeight

    GroupName string
    The name of the launch group. It can include up to 127 characters.
    SplitWeight int

    The portion of launch traffic to allocate to this launch group.

    This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the launch audience to this launch group.

    GroupName string
    The name of the launch group. It can include up to 127 characters.
    SplitWeight int

    The portion of launch traffic to allocate to this launch group.

    This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the launch audience to this launch group.

    groupName String
    The name of the launch group. It can include up to 127 characters.
    splitWeight Integer

    The portion of launch traffic to allocate to this launch group.

    This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the launch audience to this launch group.

    groupName string
    The name of the launch group. It can include up to 127 characters.
    splitWeight number

    The portion of launch traffic to allocate to this launch group.

    This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the launch audience to this launch group.

    group_name str
    The name of the launch group. It can include up to 127 characters.
    split_weight int

    The portion of launch traffic to allocate to this launch group.

    This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the launch audience to this launch group.

    groupName String
    The name of the launch group. It can include up to 127 characters.
    splitWeight Number

    The portion of launch traffic to allocate to this launch group.

    This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the launch audience to this launch group.

    LaunchMetricDefinitionObject

    EntityIdKey string
    The JSON path to reference the entity id in the event.
    MetricName string
    A name for the metric. It can include up to 255 characters.
    ValueKey string
    The JSON path to reference the numerical metric value in the event.
    EventPattern string
    Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.
    UnitLabel string
    A label for the units that the metric is measuring.
    EntityIdKey string
    The JSON path to reference the entity id in the event.
    MetricName string
    A name for the metric. It can include up to 255 characters.
    ValueKey string
    The JSON path to reference the numerical metric value in the event.
    EventPattern string
    Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.
    UnitLabel string
    A label for the units that the metric is measuring.
    entityIdKey String
    The JSON path to reference the entity id in the event.
    metricName String
    A name for the metric. It can include up to 255 characters.
    valueKey String
    The JSON path to reference the numerical metric value in the event.
    eventPattern String
    Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.
    unitLabel String
    A label for the units that the metric is measuring.
    entityIdKey string
    The JSON path to reference the entity id in the event.
    metricName string
    A name for the metric. It can include up to 255 characters.
    valueKey string
    The JSON path to reference the numerical metric value in the event.
    eventPattern string
    Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.
    unitLabel string
    A label for the units that the metric is measuring.
    entity_id_key str
    The JSON path to reference the entity id in the event.
    metric_name str
    A name for the metric. It can include up to 255 characters.
    value_key str
    The JSON path to reference the numerical metric value in the event.
    event_pattern str
    Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.
    unit_label str
    A label for the units that the metric is measuring.
    entityIdKey String
    The JSON path to reference the entity id in the event.
    metricName String
    A name for the metric. It can include up to 255 characters.
    valueKey String
    The JSON path to reference the numerical metric value in the event.
    eventPattern String
    Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.
    unitLabel String
    A label for the units that the metric is measuring.

    LaunchSegmentOverride

    EvaluationOrder int
    A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.
    Segment string
    The ARN of the segment to use for this override.
    Weights List<Pulumi.AwsNative.Evidently.Inputs.LaunchGroupToWeight>
    The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.
    EvaluationOrder int
    A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.
    Segment string
    The ARN of the segment to use for this override.
    Weights []LaunchGroupToWeight
    The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.
    evaluationOrder Integer
    A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.
    segment String
    The ARN of the segment to use for this override.
    weights List<LaunchGroupToWeight>
    The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.
    evaluationOrder number
    A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.
    segment string
    The ARN of the segment to use for this override.
    weights LaunchGroupToWeight[]
    The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.
    evaluation_order int
    A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.
    segment str
    The ARN of the segment to use for this override.
    weights Sequence[LaunchGroupToWeight]
    The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.
    evaluationOrder Number
    A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.
    segment String
    The ARN of the segment to use for this override.
    weights List<Property Map>
    The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.

    LaunchStepConfig

    GroupWeights List<Pulumi.AwsNative.Evidently.Inputs.LaunchGroupToWeight>
    An array of structures that define how much launch traffic to allocate to each launch group during this step of the launch.
    StartTime string
    The date and time to start this step of the launch. Use UTC format, yyyy-MM-ddTHH:mm:ssZ . For example, 2025-11-25T23:59:59Z
    SegmentOverrides List<Pulumi.AwsNative.Evidently.Inputs.LaunchSegmentOverride>

    An array of structures that you can use to specify different traffic splits for one or more audience segments . A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.

    For more information, see Use segments to focus your audience .

    GroupWeights []LaunchGroupToWeight
    An array of structures that define how much launch traffic to allocate to each launch group during this step of the launch.
    StartTime string
    The date and time to start this step of the launch. Use UTC format, yyyy-MM-ddTHH:mm:ssZ . For example, 2025-11-25T23:59:59Z
    SegmentOverrides []LaunchSegmentOverride

    An array of structures that you can use to specify different traffic splits for one or more audience segments . A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.

    For more information, see Use segments to focus your audience .

    groupWeights List<LaunchGroupToWeight>
    An array of structures that define how much launch traffic to allocate to each launch group during this step of the launch.
    startTime String
    The date and time to start this step of the launch. Use UTC format, yyyy-MM-ddTHH:mm:ssZ . For example, 2025-11-25T23:59:59Z
    segmentOverrides List<LaunchSegmentOverride>

    An array of structures that you can use to specify different traffic splits for one or more audience segments . A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.

    For more information, see Use segments to focus your audience .

    groupWeights LaunchGroupToWeight[]
    An array of structures that define how much launch traffic to allocate to each launch group during this step of the launch.
    startTime string
    The date and time to start this step of the launch. Use UTC format, yyyy-MM-ddTHH:mm:ssZ . For example, 2025-11-25T23:59:59Z
    segmentOverrides LaunchSegmentOverride[]

    An array of structures that you can use to specify different traffic splits for one or more audience segments . A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.

    For more information, see Use segments to focus your audience .

    group_weights Sequence[LaunchGroupToWeight]
    An array of structures that define how much launch traffic to allocate to each launch group during this step of the launch.
    start_time str
    The date and time to start this step of the launch. Use UTC format, yyyy-MM-ddTHH:mm:ssZ . For example, 2025-11-25T23:59:59Z
    segment_overrides Sequence[LaunchSegmentOverride]

    An array of structures that you can use to specify different traffic splits for one or more audience segments . A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.

    For more information, see Use segments to focus your audience .

    groupWeights List<Property Map>
    An array of structures that define how much launch traffic to allocate to each launch group during this step of the launch.
    startTime String
    The date and time to start this step of the launch. Use UTC format, yyyy-MM-ddTHH:mm:ssZ . For example, 2025-11-25T23:59:59Z
    segmentOverrides List<Property Map>

    An array of structures that you can use to specify different traffic splits for one or more audience segments . A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.

    For more information, see Use segments to focus your audience .

    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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi