Skip to content

CampaignSummary

Source code in docs_src/capo_personalize/types/campaign_summary.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class CampaignSummary(TypedDict, closed=True):
    name: NotRequired["capo_personalize.types.name.Name"]
    """<p>The name of the campaign.</p>"""
    campaign_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the campaign.</p>"""
    status: NotRequired["capo_personalize.types.status.Status"]
    """<p>The status of the campaign.</p> <p>A campaign can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul>"""
    creation_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The date and time (in Unix time) that the campaign was created.</p>"""
    last_updated_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The date and time (in Unix time) that the campaign was last updated.</p>"""
    failure_reason: NotRequired["capo_personalize.types.failure_reason.FailureReason"]
    """<p>If a campaign fails, the reason behind the failure.</p>"""

campaign_arn instance-attribute 

campaign_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the campaign.

creation_date_time instance-attribute 

creation_date_time: NotRequired[Date]

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

failure_reason instance-attribute 

failure_reason: NotRequired[FailureReason]

If a campaign fails, the reason behind the failure.

last_updated_date_time instance-attribute 

last_updated_date_time: NotRequired[Date]

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

name instance-attribute 

name: NotRequired[Name]

The name of the campaign.

status instance-attribute 

status: NotRequired[Status]

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