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: RuleActionTypeDef,  # (1)
    name: str,
    protocol: ListenerProtocolType,  # (2)
    serviceIdentifier: str,
    clientToken: str = ...,
    port: int = ...,
    tags: Mapping[str, str] = ...,
) -> CreateListenerResponseTypeDef:  # (3)
    ...
  1. See RuleActionTypeDef
  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: RuleActionTypeDef,  # (1)
    listenerIdentifier: str,
    match: RuleMatchTypeDef,  # (2)
    name: str,
    priority: int,
    serviceIdentifier: str,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateRuleResponseTypeDef:  # (3)
    ...
  1. See RuleActionTypeDef
  2. See RuleMatchTypeDef
  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 CreateServiceNetworkServiceAssociationRequestRequestTypeDef

create_service_network_vpc_association#

Associates a VPC with a service network.

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

# create_service_network_vpc_association method definition

def create_service_network_vpc_association(
    self,
    *,
    serviceNetworkIdentifier: str,
    vpcIdentifier: str,
    clientToken: str = ...,
    securityGroupIds: Sequence[str] = ...,
    tags: Mapping[str, str] = ...,
) -> CreateServiceNetworkVpcAssociationResponseTypeDef:  # (1)
    ...
  1. See CreateServiceNetworkVpcAssociationResponseTypeDef 
# create_service_network_vpc_association method usage example with argument unpacking

kwargs: CreateServiceNetworkVpcAssociationRequestRequestTypeDef = {  # (1)
    "serviceNetworkIdentifier": ...,
    "vpcIdentifier": ...,
}

parent.create_service_network_vpc_association(**kwargs)
  1. See CreateServiceNetworkVpcAssociationRequestRequestTypeDef

create_target_group#

Creates a target group.

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

# create_target_group method definition

def create_target_group(
    self,
    *,
    name: str,
    type: TargetGroupTypeType,  # (1)
    clientToken: str = ...,
    config: TargetGroupConfigTypeDef = ...,  # (2)
    tags: Mapping[str, str] = ...,
) -> CreateTargetGroupResponseTypeDef:  # (3)
    ...
  1. See TargetGroupTypeType
  2. See TargetGroupConfigTypeDef
  3. See CreateTargetGroupResponseTypeDef 
# create_target_group method usage example with argument unpacking

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

parent.create_target_group(**kwargs)
  1. See CreateTargetGroupRequestRequestTypeDef

delete_access_log_subscription#

Deletes the specified access log subscription.

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

# delete_access_log_subscription method definition

def delete_access_log_subscription(
    self,
    *,
    accessLogSubscriptionIdentifier: str,
) -> Dict[str, Any]:
    ...
# delete_access_log_subscription method usage example with argument unpacking

kwargs: DeleteAccessLogSubscriptionRequestRequestTypeDef = {  # (1)
    "accessLogSubscriptionIdentifier": ...,
}

parent.delete_access_log_subscription(**kwargs)
  1. See DeleteAccessLogSubscriptionRequestRequestTypeDef

delete_auth_policy#

Deletes the specified auth policy.

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

# delete_auth_policy method definition

def delete_auth_policy(
    self,
    *,
    resourceIdentifier: str,
) -> Dict[str, Any]:
    ...
# delete_auth_policy method usage example with argument unpacking

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

parent.delete_auth_policy(**kwargs)
  1. See DeleteAuthPolicyRequestRequestTypeDef

delete_listener#

Deletes the specified listener.

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

# delete_listener method definition

def delete_listener(
    self,
    *,
    listenerIdentifier: str,
    serviceIdentifier: str,
) -> Dict[str, Any]:
    ...
# delete_listener method usage example with argument unpacking

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

parent.delete_listener(**kwargs)
  1. See DeleteListenerRequestRequestTypeDef

delete_resource_policy#

Deletes the specified resource policy.

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

# delete_resource_policy method definition

def delete_resource_policy(
    self,
    *,
    resourceArn: str,
) -> Dict[str, Any]:
    ...
# delete_resource_policy method usage example with argument unpacking

kwargs: DeleteResourcePolicyRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.delete_resource_policy(**kwargs)
  1. See DeleteResourcePolicyRequestRequestTypeDef

delete_rule#

Deletes a listener rule.

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

# delete_rule method definition

def delete_rule(
    self,
    *,
    listenerIdentifier: str,
    ruleIdentifier: str,
    serviceIdentifier: str,
) -> Dict[str, Any]:
    ...
# delete_rule method usage example with argument unpacking

kwargs: DeleteRuleRequestRequestTypeDef = {  # (1)
    "listenerIdentifier": ...,
    "ruleIdentifier": ...,
    "serviceIdentifier": ...,
}

parent.delete_rule(**kwargs)
  1. See DeleteRuleRequestRequestTypeDef

delete_service#

Deletes a service.

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

# delete_service method definition

def delete_service(
    self,
    *,
    serviceIdentifier: str,
) -> DeleteServiceResponseTypeDef:  # (1)
    ...
  1. See DeleteServiceResponseTypeDef 
# delete_service method usage example with argument unpacking

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

parent.delete_service(**kwargs)
  1. See DeleteServiceRequestRequestTypeDef

delete_service_network#

Deletes a service network.

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

# delete_service_network method definition

def delete_service_network(
    self,
    *,
    serviceNetworkIdentifier: str,
) -> Dict[str, Any]:
    ...
# delete_service_network method usage example with argument unpacking

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

parent.delete_service_network(**kwargs)
  1. See DeleteServiceNetworkRequestRequestTypeDef

delete_service_network_service_association#

Deletes the association between a specified service and the specific service network.

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

# delete_service_network_service_association method definition

def delete_service_network_service_association(
    self,
    *,
    serviceNetworkServiceAssociationIdentifier: str,
) -> DeleteServiceNetworkServiceAssociationResponseTypeDef:  # (1)
    ...
  1. See DeleteServiceNetworkServiceAssociationResponseTypeDef 
# delete_service_network_service_association method usage example with argument unpacking

kwargs: DeleteServiceNetworkServiceAssociationRequestRequestTypeDef = {  # (1)
    "serviceNetworkServiceAssociationIdentifier": ...,
}

parent.delete_service_network_service_association(**kwargs)
  1. See DeleteServiceNetworkServiceAssociationRequestRequestTypeDef

delete_service_network_vpc_association#

Disassociates the VPC from the service network.

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

# delete_service_network_vpc_association method definition

def delete_service_network_vpc_association(
    self,
    *,
    serviceNetworkVpcAssociationIdentifier: str,
) -> DeleteServiceNetworkVpcAssociationResponseTypeDef:  # (1)
    ...
  1. See DeleteServiceNetworkVpcAssociationResponseTypeDef 
# delete_service_network_vpc_association method usage example with argument unpacking

kwargs: DeleteServiceNetworkVpcAssociationRequestRequestTypeDef = {  # (1)
    "serviceNetworkVpcAssociationIdentifier": ...,
}

parent.delete_service_network_vpc_association(**kwargs)
  1. See DeleteServiceNetworkVpcAssociationRequestRequestTypeDef

delete_target_group#

Deletes a target group.

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

# delete_target_group method definition

def delete_target_group(
    self,
    *,
    targetGroupIdentifier: str,
) -> DeleteTargetGroupResponseTypeDef:  # (1)
    ...
  1. See DeleteTargetGroupResponseTypeDef 
# delete_target_group method usage example with argument unpacking

kwargs: DeleteTargetGroupRequestRequestTypeDef = {  # (1)
    "targetGroupIdentifier": ...,
}

parent.delete_target_group(**kwargs)
  1. See DeleteTargetGroupRequestRequestTypeDef

deregister_targets#

Deregisters the specified targets from the specified target group.

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

# deregister_targets method definition

def deregister_targets(
    self,
    *,
    targetGroupIdentifier: str,
    targets: Sequence[TargetTypeDef],  # (1)
) -> DeregisterTargetsResponseTypeDef:  # (2)
    ...
  1. See TargetTypeDef
  2. See DeregisterTargetsResponseTypeDef 
# deregister_targets method usage example with argument unpacking

kwargs: DeregisterTargetsRequestRequestTypeDef = {  # (1)
    "targetGroupIdentifier": ...,
    "targets": ...,
}

parent.deregister_targets(**kwargs)
  1. See DeregisterTargetsRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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

get_access_log_subscription#

Retrieves information about the specified access log subscription.

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

# get_access_log_subscription method definition

def get_access_log_subscription(
    self,
    *,
    accessLogSubscriptionIdentifier: str,
) -> GetAccessLogSubscriptionResponseTypeDef:  # (1)
    ...
  1. See GetAccessLogSubscriptionResponseTypeDef 
# get_access_log_subscription method usage example with argument unpacking

kwargs: GetAccessLogSubscriptionRequestRequestTypeDef = {  # (1)
    "accessLogSubscriptionIdentifier": ...,
}

parent.get_access_log_subscription(**kwargs)
  1. See GetAccessLogSubscriptionRequestRequestTypeDef

get_auth_policy#

Retrieves information about the auth policy for the specified service or service network.

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

# get_auth_policy method definition

def get_auth_policy(
    self,
    *,
    resourceIdentifier: str,
) -> GetAuthPolicyResponseTypeDef:  # (1)
    ...
  1. See GetAuthPolicyResponseTypeDef 
# get_auth_policy method usage example with argument unpacking

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

parent.get_auth_policy(**kwargs)
  1. See GetAuthPolicyRequestRequestTypeDef

get_listener#

Retrieves information about the specified listener for the specified service.

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

# get_listener method definition

def get_listener(
    self,
    *,
    listenerIdentifier: str,
    serviceIdentifier: str,
) -> GetListenerResponseTypeDef:  # (1)
    ...
  1. See GetListenerResponseTypeDef 
# get_listener method usage example with argument unpacking

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

parent.get_listener(**kwargs)
  1. See GetListenerRequestRequestTypeDef

get_resource_policy#

Retrieves information about the resource policy.

Type annotations and code completion for boto3.client("vpc-lattice").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: GetResourcePolicyRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.get_resource_policy(**kwargs)
  1. See GetResourcePolicyRequestRequestTypeDef

get_rule#

Retrieves information about listener rules.

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

# get_rule method definition

def get_rule(
    self,
    *,
    listenerIdentifier: str,
    ruleIdentifier: str,
    serviceIdentifier: str,
) -> GetRuleResponseTypeDef:  # (1)
    ...
  1. See GetRuleResponseTypeDef 
# get_rule method usage example with argument unpacking

kwargs: GetRuleRequestRequestTypeDef = {  # (1)
    "listenerIdentifier": ...,
    "ruleIdentifier": ...,
    "serviceIdentifier": ...,
}

parent.get_rule(**kwargs)
  1. See GetRuleRequestRequestTypeDef

get_service#

Retrieves information about the specified service.

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

# get_service method definition

def get_service(
    self,
    *,
    serviceIdentifier: str,
) -> GetServiceResponseTypeDef:  # (1)
    ...
  1. See GetServiceResponseTypeDef 
# get_service method usage example with argument unpacking

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

parent.get_service(**kwargs)
  1. See GetServiceRequestRequestTypeDef

get_service_network#

Retrieves information about the specified service network.

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