Skip to content

Type definitions#

Index > Health > Type definitions

Auto-generated documentation for Health type annotations stubs module mypy-boto3-health.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AccountEntityAggregateTypeDef#

# AccountEntityAggregateTypeDef definition

class AccountEntityAggregateTypeDef(TypedDict):
    accountId: NotRequired[str],
    count: NotRequired[int],
    statuses: NotRequired[dict[EntityStatusCodeType, int]],  # (1)
  1. See EntityStatusCodeType

AffectedEntityTypeDef#

# AffectedEntityTypeDef definition

class AffectedEntityTypeDef(TypedDict):
    entityArn: NotRequired[str],
    eventArn: NotRequired[str],
    entityValue: NotRequired[str],
    entityUrl: NotRequired[str],
    awsAccountId: NotRequired[str],
    lastUpdatedTime: NotRequired[datetime],
    statusCode: NotRequired[EntityStatusCodeType],  # (1)
    tags: NotRequired[dict[str, str]],
    entityMetadata: NotRequired[dict[str, str]],
  1. See EntityStatusCodeType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

DescribeAffectedAccountsForOrganizationRequestRequestTypeDef#

# DescribeAffectedAccountsForOrganizationRequestRequestTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

EntityAccountFilterTypeDef#

# EntityAccountFilterTypeDef definition

class EntityAccountFilterTypeDef(TypedDict):
    eventArn: str,
    awsAccountId: NotRequired[str],
    statusCodes: NotRequired[Sequence[EntityStatusCodeType]],  # (1)
  1. See EntityStatusCodeType

EventAccountFilterTypeDef#

# EventAccountFilterTypeDef definition

class EventAccountFilterTypeDef(TypedDict):
    eventArn: str,
    awsAccountId: NotRequired[str],

OrganizationAffectedEntitiesErrorItemTypeDef#

# OrganizationAffectedEntitiesErrorItemTypeDef definition

class OrganizationAffectedEntitiesErrorItemTypeDef(TypedDict):
    awsAccountId: NotRequired[str],
    eventArn: NotRequired[str],
    errorName: NotRequired[str],
    errorMessage: NotRequired[str],

DescribeEntityAggregatesForOrganizationRequestRequestTypeDef#

# DescribeEntityAggregatesForOrganizationRequestRequestTypeDef definition

class DescribeEntityAggregatesForOrganizationRequestRequestTypeDef(TypedDict):
    eventArns: Sequence[str],
    awsAccountIds: NotRequired[Sequence[str]],

DescribeEntityAggregatesRequestRequestTypeDef#

# DescribeEntityAggregatesRequestRequestTypeDef definition

class DescribeEntityAggregatesRequestRequestTypeDef(TypedDict):
    eventArns: NotRequired[Sequence[str]],

EntityAggregateTypeDef#

# EntityAggregateTypeDef definition

class EntityAggregateTypeDef(TypedDict):
    eventArn: NotRequired[str],
    count: NotRequired[int],
    statuses: NotRequired[dict[EntityStatusCodeType, int]],  # (1)
  1. See EntityStatusCodeType

EventAggregateTypeDef#

# EventAggregateTypeDef definition

class EventAggregateTypeDef(TypedDict):
    aggregateValue: NotRequired[str],
    count: NotRequired[int],

OrganizationEventDetailsErrorItemTypeDef#

# OrganizationEventDetailsErrorItemTypeDef definition

class OrganizationEventDetailsErrorItemTypeDef(TypedDict):
    awsAccountId: NotRequired[str],
    eventArn: NotRequired[str],
    errorName: NotRequired[str],
    errorMessage: NotRequired[str],

DescribeEventDetailsRequestRequestTypeDef#

# DescribeEventDetailsRequestRequestTypeDef definition

class DescribeEventDetailsRequestRequestTypeDef(TypedDict):
    eventArns: Sequence[str],
    locale: NotRequired[str],

EventDetailsErrorItemTypeDef#

# EventDetailsErrorItemTypeDef definition

class EventDetailsErrorItemTypeDef(TypedDict):
    eventArn: NotRequired[str],
    errorName: NotRequired[str],
    errorMessage: NotRequired[str],

EventTypeFilterTypeDef#

# EventTypeFilterTypeDef definition

class EventTypeFilterTypeDef(TypedDict):
    eventTypeCodes: NotRequired[Sequence[str]],
    services: NotRequired[Sequence[str]],
    eventTypeCategories: NotRequired[Sequence[EventTypeCategoryType]],  # (1)
  1. See EventTypeCategoryType

EventTypeTypeDef#

# EventTypeTypeDef definition

class EventTypeTypeDef(TypedDict):
    service: NotRequired[str],
    code: NotRequired[str],
    category: NotRequired[EventTypeCategoryType],  # (1)
  1. See EventTypeCategoryType

OrganizationEventTypeDef#

# OrganizationEventTypeDef definition

class OrganizationEventTypeDef(TypedDict):
    arn: NotRequired[str],
    service: NotRequired[str],
    eventTypeCode: NotRequired[str],
    eventTypeCategory: NotRequired[EventTypeCategoryType],  # (1)
    eventScopeCode: NotRequired[EventScopeCodeType],  # (2)
    region: NotRequired[str],
    startTime: NotRequired[datetime],
    endTime: NotRequired[datetime],
    lastUpdatedTime: NotRequired[datetime],
    statusCode: NotRequired[EventStatusCodeType],  # (3)
  1. See EventTypeCategoryType
  2. See EventScopeCodeType
  3. See EventStatusCodeType

EventTypeDef#

# EventTypeDef definition

class EventTypeDef(TypedDict):
    arn: NotRequired[str],
    service: NotRequired[str],
    eventTypeCode: NotRequired[str],
    eventTypeCategory: NotRequired[EventTypeCategoryType],  # (1)
    region: NotRequired[str],
    availabilityZone: NotRequired[str],
    startTime: NotRequired[datetime],
    endTime: NotRequired[datetime],
    lastUpdatedTime: NotRequired[datetime],
    statusCode: NotRequired[EventStatusCodeType],  # (2)
    eventScopeCode: NotRequired[EventScopeCodeType],  # (3)
  1. See EventTypeCategoryType
  2. See EventStatusCodeType
  3. See EventScopeCodeType

EventDescriptionTypeDef#

# EventDescriptionTypeDef definition

class EventDescriptionTypeDef(TypedDict):
    latestDescription: NotRequired[str],

OrganizationEntityAggregateTypeDef#

# OrganizationEntityAggregateTypeDef definition

class OrganizationEntityAggregateTypeDef(TypedDict):
    eventArn: NotRequired[str],
    count: NotRequired[int],
    statuses: NotRequired[dict[EntityStatusCodeType, int]],  # (1)
    accounts: NotRequired[list[AccountEntityAggregateTypeDef]],  # (2)
  1. See EntityStatusCodeType
  2. See AccountEntityAggregateTypeDef

DateTimeRangeTypeDef#

# DateTimeRangeTypeDef definition

class DateTimeRangeTypeDef(TypedDict):
    from: NotRequired[TimestampTypeDef],
    to: NotRequired[TimestampTypeDef],

DescribeAffectedAccountsForOrganizationRequestPaginateTypeDef#

# DescribeAffectedAccountsForOrganizationRequestPaginateTypeDef definition

class DescribeAffectedAccountsForOrganizationRequestPaginateTypeDef(TypedDict):
    eventArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeAffectedAccountsForOrganizationResponseTypeDef#

# DescribeAffectedAccountsForOrganizationResponseTypeDef definition

class DescribeAffectedAccountsForOrganizationResponseTypeDef(TypedDict):
    affectedAccounts: list[str],
    eventScopeCode: EventScopeCodeType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See EventScopeCodeType
  2. See ResponseMetadataTypeDef

DescribeAffectedEntitiesResponseTypeDef#

# DescribeAffectedEntitiesResponseTypeDef definition

class DescribeAffectedEntitiesResponseTypeDef(TypedDict):
    entities: list[AffectedEntityTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AffectedEntityTypeDef
  2. See ResponseMetadataTypeDef

DescribeHealthServiceStatusForOrganizationResponseTypeDef#

# DescribeHealthServiceStatusForOrganizationResponseTypeDef definition

class DescribeHealthServiceStatusForOrganizationResponseTypeDef(TypedDict):
    healthServiceAccessStatusForOrganization: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeAffectedEntitiesForOrganizationRequestPaginateTypeDef#

# DescribeAffectedEntitiesForOrganizationRequestPaginateTypeDef definition

class DescribeAffectedEntitiesForOrganizationRequestPaginateTypeDef(TypedDict):
    organizationEntityFilters: NotRequired[Sequence[EventAccountFilterTypeDef]],  # (1)
    locale: NotRequired[str],
    organizationEntityAccountFilters: NotRequired[Sequence[EntityAccountFilterTypeDef]],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See EventAccountFilterTypeDef
  2. See EntityAccountFilterTypeDef
  3. See PaginatorConfigTypeDef

DescribeAffectedEntitiesForOrganizationRequestRequestTypeDef#

# DescribeAffectedEntitiesForOrganizationRequestRequestTypeDef definition

class DescribeAffectedEntitiesForOrganizationRequestRequestTypeDef(TypedDict):
    organizationEntityFilters: NotRequired[Sequence[EventAccountFilterTypeDef]],  # (1)
    locale: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    organizationEntityAccountFilters: NotRequired[Sequence[EntityAccountFilterTypeDef]],  # (2)
  1. See EventAccountFilterTypeDef
  2. See EntityAccountFilterTypeDef

DescribeEventDetailsForOrganizationRequestRequestTypeDef#

# DescribeEventDetailsForOrganizationRequestRequestTypeDef definition

class DescribeEventDetailsForOrganizationRequestRequestTypeDef(TypedDict):
    organizationEventDetailFilters: Sequence[EventAccountFilterTypeDef],  # (1)
    locale: NotRequired[str],
  1. See EventAccountFilterTypeDef

DescribeAffectedEntitiesForOrganizationResponseTypeDef#

# DescribeAffectedEntitiesForOrganizationResponseTypeDef definition

class DescribeAffectedEntitiesForOrganizationResponseTypeDef(TypedDict):
    entities: list[AffectedEntityTypeDef],  # (1)
    failedSet: list[OrganizationAffectedEntitiesErrorItemTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    nextToken: NotRequired[str],
  1. See AffectedEntityTypeDef
  2. See OrganizationAffectedEntitiesErrorItemTypeDef
  3. See ResponseMetadataTypeDef

DescribeEntityAggregatesResponseTypeDef#

# DescribeEntityAggregatesResponseTypeDef definition

class DescribeEntityAggregatesResponseTypeDef(TypedDict):
    entityAggregates: list[EntityAggregateTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EntityAggregateTypeDef
  2. See ResponseMetadataTypeDef

DescribeEventAggregatesResponseTypeDef#

# DescribeEventAggregatesResponseTypeDef definition

class DescribeEventAggregatesResponseTypeDef(TypedDict):
    eventAggregates: list[EventAggregateTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See EventAggregateTypeDef
  2. See ResponseMetadataTypeDef

DescribeEventTypesRequestPaginateTypeDef#

# DescribeEventTypesRequestPaginateTypeDef definition

class DescribeEventTypesRequestPaginateTypeDef(TypedDict):
    filter: NotRequired[EventTypeFilterTypeDef],  # (1)
    locale: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See EventTypeFilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeEventTypesRequestRequestTypeDef#

# DescribeEventTypesRequestRequestTypeDef definition

class DescribeEventTypesRequestRequestTypeDef(TypedDict):
    filter: NotRequired[EventTypeFilterTypeDef],  # (1)
    locale: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See EventTypeFilterTypeDef

DescribeEventTypesResponseTypeDef#

# DescribeEventTypesResponseTypeDef definition

class DescribeEventTypesResponseTypeDef(TypedDict):
    eventTypes: list[EventTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See EventTypeTypeDef
  2. See ResponseMetadataTypeDef

DescribeEventsForOrganizationResponseTypeDef#

# DescribeEventsForOrganizationResponseTypeDef definition

class DescribeEventsForOrganizationResponseTypeDef(TypedDict):
    events: list[OrganizationEventTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See OrganizationEventTypeDef
  2. See ResponseMetadataTypeDef

DescribeEventsResponseTypeDef#

# DescribeEventsResponseTypeDef definition

class DescribeEventsResponseTypeDef(TypedDict):
    events: list[EventTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See EventTypeDef
  2. See ResponseMetadataTypeDef

EventDetailsTypeDef#

# EventDetailsTypeDef definition

class EventDetailsTypeDef(TypedDict):
    event: NotRequired[EventTypeDef],  # (1)
    eventDescription: NotRequired[EventDescriptionTypeDef],  # (2)
    eventMetadata: NotRequired[dict[str, str]],
  1. See EventTypeDef
  2. See EventDescriptionTypeDef

OrganizationEventDetailsTypeDef#

# OrganizationEventDetailsTypeDef definition

class OrganizationEventDetailsTypeDef(TypedDict):
    awsAccountId: NotRequired[str],
    event: NotRequired[EventTypeDef],  # (1)
    eventDescription: NotRequired[EventDescriptionTypeDef],  # (2)
    eventMetadata: NotRequired[dict[str, str]],
  1. See EventTypeDef
  2. See EventDescriptionTypeDef

DescribeEntityAggregatesForOrganizationResponseTypeDef#

# DescribeEntityAggregatesForOrganizationResponseTypeDef definition

class DescribeEntityAggregatesForOrganizationResponseTypeDef(TypedDict):
    organizationEntityAggregates: list[OrganizationEntityAggregateTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See OrganizationEntityAggregateTypeDef
  2. See ResponseMetadataTypeDef

EntityFilterTypeDef#

# EntityFilterTypeDef definition

class EntityFilterTypeDef(TypedDict):
    eventArns: Sequence[str],
    entityArns: NotRequired[Sequence[str]],
    entityValues: NotRequired[Sequence[str]],
    lastUpdatedTimes: NotRequired[Sequence[DateTimeRangeTypeDef]],  # (1)
    tags: NotRequired[Sequence[Mapping[str, str]]],
    statusCodes: NotRequired[Sequence[EntityStatusCodeType]],  # (2)
  1. See DateTimeRangeTypeDef
  2. See EntityStatusCodeType

EventFilterTypeDef#

# EventFilterTypeDef definition

class EventFilterTypeDef(TypedDict):
    eventArns: NotRequired[Sequence[str]],
    eventTypeCodes: NotRequired[Sequence[str]],
    services: NotRequired[Sequence[str]],
    regions: NotRequired[Sequence[str]],
    availabilityZones: NotRequired[Sequence[str]],
    startTimes: NotRequired[Sequence[DateTimeRangeTypeDef]],  # (1)
    endTimes: NotRequired[Sequence[DateTimeRangeTypeDef]],  # (1)
    lastUpdatedTimes: NotRequired[Sequence[DateTimeRangeTypeDef]],  # (1)
    entityArns: NotRequired[Sequence[str]],
    entityValues: NotRequired[Sequence[str]],
    eventTypeCategories: NotRequired[Sequence[EventTypeCategoryType]],  # (4)
    tags: NotRequired[Sequence[Mapping[str, str]]],
    eventStatusCodes: NotRequired[Sequence[EventStatusCodeType]],  # (5)
  1. See DateTimeRangeTypeDef
  2. See DateTimeRangeTypeDef
  3. See DateTimeRangeTypeDef
  4. See EventTypeCategoryType
  5. See EventStatusCodeType

OrganizationEventFilterTypeDef#

# OrganizationEventFilterTypeDef definition

class OrganizationEventFilterTypeDef(TypedDict):
    eventTypeCodes: NotRequired[Sequence[str]],
    awsAccountIds: NotRequired[Sequence[str]],
    services: NotRequired[Sequence[str]],
    regions: NotRequired[Sequence[str]],
    startTime: NotRequired[DateTimeRangeTypeDef],  # (1)
    endTime: NotRequired[DateTimeRangeTypeDef],  # (1)
    lastUpdatedTime: NotRequired[DateTimeRangeTypeDef],  # (1)
    entityArns: NotRequired[Sequence[str]],
    entityValues: NotRequired[Sequence[str]],
    eventTypeCategories: NotRequired[Sequence[EventTypeCategoryType]],  # (4)
    eventStatusCodes: NotRequired[Sequence[EventStatusCodeType]],  # (5)
  1. See DateTimeRangeTypeDef
  2. See DateTimeRangeTypeDef
  3. See DateTimeRangeTypeDef
  4. See EventTypeCategoryType
  5. See EventStatusCodeType

DescribeEventDetailsResponseTypeDef#

# DescribeEventDetailsResponseTypeDef definition

class DescribeEventDetailsResponseTypeDef(TypedDict):
    successfulSet: list[EventDetailsTypeDef],  # (1)
    failedSet: list[EventDetailsErrorItemTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See EventDetailsTypeDef
  2. See EventDetailsErrorItemTypeDef
  3. See ResponseMetadataTypeDef

DescribeEventDetailsForOrganizationResponseTypeDef#

# DescribeEventDetailsForOrganizationResponseTypeDef definition

class DescribeEventDetailsForOrganizationResponseTypeDef(TypedDict):
    successfulSet: list[OrganizationEventDetailsTypeDef],  # (1)
    failedSet: list[OrganizationEventDetailsErrorItemTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See OrganizationEventDetailsTypeDef
  2. See OrganizationEventDetailsErrorItemTypeDef
  3. See ResponseMetadataTypeDef

DescribeAffectedEntitiesRequestPaginateTypeDef#

# DescribeAffectedEntitiesRequestPaginateTypeDef definition

class DescribeAffectedEntitiesRequestPaginateTypeDef(TypedDict):
    filter: EntityFilterTypeDef,  # (1)
    locale: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See EntityFilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeAffectedEntitiesRequestRequestTypeDef#

# DescribeAffectedEntitiesRequestRequestTypeDef definition

class DescribeAffectedEntitiesRequestRequestTypeDef(TypedDict):
    filter: EntityFilterTypeDef,  # (1)
    locale: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See EntityFilterTypeDef

DescribeEventAggregatesRequestPaginateTypeDef#

# DescribeEventAggregatesRequestPaginateTypeDef definition

class DescribeEventAggregatesRequestPaginateTypeDef(TypedDict):
    aggregateField: EventAggregateFieldType,  # (1)
    filter: NotRequired[EventFilterTypeDef],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See EventAggregateFieldType
  2. See EventFilterTypeDef
  3. See PaginatorConfigTypeDef

DescribeEventAggregatesRequestRequestTypeDef#

# DescribeEventAggregatesRequestRequestTypeDef definition

class DescribeEventAggregatesRequestRequestTypeDef(TypedDict):
    aggregateField: EventAggregateFieldType,  # (1)
    filter: NotRequired[EventFilterTypeDef],  # (2)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See EventAggregateFieldType
  2. See EventFilterTypeDef

DescribeEventsRequestPaginateTypeDef#

# DescribeEventsRequestPaginateTypeDef definition

class DescribeEventsRequestPaginateTypeDef(TypedDict):
    filter: NotRequired[EventFilterTypeDef],  # (1)
    locale: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See EventFilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeEventsRequestRequestTypeDef#

# DescribeEventsRequestRequestTypeDef definition

class DescribeEventsRequestRequestTypeDef(TypedDict):
    filter: NotRequired[EventFilterTypeDef],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    locale: NotRequired[str],
  1. See EventFilterTypeDef

DescribeEventsForOrganizationRequestPaginateTypeDef#

# DescribeEventsForOrganizationRequestPaginateTypeDef definition

class DescribeEventsForOrganizationRequestPaginateTypeDef(TypedDict):
    filter: NotRequired[OrganizationEventFilterTypeDef],  # (1)
    locale: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See OrganizationEventFilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeEventsForOrganizationRequestRequestTypeDef#

# DescribeEventsForOrganizationRequestRequestTypeDef definition

class DescribeEventsForOrganizationRequestRequestTypeDef(TypedDict):
    filter: NotRequired[OrganizationEventFilterTypeDef],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    locale: NotRequired[str],
  1. See OrganizationEventFilterTypeDef