Skip to content

TrafficDistributionGroupSummary

Source code in docs_src/capo_connect/types/traffic_distribution_group_summary.py
class TrafficDistributionGroupSummary(TypedDict, closed=True):
    id: NotRequired[
        "capo_connect.types.acgr_traffic_distribution_group_id.ACGRTrafficDistributionGroupId"
    ]
    """<p>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.</p>"""
    arn: NotRequired[
        "capo_connect.types.acgr_traffic_distribution_group_arn.ACGRTrafficDistributionGroupArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>"""
    name: NotRequired["capo_connect.types.name128.Name128"]
    """<p>The name of the traffic distribution group.</p>"""
    instance_arn: NotRequired["capo_connect.types.acgr_instance_arn.ACGRInstanceArn"]
    """<p>The Amazon Resource Name (ARN) of the instance.</p>"""
    status: NotRequired[
        "capo_connect.types.traffic_distribution_group_status.TrafficDistributionGroupStatus"
    ]
    """<p>The status of the traffic distribution group. </p> <ul> <li> <p> <code>CREATION_IN_PROGRESS</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a> operation is still in progress and has not yet completed.</p> </li> <li> <p> <code>ACTIVE</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a> operation has succeeded.</p> </li> <li> <p> <code>CREATION_FAILED</code> indicates that the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a> operation has failed.</p> </li> <li> <p> <code>PENDING_DELETION</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html">DeleteTrafficDistributionGroup</a> operation is still in progress and has not yet completed.</p> </li> <li> <p> <code>DELETION_FAILED</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html">DeleteTrafficDistributionGroup</a> operation has failed.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html">UpdateTrafficDistributionGroup</a> operation is still in progress and has not yet completed.</p> </li> </ul>"""
    is_default: "capo_connect.types.boolean.Boolean"
    """<p>Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the <code>DeleteTrafficDistributionGroup</code> API. The default traffic distribution group is deleted as part of the process for deleting a replica.</p>"""

arn instance-attribute

The Amazon Resource Name (ARN) of the traffic distribution group.

id instance-attribute

The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

instance_arn instance-attribute

instance_arn: NotRequired[ACGRInstanceArn]

The Amazon Resource Name (ARN) of the instance.

is_default instance-attribute

is_default: Boolean

Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as part of the process for deleting a replica.

name instance-attribute

name: NotRequired[Name128]

The name of the traffic distribution group.

status instance-attribute

status: NotRequired[TrafficDistributionGroupStatus]

The status of the traffic distribution group.