Skip to content

InterconnectClient#

Index > Interconnect > InterconnectClient

Auto-generated documentation for Interconnect type annotations stubs module mypy-boto3-interconnect.

InterconnectClient#

Type annotations and code completion for boto3.client("interconnect"). boto3 documentation

# InterconnectClient usage example

from boto3.session import Session
from mypy_boto3_interconnect.client import InterconnectClient

def get_interconnect_client() -> InterconnectClient:
    return Session().client("interconnect")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("interconnect").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("interconnect")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.InterconnectClientException,
    client.exceptions.InterconnectServerException,
    client.exceptions.InterconnectValidationException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_interconnect.client import Exceptions

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

Methods#

can_paginate#

Type annotations and code completion for boto3.client("interconnect").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("interconnect").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:
    ...

accept_connection_proposal#

Accepts a connection proposal which was generated at a supported partner's portal.

Type annotations and code completion for boto3.client("interconnect").accept_connection_proposal method. boto3 documentation

# accept_connection_proposal method definition

def accept_connection_proposal(
    self,
    *,
    attachPoint: AttachPointTypeDef,  # (1)
    activationKey: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> AcceptConnectionProposalResponseTypeDef:  # (2)
    ...
  1. See AttachPointTypeDef
  2. See AcceptConnectionProposalResponseTypeDef
# accept_connection_proposal method usage example with argument unpacking

kwargs: AcceptConnectionProposalRequestTypeDef = {  # (1)
    "attachPoint": ...,
    "activationKey": ...,
}

parent.accept_connection_proposal(**kwargs)
  1. See AcceptConnectionProposalRequestTypeDef

create_connection#

Initiates the process to create a Connection across the specified Environment.

Type annotations and code completion for boto3.client("interconnect").create_connection method. boto3 documentation

# create_connection method definition

def create_connection(
    self,
    *,
    bandwidth: str,
    attachPoint: AttachPointTypeDef,  # (1)
    environmentId: str,
    description: str = ...,
    remoteAccount: RemoteAccountIdentifierTypeDef = ...,  # (2)
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> CreateConnectionResponseTypeDef:  # (3)
    ...
  1. See AttachPointTypeDef
  2. See RemoteAccountIdentifierTypeDef
  3. See CreateConnectionResponseTypeDef
# create_connection method usage example with argument unpacking

kwargs: CreateConnectionRequestTypeDef = {  # (1)
    "bandwidth": ...,
    "attachPoint": ...,
    "environmentId": ...,
}

parent.create_connection(**kwargs)
  1. See CreateConnectionRequestTypeDef

delete_connection#

Deletes an existing Connection with the supplied identifier.

Type annotations and code completion for boto3.client("interconnect").delete_connection method. boto3 documentation

# delete_connection method definition

def delete_connection(
    self,
    *,
    identifier: str,
    clientToken: str = ...,
) -> DeleteConnectionResponseTypeDef:  # (1)
    ...
  1. See DeleteConnectionResponseTypeDef
# delete_connection method usage example with argument unpacking

kwargs: DeleteConnectionRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.delete_connection(**kwargs)
  1. See DeleteConnectionRequestTypeDef

describe_connection_proposal#

Describes the details of a connection proposal generated at a partner's portal.

Type annotations and code completion for boto3.client("interconnect").describe_connection_proposal method. boto3 documentation

# describe_connection_proposal method definition

def describe_connection_proposal(
    self,
    *,
    activationKey: str,
) -> DescribeConnectionProposalResponseTypeDef:  # (1)
    ...
  1. See DescribeConnectionProposalResponseTypeDef
# describe_connection_proposal method usage example with argument unpacking

kwargs: DescribeConnectionProposalRequestTypeDef = {  # (1)
    "activationKey": ...,
}

parent.describe_connection_proposal(**kwargs)
  1. See DescribeConnectionProposalRequestTypeDef

get_connection#

Describes the current state of a Connection resource as specified by the identifier.

Type annotations and code completion for boto3.client("interconnect").get_connection method. boto3 documentation

# get_connection method definition

def get_connection(
    self,
    *,
    identifier: str,
) -> GetConnectionResponseTypeDef:  # (1)
    ...
  1. See GetConnectionResponseTypeDef
# get_connection method usage example with argument unpacking

kwargs: GetConnectionRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.get_connection(**kwargs)
  1. See GetConnectionRequestTypeDef

get_environment#

Describes a specific Environment.

Type annotations and code completion for boto3.client("interconnect").get_environment method. boto3 documentation

# get_environment method definition

def get_environment(
    self,
    *,
    id: str,
) -> GetEnvironmentResponseTypeDef:  # (1)
    ...
  1. See GetEnvironmentResponseTypeDef
# get_environment method usage example with argument unpacking

kwargs: GetEnvironmentRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_environment(**kwargs)
  1. See GetEnvironmentRequestTypeDef

list_attach_points#

Lists all Attach Points the caller has access to that are valid for the specified Environment.

Type annotations and code completion for boto3.client("interconnect").list_attach_points method. boto3 documentation

# list_attach_points method definition

def list_attach_points(
    self,
    *,
    environmentId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAttachPointsResponseTypeDef:  # (1)
    ...
  1. See ListAttachPointsResponseTypeDef
# list_attach_points method usage example with argument unpacking

kwargs: ListAttachPointsRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.list_attach_points(**kwargs)
  1. See ListAttachPointsRequestTypeDef

list_connections#

Lists all connection objects to which the caller has access.

Type annotations and code completion for boto3.client("interconnect").list_connections method. boto3 documentation

# list_connections method definition

def list_connections(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    state: ConnectionStateType = ...,  # (1)
    environmentId: str = ...,
    provider: ProviderTypeDef = ...,  # (2)
    attachPoint: AttachPointTypeDef = ...,  # (3)
) -> ListConnectionsResponseTypeDef:  # (4)
    ...
  1. See ConnectionStateType
  2. See ProviderTypeDef
  3. See AttachPointTypeDef
  4. See ListConnectionsResponseTypeDef
# list_connections method usage example with argument unpacking

kwargs: ListConnectionsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_connections(**kwargs)
  1. See ListConnectionsRequestTypeDef

list_environments#

Lists all of the environments that can produce connections that will land in the called AWS region.

Type annotations and code completion for boto3.client("interconnect").list_environments method. boto3 documentation

# list_environments method definition

def list_environments(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    provider: ProviderTypeDef = ...,  # (1)
    location: str = ...,
) -> ListEnvironmentsResponseTypeDef:  # (2)
    ...
  1. See ProviderTypeDef
  2. See ListEnvironmentsResponseTypeDef
# list_environments method usage example with argument unpacking

kwargs: ListEnvironmentsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_environments(**kwargs)
  1. See ListEnvironmentsRequestTypeDef

list_tags_for_resource#

List all current tags on the specified resource.

Type annotations and code completion for boto3.client("interconnect").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    arn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

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

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

tag_resource#

Add new tags to the specified resource.

Type annotations and code completion for boto3.client("interconnect").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    arn: str,
    tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "arn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Removes tags from the specified resource.

Type annotations and code completion for boto3.client("interconnect").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    arn: str,
    tagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "arn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_connection#

Modifies an existing connection.

Type annotations and code completion for boto3.client("interconnect").update_connection method. boto3 documentation

# update_connection method definition

def update_connection(
    self,
    *,
    identifier: str,
    description: str = ...,
    bandwidth: str = ...,
    clientToken: str = ...,
) -> UpdateConnectionResponseTypeDef:  # (1)
    ...
  1. See UpdateConnectionResponseTypeDef
# update_connection method usage example with argument unpacking

kwargs: UpdateConnectionRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.update_connection(**kwargs)
  1. See UpdateConnectionRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("interconnect").get_paginator method with overloads.

get_waiter#

Type annotations and code completion for boto3.client("interconnect").get_waiter method with overloads.