SSM Configuration Compliance State Change

This is emitted when Systems Manager sends a Configuration Compliance State Change event. See AWS documentation for example payloads and event behavior.

Primary Model

pydantic model botocraft.eventbridge.ssm.SSMConfigurationComplianceStateChangeEvent[source]

Bases: EventBridgeEvent, SSMConfigurationComplianceStateChangeEvent

EventBridge event for an SSM compliance state change.

Show JSON schema
{
   "title": "SSMConfigurationComplianceStateChangeEvent",
   "description": "EventBridge event for an SSM compliance state change.",
   "type": "object",
   "properties": {
      "account": {
         "title": "Account",
         "type": "string"
      },
      "detail": {
         "$ref": "#/$defs/Detail"
      },
      "detail-type": {
         "title": "Detail-Type",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "region": {
         "title": "Region",
         "type": "string"
      },
      "resources": {
         "items": {
            "type": "string"
         },
         "title": "Resources",
         "type": "array"
      },
      "source": {
         "title": "Source",
         "type": "string"
      },
      "time": {
         "title": "Time",
         "type": "string"
      },
      "version": {
         "title": "Version",
         "type": "string"
      },
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      }
   },
   "$defs": {
      "Detail": {
         "description": "Detail payload for this SSM event.",
         "properties": {
            "compliance-status": {
               "title": "Compliance-Status",
               "type": "string"
            },
            "compliance-type": {
               "title": "Compliance-Type",
               "type": "string"
            },
            "last-runtime": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Last-Runtime"
            },
            "patch-baseline-id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Patch-Baseline-Id"
            },
            "resource-id": {
               "title": "Resource-Id",
               "type": "string"
            },
            "resource-type": {
               "title": "Resource-Type",
               "type": "string"
            },
            "severity": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Severity"
            }
         },
         "required": [
            "compliance-status",
            "compliance-type",
            "resource-id",
            "resource-type"
         ],
         "title": "Detail",
         "type": "object"
      }
   },
   "required": [
      "account",
      "detail",
      "detail-type",
      "id",
      "region",
      "resources",
      "source",
      "time",
      "version"
   ]
}

Fields:
field account: str [Required]

AWS account that emitted the event.

field detail: Detail [Required]

Event-specific detail payload from Systems Manager.

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

EventBridge detail type for the event.

field id: str [Required]

Unique identifier for the EventBridge event.

field region: str [Required]

AWS region where the event was emitted.

field resources: list[str] [Required]

Resources associated with the event.

field source: str [Required]

Event source identifier.

field time: str [Required]

Timestamp when EventBridge recorded the event.

field version: str [Required]

EventBridge payload version.

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 is_compliant: bool

Check whether the reported compliance state is compliant.

Returns:

True when the event status is compliant.

property resource_arn: str | None

Return the managed resource ARN named by the event.

Returns:

Resource ARN when one is present, otherwise None.

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

Raw Event Models from AWS Example Payload

pydantic model botocraft.eventbridge.raw.ssm.configuration_compliance_state_change.Detail[source]

Bases: BaseModel

Detail payload for this SSM event.

Show JSON schema
{
   "title": "Detail",
   "description": "Detail payload for this SSM event.",
   "type": "object",
   "properties": {
      "compliance-status": {
         "title": "Compliance-Status",
         "type": "string"
      },
      "compliance-type": {
         "title": "Compliance-Type",
         "type": "string"
      },
      "last-runtime": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last-Runtime"
      },
      "patch-baseline-id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Patch-Baseline-Id"
      },
      "resource-id": {
         "title": "Resource-Id",
         "type": "string"
      },
      "resource-type": {
         "title": "Resource-Type",
         "type": "string"
      },
      "severity": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Severity"
      }
   },
   "required": [
      "compliance-status",
      "compliance-type",
      "resource-id",
      "resource-type"
   ]
}

Fields:
field compliance_status: str [Required] (alias 'compliance-status')

Event field compliance-status.

field compliance_type: str [Required] (alias 'compliance-type')

Event field compliance-type.

field last_runtime: str | None = None (alias 'last-runtime')

Event field last-runtime.

field patch_baseline_id: str | None = None (alias 'patch-baseline-id')

Event field patch-baseline-id.

field resource_id: str [Required] (alias 'resource-id')

Event field resource-id.

field resource_type: str [Required] (alias 'resource-type')

Event field resource-type.

field severity: str | None = None

Event field severity.

pydantic model botocraft.eventbridge.raw.ssm.configuration_compliance_state_change.SSMConfigurationComplianceStateChangeEvent[source]

Bases: BaseModel

Raw EventBridge payload for this SSM event.

Show JSON schema
{
   "title": "SSMConfigurationComplianceStateChangeEvent",
   "description": "Raw EventBridge payload for this SSM event.",
   "type": "object",
   "properties": {
      "account": {
         "title": "Account",
         "type": "string"
      },
      "detail": {
         "$ref": "#/$defs/Detail"
      },
      "detail-type": {
         "title": "Detail-Type",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "region": {
         "title": "Region",
         "type": "string"
      },
      "resources": {
         "items": {
            "type": "string"
         },
         "title": "Resources",
         "type": "array"
      },
      "source": {
         "title": "Source",
         "type": "string"
      },
      "time": {
         "title": "Time",
         "type": "string"
      },
      "version": {
         "title": "Version",
         "type": "string"
      }
   },
   "$defs": {
      "Detail": {
         "description": "Detail payload for this SSM event.",
         "properties": {
            "compliance-status": {
               "title": "Compliance-Status",
               "type": "string"
            },
            "compliance-type": {
               "title": "Compliance-Type",
               "type": "string"
            },
            "last-runtime": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Last-Runtime"
            },
            "patch-baseline-id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Patch-Baseline-Id"
            },
            "resource-id": {
               "title": "Resource-Id",
               "type": "string"
            },
            "resource-type": {
               "title": "Resource-Type",
               "type": "string"
            },
            "severity": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Severity"
            }
         },
         "required": [
            "compliance-status",
            "compliance-type",
            "resource-id",
            "resource-type"
         ],
         "title": "Detail",
         "type": "object"
      }
   },
   "required": [
      "account",
      "detail",
      "detail-type",
      "id",
      "region",
      "resources",
      "source",
      "time",
      "version"
   ]
}

Fields:
field account: str [Required]

AWS account that emitted the event.

field detail: Detail [Required]

Event-specific detail payload from Systems Manager.

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

EventBridge detail type for the event.

field id: str [Required]

Unique identifier for the EventBridge event.

field region: str [Required]

AWS region where the event was emitted.

field resources: list[str] [Required]

Resources associated with the event.

field source: str [Required]

Event source identifier.

field time: str [Required]

Timestamp when EventBridge recorded the event.

field version: str [Required]

EventBridge payload version.