Skip to content

Integration

Source code in docs_src/capo_cloudwatchomni/types/integration.py
class Integration(TypedDict, closed=True):
    integration_id: "str"
    """The unique identifier of the integration."""
    integration_arn: NotRequired[
        "capo_cloudwatchomni.types.integration_arn.IntegrationArn"
    ]
    """The Amazon Resource Name (ARN) of the integration."""
    integration_type: "capo_cloudwatchomni.types.integration_type.IntegrationType"
    name: "str"
    """The customer-provided name of the integration."""
    status: "capo_cloudwatchomni.types.integration_status.IntegrationStatus"
    auth_type: NotRequired["capo_cloudwatchomni.types.auth_type.AuthType"]
    credential_arn: NotRequired["str"]
    """The Amazon Resource Name (ARN) of the secret that stores the integration's credentials."""
    role_arn: NotRequired["str"]
    """The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to access the external system."""
    integration_attributes: NotRequired[
        "capo_cloudwatchomni.types.string_map.StringMap"
    ]
    """Provider-specific key/value attributes that configure the integration."""
    authorization_url: NotRequired["str"]
    """The URL the customer visits to authorize the integration. Present while an OAuth authorization is pending."""
    error_message: NotRequired["str"]
    """A human-readable description of why the integration is in an ERROR or FAILED state. Present only when the integration has failed."""
    created_at: NotRequired["datetime.datetime"]
    """The time at which the integration was created."""
    updated_at: NotRequired["datetime.datetime"]
    """The time at which the integration was last updated."""
    scope: NotRequired["capo_cloudwatchomni.types.scope.Scope"]
    """Whether this integration is account-scoped (ACCOUNT, customer-created) or organization-scoped (ORGANIZATION, created by an org-enablement rule). Absent on legacy records is treated as ACCOUNT."""

auth_type instance-attribute

auth_type: NotRequired[AuthType]

authorization_url instance-attribute

authorization_url: NotRequired[str]

The URL the customer visits to authorize the integration. Present while an OAuth authorization is pending.

created_at instance-attribute

created_at: NotRequired[datetime]

The time at which the integration was created.

credential_arn instance-attribute

credential_arn: NotRequired[str]

The Amazon Resource Name (ARN) of the secret that stores the integration's credentials.

error_message instance-attribute

error_message: NotRequired[str]

A human-readable description of why the integration is in an ERROR or FAILED state. Present only when the integration has failed.

integration_arn instance-attribute

integration_arn: NotRequired[IntegrationArn]

The Amazon Resource Name (ARN) of the integration.

integration_attributes instance-attribute

integration_attributes: NotRequired[StringMap]

Provider-specific key/value attributes that configure the integration.

integration_id instance-attribute

integration_id: str

The unique identifier of the integration.

integration_type instance-attribute

integration_type: IntegrationType

name instance-attribute

name: str

The customer-provided name of the integration.

role_arn instance-attribute

role_arn: NotRequired[str]

The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to access the external system.

scope instance-attribute

scope: NotRequired[Scope]

Whether this integration is account-scoped (ACCOUNT, customer-created) or organization-scoped (ORGANIZATION, created by an org-enablement rule). Absent on legacy records is treated as ACCOUNT.

status instance-attribute

updated_at instance-attribute

updated_at: NotRequired[datetime]

The time at which the integration was last updated.