Module Values.CampaignSource

An object that describes the deployment of a solution version. For more information on campaigns, see CreateCampaign.

Sourcetype nonrec t = {
  1. name : Name.t option;
    (*

    The name of the campaign.

    *)
  2. campaignArn : Arn.t option;
    (*

    The Amazon Resource Name (ARN) of the campaign.

    *)
  3. solutionVersionArn : Arn.t option;
    (*

    The Amazon Resource Name (ARN) of the solution version the campaign uses.

    *)
  4. minProvisionedTPS : TransactionsPerSecond.t option;
    (*

    Specifies the requested minimum provisioned transactions (recommendations) per second. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

    *)
  5. campaignConfig : CampaignConfig.t option;
    (*

    The configuration details of a campaign.

    *)
  6. status : Status.t option;
    (*

    The status of the campaign. A campaign can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS

    *)
  7. failureReason : FailureReason.t option;
    (*

    If a campaign fails, the reason behind the failure.

    *)
  8. creationDateTime : Date.t option;
    (*

    The date and time (in Unix format) that the campaign was created.

    *)
  9. lastUpdatedDateTime : Date.t option;
    (*

    The date and time (in Unix format) that the campaign was last updated.

    *)
  10. latestCampaignUpdate : CampaignUpdateSummary.t option;
    (*

    Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API. The latestCampaignUpdate field is only returned when the campaign has had at least one UpdateCampaign call.

    *)
}
Sourceval make : ?name:??? -> ?campaignArn:??? -> ?solutionVersionArn:??? -> ?minProvisionedTPS:??? -> ?campaignConfig:??? -> ?status:??? -> ?failureReason:??? -> ?creationDateTime:??? -> ?lastUpdatedDateTime:??? -> ?latestCampaignUpdate:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of TransactionsPerSecond.t | `String of Name.t | `Structure of (string * [> `Boolean of Boolean.t | `Integer of TransactionsPerSecond.t | `Map of ([> `Enum of string | `String of ParameterName.t ] * [> `Double of RankingInfluenceWeight.t | `String of ParameterValue.t ]) list | `String of Arn.t | `Structure of (string * [> `Boolean of Boolean.t | `Map of ([> `Enum of string | `String of ParameterName.t ] * [> `Double of RankingInfluenceWeight.t | `String of ParameterValue.t ]) list ]) list | `Timestamp of Date.t ]) list | `Timestamp of Date.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t