Skip to content

VPCLatticeClient#

Index > VPCLattice > VPCLatticeClient

Auto-generated documentation for VPCLattice type annotations stubs module mypy-boto3-vpc-lattice.

VPCLatticeClient#

Type annotations and code completion for boto3.client("vpc-lattice"). boto3 documentation

# VPCLatticeClient usage example

from boto3.session import Session
from mypy_boto3_vpc_lattice.client import VPCLatticeClient

def get_vpc-lattice_client() -> VPCLatticeClient:
    return Session().client("vpc-lattice")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("vpc-lattice")

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_vpc_lattice.client import Exceptions

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

Methods#

batch_update_rule#

Updates the listener rules in a batch.

Type annotations and code completion for boto3.client("vpc-lattice").batch_update_rule method. boto3 documentation

# batch_update_rule method definition

def batch_update_rule(
    self,
    *,
    listenerIdentifier: str,
    rules: Sequence[RuleUpdateTypeDef],  # (1)
    serviceIdentifier: str,
) -> BatchUpdateRuleResponseTypeDef:  # (2)
    ...
  1. See RuleUpdateTypeDef
  2. See BatchUpdateRuleResponseTypeDef
# batch_update_rule method usage example with argument unpacking

kwargs: BatchUpdateRuleRequestRequestTypeDef = {  # (1)
    "listenerIdentifier": ...,
    "rules": ...,
    "serviceIdentifier": ...,
}

parent.batch_update_rule(**kwargs)
  1. See BatchUpdateRuleRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("vpc-lattice").can_paginate method. boto3 documentation

# can_paginate method definition

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

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("vpc-lattice").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_access_log_subscription#

Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose.

Type annotations and code completion for boto3.client("vpc-lattice").create_access_log_subscription method. boto3 documentation

# create_access_log_subscription method definition

def create_access_log_subscription(
    self,
    *,
    destinationArn: str,
    resourceIdentifier: str,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAccessLogSubscriptionResponseTypeDef:  # (1)
    ...
  1. See CreateAccessLogSubscriptionResponseTypeDef
# create_access_log_subscription method usage example with argument unpacking

kwargs: CreateAccessLogSubscriptionRequestRequestTypeDef = {  # (1)
    "destinationArn": ...,
    "resourceIdentifier": ...,
}

parent.create_access_log_subscription(**kwargs)
  1. See CreateAccessLogSubscriptionRequestRequestTypeDef

create_listener#

Creates a listener for a service.

Type annotations and code completion for boto3.client("vpc-lattice").create_listener method. boto3 documentation

# create_listener method definition

def create_listener(
    self,
    *,
    defaultAction: Union[RuleActionTypeDef, RuleActionOutputTypeDef],  # (1)
    name: str,
    protocol: ListenerProtocolType,  # (2)
    serviceIdentifier: str,
    clientToken: str = ...,
    port: int = ...,
    tags: Mapping[str, str] = ...,
) -> CreateListenerResponseTypeDef:  # (3)
    ...
  1. See RuleActionTypeDef RuleActionOutputTypeDef
  2. See ListenerProtocolType
  3. See CreateListenerResponseTypeDef
# create_listener method usage example with argument unpacking

kwargs: CreateListenerRequestRequestTypeDef = {  # (1)
    "defaultAction": ...,
    "name": ...,
    "protocol": ...,
    "serviceIdentifier": ...,
}

parent.create_listener(**kwargs)
  1. See CreateListenerRequestRequestTypeDef

create_rule#

Creates a listener rule.

Type annotations and code completion for boto3.client("vpc-lattice").create_rule method. boto3 documentation

# create_rule method definition

def create_rule(
    self,
    *,
    action: Union[RuleActionTypeDef, RuleActionOutputTypeDef],  # (1)
    listenerIdentifier: str,
    match: Union[RuleMatchTypeDef, RuleMatchOutputTypeDef],  # (2)
    name: str,
    priority: int,
    serviceIdentifier: str,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateRuleResponseTypeDef:  # (3)
    ...
  1. See RuleActionTypeDef RuleActionOutputTypeDef
  2. See RuleMatchTypeDef RuleMatchOutputTypeDef
  3. See CreateRuleResponseTypeDef
# create_rule method usage example with argument unpacking

kwargs: CreateRuleRequestRequestTypeDef = {  # (1)
    "action": ...,
    "listenerIdentifier": ...,
    "match": ...,
    "name": ...,
    "priority": ...,
    "serviceIdentifier": ...,
}

parent.create_rule(**kwargs)
  1. See CreateRuleRequestRequestTypeDef

create_service#

Creates a service.

Type annotations and code completion for boto3.client("vpc-lattice").create_service method. boto3 documentation

# create_service method definition

def create_service(
    self,
    *,
    name: str,
    authType: AuthTypeType = ...,  # (1)
    certificateArn: str = ...,
    clientToken: str = ...,
    customDomainName: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateServiceResponseTypeDef:  # (2)
    ...
  1. See AuthTypeType
  2. See CreateServiceResponseTypeDef
# create_service method usage example with argument unpacking

kwargs: CreateServiceRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_service(**kwargs)
  1. See CreateServiceRequestRequestTypeDef

create_service_network#

Creates a service network.

Type annotations and code completion for boto3.client("vpc-lattice").create_service_network method. boto3 documentation

# create_service_network method definition

def create_service_network(
    self,
    *,
    name: str,
    authType: AuthTypeType = ...,  # (1)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateServiceNetworkResponseTypeDef:  # (2)
    ...
  1. See AuthTypeType
  2. See CreateServiceNetworkResponseTypeDef
# create_service_network method usage example with argument unpacking

kwargs: CreateServiceNetworkRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_service_network(**kwargs)
  1. See CreateServiceNetworkRequestRequestTypeDef

create_service_network_service_association#

Associates a service with a service network.

Type annotations and code completion for boto3.client("vpc-lattice").create_service_network_service_association method. boto3 documentation

# create_service_network_service_association method definition

def create_service_network_service_association(
    self,
    *,
    serviceIdentifier: str,
    serviceNetworkIdentifier: str,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateServiceNetworkServiceAssociationResponseTypeDef:  # (1)
    ...
  1. See CreateServiceNetworkServiceAssociationResponseTypeDef
# create_service_network_service_association method usage example with argument unpacking

kwargs: CreateServiceNetworkServiceAssociationRequestRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
    "serviceNetworkIdentifier": ...,
}

parent.create_service_network_service_association(**kwargs)
  1. See