1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. personalize
  6. getCampaign

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

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

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

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi

    A deployment of a solution version that provides real-time recommendations.

    Using getCampaign

    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 getCampaign(args: GetCampaignArgs, opts?: InvokeOptions): Promise<GetCampaignResult>
    function getCampaignOutput(args: GetCampaignOutputArgs, opts?: InvokeOutputOptions): Output<GetCampaignResult>
    def get_campaign(campaign_arn: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCampaignResult
    def get_campaign_output(campaign_arn: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetCampaignResult]
    func LookupCampaign(ctx *Context, args *LookupCampaignArgs, opts ...InvokeOption) (*LookupCampaignResult, error)
    func LookupCampaignOutput(ctx *Context, args *LookupCampaignOutputArgs, opts ...InvokeOption) LookupCampaignResultOutput

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

    public static class GetCampaign 
    {
        public static Task<GetCampaignResult> InvokeAsync(GetCampaignArgs args, InvokeOptions? opts = null)
        public static Output<GetCampaignResult> Invoke(GetCampaignInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetCampaignResult> Invoke(GetCampaignInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetCampaignResult> getCampaign(GetCampaignArgs args, InvokeOptions options)
    public static Output<GetCampaignResult> getCampaign(GetCampaignArgs args, InvokeOptions options)
    public static Output<GetCampaignResult> getCampaign(GetCampaignArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: aws-native:personalize:getCampaign
      arguments:
        # arguments dictionary
    data "aws-native_personalize_get_campaign" "name" {
        # arguments
    }

    The following arguments are supported:

    CampaignArn string
    The ARN of the campaign.
    CampaignArn string
    The ARN of the campaign.
    campaign_arn string
    The ARN of the campaign.
    campaignArn String
    The ARN of the campaign.
    campaignArn string
    The ARN of the campaign.
    campaign_arn str
    The ARN of the campaign.
    campaignArn String
    The ARN of the campaign.

    getCampaign Result

    The following output properties are available:

    CampaignArn string
    The ARN of the campaign.
    CampaignConfig Pulumi.AwsNative.Personalize.Outputs.CampaignConfig
    CreationDateTime string
    The time at which the campaign was created.
    LastUpdatedDateTime string
    The time at which the campaign was last updated.
    MinProvisionedTps int
    Specifies the requested minimum provisioned transactions per second.
    SolutionVersionArn string
    The ARN of the solution version to deploy.
    Status string
    The status of the campaign.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Tags to associate with the campaign.
    CampaignArn string
    The ARN of the campaign.
    CampaignConfig CampaignConfig
    CreationDateTime string
    The time at which the campaign was created.
    LastUpdatedDateTime string
    The time at which the campaign was last updated.
    MinProvisionedTps int
    Specifies the requested minimum provisioned transactions per second.
    SolutionVersionArn string
    The ARN of the solution version to deploy.
    Status string
    The status of the campaign.
    Tags Tag
    Tags to associate with the campaign.
    campaign_arn string
    The ARN of the campaign.
    campaign_config object
    creation_date_time string
    The time at which the campaign was created.
    last_updated_date_time string
    The time at which the campaign was last updated.
    min_provisioned_tps number
    Specifies the requested minimum provisioned transactions per second.
    solution_version_arn string
    The ARN of the solution version to deploy.
    status string
    The status of the campaign.
    tags list(object)
    Tags to associate with the campaign.
    campaignArn String
    The ARN of the campaign.
    campaignConfig CampaignConfig
    creationDateTime String
    The time at which the campaign was created.
    lastUpdatedDateTime String
    The time at which the campaign was last updated.
    minProvisionedTps Integer
    Specifies the requested minimum provisioned transactions per second.
    solutionVersionArn String
    The ARN of the solution version to deploy.
    status String
    The status of the campaign.
    tags List<Tag>
    Tags to associate with the campaign.
    campaignArn string
    The ARN of the campaign.
    campaignConfig CampaignConfig
    creationDateTime string
    The time at which the campaign was created.
    lastUpdatedDateTime string
    The time at which the campaign was last updated.
    minProvisionedTps number
    Specifies the requested minimum provisioned transactions per second.
    solutionVersionArn string
    The ARN of the solution version to deploy.
    status string
    The status of the campaign.
    tags Tag[]
    Tags to associate with the campaign.
    campaign_arn str
    The ARN of the campaign.
    campaign_config CampaignConfig
    creation_date_time str
    The time at which the campaign was created.
    last_updated_date_time str
    The time at which the campaign was last updated.
    min_provisioned_tps int
    Specifies the requested minimum provisioned transactions per second.
    solution_version_arn str
    The ARN of the solution version to deploy.
    status str
    The status of the campaign.
    tags Sequence[root_Tag]
    Tags to associate with the campaign.
    campaignArn String
    The ARN of the campaign.
    campaignConfig Property Map
    creationDateTime String
    The time at which the campaign was created.
    lastUpdatedDateTime String
    The time at which the campaign was last updated.
    minProvisionedTps Number
    Specifies the requested minimum provisioned transactions per second.
    solutionVersionArn String
    The ARN of the solution version to deploy.
    status String
    The status of the campaign.
    tags List<Property Map>
    Tags to associate with the campaign.

    Supporting Types

    CampaignConfig

    EnableMetadataWithRecommendations bool
    Whether metadata with recommendations is enabled for the campaign.
    ItemExplorationConfig Dictionary<string, string>
    Specifies the exploration configuration hyperparameters.
    RankingInfluence Dictionary<string, double>
    A map of ranking influence values for POPULARITY and FRESHNESS.
    SyncWithLatestSolutionVersion bool
    Whether the campaign automatically updates to use the latest solution version.
    EnableMetadataWithRecommendations bool
    Whether metadata with recommendations is enabled for the campaign.
    ItemExplorationConfig map[string]string
    Specifies the exploration configuration hyperparameters.
    RankingInfluence map[string]float64
    A map of ranking influence values for POPULARITY and FRESHNESS.
    SyncWithLatestSolutionVersion bool
    Whether the campaign automatically updates to use the latest solution version.
    enable_metadata_with_recommendations bool
    Whether metadata with recommendations is enabled for the campaign.
    item_exploration_config map(string)
    Specifies the exploration configuration hyperparameters.
    ranking_influence map(number)
    A map of ranking influence values for POPULARITY and FRESHNESS.
    sync_with_latest_solution_version bool
    Whether the campaign automatically updates to use the latest solution version.
    enableMetadataWithRecommendations Boolean
    Whether metadata with recommendations is enabled for the campaign.
    itemExplorationConfig Map<String,String>
    Specifies the exploration configuration hyperparameters.
    rankingInfluence Map<String,Double>
    A map of ranking influence values for POPULARITY and FRESHNESS.
    syncWithLatestSolutionVersion Boolean
    Whether the campaign automatically updates to use the latest solution version.
    enableMetadataWithRecommendations boolean
    Whether metadata with recommendations is enabled for the campaign.
    itemExplorationConfig {[key: string]: string}
    Specifies the exploration configuration hyperparameters.
    rankingInfluence {[key: string]: number}
    A map of ranking influence values for POPULARITY and FRESHNESS.
    syncWithLatestSolutionVersion boolean
    Whether the campaign automatically updates to use the latest solution version.
    enable_metadata_with_recommendations bool
    Whether metadata with recommendations is enabled for the campaign.
    item_exploration_config Mapping[str, str]
    Specifies the exploration configuration hyperparameters.
    ranking_influence Mapping[str, float]
    A map of ranking influence values for POPULARITY and FRESHNESS.
    sync_with_latest_solution_version bool
    Whether the campaign automatically updates to use the latest solution version.
    enableMetadataWithRecommendations Boolean
    Whether metadata with recommendations is enabled for the campaign.
    itemExplorationConfig Map<String>
    Specifies the exploration configuration hyperparameters.
    rankingInfluence Map<Number>
    A map of ranking influence values for POPULARITY and FRESHNESS.
    syncWithLatestSolutionVersion Boolean
    Whether the campaign automatically updates to use the latest solution version.

    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 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 logo AWS Cloud Control

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

    Viewing docs for AWS Cloud Control v1.85.0
    published on Monday, Nov 2, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial