Skip to content

Type definitions#

Index > CloudWatchEvidently > Type definitions

Auto-generated documentation for CloudWatchEvidently type annotations stubs module mypy-boto3-evidently.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

EvaluationRequestTypeDef#

# EvaluationRequestTypeDef definition

class EvaluationRequestTypeDef(TypedDict):
    entityId: str,
    feature: str,
    evaluationContext: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CloudWatchLogsDestinationConfigTypeDef#

# CloudWatchLogsDestinationConfigTypeDef definition

class CloudWatchLogsDestinationConfigTypeDef(TypedDict):
    logGroup: NotRequired[str],

CloudWatchLogsDestinationTypeDef#

# CloudWatchLogsDestinationTypeDef definition

class CloudWatchLogsDestinationTypeDef(TypedDict):
    logGroup: NotRequired[str],

OnlineAbConfigTypeDef#

# OnlineAbConfigTypeDef definition

class OnlineAbConfigTypeDef(TypedDict):
    controlTreatmentName: NotRequired[str],
    treatmentWeights: NotRequired[Mapping[str, int]],

TreatmentConfigTypeDef#

# TreatmentConfigTypeDef definition

class TreatmentConfigTypeDef(TypedDict):
    feature: str,
    name: str,
    variation: str,
    description: NotRequired[str],

LaunchGroupConfigTypeDef#

# LaunchGroupConfigTypeDef definition

class LaunchGroupConfigTypeDef(TypedDict):
    feature: str,
    name: str,
    variation: str,
    description: NotRequired[str],

ProjectAppConfigResourceConfigTypeDef#

# ProjectAppConfigResourceConfigTypeDef definition

class ProjectAppConfigResourceConfigTypeDef(TypedDict):
    applicationId: NotRequired[str],
    environmentId: NotRequired[str],

CreateSegmentRequestRequestTypeDef#

# CreateSegmentRequestRequestTypeDef definition

class CreateSegmentRequestRequestTypeDef(TypedDict):
    name: str,
    pattern: str,
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

SegmentTypeDef#

# SegmentTypeDef definition

class SegmentTypeDef(TypedDict):
    arn: str,
    createdTime: datetime,
    lastUpdatedTime: datetime,
    name: str,
    pattern: str,
    description: NotRequired[str],
    experimentCount: NotRequired[int],
    launchCount: NotRequired[int],
    tags: NotRequired[Dict[str, str]],

DeleteExperimentRequestRequestTypeDef#

# DeleteExperimentRequestRequestTypeDef definition

class DeleteExperimentRequestRequestTypeDef(TypedDict):
    experiment: str,
    project: str,

DeleteFeatureRequestRequestTypeDef#

# DeleteFeatureRequestRequestTypeDef definition

class DeleteFeatureRequestRequestTypeDef(TypedDict):
    feature: str,
    project: str,

DeleteLaunchRequestRequestTypeDef#

# DeleteLaunchRequestRequestTypeDef definition

class DeleteLaunchRequestRequestTypeDef(TypedDict):
    launch: str,
    project: str,

DeleteProjectRequestRequestTypeDef#

# DeleteProjectRequestRequestTypeDef definition

class DeleteProjectRequestRequestTypeDef(TypedDict):
    project: str,

DeleteSegmentRequestRequestTypeDef#

# DeleteSegmentRequestRequestTypeDef definition

class DeleteSegmentRequestRequestTypeDef(TypedDict):
    segment: str,

EvaluateFeatureRequestRequestTypeDef#

# EvaluateFeatureRequestRequestTypeDef definition

class EvaluateFeatureRequestRequestTypeDef(TypedDict):
    entityId: str,
    feature: str,
    project: str,
    evaluationContext: NotRequired[str],

VariableValueTypeDef#

# VariableValueTypeDef definition

class VariableValueTypeDef(TypedDict):
    boolValue: NotRequired[bool],
    doubleValue: NotRequired[float],
    longValue: NotRequired[int],
    stringValue: NotRequired[str],

EvaluationRuleTypeDef#

# EvaluationRuleTypeDef definition

class EvaluationRuleTypeDef(TypedDict):
    type: str,
    name: NotRequired[str],

ExperimentExecutionTypeDef#

# ExperimentExecutionTypeDef definition

class ExperimentExecutionTypeDef(TypedDict):
    endedTime: NotRequired[datetime],
    startedTime: NotRequired[datetime],

ExperimentReportTypeDef#

# ExperimentReportTypeDef definition

class ExperimentReportTypeDef(TypedDict):
    content: NotRequired[str],
    metricName: NotRequired[str],
    reportName: NotRequired[ExperimentReportNameType],  # (1)
    treatmentName: NotRequired[str],
  1. See ExperimentReportNameType

ExperimentResultsDataTypeDef#

# ExperimentResultsDataTypeDef definition

class ExperimentResultsDataTypeDef(TypedDict):
    metricName: NotRequired[str],
    resultStat: NotRequired[ExperimentResultResponseTypeType],  # (1)
    treatmentName: NotRequired[str],
    values: NotRequired[List[float]],
  1. See ExperimentResultResponseTypeType

ExperimentScheduleTypeDef#

# ExperimentScheduleTypeDef definition

class ExperimentScheduleTypeDef(TypedDict):
    analysisCompleteTime: NotRequired[datetime],

OnlineAbDefinitionTypeDef#

# OnlineAbDefinitionTypeDef definition

class OnlineAbDefinitionTypeDef(TypedDict):
    controlTreatmentName: NotRequired[str],
    treatmentWeights: NotRequired[Dict[str, int]],

TreatmentTypeDef#

# TreatmentTypeDef definition

class TreatmentTypeDef(TypedDict):
    name: str,
    description: NotRequired[str],
    featureVariations: NotRequired[Dict[str, str]],

GetExperimentRequestRequestTypeDef#

# GetExperimentRequestRequestTypeDef definition

class GetExperimentRequestRequestTypeDef(TypedDict):
    experiment: str,
    project: str,

GetFeatureRequestRequestTypeDef#

# GetFeatureRequestRequestTypeDef definition

class GetFeatureRequestRequestTypeDef(TypedDict):
    feature: str,
    project: str,

GetLaunchRequestRequestTypeDef#

# GetLaunchRequestRequestTypeDef definition

class GetLaunchRequestRequestTypeDef(TypedDict):
    launch: str,
    project: str,

GetProjectRequestRequestTypeDef#

# GetProjectRequestRequestTypeDef definition

class GetProjectRequestRequestTypeDef(TypedDict):
    project: str,

GetSegmentRequestRequestTypeDef#

# GetSegmentRequestRequestTypeDef definition

class GetSegmentRequestRequestTypeDef(TypedDict):
    segment: str,

LaunchExecutionTypeDef#

# LaunchExecutionTypeDef definition

class LaunchExecutionTypeDef(TypedDict):
    endedTime: NotRequired[datetime],
    startedTime: NotRequired[datetime],

LaunchGroupTypeDef#

# LaunchGroupTypeDef definition

class LaunchGroupTypeDef(TypedDict):
    featureVariations: Dict[str, str],
    name: str,
    description: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListExperimentsRequestRequestTypeDef#

# ListExperimentsRequestRequestTypeDef definition

class ListExperimentsRequestRequestTypeDef(TypedDict):
    project: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    status: NotRequired[ExperimentStatusType],  # (1)
  1. See ExperimentStatusType

ListFeaturesRequestRequestTypeDef#

# ListFeaturesRequestRequestTypeDef definition

class ListFeaturesRequestRequestTypeDef(TypedDict):
    project: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListLaunchesRequestRequestTypeDef#

# ListLaunchesRequestRequestTypeDef definition

class ListLaunchesRequestRequestTypeDef(TypedDict):
    project: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    status: NotRequired[LaunchStatusType],  # (1)
  1. See LaunchStatusType

ListProjectsRequestRequestTypeDef#

# ListProjectsRequestRequestTypeDef definition

class ListProjectsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ProjectSummaryTypeDef#

# ProjectSummaryTypeDef definition

class ProjectSummaryTypeDef(TypedDict):
    arn: str,
    createdTime: datetime,
    lastUpdatedTime: datetime,
    name: str,
    status: ProjectStatusType,  # (1)
    activeExperimentCount: NotRequired[int],
    activeLaunchCount: NotRequired[int],
    description: NotRequired[str],
    experimentCount: NotRequired[int],
    featureCount: NotRequired[int],
    launchCount: NotRequired[int],
    tags: NotRequired[Dict[str, str]],
  1. See ProjectStatusType

ListSegmentReferencesRequestRequestTypeDef#

# ListSegmentReferencesRequestRequestTypeDef definition

class ListSegmentReferencesRequestRequestTypeDef(TypedDict):
    segment: str,
    type: SegmentReferenceResourceTypeType,  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See SegmentReferenceResourceTypeType

RefResourceTypeDef#

# RefResourceTypeDef definition

class RefResourceTypeDef(TypedDict):
    name: str,
    type: str,
    arn: NotRequired[str],
    endTime: NotRequired[str],
    lastUpdatedOn: NotRequired[str],
    startTime: NotRequired[str],
    status: NotRequired[str],

ListSegmentsRequestRequestTypeDef#

# ListSegmentsRequestRequestTypeDef definition

class ListSegmentsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

MetricDefinitionConfigTypeDef#

# MetricDefinitionConfigTypeDef definition

class MetricDefinitionConfigTypeDef(TypedDict):
    entityIdKey: str,
    name: str,
    valueKey: str,
    eventPattern: NotRequired[str],
    unitLabel: NotRequired[str],

MetricDefinitionTypeDef#

# MetricDefinitionTypeDef definition

class MetricDefinitionTypeDef(TypedDict):
    entityIdKey: NotRequired[str],
    eventPattern: NotRequired[str],
    name: NotRequired[str],
    unitLabel: NotRequired[str],
    valueKey: NotRequired[str],

ProjectAppConfigResourceTypeDef#

# ProjectAppConfigResourceTypeDef definition

class ProjectAppConfigResourceTypeDef(TypedDict):
    applicationId: str,
    configurationProfileId: str,
    environmentId: str,

S3DestinationConfigTypeDef#

# S3DestinationConfigTypeDef definition

class S3DestinationConfigTypeDef(TypedDict):
    bucket: NotRequired[str],
    prefix: NotRequired[str],

S3DestinationTypeDef#

# S3DestinationTypeDef definition

class S3DestinationTypeDef(TypedDict):
    bucket: NotRequired[str],
    prefix: NotRequired[str],

PutProjectEventsResultEntryTypeDef#

# PutProjectEventsResultEntryTypeDef definition

class PutProjectEventsResultEntryTypeDef(TypedDict):
    errorCode: NotRequired[str],
    errorMessage: NotRequired[str],
    eventId: NotRequired[str],

SegmentOverrideTypeDef#

# SegmentOverrideTypeDef definition

class SegmentOverrideTypeDef(TypedDict):
    evaluationOrder: int,
    segment: str,
    weights: Mapping[str, int],

SegmentOverridePaginatorTypeDef#

# SegmentOverridePaginatorTypeDef definition

class SegmentOverridePaginatorTypeDef(TypedDict):
    evaluationOrder: int,
    segment: str,
    weights: Dict[str, int],

StartLaunchRequestRequestTypeDef#

# StartLaunchRequestRequestTypeDef definition

class StartLaunchRequestRequestTypeDef(TypedDict):
    launch: str,
    project: str,

StopExperimentRequestRequestTypeDef#

# StopExperimentRequestRequestTypeDef definition

class StopExperimentRequestRequestTypeDef(TypedDict):
    experiment: str,
    project: str,
    desiredState: NotRequired[ExperimentStopDesiredStateType],  # (1)
    reason: NotRequired[str],
  1. See ExperimentStopDesiredStateType

StopLaunchRequestRequestTypeDef#

# StopLaunchRequestRequestTypeDef definition

class StopLaunchRequestRequestTypeDef(TypedDict):
    launch: str,
    project: str,
    desiredState: NotRequired[LaunchStopDesiredStateType],  # (1)
    reason: NotRequired[str],
  1. See LaunchStopDesiredStateType

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

TestSegmentPatternRequestRequestTypeDef#

# TestSegmentPatternRequestRequestTypeDef definition

class TestSegmentPatternRequestRequestTypeDef(TypedDict):
    pattern: str,
    payload: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

BatchEvaluateFeatureRequestRequestTypeDef#

# BatchEvaluateFeatureRequestRequestTypeDef definition

class BatchEvaluateFeatureRequestRequestTypeDef(TypedDict):
    project: str,
    requests: Sequence[EvaluationRequestTypeDef],  # (1)
  1. See EvaluationRequestTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartExperimentResponseTypeDef#

# StartExperimentResponseTypeDef definition

class StartExperimentResponseTypeDef(TypedDict):
    startedTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopExperimentResponseTypeDef#

# StopExperimentResponseTypeDef definition

class StopExperimentResponseTypeDef(TypedDict):
    endedTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopLaunchResponseTypeDef#

# StopLaunchResponseTypeDef definition

class StopLaunchResponseTypeDef(TypedDict):
    endedTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TestSegmentPatternResponseTypeDef#

# TestSegmentPatternResponseTypeDef definition

class TestSegmentPatternResponseTypeDef(TypedDict):
    match: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateProjectRequestRequestTypeDef#

# UpdateProjectRequestRequestTypeDef definition

class UpdateProjectRequestRequestTypeDef(TypedDict):
    project: str,
    appConfigResource: NotRequired[ProjectAppConfigResourceConfigTypeDef],  # (1)
    description: NotRequired[str],
  1. See ProjectAppConfigResourceConfigTypeDef

CreateSegmentResponseTypeDef#

# CreateSegmentResponseTypeDef definition

class CreateSegmentResponseTypeDef(TypedDict):
    segment: SegmentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SegmentTypeDef
  2. See ResponseMetadataTypeDef

GetSegmentResponseTypeDef#

# GetSegmentResponseTypeDef definition

class GetSegmentResponseTypeDef(TypedDict):
    segment: SegmentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SegmentTypeDef
  2. See ResponseMetadataTypeDef

ListSegmentsResponseTypeDef#

# ListSegmentsResponseTypeDef definition

class ListSegmentsResponseTypeDef(TypedDict):
    nextToken: str,
    segments: List[SegmentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SegmentTypeDef
  2. See ResponseMetadataTypeDef

EvaluateFeatureResponseTypeDef#

# EvaluateFeatureResponseTypeDef definition

class EvaluateFeatureResponseTypeDef(TypedDict):
    details: str,
    reason: str,
    value: VariableValueTypeDef,  # (1)
    variation: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VariableValueTypeDef
  2. See ResponseMetadataTypeDef

EvaluationResultTypeDef#

# EvaluationResultTypeDef definition

class EvaluationResultTypeDef(TypedDict):
    entityId: str,
    feature: str,
    details: NotRequired[str],
    project: NotRequired[str],
    reason: NotRequired[str],
    value: NotRequired[VariableValueTypeDef],  # (1)
    variation: NotRequired[str],
  1. See VariableValueTypeDef

VariationConfigTypeDef#

# VariationConfigTypeDef definition

class VariationConfigTypeDef(TypedDict):
    name: str,
    value: VariableValueTypeDef,  # (1)
  1. See VariableValueTypeDef

VariationTypeDef#

# VariationTypeDef definition

class VariationTypeDef(TypedDict):
    name: NotRequired[str],
    value: NotRequired[VariableValueTypeDef],  # (1)
  1. See VariableValueTypeDef

FeatureSummaryTypeDef#

# FeatureSummaryTypeDef definition

class FeatureSummaryTypeDef(TypedDict):
    arn: str,
    createdTime: datetime,
    evaluationStrategy: FeatureEvaluationStrategyType,  # (2)
    lastUpdatedTime: datetime,
    name: str,
    status: FeatureStatusType,  # (3)
    defaultVariation: NotRequired[str],
    evaluationRules: NotRequired[List[EvaluationRuleTypeDef]],  # (1)
    project: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See EvaluationRuleTypeDef
  2. See FeatureEvaluationStrategyType
  3. See FeatureStatusType

EventTypeDef#

# EventTypeDef definition

class EventTypeDef(TypedDict):
    data: str,
    timestamp: Union[datetime, str],
    type: EventTypeType,  # (1)
  1. See EventTypeType

GetExperimentResultsRequestRequestTypeDef#

# GetExperimentResultsRequestRequestTypeDef definition

class GetExperimentResultsRequestRequestTypeDef(TypedDict):
    experiment: str,
    metric