InstanceEvents

class aws_cdk.mixins_preview.aws_connect.events.InstanceEvents(*args: Any, **kwargs)

Bases: object

(experimental) EventBridge event patterns for Instance.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_connect import events as connect_events
from aws_cdk.interfaces import aws_connect as interfaces_connect

# instance_ref: interfaces_connect.IInstanceRef

instance_events = connect_events.InstanceEvents.from_instance(instance_ref)

Methods

code_connect_contact_pattern(*, agent_info=None, channel=None, contact_id=None, event_metadata=None, event_type=None, initial_contact_id=None, initiation_method=None, instance_arn=None, previous_contact_id=None, queue_info=None)

(experimental) EventBridge event pattern for Instance Amazon Connect Contact Event.

Parameters:

agent_info (Union[AgentInfo, Dict[str, Any], None]) – (experimental) agentInfo property. Specify an array of string values to match this event if the actual value of agentInfo is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
channel (Optional[Sequence[str]]) – (experimental) channel property. Specify an array of string values to match this event if the actual value of channel is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
contact_id (Optional[Sequence[str]]) – (experimental) contactId property. Specify an array of string values to match this event if the actual value of contactId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
event_type (Optional[Sequence[str]]) – (experimental) eventType property. Specify an array of string values to match this event if the actual value of eventType is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
initial_contact_id (Optional[Sequence[str]]) – (experimental) initialContactId property. Specify an array of string values to match this event if the actual value of initialContactId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
initiation_method (Optional[Sequence[str]]) – (experimental) initiationMethod property. Specify an array of string values to match this event if the actual value of initiationMethod is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
instance_arn (Optional[Sequence[str]]) – (experimental) instanceArn property. Specify an array of string values to match this event if the actual value of instanceArn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Instance reference
previous_contact_id (Optional[Sequence[str]]) – (experimental) previousContactId property. Specify an array of string values to match this event if the actual value of previousContactId is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
queue_info (Union[QueueInfo, Dict[str, Any], None]) – (experimental) queueInfo property. Specify an array of string values to match this event if the actual value of queueInfo is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

contact_lens_post_call_rules_matched_pattern(*, action_name=None, agent_arn=None, contact_arn=None, event_metadata=None, instance_arn=None, queue_arn=None, rule_name=None, version=None)

(experimental) EventBridge event pattern for Instance Contact Lens Post Call Rules Matched.

Parameters:

action_name (Optional[Sequence[str]]) – (experimental) actionName property. Specify an array of string values to match this event if the actual value of actionName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
agent_arn (Optional[Sequence[str]]) – (experimental) agentArn property. Specify an array of string values to match this event if the actual value of agentArn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
contact_arn (Optional[Sequence[str]]) – (experimental) contactArn property. Specify an array of string values to match this event if the actual value of contactArn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
instance_arn (Optional[Sequence[str]]) – (experimental) instanceArn property. Specify an array of string values to match this event if the actual value of instanceArn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Instance reference
queue_arn (Optional[Sequence[str]]) – (experimental) queueArn property. Specify an array of string values to match this event if the actual value of queueArn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
rule_name (Optional[Sequence[str]]) – (experimental) ruleName property. Specify an array of string values to match this event if the actual value of ruleName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

contact_lens_realtime_rules_matched_pattern(*, action_name=None, agent_arn=None, contact_arn=None, event_metadata=None, instance_arn=None, queue_arn=None, rule_name=None, version=None)

(experimental) EventBridge event pattern for Instance Contact Lens Realtime Rules Matched.

Parameters:

action_name (Optional[Sequence[str]]) – (experimental) actionName property. Specify an array of string values to match this event if the actual value of actionName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
agent_arn (Optional[Sequence[str]]) – (experimental) agentArn property. Specify an array of string values to match this event if the actual value of agentArn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
contact_arn (Optional[Sequence[str]]) – (experimental) contactArn property. Specify an array of string values to match this event if the actual value of contactArn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
instance_arn (Optional[Sequence[str]]) – (experimental) instanceArn property. Specify an array of string values to match this event if the actual value of instanceArn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Instance reference
queue_arn (Optional[Sequence[str]]) – (experimental) queueArn property. Specify an array of string values to match this event if the actual value of queueArn is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
rule_name (Optional[Sequence[str]]) – (experimental) ruleName property. Specify an array of string values to match this event if the actual value of ruleName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
version (Optional[Sequence[str]]) – (experimental) version property. Specify an array of string values to match this event if the actual value of version is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

Static Methods

classmethod from_instance(instance_ref)

(experimental) Create InstanceEvents from a Instance reference.

Parameters:: instance_ref (IInstanceRef)
Stability:: experimental
Return type:: InstanceEvents