Skip to content

ConfigurationItem

Source code in docs_src/capo_config_service/types/configuration_item.py
class ConfigurationItem(TypedDict, closed=True):
    version: NotRequired["capo_config_service.types.version.Version"]
    """<p>The version number of the resource configuration.</p>"""
    account_id: NotRequired["capo_config_service.types.account_id.AccountId"]
    """<p>The 12-digit Amazon Web Services account ID associated with the resource.</p>"""
    configuration_item_capture_time: NotRequired[
        "capo_config_service.types.configuration_item_capture_time.ConfigurationItemCaptureTime"
    ]
    """<p>The time when the recording of configuration changes was initiated for the resource.</p>"""
    configuration_item_status: NotRequired[
        "capo_config_service.types.configuration_item_status.ConfigurationItemStatus"
    ]
    """<p>The configuration item status. Valid values include:</p> <ul> <li> <p>OK – The resource configuration has been updated</p> </li> <li> <p>ResourceDiscovered – The resource was newly discovered</p> </li> <li> <p>ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder doesn't record resources of this type</p> </li> <li> <p>ResourceDeleted – The resource was deleted</p> </li> <li> <p>ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder doesn't record resources of this type</p> </li> </ul>"""
    configuration_state_id: NotRequired[
        "capo_config_service.types.configuration_state_id.ConfigurationStateId"
    ]
    """<p>An identifier that indicates the ordering of the configuration items of a resource.</p>"""
    configuration_item_md5_hash: NotRequired[
        "capo_config_service.types.configuration_item_md5_hash.ConfigurationItemMD5Hash"
    ]
    """<p>Unique MD5 hash that represents the configuration item's state.</p> <p>You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.</p>"""
    arn: NotRequired["capo_config_service.types.arn.ARN"]
    """<p>Amazon Resource Name (ARN) associated with the resource.</p>"""
    resource_type: NotRequired["capo_config_service.types.resource_type.ResourceType"]
    """<p>The type of Amazon Web Services resource.</p>"""
    resource_id: NotRequired["capo_config_service.types.resource_id.ResourceId"]
    """<p>The ID of the resource (for example, <code>sg-xxxxxx</code>).</p>"""
    resource_name: NotRequired["capo_config_service.types.resource_name.ResourceName"]
    """<p>The custom name of the resource, if available.</p>"""
    aws_region: NotRequired["capo_config_service.types.aws_region.AwsRegion"]
    """<p>The region where the resource resides.</p>"""
    availability_zone: NotRequired[
        "capo_config_service.types.availability_zone.AvailabilityZone"
    ]
    """<p>The Availability Zone associated with the resource.</p>"""
    resource_creation_time: NotRequired[
        "capo_config_service.types.resource_creation_time.ResourceCreationTime"
    ]
    """<p>The time stamp when the resource was created.</p>"""
    tags: NotRequired["capo_config_service.types.tags.Tags"]
    """<p>A mapping of key value tags associated with the resource.</p>"""
    related_events: NotRequired[
        "capo_config_service.types.related_event_list.RelatedEventList"
    ]
    """<p>A list of CloudTrail event IDs.</p> <p>A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">What Is CloudTrail</a>.</p> <p>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 <a href="https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_LookupEvents.html">LookupEvents API</a> in the <i>CloudTrail API Reference</i> to retrieve the events for the resource.</p>"""
    relationships: NotRequired[
        "capo_config_service.types.relationship_list.RelationshipList"
    ]
    """<p>A list of related Amazon Web Services resources.</p>"""
    configuration: NotRequired["capo_config_service.types.configuration.Configuration"]
    """<p>A JSON-encoded string that contains the contents for the resource configuration. This string needs to be deserialized using <code>json.loads()</code> before you can access the contents.</p>"""
    supplementary_configuration: NotRequired[
        "capo_config_service.types.supplementary_configuration.SupplementaryConfiguration"
    ]
    """<p>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 <code>configuration</code> field.</p> <p>This string to string map needs to be deserialized using <code>json.loads()</code> before you can accessing the contents.</p>"""
    recording_frequency: NotRequired[
        "capo_config_service.types.recording_frequency.RecordingFrequency"
    ]
    """<p>The recording frequency that Config uses to record configuration changes for the resource.</p> <note> <p>This field only appears in the API response when <code>DAILY</code> recording is enabled for a resource type. If this field is not present, <code>CONTINUOUS</code> recording is enabled for that resource type. For more information on daily recording and continuous recording, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-recording-frequency">Recording Frequency</a> in the <i>Config Developer Guide</i>.</p> </note>"""
    configuration_item_delivery_time: NotRequired[
        "capo_config_service.types.configuration_item_delivery_time.ConfigurationItemDeliveryTime"
    ]
    """<p>The time when configuration changes for the resource were delivered.</p> <note> <p>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.</p> <p>For more information on daily recording and continuous recording, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-recording-frequency">Recording Frequency</a> in the <i>Config Developer Guide</i>.</p> </note>"""

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.

tags instance-attribute

tags: NotRequired[Tags]

A mapping of key value tags associated with the resource.

version instance-attribute

version: NotRequired[Version]

The version number of the resource configuration.