ConfigurationItem
¶
Source code in docs_src/capo_config_service/types/configuration_item.py
account_id
instance-attribute
¶
account_id: NotRequired[AccountId]
The 12-digit Amazon Web Services account ID associated with the resource.
arn
instance-attribute
¶
arn: NotRequired[ARN]
Amazon Resource Name (ARN) associated with the resource.
availability_zone
instance-attribute
¶
availability_zone: NotRequired[AvailabilityZone]
The Availability Zone associated with the resource.
aws_region
instance-attribute
¶
aws_region: NotRequired[AwsRegion]
The region where the resource resides.
configuration
instance-attribute
¶
configuration: NotRequired[Configuration]
A JSON-encoded string that contains the contents for the resource configuration. This string needs to be deserialized using json.loads() before you can access the contents.
configuration_item_capture_time
instance-attribute
¶
configuration_item_capture_time: NotRequired[ConfigurationItemCaptureTime]
The time when the recording of configuration changes was initiated for the resource.
configuration_item_delivery_time
instance-attribute
¶
configuration_item_delivery_time: NotRequired[ConfigurationItemDeliveryTime]
The time when configuration changes for the resource were delivered.
This field is optional and is not guaranteed to be present in a configuration item (CI). If you are using daily recording, this field will be populated. However, if you are using continuous recording, this field will be omitted since the delivery time is instantaneous as the CI is available right away.
For more information on daily recording and continuous recording, see Recording Frequency in the Config Developer Guide.
configuration_item_md5_hash
instance-attribute
¶
configuration_item_md5_hash: NotRequired[ConfigurationItemMD5Hash]
Unique MD5 hash that represents the configuration item's state.
You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.
configuration_item_status
instance-attribute
¶
configuration_item_status: NotRequired[ConfigurationItemStatus]
The configuration item status. Valid values include:
-
OK – The resource configuration has been updated
-
ResourceDiscovered – The resource was newly discovered
-
ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder doesn't record resources of this type
-
ResourceDeleted – The resource was deleted
-
ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder doesn't record resources of this type
configuration_state_id
instance-attribute
¶
configuration_state_id: NotRequired[ConfigurationStateId]
An identifier that indicates the ordering of the configuration items of a resource.
recording_frequency
instance-attribute
¶
recording_frequency: NotRequired[RecordingFrequency]
The recording frequency that Config uses to record configuration changes for the resource.
This field only appears in the API response when DAILY recording is enabled for a resource type. If this field is not present, CONTINUOUS recording is enabled for that resource type. For more information on daily recording and continuous recording, see Recording Frequency in the Config Developer Guide.
related_events
instance-attribute
¶
related_events: NotRequired[RelatedEventList]
A list of CloudTrail event IDs.
A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail.
An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.
relationships
instance-attribute
¶
relationships: NotRequired[RelationshipList]
A list of related Amazon Web Services resources.
resource_creation_time
instance-attribute
¶
resource_creation_time: NotRequired[ResourceCreationTime]
The time stamp when the resource was created.
resource_id
instance-attribute
¶
resource_id: NotRequired[ResourceId]
The ID of the resource (for example, sg-xxxxxx).
resource_name
instance-attribute
¶
resource_name: NotRequired[ResourceName]
The custom name of the resource, if available.
resource_type
instance-attribute
¶
resource_type: NotRequired[ResourceType]
The type of Amazon Web Services resource.
supplementary_configuration
instance-attribute
¶
supplementary_configuration: NotRequired[SupplementaryConfiguration]
A string to string map that contains additional contents for the resource configuration.Config returns this field for certain resource types to supplement the information returned for the configuration field.
This string to string map needs to be deserialized using json.loads() before you can accessing the contents.