Status Page¶

This is a standalone module containing all StatusPage related return classes, responsible for fetching the current server status from the status page.

class arez.StatusPage(url, *, loop=None)[source]¶

An object representing StatusPage access.

Parameters: url (str) – The URL of the StatusPage you want to get this object for.

await get_status()[source]¶

Fetches the current statuspage’s status.

Returns: The current status requested.
Return type: CurrentStatus
Raises: aiohttp.ClientError – When there was an error while fetching the current status.

class arez.statuspage.CurrentStatus[source]¶

Represents the current server’s status.

id¶

The ID of the status page.

Type: str

name¶

The name of the status page.

Type: str

updated_at¶

The timestamp of when the current status was last updated.

Type: datetime.datetime

status¶

The current overall page’s status.

Type: Literal[“All Systems Operational”, “Major System Outage”, “Partial System Outage”, “Minor Service Outage”, “Degraded System Service”, “Partially Degraded Service”, “Service Under Maintenance”]

impact¶

The current overall page’s impact.

Type: Literal[“None”, “Minor”, “Major”, “Critical”]

color¶

The color associated with this status (based on impact).

There is an alias for this under colour.

Type: int

components¶

A list of components this status page contains. This doesn’t include groups.

Type: List[Component]

groups¶

A list of component groups this status page contains. This includes groups only.

Type: List[ComponentGroup]

incidents¶

A list of current incidents.

Type: List[Incident]

maintenances¶

A list of scheduled maintenances.

Type: List[Maintenance]

component(component)[source]¶

Lookup a component of this status by either it’s ID or Name.

Parameters

component (str) – The component’s ID or Name you want to get.

Returns

The component requested.

None is returned if no components matched.

Return type

Optional[Component]

group(group)[source]¶

Lookup a component group of this status by either it’s ID or Name.

Parameters

group (str) – The component group’s ID or Name you want to get.

Returns

The component group requested.

None is returned if no component groups matched.

Return type

Optional[ComponentGroup]

class arez.statuspage.ComponentGroup[source]¶

Represents a component’s group.

id¶

The ID of the component group.

Type: str

created_at¶

The time when this component group was created.

Type: datetime.datetime

updated_at¶

The last time this component group was updated.

Type: datetime.datetime

name¶

The name of the component group.

Type: str

status¶

The current component group’s status.

This represents the worst status of all of the components in a group.

Under Maintenance is considered second worst.

Type: Literal[“Operational”, “Under Maintenance”, “Degraded Performance”, “Partial Outage”, “Major Outage”]

color¶

The color associated with this component (based on status).

There is an alias for this under colour.

Type: int

components¶

A list of components this group has.

Type: List[Component]

incidents¶

A list of incidents referring to components of this group.

Type: List[Incident]

maintenances¶

A list of scheduled maintenances referring to components of this group.

Type: List[Maintenance]

class arez.statuspage.Component[source]¶

Represents a status component.

id¶

The ID of the component.

Type: str

created_at¶

The time when this component was created.

Type: datetime.datetime

updated_at¶

The last time this component was updated.

Type: datetime.datetime

name¶

The name of the component.

Type: str

status¶

The current component’s status.

Type: Literal[“Operational”, “Under Maintenance”, “Degraded Performance”, “Partial Outage”, “Major Outage”]

color¶

The color associated with this component (based on status).

There is an alias for this under colour.

Type: int

group¶

The component group this component belongs to.

Can be None if it belongs to no group.

Type: Optional[ComponentGroup]

incidents¶

A list of incidents referring to this component.

Type: List[Incident]

maintenances¶

A list of maintenances referring to this component.

Type: List[Maintenance]

class arez.statuspage.Incident[source]¶

Represents an incident.

id¶

The ID of the incident.

Type: str

created_at¶

The time when this incident was created.

Type: datetime.datetime

updated_at¶

The last time this incident was updated.

Type: datetime.datetime

name¶

The name of the incident.

Type: str

status¶

The current incident’s status.

Type: Literal[“Investigating”, “Identified”, “Monitoring”, “Resolved”, “Postmortem”]

impact¶

The impact of this incident.

Type: Literal[“None”, “Minor”, “Major”, “Critical”]

color¶

The color associated with this incident (based on impact).

There is an alias for this under colour.

Type: int

components¶

A list of components affected by this incident.

Type: List[Component]

updates¶

A list of updates this incident has.

Type: List[Update]

last_update¶

The most recent update this incident has.

Type: Update

class arez.statuspage.Maintenance[source]¶

Represents a (scheduled) maintenance.

id¶

The ID of the maintenance.

Type: str

created_at¶

The time when this maintenance was created.

Type: datetime.datetime

updated_at¶

The last time this maintenance was updated.

Type: datetime.datetime

name¶

The name of the maintenance.

Type: str

status¶

The current maintenance’s status.

Type: Literal[“Scheduled”, “In Progress”, “Verifying”, “Completed”]

impact¶

The impact of this maintenance.

Type: Literal[“Maintenance”]

color¶

The color associated with this maintenance (based on impact).

There is an alias for this under colour.

Type: int

components¶

A list of components affected by this maintenance.

Type: List[Component]

scheduled_for¶

The planned time this maintenance is to start.

Type: datetime.datetime

scheduled_until¶

The planned time this maintenance is to end.

Type: datetime.datetime

updates¶

A list of updates this maintenance has.

Type: List[Update]

last_update¶

The most recent update this maintenance has.

Type: Update

class arez.statuspage.Update[source]¶

Represents an incident or scheduled maintenance status update.

id¶

The ID of the update.

Type: str

created_at¶

The time when this update was created.

Type: datetime.datetime

updated_at¶

The last time this update was updated.

Type: datetime.datetime

description¶

Description explaining what this update is about.

Type: str

status¶

The status of this update.

Type: str

Status Page¶

Previous topic

This Page