Skip to content

AwsApiCallAction

Source code in docs_src/capo_securityhub/types/aws_api_call_action.py
class AwsApiCallAction(TypedDict, closed=True):
    api: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The name of the API method that was issued.</p> <p>Length Constraints: 128.</p>"""
    service_name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The name of the Amazon Web Services service that the API method belongs to.</p> <p>Length Constraints: 128.</p>"""
    caller_type: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>Indicates whether the API call originated from a remote IP address (<code>remoteip</code>) or from a DNS domain (<code>domain</code>).</p>"""
    remote_ip_details: NotRequired[
        "capo_securityhub.types.action_remote_ip_details.ActionRemoteIpDetails"
    ]
    """<p>Provided if <code>CallerType</code> is <code>remoteip</code>. Provides information about the remote IP address that the API call originated from.</p>"""
    domain_details: NotRequired[
        "capo_securityhub.types.aws_api_call_action_domain_details.AwsApiCallActionDomainDetails"
    ]
    """<p>Provided if <code>CallerType</code> is <code>domain</code>. Provides information about the DNS domain that the API call originated from.</p>"""
    affected_resources: NotRequired["capo_securityhub.types.field_map.FieldMap"]
    """<p>Identifies the resources that were affected by the API call.</p>"""
    first_seen: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>A timestamp that indicates when the API call was first observed.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    last_seen: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>A timestamp that indicates when the API call was most recently observed.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""

affected_resources instance-attribute

affected_resources: NotRequired[FieldMap]

Identifies the resources that were affected by the API call.

api instance-attribute

api: NotRequired[NonEmptyString]

The name of the API method that was issued.

Length Constraints: 128.

caller_type instance-attribute

caller_type: NotRequired[NonEmptyString]

Indicates whether the API call originated from a remote IP address (remoteip) or from a DNS domain (domain).

domain_details instance-attribute

domain_details: NotRequired[AwsApiCallActionDomainDetails]

Provided if CallerType is domain. Provides information about the DNS domain that the API call originated from.

first_seen instance-attribute

first_seen: NotRequired[NonEmptyString]

A timestamp that indicates when the API call was first observed.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

last_seen instance-attribute

last_seen: NotRequired[NonEmptyString]

A timestamp that indicates when the API call was most recently observed.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

remote_ip_details instance-attribute

remote_ip_details: NotRequired[ActionRemoteIpDetails]

Provided if CallerType is remoteip. Provides information about the remote IP address that the API call originated from.

service_name instance-attribute

service_name: NotRequired[NonEmptyString]

The name of the Amazon Web Services service that the API method belongs to.

Length Constraints: 128.