Route53RecoveryControlConfigClient

Index > Route53RecoveryControlConfig > Route53RecoveryControlConfigClient

Auto-generated documentation for Route53RecoveryControlConfig type annotations stubs module mypy-boto3-route53-recovery-control-config.

Route53RecoveryControlConfigClient

Type annotations and code completion for boto3.client("route53-recovery-control-config"). boto3 documentation

# Route53RecoveryControlConfigClient usage example

from boto3.session import Session
from mypy_boto3_route53_recovery_control_config.client import Route53RecoveryControlConfigClient

def get_route53-recovery-control-config_client() -> Route53RecoveryControlConfigClient:
    return Session().client("route53-recovery-control-config")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("route53-recovery-control-config").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("route53-recovery-control-config")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_route53_recovery_control_config.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("route53-recovery-control-config").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("route53-recovery-control-config").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_cluster

Create a new cluster.

Type annotations and code completion for boto3.client("route53-recovery-control-config").create_cluster method. boto3 documentation

# create_cluster method definition

def create_cluster(
    self,
    *,
    ClusterName: str,
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
    NetworkType: NetworkTypeType = ...,  # (1)
) -> CreateClusterResponseTypeDef:  # (2)
    ...

1. See NetworkTypeType
2. See CreateClusterResponseTypeDef

# create_cluster method usage example with argument unpacking

kwargs: CreateClusterRequestTypeDef = {  # (1)
    "ClusterName": ...,
}

parent.create_cluster(**kwargs)

1. See CreateClusterRequestTypeDef

create_control_panel

Creates a new control panel.

Type annotations and code completion for boto3.client("route53-recovery-control-config").create_control_panel method. boto3 documentation

# create_control_panel method definition

def create_control_panel(
    self,
    *,
    ClusterArn: str,
    ControlPanelName: str,
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateControlPanelResponseTypeDef:  # (1)
    ...

1. See CreateControlPanelResponseTypeDef

# create_control_panel method usage example with argument unpacking

kwargs: CreateControlPanelRequestTypeDef = {  # (1)
    "ClusterArn": ...,
    "ControlPanelName": ...,
}

parent.create_control_panel(**kwargs)

1. See CreateControlPanelRequestTypeDef

create_routing_control

Creates a new routing control.

Type annotations and code completion for boto3.client("route53-recovery-control-config").create_routing_control method. boto3 documentation

# create_routing_control method definition

def create_routing_control(
    self,
    *,
    ClusterArn: str,
    RoutingControlName: str,
    ClientToken: str = ...,
    ControlPanelArn: str = ...,
) -> CreateRoutingControlResponseTypeDef:  # (1)
    ...

1. See CreateRoutingControlResponseTypeDef

# create_routing_control method usage example with argument unpacking

kwargs: CreateRoutingControlRequestTypeDef = {  # (1)
    "ClusterArn": ...,
    "RoutingControlName": ...,
}

parent.create_routing_control(**kwargs)

1. See CreateRoutingControlRequestTypeDef

create_safety_rule

Creates a safety rule in a control panel.

Type annotations and code completion for boto3.client("route53-recovery-control-config").create_safety_rule method. boto3 documentation

# create_safety_rule method definition

def create_safety_rule(
    self,
    *,
    AssertionRule: NewAssertionRuleTypeDef = ...,  # (1)
    ClientToken: str = ...,
    GatingRule: NewGatingRuleTypeDef = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreateSafetyRuleResponseTypeDef:  # (3)
    ...

1. See NewAssertionRuleTypeDef
2. See NewGatingRuleTypeDef
3. See CreateSafetyRuleResponseTypeDef

# create_safety_rule method usage example with argument unpacking

kwargs: CreateSafetyRuleRequestTypeDef = {  # (1)
    "AssertionRule": ...,
}

parent.create_safety_rule(**kwargs)

1. See CreateSafetyRuleRequestTypeDef

delete_cluster

Delete a cluster.

Type annotations and code completion for boto3.client("route53-recovery-control-config").delete_cluster method. boto3 documentation

# delete_cluster method definition

def delete_cluster(
    self,
    *,
    ClusterArn: str,
) -> Dict[str, Any]:
    ...

# delete_cluster method usage example with argument unpacking

kwargs: DeleteClusterRequestTypeDef = {  # (1)
    "ClusterArn": ...,
}

parent.delete_cluster(**kwargs)

1. See DeleteClusterRequestTypeDef

delete_control_panel

Deletes a control panel.

Type annotations and code completion for boto3.client("route53-recovery-control-config").delete_control_panel method. boto3 documentation

# delete_control_panel method definition

def delete_control_panel(
    self,
    *,
    ControlPanelArn: str,
) -> Dict[str, Any]:
    ...

# delete_control_panel method usage example with argument unpacking

kwargs: DeleteControlPanelRequestTypeDef = {  # (1)
    "ControlPanelArn": ...,
}

parent.delete_control_panel(**kwargs)

1. See DeleteControlPanelRequestTypeDef

delete_routing_control

Deletes a routing control.

Type annotations and code completion for boto3.client("route53-recovery-control-config").delete_routing_control method. boto3 documentation

# delete_routing_control method definition

def delete_routing_control(
    self,
    *,
    RoutingControlArn: str,
) -> Dict[str, Any]:
    ...

# delete_routing_control method usage example with argument unpacking

kwargs: DeleteRoutingControlRequestTypeDef = {  # (1)
    "RoutingControlArn": ...,
}

parent.delete_routing_control(**kwargs)

1. See DeleteRoutingControlRequestTypeDef

delete_safety_rule

Deletes a safety rule.

Type annotations and code completion for boto3.client("route53-recovery-control-config").delete_safety_rule method. boto3 documentation

# delete_safety_rule method definition

def delete_safety_rule(
    self,
    *,
    SafetyRuleArn: str,
) -> Dict[str, Any]:
    ...

# delete_safety_rule method usage example with argument unpacking

kwargs: DeleteSafetyRuleRequestTypeDef = {  # (1)
    "SafetyRuleArn": ...,
}

parent.delete_safety_rule(**kwargs)

1. See DeleteSafetyRuleRequestTypeDef

describe_cluster

Display the details about a cluster.

Type annotations and code completion for boto3.client("route53-recovery-control-config").describe_cluster method. boto3 documentation

# describe_cluster method definition

def describe_cluster(
    self,
    *,
    ClusterArn: str,
) -> DescribeClusterResponseTypeDef:  # (1)
    ...

1. See DescribeClusterResponseTypeDef

# describe_cluster method usage example with argument unpacking

kwargs: DescribeClusterRequestTypeDef = {  # (1)
    "ClusterArn": ...,
}

parent.describe_cluster(**kwargs)

1. See DescribeClusterRequestTypeDef

describe_control_panel

Displays details about a control panel.

Type annotations and code completion for boto3.client("route53-recovery-control-config").describe_control_panel method. boto3 documentation

# describe_control_panel method definition

def describe_control_panel(
    self,
    *,
    ControlPanelArn: str,
) -> DescribeControlPanelResponseTypeDef:  # (1)
    ...

1. See DescribeControlPanelResponseTypeDef

# describe_control_panel method usage example with argument unpacking

kwargs: DescribeControlPanelRequestTypeDef = {  # (1)
    "ControlPanelArn": ...,
}

parent.describe_control_panel(**kwargs)

1. See DescribeControlPanelRequestTypeDef

describe_routing_control

Displays details about a routing control.

Type annotations and code completion for boto3.client("route53-recovery-control-config").describe_routing_control method. boto3 documentation

# describe_routing_control method definition

def describe_routing_control(
    self,
    *,
    RoutingControlArn: str,
) -> DescribeRoutingControlResponseTypeDef:  # (1)
    ...

1. See DescribeRoutingControlResponseTypeDef

# describe_routing_control method usage example with argument unpacking

kwargs: DescribeRoutingControlRequestTypeDef = {  # (1)
    "RoutingControlArn": ...,
}

parent.describe_routing_control(**kwargs)

1. See DescribeRoutingControlRequestTypeDef

describe_safety_rule

Returns information about a safety rule.

Type annotations and code completion for boto3.client("route53-recovery-control-config").describe_safety_rule method. boto3 documentation

# describe_safety_rule method definition

def describe_safety_rule(
    self,
    *,
    SafetyRuleArn: str,
) -> DescribeSafetyRuleResponseTypeDef:  # (1)
    ...

1. See DescribeSafetyRuleResponseTypeDef

# describe_safety_rule method usage example with argument unpacking

kwargs: DescribeSafetyRuleRequestTypeDef = {  # (1)
    "SafetyRuleArn": ...,
}

parent.describe_safety_rule(**kwargs)

1. See DescribeSafetyRuleRequestTypeDef

get_resource_policy

Get information about the resource policy for a cluster.

Type annotations and code completion for boto3.client("route53-recovery-control-config").get_resource_policy method. boto3 documentation

# get_resource_policy method definition

def get_resource_policy(
    self,
    *,
    ResourceArn: str,
) -> GetResourcePolicyResponseTypeDef:  # (1)
    ...

1. See GetResourcePolicyResponseTypeDef

# get_resource_policy method usage example with argument unpacking

kwargs: GetResourcePolicyRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_resource_policy(**kwargs)

1. See GetResourcePolicyRequestTypeDef

list_associated_route53_health_checks

Returns an array of all Amazon Route 53 health checks associated with a specific routing control.

Type annotations and code completion for boto3.client("route53-recovery-control-config").list_associated_route53_health_checks method. boto3 documentation

# list_associated_route53_health_checks method definition

def list_associated_route53_health_checks(
    self,
    *,
    RoutingControlArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAssociatedRoute53HealthChecksResponseTypeDef:  # (1)
    ...

1. See ListAssociatedRoute53HealthChecksResponseTypeDef

# list_associated_route53_health_checks method usage example with argument unpacking

kwargs: ListAssociatedRoute53HealthChecksRequestTypeDef = {  # (1)
    "RoutingControlArn": ...,
}

parent.list_associated_route53_health_checks(**kwargs)

1. See ListAssociatedRoute53HealthChecksRequestTypeDef

list_clusters

Returns an array of all the clusters in an account.

Type annotations and code completion for boto3.client("route53-recovery-control-config").list_clusters method. boto3 documentation

# list_clusters method definition

def list_clusters(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListClustersResponseTypeDef:  # (1)
    ...

1. See ListClustersResponseTypeDef

# list_clusters method usage example with argument unpacking

kwargs: ListClustersRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_clusters(**kwargs)

1. See ListClustersRequestTypeDef

list_control_panels

Returns an array of control panels in an account or in a cluster.

Type annotations and code completion for boto3.client("route53-recovery-control-config").list_control_panels method. boto3 documentation

# list_control_panels method definition

def list_control_panels(
    self,
    *,
    ClusterArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListControlPanelsResponseTypeDef:  # (1)
    ...

1. See ListControlPanelsResponseTypeDef

# list_control_panels method usage example with argument unpacking

kwargs: ListControlPanelsRequestTypeDef = {  # (1)
    "ClusterArn": ...,
}

parent.list_control_panels(**kwargs)

1. See ListControlPanelsRequestTypeDef

list_routing_controls

Returns an array of routing controls for a control panel.

Type annotations and code completion for boto3.client("route53-recovery-control-config").list_routing_controls method. boto3 documentation

# list_routing_controls method definition

def list_routing_controls(
    self,
    *,
    ControlPanelArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRoutingControlsResponseTypeDef:  # (1)
    ...

1. See ListRoutingControlsResponseTypeDef

# list_routing_controls method usage example with argument unpacking

kwargs: ListRoutingControlsRequestTypeDef = {  # (1)
    "ControlPanelArn": ...,
}

parent.list_routing_controls(**kwargs)

1. See ListRoutingControlsRequestTypeDef

list_safety_rules

List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.

Type annotations and code completion for boto3.client("route53-recovery-control-config").list_safety_rules method. boto3 documentation

# list_safety_rules method definition

def list_safety_rules(
    self,
    *,
    ControlPanelArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSafetyRulesResponseTypeDef:  # (1)
    ...

1. See ListSafetyRulesResponseTypeDef

# list_safety_rules method usage example with argument unpacking

kwargs: ListSafetyRulesRequestTypeDef = {  # (1)
    "ControlPanelArn": ...,
}

parent.list_safety_rules(**kwargs)

1. See ListSafetyRulesRequestTypeDef

list_tags_for_resource

Lists the tags for a resource.

Type annotations and code completion for boto3.client("route53-recovery-control-config").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

tag_resource

Adds a tag to a resource.

Type annotations and code completion for boto3.client("route53-recovery-control-config").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes a tag from a resource.

Type annotations and code completion for boto3.client("route53-recovery-control-config").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_cluster

Updates an existing cluster.

Type annotations and code completion for boto3.client("route53-recovery-control-config").update_cluster method. boto3 documentation

# update_cluster method definition

def update_cluster(
    self,
    *,
    ClusterArn: str,
    NetworkType: NetworkTypeType,  # (1)
) -> UpdateClusterResponseTypeDef:  # (2)
    ...

1. See NetworkTypeType
2. See UpdateClusterResponseTypeDef

# update_cluster method usage example with argument unpacking

kwargs: UpdateClusterRequestTypeDef = {  # (1)
    "ClusterArn": ...,
    "NetworkType": ...,
}

parent.update_cluster(**kwargs)

1. See UpdateClusterRequestTypeDef

update_control_panel

Updates a control panel.

Type annotations and code completion for boto3.client("route53-recovery-control-config").update_control_panel method. boto3 documentation

# update_control_panel method definition

def update_control_panel(
    self,
    *,
    ControlPanelArn: str,
    ControlPanelName: str,
) -> UpdateControlPanelResponseTypeDef:  # (1)
    ...

1. See UpdateControlPanelResponseTypeDef

# update_control_panel method usage example with argument unpacking

kwargs: UpdateControlPanelRequestTypeDef = {  # (1)
    "ControlPanelArn": ...,
    "ControlPanelName": ...,
}

parent.update_control_panel(**kwargs)

1. See UpdateControlPanelRequestTypeDef

update_routing_control

Updates a routing control.

Type annotations and code completion for boto3.client("route53-recovery-control-config").update_routing_control method. boto3 documentation

# update_routing_control method definition

def update_routing_control(
    self,
    *,
    RoutingControlArn: str,
    RoutingControlName: str,
) -> UpdateRoutingControlResponseTypeDef:  # (1)
    ...

1. See UpdateRoutingControlResponseTypeDef

# update_routing_control method usage example with argument unpacking

kwargs: UpdateRoutingControlRequestTypeDef = {  # (1)
    "RoutingControlArn": ...,
    "RoutingControlName": ...,
}

parent.update_routing_control(**kwargs)

1. See UpdateRoutingControlRequestTypeDef

update_safety_rule

Update a safety rule (an assertion rule or gating rule).

Type annotations and code completion for boto3.client("route53-recovery-control-config").update_safety_rule method. boto3 documentation

# update_safety_rule method definition

def update_safety_rule(
    self,
    *,
    AssertionRuleUpdate: AssertionRuleUpdateTypeDef = ...,  # (1)
    GatingRuleUpdate: GatingRuleUpdateTypeDef = ...,  # (2)
) -> UpdateSafetyRuleResponseTypeDef:  # (3)
    ...

1. See AssertionRuleUpdateTypeDef
2. See GatingRuleUpdateTypeDef
3. See UpdateSafetyRuleResponseTypeDef

# update_safety_rule method usage example with argument unpacking

kwargs: UpdateSafetyRuleRequestTypeDef = {  # (1)
    "AssertionRuleUpdate": ...,
}

parent.update_safety_rule(**kwargs)

1. See UpdateSafetyRuleRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("route53-recovery-control-config").get_paginator method with overloads.

• client.get_paginator("list_associated_route53_health_checks") -> ListAssociatedRoute53HealthChecksPaginator
• client.get_paginator("list_clusters") -> ListClustersPaginator
• client.get_paginator("list_control_panels") -> ListControlPanelsPaginator
• client.get_paginator("list_routing_controls") -> ListRoutingControlsPaginator
• client.get_paginator("list_safety_rules") -> ListSafetyRulesPaginator

get_waiter

Type annotations and code completion for boto3.client("route53-recovery-control-config").get_waiter method with overloads.

• client.get_waiter("cluster_created") -> ClusterCreatedWaiter
• client.get_waiter("cluster_deleted") -> ClusterDeletedWaiter
• client.get_waiter("control_panel_created") -> ControlPanelCreatedWaiter
• client.get_waiter("control_panel_deleted") -> ControlPanelDeletedWaiter
• client.get_waiter("routing_control_created") -> RoutingControlCreatedWaiter
• client.get_waiter("routing_control_deleted") -> RoutingControlDeletedWaiter