VPCLatticeClient#
Index > VPCLattice > VPCLatticeClient
Auto-generated documentation for VPCLattice type annotations stubs module types-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 types_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 types_boto3_vpc_lattice.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...Methods#
can_paginate#
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:
    ...generate_presigned_url#
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:
    ...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,
    *,
    serviceIdentifier: str,
    listenerIdentifier: str,
    rules: Sequence[RuleUpdateTypeDef],  # (1)
) -> BatchUpdateRuleResponseTypeDef:  # (2)
    ...- See Sequence[RuleUpdateTypeDef]
- See BatchUpdateRuleResponseTypeDef
# batch_update_rule method usage example with argument unpacking
kwargs: BatchUpdateRuleRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
    "listenerIdentifier": ...,
    "rules": ...,
}
parent.batch_update_rule(**kwargs)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,
    *,
    resourceIdentifier: str,
    destinationArn: str,
    clientToken: str = ...,
    serviceNetworkLogType: ServiceNetworkLogTypeType = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateAccessLogSubscriptionResponseTypeDef:  # (2)
    ...# create_access_log_subscription method usage example with argument unpacking
kwargs: CreateAccessLogSubscriptionRequestTypeDef = {  # (1)
    "resourceIdentifier": ...,
    "destinationArn": ...,
}
parent.create_access_log_subscription(**kwargs)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,
    *,
    serviceIdentifier: str,
    name: str,
    protocol: ListenerProtocolType,  # (1)
    defaultAction: RuleActionUnionTypeDef,  # (2)
    port: int = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateListenerResponseTypeDef:  # (3)
    ...# create_listener method usage example with argument unpacking
kwargs: CreateListenerRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
    "name": ...,
    "protocol": ...,
    "defaultAction": ...,
}
parent.create_listener(**kwargs)create_resource_configuration#
Creates a resource configuration.
Type annotations and code completion for boto3.client("vpc-lattice").create_resource_configuration method.
 boto3 documentation
# create_resource_configuration method definition
def create_resource_configuration(
    self,
    *,
    name: str,
    type: ResourceConfigurationTypeType,  # (1)
    portRanges: Sequence[str] = ...,
    protocol: ProtocolTypeType = ...,  # (2)
    resourceGatewayIdentifier: str = ...,
    resourceConfigurationGroupIdentifier: str = ...,
    resourceConfigurationDefinition: ResourceConfigurationDefinitionTypeDef = ...,  # (3)
    allowAssociationToShareableServiceNetwork: bool = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateResourceConfigurationResponseTypeDef:  # (4)
    ...- See ResourceConfigurationTypeType
- See ProtocolTypeType
- See ResourceConfigurationDefinitionTypeDef
- See CreateResourceConfigurationResponseTypeDef
# create_resource_configuration method usage example with argument unpacking
kwargs: CreateResourceConfigurationRequestTypeDef = {  # (1)
    "name": ...,
    "type": ...,
}
parent.create_resource_configuration(**kwargs)create_resource_gateway#
A resource gateway is a point of ingress into the VPC where a resource resides.
Type annotations and code completion for boto3.client("vpc-lattice").create_resource_gateway method.
 boto3 documentation
# create_resource_gateway method definition
def create_resource_gateway(
    self,
    *,
    name: str,
    clientToken: str = ...,
    vpcIdentifier: str = ...,
    subnetIds: Sequence[str] = ...,
    securityGroupIds: Sequence[str] = ...,
    ipAddressType: ResourceGatewayIpAddressTypeType = ...,  # (1)
    ipv4AddressesPerEni: int = ...,
    tags: Mapping[str, str] = ...,
) -> CreateResourceGatewayResponseTypeDef:  # (2)
    ...# create_resource_gateway method usage example with argument unpacking
kwargs: CreateResourceGatewayRequestTypeDef = {  # (1)
    "name": ...,
}
parent.create_resource_gateway(**kwargs)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,
    *,
    serviceIdentifier: str,
    listenerIdentifier: str,
    name: str,
    match: RuleMatchUnionTypeDef,  # (1)
    priority: int,
    action: RuleActionUnionTypeDef,  # (2)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateRuleResponseTypeDef:  # (3)
    ...# create_rule method usage example with argument unpacking
kwargs: CreateRuleRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
    "listenerIdentifier": ...,
    "name": ...,
    "match": ...,
    "priority": ...,
    "action": ...,
}
parent.create_rule(**kwargs)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,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
    customDomainName: str = ...,
    certificateArn: str = ...,
    authType: AuthTypeType = ...,  # (1)
) -> CreateServiceResponseTypeDef:  # (2)
    ...# create_service method usage example with argument unpacking
kwargs: CreateServiceRequestTypeDef = {  # (1)
    "name": ...,
}
parent.create_service(**kwargs)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,
    clientToken: str = ...,
    authType: AuthTypeType = ...,  # (1)
    tags: Mapping[str, str] = ...,
    sharingConfig: SharingConfigTypeDef = ...,  # (2)
) -> CreateServiceNetworkResponseTypeDef:  # (3)
    ...# create_service_network method usage example with argument unpacking
kwargs: CreateServiceNetworkRequestTypeDef = {  # (1)
    "name": ...,
}
parent.create_service_network(**kwargs)create_service_network_resource_association#
Associates the specified service network with the specified resource configuration.
Type annotations and code completion for boto3.client("vpc-lattice").create_service_network_resource_association method.
 boto3 documentation
# create_service_network_resource_association method definition
def create_service_network_resource_association(
    self,
    *,
    resourceConfigurationIdentifier: str,
    serviceNetworkIdentifier: str,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateServiceNetworkResourceAssociationResponseTypeDef:  # (1)
    ...# create_service_network_resource_association method usage example with argument unpacking
kwargs: CreateServiceNetworkResourceAssociationRequestTypeDef = {  # (1)
    "resourceConfigurationIdentifier": ...,
    "serviceNetworkIdentifier": ...,
}
parent.create_service_network_resource_association(**kwargs)create_service_network_service_association#
Associates the specified service with the specified 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)
    ...# create_service_network_service_association method usage example with argument unpacking
kwargs: CreateServiceNetworkServiceAssociationRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
    "serviceNetworkIdentifier": ...,
}
parent.create_service_network_service_association(**kwargs)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)
    ...# create_service_network_vpc_association method usage example with argument unpacking
kwargs: CreateServiceNetworkVpcAssociationRequestTypeDef = {  # (1)
    "serviceNetworkIdentifier": ...,
    "vpcIdentifier": ...,
}
parent.create_service_network_vpc_association(**kwargs)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)
    config: TargetGroupConfigTypeDef = ...,  # (2)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateTargetGroupResponseTypeDef:  # (3)
    ...# create_target_group method usage example with argument unpacking
kwargs: CreateTargetGroupRequestTypeDef = {  # (1)
    "name": ...,
    "type": ...,
}
parent.create_target_group(**kwargs)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: DeleteAccessLogSubscriptionRequestTypeDef = {  # (1)
    "accessLogSubscriptionIdentifier": ...,
}
parent.delete_access_log_subscription(**kwargs)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: DeleteAuthPolicyRequestTypeDef = {  # (1)
    "resourceIdentifier": ...,
}
parent.delete_auth_policy(**kwargs)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,
    *,
    serviceIdentifier: str,
    listenerIdentifier: str,
) -> Dict[str, Any]:
    ...# delete_listener method usage example with argument unpacking
kwargs: DeleteListenerRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
    "listenerIdentifier": ...,
}
parent.delete_listener(**kwargs)delete_resource_configuration#
Deletes the specified resource configuration.
Type annotations and code completion for boto3.client("vpc-lattice").delete_resource_configuration method.
 boto3 documentation
# delete_resource_configuration method definition
def delete_resource_configuration(
    self,
    *,
    resourceConfigurationIdentifier: str,
) -> Dict[str, Any]:
    ...# delete_resource_configuration method usage example with argument unpacking
kwargs: DeleteResourceConfigurationRequestTypeDef = {  # (1)
    "resourceConfigurationIdentifier": ...,
}
parent.delete_resource_configuration(**kwargs)delete_resource_endpoint_association#
Disassociates the resource configuration from the resource VPC endpoint.
Type annotations and code completion for boto3.client("vpc-lattice").delete_resource_endpoint_association method.
 boto3 documentation
# delete_resource_endpoint_association method definition
def delete_resource_endpoint_association(
    self,
    *,
    resourceEndpointAssociationIdentifier: str,
) -> DeleteResourceEndpointAssociationResponseTypeDef:  # (1)
    ...# delete_resource_endpoint_association method usage example with argument unpacking
kwargs: DeleteResourceEndpointAssociationRequestTypeDef = {  # (1)
    "resourceEndpointAssociationIdentifier": ...,
}
parent.delete_resource_endpoint_association(**kwargs)delete_resource_gateway#
Deletes the specified resource gateway.
Type annotations and code completion for boto3.client("vpc-lattice").delete_resource_gateway method.
 boto3 documentation
# delete_resource_gateway method definition
def delete_resource_gateway(
    self,
    *,
    resourceGatewayIdentifier: str,
) -> DeleteResourceGatewayResponseTypeDef:  # (1)
    ...# delete_resource_gateway method usage example with argument unpacking
kwargs: DeleteResourceGatewayRequestTypeDef = {  # (1)
    "resourceGatewayIdentifier": ...,
}
parent.delete_resource_gateway(**kwargs)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: DeleteResourcePolicyRequestTypeDef = {  # (1)
    "resourceArn": ...,
}
parent.delete_resource_policy(**kwargs)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,
    *,
    serviceIdentifier: str,
    listenerIdentifier: str,
    ruleIdentifier: str,
) -> Dict[str, Any]:
    ...# delete_rule method usage example with argument unpacking
kwargs: DeleteRuleRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
    "listenerIdentifier": ...,
    "ruleIdentifier": ...,
}
parent.delete_rule(**kwargs)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)
    ...# delete_service method usage example with argument unpacking
kwargs: DeleteServiceRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
}
parent.delete_service(**kwargs)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: DeleteServiceNetworkRequestTypeDef = {  # (1)
    "serviceNetworkIdentifier": ...,
}
parent.delete_service_network(**kwargs)delete_service_network_resource_association#
Deletes the association between a service network and a resource configuration.
Type annotations and code completion for boto3.client("vpc-lattice").delete_service_network_resource_association method.
 boto3 documentation
# delete_service_network_resource_association method definition
def delete_service_network_resource_association(
    self,
    *,
    serviceNetworkResourceAssociationIdentifier: str,
) -> DeleteServiceNetworkResourceAssociationResponseTypeDef:  # (1)
    ...# delete_service_network_resource_association method usage example with argument unpacking
kwargs: DeleteServiceNetworkResourceAssociationRequestTypeDef = {  # (1)
    "serviceNetworkResourceAssociationIdentifier": ...,
}
parent.delete_service_network_resource_association(**kwargs)delete_service_network_service_association#
Deletes the association between a service and a 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)
    ...# delete_service_network_service_association method usage example with argument unpacking
kwargs: DeleteServiceNetworkServiceAssociationRequestTypeDef = {  # (1)
    "serviceNetworkServiceAssociationIdentifier": ...,
}
parent.delete_service_network_service_association(**kwargs)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)
    ...# delete_service_network_vpc_association method usage example with argument unpacking
kwargs: DeleteServiceNetworkVpcAssociationRequestTypeDef = {  # (1)
    "serviceNetworkVpcAssociationIdentifier": ...,
}
parent.delete_service_network_vpc_association(**kwargs)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)
    ...# delete_target_group method usage example with argument unpacking
kwargs: DeleteTargetGroupRequestTypeDef = {  # (1)
    "targetGroupIdentifier": ...,
}
parent.delete_target_group(**kwargs)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)
    ...- See Sequence[TargetTypeDef]
- See DeregisterTargetsResponseTypeDef
# deregister_targets method usage example with argument unpacking
kwargs: DeregisterTargetsRequestTypeDef = {  # (1)
    "targetGroupIdentifier": ...,
    "targets": ...,
}
parent.deregister_targets(**kwargs)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)
    ...# get_access_log_subscription method usage example with argument unpacking
kwargs: GetAccessLogSubscriptionRequestTypeDef = {  # (1)
    "accessLogSubscriptionIdentifier": ...,
}
parent.get_access_log_subscription(**kwargs)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)
    ...# get_auth_policy method usage example with argument unpacking
kwargs: GetAuthPolicyRequestTypeDef = {  # (1)
    "resourceIdentifier": ...,
}
parent.get_auth_policy(**kwargs)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,
    *,
    serviceIdentifier: str,
    listenerIdentifier: str,
) -> GetListenerResponseTypeDef:  # (1)
    ...# get_listener method usage example with argument unpacking
kwargs: GetListenerRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
    "listenerIdentifier": ...,
}
parent.get_listener(**kwargs)get_resource_configuration#
Retrieves information about the specified resource configuration.
Type annotations and code completion for boto3.client("vpc-lattice").get_resource_configuration method.
 boto3 documentation
# get_resource_configuration method definition
def get_resource_configuration(
    self,
    *,
    resourceConfigurationIdentifier: str,
) -> GetResourceConfigurationResponseTypeDef:  # (1)
    ...# get_resource_configuration method usage example with argument unpacking
kwargs: GetResourceConfigurationRequestTypeDef = {  # (1)
    "resourceConfigurationIdentifier": ...,
}
parent.get_resource_configuration(**kwargs)get_resource_gateway#
Retrieves information about the specified resource gateway.
Type annotations and code completion for boto3.client("vpc-lattice").get_resource_gateway method.
 boto3 documentation
# get_resource_gateway method definition
def get_resource_gateway(
    self,
    *,
    resourceGatewayIdentifier: str,
) -> GetResourceGatewayResponseTypeDef:  # (1)
    ...# get_resource_gateway method usage example with argument unpacking
kwargs: GetResourceGatewayRequestTypeDef = {  # (1)
    "resourceGatewayIdentifier": ...,
}
parent.get_resource_gateway(**kwargs)get_resource_policy#
Retrieves information about the specified 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)
    ...# get_resource_policy method usage example with argument unpacking
kwargs: GetResourcePolicyRequestTypeDef = {  # (1)
    "resourceArn": ...,
}
parent.get_resource_policy(**kwargs)get_rule#
Retrieves information about the specified 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,
    *,
    serviceIdentifier: str,
    listenerIdentifier: str,
    ruleIdentifier: str,
) -> GetRuleResponseTypeDef:  # (1)
    ...# get_rule method usage example with argument unpacking
kwargs: GetRuleRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
    "listenerIdentifier": ...,
    "ruleIdentifier": ...,
}
parent.get_rule(**kwargs)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)
    ...# get_service method usage example with argument unpacking
kwargs: GetServiceRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
}
parent.get_service(**kwargs)get_service_network#
Retrieves information about the specified service network.
Type annotations and code completion for boto3.client("vpc-lattice").get_service_network method.
 boto3 documentation
# get_service_network method definition
def get_service_network(
    self,
    *,
    serviceNetworkIdentifier: str,
) -> GetServiceNetworkResponseTypeDef:  # (1)
    ...# get_service_network method usage example with argument unpacking
kwargs: GetServiceNetworkRequestTypeDef = {  # (1)
    "serviceNetworkIdentifier": ...,
}
parent.get_service_network(**kwargs)get_service_network_resource_association#
Retrieves information about the specified association between a service network and a resource configuration.
Type annotations and code completion for boto3.client("vpc-lattice").get_service_network_resource_association method.
 boto3 documentation
# get_service_network_resource_association method definition
def get_service_network_resource_association(
    self,
    *,
    serviceNetworkResourceAssociationIdentifier: str,
) -> GetServiceNetworkResourceAssociationResponseTypeDef:  # (1)
    ...# get_service_network_resource_association method usage example with argument unpacking
kwargs: GetServiceNetworkResourceAssociationRequestTypeDef = {  # (1)
    "serviceNetworkResourceAssociationIdentifier": ...,
}
parent.get_service_network_resource_association(**kwargs)get_service_network_service_association#
Retrieves information about the specified association between a service network and a service.
Type annotations and code completion for boto3.client("vpc-lattice").get_service_network_service_association method.
 boto3 documentation
# get_service_network_service_association method definition
def get_service_network_service_association(
    self,
    *,
    serviceNetworkServiceAssociationIdentifier: str,
) -> GetServiceNetworkServiceAssociationResponseTypeDef:  # (1)
    ...# get_service_network_service_association method usage example with argument unpacking
kwargs: GetServiceNetworkServiceAssociationRequestTypeDef = {  # (1)
    "serviceNetworkServiceAssociationIdentifier": ...,
}
parent.get_service_network_service_association(**kwargs)get_service_network_vpc_association#
Retrieves information about the specified association between a service network and a VPC.
Type annotations and code completion for boto3.client("vpc-lattice").get_service_network_vpc_association method.
 boto3 documentation
# get_service_network_vpc_association method definition
def get_service_network_vpc_association(
    self,
    *,
    serviceNetworkVpcAssociationIdentifier: str,
) -> GetServiceNetworkVpcAssociationResponseTypeDef:  # (1)
    ...# get_service_network_vpc_association method usage example with argument unpacking
kwargs: GetServiceNetworkVpcAssociationRequestTypeDef = {  # (1)
    "serviceNetworkVpcAssociationIdentifier": ...,
}
parent.get_service_network_vpc_association(**kwargs)get_target_group#
Retrieves information about the specified target group.
Type annotations and code completion for boto3.client("vpc-lattice").get_target_group method.
 boto3 documentation
# get_target_group method definition
def get_target_group(
    self,
    *,
    targetGroupIdentifier: str,
) -> GetTargetGroupResponseTypeDef:  # (1)
    ...# get_target_group method usage example with argument unpacking
kwargs: GetTargetGroupRequestTypeDef = {  # (1)
    "targetGroupIdentifier": ...,
}
parent.get_target_group(**kwargs)list_access_log_subscriptions#
Lists the access log subscriptions for the specified service network or service.
Type annotations and code completion for boto3.client("vpc-lattice").list_access_log_subscriptions method.
 boto3 documentation
# list_access_log_subscriptions method definition
def list_access_log_subscriptions(
    self,
    *,
    resourceIdentifier: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAccessLogSubscriptionsResponseTypeDef:  # (1)
    ...# list_access_log_subscriptions method usage example with argument unpacking
kwargs: ListAccessLogSubscriptionsRequestTypeDef = {  # (1)
    "resourceIdentifier": ...,
}
parent.list_access_log_subscriptions(**kwargs)list_listeners#
Lists the listeners for the specified service.
Type annotations and code completion for boto3.client("vpc-lattice").list_listeners method.
 boto3 documentation
# list_listeners method definition
def list_listeners(
    self,
    *,
    serviceIdentifier: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListListenersResponseTypeDef:  # (1)
    ...# list_listeners method usage example with argument unpacking
kwargs: ListListenersRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
}
parent.list_listeners(**kwargs)list_resource_configurations#
Lists the resource configurations owned by or shared with this account.
Type annotations and code completion for boto3.client("vpc-lattice").list_resource_configurations method.
 boto3 documentation
# list_resource_configurations method definition
def list_resource_configurations(
    self,
    *,
    resourceGatewayIdentifier: str = ...,
    resourceConfigurationGroupIdentifier: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListResourceConfigurationsResponseTypeDef:  # (1)
    ...# list_resource_configurations method usage example with argument unpacking
kwargs: ListResourceConfigurationsRequestTypeDef = {  # (1)
    "resourceGatewayIdentifier": ...,
}
parent.list_resource_configurations(**kwargs)list_resource_endpoint_associations#
Lists the associations for the specified VPC endpoint.
Type annotations and code completion for boto3.client("vpc-lattice").list_resource_endpoint_associations method.
 boto3 documentation
# list_resource_endpoint_associations method definition
def list_resource_endpoint_associations(
    self,
    *,
    resourceConfigurationIdentifier: str,
    resourceEndpointAssociationIdentifier: str = ...,
    vpcEndpointId: str = ...,
    vpcEndpointOwner: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListResourceEndpointAssociationsResponseTypeDef:  # (1)
    ...# list_resource_endpoint_associations method usage example with argument unpacking
kwargs: ListResourceEndpointAssociationsRequestTypeDef = {  # (1)
    "resourceConfigurationIdentifier": ...,
}
parent.list_resource_endpoint_associations(**kwargs)list_resource_gateways#
Lists the resource gateways that you own or that were shared with you.
Type annotations and code completion for boto3.client("vpc-lattice").list_resource_gateways method.
 boto3 documentation
# list_resource_gateways method definition
def list_resource_gateways(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListResourceGatewaysResponseTypeDef:  # (1)
    ...# list_resource_gateways method usage example with argument unpacking
kwargs: ListResourceGatewaysRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_resource_gateways(**kwargs)list_rules#
Lists the rules for the specified listener.
Type annotations and code completion for boto3.client("vpc-lattice").list_rules method.
 boto3 documentation
# list_rules method definition
def list_rules(
    self,
    *,
    serviceIdentifier: str,
    listenerIdentifier: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListRulesResponseTypeDef:  # (1)
    ...# list_rules method usage example with argument unpacking
kwargs: ListRulesRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
    "listenerIdentifier": ...,
}
parent.list_rules(**kwargs)list_service_network_resource_associations#
Lists the associations between a service network and a resource configuration.
Type annotations and code completion for boto3.client("vpc-lattice").list_service_network_resource_associations method.
 boto3 documentation
# list_service_network_resource_associations method definition
def list_service_network_resource_associations(
    self,
    *,
    serviceNetworkIdentifier: str = ...,
    resourceConfigurationIdentifier: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    includeChildren: bool = ...,
) -> ListServiceNetworkResourceAssociationsResponseTypeDef:  # (1)
    ...# list_service_network_resource_associations method usage example with argument unpacking
kwargs: ListServiceNetworkResourceAssociationsRequestTypeDef = {  # (1)
    "serviceNetworkIdentifier": ...,
}
parent.list_service_network_resource_associations(**kwargs)list_service_network_service_associations#
Lists the associations between a service network and a service.
Type annotations and code completion for boto3.client("vpc-lattice").list_service_network_service_associations method.
 boto3 documentation
# list_service_network_service_associations method definition
def list_service_network_service_associations(
    self,
    *,
    serviceNetworkIdentifier: str = ...,
    serviceIdentifier: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListServiceNetworkServiceAssociationsResponseTypeDef:  # (1)
    ...# list_service_network_service_associations method usage example with argument unpacking
kwargs: ListServiceNetworkServiceAssociationsRequestTypeDef = {  # (1)
    "serviceNetworkIdentifier": ...,
}
parent.list_service_network_service_associations(**kwargs)list_service_network_vpc_associations#
Lists the associations between a service network and a VPC.
Type annotations and code completion for boto3.client("vpc-lattice").list_service_network_vpc_associations method.
 boto3 documentation
# list_service_network_vpc_associations method definition
def list_service_network_vpc_associations(
    self,
    *,
    serviceNetworkIdentifier: str = ...,
    vpcIdentifier: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListServiceNetworkVpcAssociationsResponseTypeDef:  # (1)
    ...# list_service_network_vpc_associations method usage example with argument unpacking
kwargs: ListServiceNetworkVpcAssociationsRequestTypeDef = {  # (1)
    "serviceNetworkIdentifier": ...,
}
parent.list_service_network_vpc_associations(**kwargs)list_service_network_vpc_endpoint_associations#
Lists the associations between a service network and a VPC endpoint.
Type annotations and code completion for boto3.client("vpc-lattice").list_service_network_vpc_endpoint_associations method.
 boto3 documentation
# list_service_network_vpc_endpoint_associations method definition
def list_service_network_vpc_endpoint_associations(
    self,
    *,
    serviceNetworkIdentifier: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListServiceNetworkVpcEndpointAssociationsResponseTypeDef:  # (1)
    ...# list_service_network_vpc_endpoint_associations method usage example with argument unpacking
kwargs: ListServiceNetworkVpcEndpointAssociationsRequestTypeDef = {  # (1)
    "serviceNetworkIdentifier": ...,
}
parent.list_service_network_vpc_endpoint_associations(**kwargs)list_service_networks#
Lists the service networks owned by or shared with this account.
Type annotations and code completion for boto3.client("vpc-lattice").list_service_networks method.
 boto3 documentation
# list_service_networks method definition
def list_service_networks(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListServiceNetworksResponseTypeDef:  # (1)
    ...# list_service_networks method usage example with argument unpacking
kwargs: ListServiceNetworksRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_service_networks(**kwargs)list_services#
Lists the services owned by the caller account or shared with the caller account.
Type annotations and code completion for boto3.client("vpc-lattice").list_services method.
 boto3 documentation
# list_services method definition
def list_services(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListServicesResponseTypeDef:  # (1)
    ...# list_services method usage example with argument unpacking
kwargs: ListServicesRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_services(**kwargs)list_tags_for_resource#
Lists the tags for the specified resource.
Type annotations and code completion for boto3.client("vpc-lattice").list_tags_for_resource method.
 boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)list_target_groups#
Lists your target groups.
Type annotations and code completion for boto3.client("vpc-lattice").list_target_groups method.
 boto3 documentation
# list_target_groups method definition
def list_target_groups(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    vpcIdentifier: str = ...,
    targetGroupType: TargetGroupTypeType = ...,  # (1)
) -> ListTargetGroupsResponseTypeDef:  # (2)
    ...# list_target_groups method usage example with argument unpacking
kwargs: ListTargetGroupsRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_target_groups(**kwargs)list_targets#
Lists the targets for the target group.
Type annotations and code completion for boto3.client("vpc-lattice").list_targets method.
 boto3 documentation
# list_targets method definition
def list_targets(
    self,
    *,
    targetGroupIdentifier: str,
    maxResults: int = ...,
    nextToken: str = ...,
    targets: Sequence[TargetTypeDef] = ...,  # (1)
) -> ListTargetsResponseTypeDef:  # (2)
    ...- See Sequence[TargetTypeDef]
- See ListTargetsResponseTypeDef
# list_targets method usage example with argument unpacking
kwargs: ListTargetsRequestTypeDef = {  # (1)
    "targetGroupIdentifier": ...,
}
parent.list_targets(**kwargs)put_auth_policy#
Creates or updates the auth policy.
Type annotations and code completion for boto3.client("vpc-lattice").put_auth_policy method.
 boto3 documentation
# put_auth_policy method definition
def put_auth_policy(
    self,
    *,
    resourceIdentifier: str,
    policy: str,
) -> PutAuthPolicyResponseTypeDef:  # (1)
    ...# put_auth_policy method usage example with argument unpacking
kwargs: PutAuthPolicyRequestTypeDef = {  # (1)
    "resourceIdentifier": ...,
    "policy": ...,
}
parent.put_auth_policy(**kwargs)put_resource_policy#
Attaches a resource-based permission policy to a service or service network.
Type annotations and code completion for boto3.client("vpc-lattice").put_resource_policy method.
 boto3 documentation
# put_resource_policy method definition
def put_resource_policy(
    self,
    *,
    resourceArn: str,
    policy: str,
) -> Dict[str, Any]:
    ...# put_resource_policy method usage example with argument unpacking
kwargs: PutResourcePolicyRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "policy": ...,
}
parent.put_resource_policy(**kwargs)register_targets#
Registers the targets with the target group.
Type annotations and code completion for boto3.client("vpc-lattice").register_targets method.
 boto3 documentation
# register_targets method definition
def register_targets(
    self,
    *,
    targetGroupIdentifier: str,
    targets: Sequence[TargetTypeDef],  # (1)
) -> RegisterTargetsResponseTypeDef:  # (2)
    ...- See Sequence[TargetTypeDef]
- See RegisterTargetsResponseTypeDef
# register_targets method usage example with argument unpacking
kwargs: RegisterTargetsRequestTypeDef = {  # (1)
    "targetGroupIdentifier": ...,
    "targets": ...,
}
parent.register_targets(**kwargs)tag_resource#
Adds the specified tags to the specified resource.
Type annotations and code completion for boto3.client("vpc-lattice").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)untag_resource#
Removes the specified tags from the specified resource.
Type annotations and code completion for boto3.client("vpc-lattice").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)update_access_log_subscription#
Updates the specified access log subscription.
Type annotations and code completion for boto3.client("vpc-lattice").update_access_log_subscription method.
 boto3 documentation
# update_access_log_subscription method definition
def update_access_log_subscription(
    self,
    *,
    accessLogSubscriptionIdentifier: str,
    destinationArn: str,
) -> UpdateAccessLogSubscriptionResponseTypeDef:  # (1)
    ...# update_access_log_subscription method usage example with argument unpacking
kwargs: UpdateAccessLogSubscriptionRequestTypeDef = {  # (1)
    "accessLogSubscriptionIdentifier": ...,
    "destinationArn": ...,
}
parent.update_access_log_subscription(**kwargs)update_listener#
Updates the specified listener for the specified service.
Type annotations and code completion for boto3.client("vpc-lattice").update_listener method.
 boto3 documentation
# update_listener method definition
def update_listener(
    self,
    *,
    serviceIdentifier: str,
    listenerIdentifier: str,
    defaultAction: RuleActionUnionTypeDef,  # (1)
) -> UpdateListenerResponseTypeDef:  # (2)
    ...# update_listener method usage example with argument unpacking
kwargs: UpdateListenerRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
    "listenerIdentifier": ...,
    "defaultAction": ...,
}
parent.update_listener(**kwargs)update_resource_configuration#
Updates the specified resource configuration.
Type annotations and code completion for boto3.client("vpc-lattice").update_resource_configuration method.
 boto3 documentation
# update_resource_configuration method definition
def update_resource_configuration(
    self,
    *,
    resourceConfigurationIdentifier: str,
    resourceConfigurationDefinition: ResourceConfigurationDefinitionTypeDef = ...,  # (1)
    allowAssociationToShareableServiceNetwork: bool = ...,
    portRanges: Sequence[str] = ...,
) -> UpdateResourceConfigurationResponseTypeDef:  # (2)
    ...# update_resource_configuration method usage example with argument unpacking
kwargs: UpdateResourceConfigurationRequestTypeDef = {  # (1)
    "resourceConfigurationIdentifier": ...,
}
parent.update_resource_configuration(**kwargs)update_resource_gateway#
Updates the specified resource gateway.
Type annotations and code completion for boto3.client("vpc-lattice").update_resource_gateway method.
 boto3 documentation
# update_resource_gateway method definition
def update_resource_gateway(
    self,
    *,
    resourceGatewayIdentifier: str,
    securityGroupIds: Sequence[str] = ...,
) -> UpdateResourceGatewayResponseTypeDef:  # (1)
    ...# update_resource_gateway method usage example with argument unpacking
kwargs: UpdateResourceGatewayRequestTypeDef = {  # (1)
    "resourceGatewayIdentifier": ...,
}
parent.update_resource_gateway(**kwargs)update_rule#
Updates a specified rule for the listener.
Type annotations and code completion for boto3.client("vpc-lattice").update_rule method.
 boto3 documentation
# update_rule method definition
def update_rule(
    self,
    *,
    serviceIdentifier: str,
    listenerIdentifier: str,
    ruleIdentifier: str,
    match: RuleMatchUnionTypeDef = ...,  # (1)
    priority: int = ...,
    action: RuleActionUnionTypeDef = ...,  # (2)
) -> UpdateRuleResponseTypeDef:  # (3)
    ...# update_rule method usage example with argument unpacking
kwargs: UpdateRuleRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
    "listenerIdentifier": ...,
    "ruleIdentifier": ...,
}
parent.update_rule(**kwargs)update_service#
Updates the specified service.
Type annotations and code completion for boto3.client("vpc-lattice").update_service method.
 boto3 documentation
# update_service method definition
def update_service(
    self,
    *,
    serviceIdentifier: str,
    certificateArn: str = ...,
    authType: AuthTypeType = ...,  # (1)
) -> UpdateServiceResponseTypeDef:  # (2)
    ...# update_service method usage example with argument unpacking
kwargs: UpdateServiceRequestTypeDef = {  # (1)
    "serviceIdentifier": ...,
}
parent.update_service(**kwargs)update_service_network#
Updates the specified service network.
Type annotations and code completion for boto3.client("vpc-lattice").update_service_network method.
 boto3 documentation
# update_service_network method definition
def update_service_network(
    self,
    *,
    serviceNetworkIdentifier: str,
    authType: AuthTypeType,  # (1)
) -> UpdateServiceNetworkResponseTypeDef:  # (2)
    ...# update_service_network method usage example with argument unpacking
kwargs: UpdateServiceNetworkRequestTypeDef = {  # (1)
    "serviceNetworkIdentifier": ...,
    "authType": ...,
}
parent.update_service_network(**kwargs)update_service_network_vpc_association#
Updates the service network and VPC association.
Type annotations and code completion for boto3.client("vpc-lattice").update_service_network_vpc_association method.
 boto3 documentation
# update_service_network_vpc_association method definition
def update_service_network_vpc_association(
    self,
    *,
    serviceNetworkVpcAssociationIdentifier: str,
    securityGroupIds: Sequence[str],
) -> UpdateServiceNetworkVpcAssociationResponseTypeDef:  # (1)
    ...# update_service_network_vpc_association method usage example with argument unpacking
kwargs: UpdateServiceNetworkVpcAssociationRequestTypeDef = {  # (1)
    "serviceNetworkVpcAssociationIdentifier": ...,
    "securityGroupIds": ...,
}
parent.update_service_network_vpc_association(**kwargs)update_target_group#
Updates the specified target group.
Type annotations and code completion for boto3.client("vpc-lattice").update_target_group method.
 boto3 documentation
# update_target_group method definition
def update_target_group(
    self,
    *,
    targetGroupIdentifier: str,
    healthCheck: HealthCheckConfigTypeDef,  # (1)
) -> UpdateTargetGroupResponseTypeDef:  # (2)
    ...# update_target_group method usage example with argument unpacking
kwargs: UpdateTargetGroupRequestTypeDef = {  # (1)
    "targetGroupIdentifier": ...,
    "healthCheck": ...,
}
parent.update_target_group(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("vpc-lattice").get_paginator method with overloads.
- client.get_paginator("list_access_log_subscriptions")-> ListAccessLogSubscriptionsPaginator
- client.get_paginator("list_listeners")-> ListListenersPaginator
- client.get_paginator("list_resource_configurations")-> ListResourceConfigurationsPaginator
- client.get_paginator("list_resource_endpoint_associations")-> ListResourceEndpointAssociationsPaginator
- client.get_paginator("list_resource_gateways")-> ListResourceGatewaysPaginator
- client.get_paginator("list_rules")-> ListRulesPaginator
- client.get_paginator("list_service_network_resource_associations")-> ListServiceNetworkResourceAssociationsPaginator
- client.get_paginator("list_service_network_service_associations")-> ListServiceNetworkServiceAssociationsPaginator
- client.get_paginator("list_service_network_vpc_associations")-> ListServiceNetworkVpcAssociationsPaginator
- client.get_paginator("list_service_network_vpc_endpoint_associations")-> ListServiceNetworkVpcEndpointAssociationsPaginator
- client.get_paginator("list_service_networks")-> ListServiceNetworksPaginator
- client.get_paginator("list_services")-> ListServicesPaginator
- client.get_paginator("list_target_groups")-> ListTargetGroupsPaginator
- client.get_paginator("list_targets")-> ListTargetsPaginator