ECS Deployment State Change

This is emitted when an ECS Service Deployment occurs. See AWS documentation for more information on when this might be emitted.

Primary Model

pydantic model botocraft.eventbridge.ecs.ECSServiceDeploymentStateChangeEvent

Bases: EventBridgeEvent, ECSServiceDeploymentStateChangeEvent

EventBridge event for ECS service deployment state change.

Show JSON schema

{
   "title": "ECSServiceDeploymentStateChangeEvent",
   "description": "EventBridge event for ECS service deployment state change.",
   "type": "object",
   "properties": {
      "detail": {
         "$ref": "#/$defs/ECSServiceDeploymentStateChange"
      },
      "detail-type": {
         "title": "Detail-Type",
         "type": "string"
      },
      "resources": {
         "items": {
            "type": "string"
         },
         "title": "Resources",
         "type": "array"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "source": {
         "title": "Source",
         "type": "string"
      },
      "region": {
         "title": "Region",
         "type": "string"
      },
      "time": {
         "format": "date-time",
         "title": "Time",
         "type": "string"
      },
      "version": {
         "title": "Version",
         "type": "string"
      },
      "account": {
         "title": "Account",
         "type": "string"
      },
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      }
   },
   "$defs": {
      "ECSServiceDeploymentStateChange": {
         "description": "The main body of the ECS Service Deployment State Change event.",
         "properties": {
            "eventName": {
               "title": "Eventname",
               "type": "string"
            },
            "eventType": {
               "title": "Eventtype",
               "type": "string"
            },
            "deploymentId": {
               "title": "Deploymentid",
               "type": "string"
            },
            "updatedAt": {
               "format": "date-time",
               "title": "Updatedat",
               "type": "string"
            },
            "reason": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Reason"
            }
         },
         "required": [
            "eventName",
            "eventType",
            "deploymentId",
            "updatedAt"
         ],
         "title": "ECSServiceDeploymentStateChange",
         "type": "object"
      }
   },
   "required": [
      "detail",
      "detail-type",
      "resources",
      "id",
      "source",
      "region",
      "time",
      "version",
      "account"
   ]
}

Fields:

• account (str)

• detail (botocraft.eventbridge.raw.ecs.service_deployment_state_change.ECSServiceDeploymentStateChange)

• detail_type (str)

• id (str)

• region (str)

• resources (list[str])

• session (Any | None)

• source (str)

• time (datetime.datetime)

• version (str)

field account: str [Required]

The account the event was generated in

field detail: ECSServiceDeploymentStateChange [Required]

Where the meat of the event is

field detail_type: str [Required] (alias 'detail-type')

The human readable name of the event

field id: str [Required]

The ID of the event

field region: str [Required]

The region the event was generated in

field resources: list[str] [Required]

The resources the event applies to. This will be a list of ARNs

field source: str [Required]

The source of the event, e.g. “aws.ecs”

field time: datetime [Required]

The time the event was generated, in UTC

field version: str [Required]

The version of the schema for the event

classmethod construct(_fields_set: set[str] | None = None, **values: Any) → Self

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) → Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:

• _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

• values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

model_copy(*, update: Mapping[str, Any] | None = None, deep: bool = False) → Self

!!! abstract “Usage Documentation”

[model_copy](../concepts/serialization.md#model_copy)

Returns a copy of the model.

!!! note

The underlying instance’s [__dict__][object.__dict__] attribute is copied. This might have unexpected side effects if you store anything in it, on top of the model fields (e.g. the value of [cached properties][functools.cached_property]).

Parameters:

• update – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.

• deep – Set to True to make a deep copy of the model.

Returns:

New model instance.

model_dump_json(*, indent: int | None = None, include: set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, exclude: set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, context: Any | None = None, by_alias: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, round_trip: bool = False, warnings: bool | Literal['none', 'warn', 'error'] = True, fallback: Callable[[Any], Any] | None = None, serialize_as_any: bool = False) → str

!!! abstract “Usage Documentation”

[model_dump_json](../concepts/serialization.md#modelmodel_dump_json)

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

• indent – Indentation to use in the JSON output. If None is passed, the output will be compact.

• include – Field(s) to include in the JSON output.

• exclude – Field(s) to exclude from the JSON output.

• context – Additional context to pass to the serializer.

• by_alias – Whether to serialize using field aliases.

• exclude_unset – Whether to exclude fields that have not been explicitly set.

• exclude_defaults – Whether to exclude fields that are set to their default value.

• exclude_none – Whether to exclude fields that have a value of None.

• round_trip – If True, dumped values should be valid as input for non-idempotent types such as Json[T].

• warnings – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].

• fallback – A function to call when an unknown value is encountered. If not provided, a [PydanticSerializationError][pydantic_core.PydanticSerializationError] error is raised.

• serialize_as_any – Whether to serialize fields with duck-typing serialization behavior.

Returns:

A JSON string representation of the model.

classmethod model_validate(obj: Any, *, strict: bool | None = None, from_attributes: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) → Self

Validate a pydantic model instance.

Parameters:

• obj – The object to validate.

• strict – Whether to enforce types strictly.

• from_attributes – Whether to extract data from object attributes.

• context – Additional context to pass to the validator.

• by_alias – Whether to use the field’s alias when validating against the provided input data.

• by_name – Whether to use the field’s name when validating against the provided input data.

Raises:

ValidationError – If the object could not be validated.

Returns:

The validated model instance.

classmethod model_validate_json(json_data: str | bytes | bytearray, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) → Self

!!! abstract “Usage Documentation”

[JSON Parsing](../concepts/json.md#json-parsing)

Validate the given JSON data against the Pydantic model.

Parameters:

• json_data – The JSON data to validate.

• strict – Whether to enforce types strictly.

• context – Extra variables to pass to the validator.

• by_alias – Whether to use the field’s alias when validating against the provided input data.

• by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) → Self

Validate the given object with string data against the Pydantic model.

Parameters:

• obj – The object containing string data to validate.

• strict – Whether to enforce types strictly.

• context – Extra variables to pass to the validator.

• by_alias – Whether to use the field’s alias when validating against the provided input data.

• by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

classmethod parse_file(path: str | Path, *, content_type: str | None = None, encoding: str = 'utf8', proto: DeprecatedParseProtocol | None = None, allow_pickle: bool = False) → Self

classmethod parse_obj(obj: Any) → Self

classmethod parse_raw(b: str | bytes, *, content_type: str | None = None, encoding: str = 'utf8', proto: DeprecatedParseProtocol | None = None, allow_pickle: bool = False) → Self

property cluster: Cluster

Get the cluster name from the event.

property service: Service

Get the service ARN from the event.

session: Any | None = FieldInfo(annotation=Union[Any, NoneType], required=False, default=None, exclude=True)

Raw Event Models from AWS Schema

pydantic model botocraft.eventbridge.raw.ecs.service_deployment_state_change.ECSServiceDeploymentStateChange

Bases: BaseModel

The main body of the ECS Service Deployment State Change event.

Show JSON schema

{
   "title": "ECSServiceDeploymentStateChange",
   "description": "The main body of the ECS Service Deployment State Change event.",
   "type": "object",
   "properties": {
      "eventName": {
         "title": "Eventname",
         "type": "string"
      },
      "eventType": {
         "title": "Eventtype",
         "type": "string"
      },
      "deploymentId": {
         "title": "Deploymentid",
         "type": "string"
      },
      "updatedAt": {
         "format": "date-time",
         "title": "Updatedat",
         "type": "string"
      },
      "reason": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Reason"
      }
   },
   "required": [
      "eventName",
      "eventType",
      "deploymentId",
      "updatedAt"
   ]
}

Fields:

• deploymentId (str)

• eventName (str)

• eventType (str)

• reason (str | None)

• updatedAt (datetime.datetime)

field deploymentId: str [Required]

The service deployment ID.

Note

This is not the same as the py:class:~botocraft.services.ecs.ServiceDeployment ARN. Not sure what this is, really.

field eventName: str [Required]

The name of the event

field eventType: str [Required]

The type of the event

field reason: str | None = None

The reason the Service Deployment was started

field updatedAt: datetime [Required]

The time the Service Deployment was created

pydantic model botocraft.eventbridge.raw.ecs.service_deployment_state_change.ECSServiceDeploymentStateChangeEvent

Bases: BaseModel

An ECS Service Deployment State Change Event class.

Important

There’s no schema in the EventBridge schema registry for this event, so this is a best effort attempt to create a schema for it manually.

Show JSON schema

{
   "title": "ECSServiceDeploymentStateChangeEvent",
   "description": "An ECS Service Deployment State Change Event class.\n\n.. important::\n\n    There's no schema in the EventBridge schema registry for this event,\n    so this is a best effort attempt to create a schema for it manually.",
   "type": "object",
   "properties": {
      "detail": {
         "$ref": "#/$defs/ECSServiceDeploymentStateChange"
      },
      "detail-type": {
         "title": "Detail-Type",
         "type": "string"
      },
      "resources": {
         "items": {
            "type": "string"
         },
         "title": "Resources",
         "type": "array"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "source": {
         "title": "Source",
         "type": "string"
      },
      "region": {
         "title": "Region",
         "type": "string"
      },
      "time": {
         "format": "date-time",
         "title": "Time",
         "type": "string"
      },
      "version": {
         "title": "Version",
         "type": "string"
      },
      "account": {
         "title": "Account",
         "type": "string"
      }
   },
   "$defs": {
      "ECSServiceDeploymentStateChange": {
         "description": "The main body of the ECS Service Deployment State Change event.",
         "properties": {
            "eventName": {
               "title": "Eventname",
               "type": "string"
            },
            "eventType": {
               "title": "Eventtype",
               "type": "string"
            },
            "deploymentId": {
               "title": "Deploymentid",
               "type": "string"
            },
            "updatedAt": {
               "format": "date-time",
               "title": "Updatedat",
               "type": "string"
            },
            "reason": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Reason"
            }
         },
         "required": [
            "eventName",
            "eventType",
            "deploymentId",
            "updatedAt"
         ],
         "title": "ECSServiceDeploymentStateChange",
         "type": "object"
      }
   },
   "required": [
      "detail",
      "detail-type",
      "resources",
      "id",
      "source",
      "region",
      "time",
      "version",
      "account"
   ]
}

Fields:

• account (str)

• detail (botocraft.eventbridge.raw.ecs.service_deployment_state_change.ECSServiceDeploymentStateChange)

• detail_type (str)

• id (str)

• region (str)

• resources (list[str])

• source (str)

• time (datetime.datetime)

• version (str)

field account: str [Required]

The account the event was generated in

field detail: ECSServiceDeploymentStateChange [Required]

Where the meat of the event is

field detail_type: str [Required] (alias 'detail-type')

The human readable name of the event

field id: str [Required]

The ID of the event

field region: str [Required]

The region the event was generated in

field resources: list[str] [Required]

The resources the event applies to. This will be a list of ARNs

field source: str [Required]

The source of the event, e.g. “aws.ecs”

field time: datetime [Required]

The time the event was generated, in UTC

field version: str [Required]

The version of the schema for the event