aws-sdk
Version:
AWS SDK for JavaScript
665 lines • 114 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class VPCLattice extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: VPCLattice.Types.ClientConfiguration)
config: Config & VPCLattice.Types.ClientConfiguration;
/**
* Updates the listener rules in a batch. You can use this operation to change the priority of listener rules. This can be useful when bulk updating or swapping rule priority. Required permissions: vpc-lattice:UpdateRule For more information, see How Amazon VPC Lattice works with IAM in the Amazon VPC Lattice User Guide.
*/
batchUpdateRule(params: VPCLattice.Types.BatchUpdateRuleRequest, callback?: (err: AWSError, data: VPCLattice.Types.BatchUpdateRuleResponse) => void): Request<VPCLattice.Types.BatchUpdateRuleResponse, AWSError>;
/**
* Updates the listener rules in a batch. You can use this operation to change the priority of listener rules. This can be useful when bulk updating or swapping rule priority. Required permissions: vpc-lattice:UpdateRule For more information, see How Amazon VPC Lattice works with IAM in the Amazon VPC Lattice User Guide.
*/
batchUpdateRule(callback?: (err: AWSError, data: VPCLattice.Types.BatchUpdateRuleResponse) => void): Request<VPCLattice.Types.BatchUpdateRuleResponse, AWSError>;
/**
* Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner can only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network. For more information, see Access logs in the Amazon VPC Lattice User Guide.
*/
createAccessLogSubscription(params: VPCLattice.Types.CreateAccessLogSubscriptionRequest, callback?: (err: AWSError, data: VPCLattice.Types.CreateAccessLogSubscriptionResponse) => void): Request<VPCLattice.Types.CreateAccessLogSubscriptionResponse, AWSError>;
/**
* Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner can only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network. For more information, see Access logs in the Amazon VPC Lattice User Guide.
*/
createAccessLogSubscription(callback?: (err: AWSError, data: VPCLattice.Types.CreateAccessLogSubscriptionResponse) => void): Request<VPCLattice.Types.CreateAccessLogSubscriptionResponse, AWSError>;
/**
* Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide.
*/
createListener(params: VPCLattice.Types.CreateListenerRequest, callback?: (err: AWSError, data: VPCLattice.Types.CreateListenerResponse) => void): Request<VPCLattice.Types.CreateListenerResponse, AWSError>;
/**
* Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide.
*/
createListener(callback?: (err: AWSError, data: VPCLattice.Types.CreateListenerResponse) => void): Request<VPCLattice.Types.CreateListenerResponse, AWSError>;
/**
* Creates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. For more information, see Listener rules in the Amazon VPC Lattice User Guide.
*/
createRule(params: VPCLattice.Types.CreateRuleRequest, callback?: (err: AWSError, data: VPCLattice.Types.CreateRuleResponse) => void): Request<VPCLattice.Types.CreateRuleResponse, AWSError>;
/**
* Creates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. For more information, see Listener rules in the Amazon VPC Lattice User Guide.
*/
createRule(callback?: (err: AWSError, data: VPCLattice.Types.CreateRuleResponse) => void): Request<VPCLattice.Types.CreateRuleResponse, AWSError>;
/**
* Creates a service. A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC). For more information, see Services in the Amazon VPC Lattice User Guide.
*/
createService(params: VPCLattice.Types.CreateServiceRequest, callback?: (err: AWSError, data: VPCLattice.Types.CreateServiceResponse) => void): Request<VPCLattice.Types.CreateServiceResponse, AWSError>;
/**
* Creates a service. A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC). For more information, see Services in the Amazon VPC Lattice User Guide.
*/
createService(callback?: (err: AWSError, data: VPCLattice.Types.CreateServiceResponse) => void): Request<VPCLattice.Types.CreateServiceResponse, AWSError>;
/**
* Creates a service network. A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network. For more information, see Service networks in the Amazon VPC Lattice User Guide.
*/
createServiceNetwork(params: VPCLattice.Types.CreateServiceNetworkRequest, callback?: (err: AWSError, data: VPCLattice.Types.CreateServiceNetworkResponse) => void): Request<VPCLattice.Types.CreateServiceNetworkResponse, AWSError>;
/**
* Creates a service network. A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network. For more information, see Service networks in the Amazon VPC Lattice User Guide.
*/
createServiceNetwork(callback?: (err: AWSError, data: VPCLattice.Types.CreateServiceNetworkResponse) => void): Request<VPCLattice.Types.CreateServiceNetworkResponse, AWSError>;
/**
* Associates a service with a service network. For more information, see Manage service associations in the Amazon VPC Lattice User Guide. You can't use this operation if the service and service network are already associated or if there is a disassociation or deletion in progress. If the association fails, you can retry the operation by deleting the association and recreating it. You cannot associate a service and service network that are shared with a caller. The caller must own either the service or the service network. As a result of this operation, the association is created in the service network account and the association owner account.
*/
createServiceNetworkServiceAssociation(params: VPCLattice.Types.CreateServiceNetworkServiceAssociationRequest, callback?: (err: AWSError, data: VPCLattice.Types.CreateServiceNetworkServiceAssociationResponse) => void): Request<VPCLattice.Types.CreateServiceNetworkServiceAssociationResponse, AWSError>;
/**
* Associates a service with a service network. For more information, see Manage service associations in the Amazon VPC Lattice User Guide. You can't use this operation if the service and service network are already associated or if there is a disassociation or deletion in progress. If the association fails, you can retry the operation by deleting the association and recreating it. You cannot associate a service and service network that are shared with a caller. The caller must own either the service or the service network. As a result of this operation, the association is created in the service network account and the association owner account.
*/
createServiceNetworkServiceAssociation(callback?: (err: AWSError, data: VPCLattice.Types.CreateServiceNetworkServiceAssociationResponse) => void): Request<VPCLattice.Types.CreateServiceNetworkServiceAssociationResponse, AWSError>;
/**
* Associates a VPC with a service network. When you associate a VPC with the service network, it enables all the resources within that VPC to be clients and communicate with other services in the service network. For more information, see Manage VPC associations in the Amazon VPC Lattice User Guide. You can't use this operation if there is a disassociation in progress. If the association fails, retry by deleting the association and recreating it. As a result of this operation, the association gets created in the service network account and the VPC owner account. If you add a security group to the service network and VPC association, the association must continue to always have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and recreate it without security groups.
*/
createServiceNetworkVpcAssociation(params: VPCLattice.Types.CreateServiceNetworkVpcAssociationRequest, callback?: (err: AWSError, data: VPCLattice.Types.CreateServiceNetworkVpcAssociationResponse) => void): Request<VPCLattice.Types.CreateServiceNetworkVpcAssociationResponse, AWSError>;
/**
* Associates a VPC with a service network. When you associate a VPC with the service network, it enables all the resources within that VPC to be clients and communicate with other services in the service network. For more information, see Manage VPC associations in the Amazon VPC Lattice User Guide. You can't use this operation if there is a disassociation in progress. If the association fails, retry by deleting the association and recreating it. As a result of this operation, the association gets created in the service network account and the VPC owner account. If you add a security group to the service network and VPC association, the association must continue to always have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and recreate it without security groups.
*/
createServiceNetworkVpcAssociation(callback?: (err: AWSError, data: VPCLattice.Types.CreateServiceNetworkVpcAssociationResponse) => void): Request<VPCLattice.Types.CreateServiceNetworkVpcAssociationResponse, AWSError>;
/**
* Creates a target group. A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service. For more information, see Target groups in the Amazon VPC Lattice User Guide.
*/
createTargetGroup(params: VPCLattice.Types.CreateTargetGroupRequest, callback?: (err: AWSError, data: VPCLattice.Types.CreateTargetGroupResponse) => void): Request<VPCLattice.Types.CreateTargetGroupResponse, AWSError>;
/**
* Creates a target group. A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service. For more information, see Target groups in the Amazon VPC Lattice User Guide.
*/
createTargetGroup(callback?: (err: AWSError, data: VPCLattice.Types.CreateTargetGroupResponse) => void): Request<VPCLattice.Types.CreateTargetGroupResponse, AWSError>;
/**
* Deletes the specified access log subscription.
*/
deleteAccessLogSubscription(params: VPCLattice.Types.DeleteAccessLogSubscriptionRequest, callback?: (err: AWSError, data: VPCLattice.Types.DeleteAccessLogSubscriptionResponse) => void): Request<VPCLattice.Types.DeleteAccessLogSubscriptionResponse, AWSError>;
/**
* Deletes the specified access log subscription.
*/
deleteAccessLogSubscription(callback?: (err: AWSError, data: VPCLattice.Types.DeleteAccessLogSubscriptionResponse) => void): Request<VPCLattice.Types.DeleteAccessLogSubscriptionResponse, AWSError>;
/**
* Deletes the specified auth policy. If an auth is set to AWS_IAM and the auth policy is deleted, all requests are denied. If you are trying to remove the auth policy completely, you must set the auth type to NONE. If auth is enabled on the resource, but no auth policy is set, all requests are denied.
*/
deleteAuthPolicy(params: VPCLattice.Types.DeleteAuthPolicyRequest, callback?: (err: AWSError, data: VPCLattice.Types.DeleteAuthPolicyResponse) => void): Request<VPCLattice.Types.DeleteAuthPolicyResponse, AWSError>;
/**
* Deletes the specified auth policy. If an auth is set to AWS_IAM and the auth policy is deleted, all requests are denied. If you are trying to remove the auth policy completely, you must set the auth type to NONE. If auth is enabled on the resource, but no auth policy is set, all requests are denied.
*/
deleteAuthPolicy(callback?: (err: AWSError, data: VPCLattice.Types.DeleteAuthPolicyResponse) => void): Request<VPCLattice.Types.DeleteAuthPolicyResponse, AWSError>;
/**
* Deletes the specified listener.
*/
deleteListener(params: VPCLattice.Types.DeleteListenerRequest, callback?: (err: AWSError, data: VPCLattice.Types.DeleteListenerResponse) => void): Request<VPCLattice.Types.DeleteListenerResponse, AWSError>;
/**
* Deletes the specified listener.
*/
deleteListener(callback?: (err: AWSError, data: VPCLattice.Types.DeleteListenerResponse) => void): Request<VPCLattice.Types.DeleteListenerResponse, AWSError>;
/**
* Deletes the specified resource policy.
*/
deleteResourcePolicy(params: VPCLattice.Types.DeleteResourcePolicyRequest, callback?: (err: AWSError, data: VPCLattice.Types.DeleteResourcePolicyResponse) => void): Request<VPCLattice.Types.DeleteResourcePolicyResponse, AWSError>;
/**
* Deletes the specified resource policy.
*/
deleteResourcePolicy(callback?: (err: AWSError, data: VPCLattice.Types.DeleteResourcePolicyResponse) => void): Request<VPCLattice.Types.DeleteResourcePolicyResponse, AWSError>;
/**
* Deletes a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. You can delete additional listener rules, but you cannot delete the default rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.
*/
deleteRule(params: VPCLattice.Types.DeleteRuleRequest, callback?: (err: AWSError, data: VPCLattice.Types.DeleteRuleResponse) => void): Request<VPCLattice.Types.DeleteRuleResponse, AWSError>;
/**
* Deletes a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. You can delete additional listener rules, but you cannot delete the default rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.
*/
deleteRule(callback?: (err: AWSError, data: VPCLattice.Types.DeleteRuleResponse) => void): Request<VPCLattice.Types.DeleteRuleResponse, AWSError>;
/**
* Deletes a service. A service can't be deleted if it's associated with a service network. If you delete a service, all resources related to the service, such as the resource policy, auth policy, listeners, listener rules, and access log subscriptions, are also deleted. For more information, see Delete a service in the Amazon VPC Lattice User Guide.
*/
deleteService(params: VPCLattice.Types.DeleteServiceRequest, callback?: (err: AWSError, data: VPCLattice.Types.DeleteServiceResponse) => void): Request<VPCLattice.Types.DeleteServiceResponse, AWSError>;
/**
* Deletes a service. A service can't be deleted if it's associated with a service network. If you delete a service, all resources related to the service, such as the resource policy, auth policy, listeners, listener rules, and access log subscriptions, are also deleted. For more information, see Delete a service in the Amazon VPC Lattice User Guide.
*/
deleteService(callback?: (err: AWSError, data: VPCLattice.Types.DeleteServiceResponse) => void): Request<VPCLattice.Types.DeleteServiceResponse, AWSError>;
/**
* Deletes a service network. You can only delete the service network if there is no service or VPC associated with it. If you delete a service network, all resources related to the service network, such as the resource policy, auth policy, and access log subscriptions, are also deleted. For more information, see Delete a service network in the Amazon VPC Lattice User Guide.
*/
deleteServiceNetwork(params: VPCLattice.Types.DeleteServiceNetworkRequest, callback?: (err: AWSError, data: VPCLattice.Types.DeleteServiceNetworkResponse) => void): Request<VPCLattice.Types.DeleteServiceNetworkResponse, AWSError>;
/**
* Deletes a service network. You can only delete the service network if there is no service or VPC associated with it. If you delete a service network, all resources related to the service network, such as the resource policy, auth policy, and access log subscriptions, are also deleted. For more information, see Delete a service network in the Amazon VPC Lattice User Guide.
*/
deleteServiceNetwork(callback?: (err: AWSError, data: VPCLattice.Types.DeleteServiceNetworkResponse) => void): Request<VPCLattice.Types.DeleteServiceNetworkResponse, AWSError>;
/**
* Deletes the association between a specified service and the specific service network. This operation fails if an association is still in progress.
*/
deleteServiceNetworkServiceAssociation(params: VPCLattice.Types.DeleteServiceNetworkServiceAssociationRequest, callback?: (err: AWSError, data: VPCLattice.Types.DeleteServiceNetworkServiceAssociationResponse) => void): Request<VPCLattice.Types.DeleteServiceNetworkServiceAssociationResponse, AWSError>;
/**
* Deletes the association between a specified service and the specific service network. This operation fails if an association is still in progress.
*/
deleteServiceNetworkServiceAssociation(callback?: (err: AWSError, data: VPCLattice.Types.DeleteServiceNetworkServiceAssociationResponse) => void): Request<VPCLattice.Types.DeleteServiceNetworkServiceAssociationResponse, AWSError>;
/**
* Disassociates the VPC from the service network. You can't disassociate the VPC if there is a create or update association in progress.
*/
deleteServiceNetworkVpcAssociation(params: VPCLattice.Types.DeleteServiceNetworkVpcAssociationRequest, callback?: (err: AWSError, data: VPCLattice.Types.DeleteServiceNetworkVpcAssociationResponse) => void): Request<VPCLattice.Types.DeleteServiceNetworkVpcAssociationResponse, AWSError>;
/**
* Disassociates the VPC from the service network. You can't disassociate the VPC if there is a create or update association in progress.
*/
deleteServiceNetworkVpcAssociation(callback?: (err: AWSError, data: VPCLattice.Types.DeleteServiceNetworkVpcAssociationResponse) => void): Request<VPCLattice.Types.DeleteServiceNetworkVpcAssociationResponse, AWSError>;
/**
* Deletes a target group. You can't delete a target group if it is used in a listener rule or if the target group creation is in progress.
*/
deleteTargetGroup(params: VPCLattice.Types.DeleteTargetGroupRequest, callback?: (err: AWSError, data: VPCLattice.Types.DeleteTargetGroupResponse) => void): Request<VPCLattice.Types.DeleteTargetGroupResponse, AWSError>;
/**
* Deletes a target group. You can't delete a target group if it is used in a listener rule or if the target group creation is in progress.
*/
deleteTargetGroup(callback?: (err: AWSError, data: VPCLattice.Types.DeleteTargetGroupResponse) => void): Request<VPCLattice.Types.DeleteTargetGroupResponse, AWSError>;
/**
* Deregisters the specified targets from the specified target group.
*/
deregisterTargets(params: VPCLattice.Types.DeregisterTargetsRequest, callback?: (err: AWSError, data: VPCLattice.Types.DeregisterTargetsResponse) => void): Request<VPCLattice.Types.DeregisterTargetsResponse, AWSError>;
/**
* Deregisters the specified targets from the specified target group.
*/
deregisterTargets(callback?: (err: AWSError, data: VPCLattice.Types.DeregisterTargetsResponse) => void): Request<VPCLattice.Types.DeregisterTargetsResponse, AWSError>;
/**
* Retrieves information about the specified access log subscription.
*/
getAccessLogSubscription(params: VPCLattice.Types.GetAccessLogSubscriptionRequest, callback?: (err: AWSError, data: VPCLattice.Types.GetAccessLogSubscriptionResponse) => void): Request<VPCLattice.Types.GetAccessLogSubscriptionResponse, AWSError>;
/**
* Retrieves information about the specified access log subscription.
*/
getAccessLogSubscription(callback?: (err: AWSError, data: VPCLattice.Types.GetAccessLogSubscriptionResponse) => void): Request<VPCLattice.Types.GetAccessLogSubscriptionResponse, AWSError>;
/**
* Retrieves information about the auth policy for the specified service or service network.
*/
getAuthPolicy(params: VPCLattice.Types.GetAuthPolicyRequest, callback?: (err: AWSError, data: VPCLattice.Types.GetAuthPolicyResponse) => void): Request<VPCLattice.Types.GetAuthPolicyResponse, AWSError>;
/**
* Retrieves information about the auth policy for the specified service or service network.
*/
getAuthPolicy(callback?: (err: AWSError, data: VPCLattice.Types.GetAuthPolicyResponse) => void): Request<VPCLattice.Types.GetAuthPolicyResponse, AWSError>;
/**
* Retrieves information about the specified listener for the specified service.
*/
getListener(params: VPCLattice.Types.GetListenerRequest, callback?: (err: AWSError, data: VPCLattice.Types.GetListenerResponse) => void): Request<VPCLattice.Types.GetListenerResponse, AWSError>;
/**
* Retrieves information about the specified listener for the specified service.
*/
getListener(callback?: (err: AWSError, data: VPCLattice.Types.GetListenerResponse) => void): Request<VPCLattice.Types.GetListenerResponse, AWSError>;
/**
* Retrieves information about the resource policy. The resource policy is an IAM policy created on behalf of the resource owner when they share a resource.
*/
getResourcePolicy(params: VPCLattice.Types.GetResourcePolicyRequest, callback?: (err: AWSError, data: VPCLattice.Types.GetResourcePolicyResponse) => void): Request<VPCLattice.Types.GetResourcePolicyResponse, AWSError>;
/**
* Retrieves information about the resource policy. The resource policy is an IAM policy created on behalf of the resource owner when they share a resource.
*/
getResourcePolicy(callback?: (err: AWSError, data: VPCLattice.Types.GetResourcePolicyResponse) => void): Request<VPCLattice.Types.GetResourcePolicyResponse, AWSError>;
/**
* Retrieves information about listener rules. You can also retrieve information about the default listener rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.
*/
getRule(params: VPCLattice.Types.GetRuleRequest, callback?: (err: AWSError, data: VPCLattice.Types.GetRuleResponse) => void): Request<VPCLattice.Types.GetRuleResponse, AWSError>;
/**
* Retrieves information about listener rules. You can also retrieve information about the default listener rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.
*/
getRule(callback?: (err: AWSError, data: VPCLattice.Types.GetRuleResponse) => void): Request<VPCLattice.Types.GetRuleResponse, AWSError>;
/**
* Retrieves information about the specified service.
*/
getService(params: VPCLattice.Types.GetServiceRequest, callback?: (err: AWSError, data: VPCLattice.Types.GetServiceResponse) => void): Request<VPCLattice.Types.GetServiceResponse, AWSError>;
/**
* Retrieves information about the specified service.
*/
getService(callback?: (err: AWSError, data: VPCLattice.Types.GetServiceResponse) => void): Request<VPCLattice.Types.GetServiceResponse, AWSError>;
/**
* Retrieves information about the specified service network.
*/
getServiceNetwork(params: VPCLattice.Types.GetServiceNetworkRequest, callback?: (err: AWSError, data: VPCLattice.Types.GetServiceNetworkResponse) => void): Request<VPCLattice.Types.GetServiceNetworkResponse, AWSError>;
/**
* Retrieves information about the specified service network.
*/
getServiceNetwork(callback?: (err: AWSError, data: VPCLattice.Types.GetServiceNetworkResponse) => void): Request<VPCLattice.Types.GetServiceNetworkResponse, AWSError>;
/**
* Retrieves information about the specified association between a service network and a service.
*/
getServiceNetworkServiceAssociation(params: VPCLattice.Types.GetServiceNetworkServiceAssociationRequest, callback?: (err: AWSError, data: VPCLattice.Types.GetServiceNetworkServiceAssociationResponse) => void): Request<VPCLattice.Types.GetServiceNetworkServiceAssociationResponse, AWSError>;
/**
* Retrieves information about the specified association between a service network and a service.
*/
getServiceNetworkServiceAssociation(callback?: (err: AWSError, data: VPCLattice.Types.GetServiceNetworkServiceAssociationResponse) => void): Request<VPCLattice.Types.GetServiceNetworkServiceAssociationResponse, AWSError>;
/**
* Retrieves information about the association between a service network and a VPC.
*/
getServiceNetworkVpcAssociation(params: VPCLattice.Types.GetServiceNetworkVpcAssociationRequest, callback?: (err: AWSError, data: VPCLattice.Types.GetServiceNetworkVpcAssociationResponse) => void): Request<VPCLattice.Types.GetServiceNetworkVpcAssociationResponse, AWSError>;
/**
* Retrieves information about the association between a service network and a VPC.
*/
getServiceNetworkVpcAssociation(callback?: (err: AWSError, data: VPCLattice.Types.GetServiceNetworkVpcAssociationResponse) => void): Request<VPCLattice.Types.GetServiceNetworkVpcAssociationResponse, AWSError>;
/**
* Retrieves information about the specified target group.
*/
getTargetGroup(params: VPCLattice.Types.GetTargetGroupRequest, callback?: (err: AWSError, data: VPCLattice.Types.GetTargetGroupResponse) => void): Request<VPCLattice.Types.GetTargetGroupResponse, AWSError>;
/**
* Retrieves information about the specified target group.
*/
getTargetGroup(callback?: (err: AWSError, data: VPCLattice.Types.GetTargetGroupResponse) => void): Request<VPCLattice.Types.GetTargetGroupResponse, AWSError>;
/**
* Lists all access log subscriptions for the specified service network or service.
*/
listAccessLogSubscriptions(params: VPCLattice.Types.ListAccessLogSubscriptionsRequest, callback?: (err: AWSError, data: VPCLattice.Types.ListAccessLogSubscriptionsResponse) => void): Request<VPCLattice.Types.ListAccessLogSubscriptionsResponse, AWSError>;
/**
* Lists all access log subscriptions for the specified service network or service.
*/
listAccessLogSubscriptions(callback?: (err: AWSError, data: VPCLattice.Types.ListAccessLogSubscriptionsResponse) => void): Request<VPCLattice.Types.ListAccessLogSubscriptionsResponse, AWSError>;
/**
* Lists the listeners for the specified service.
*/
listListeners(params: VPCLattice.Types.ListListenersRequest, callback?: (err: AWSError, data: VPCLattice.Types.ListListenersResponse) => void): Request<VPCLattice.Types.ListListenersResponse, AWSError>;
/**
* Lists the listeners for the specified service.
*/
listListeners(callback?: (err: AWSError, data: VPCLattice.Types.ListListenersResponse) => void): Request<VPCLattice.Types.ListListenersResponse, AWSError>;
/**
* Lists the rules for the listener.
*/
listRules(params: VPCLattice.Types.ListRulesRequest, callback?: (err: AWSError, data: VPCLattice.Types.ListRulesResponse) => void): Request<VPCLattice.Types.ListRulesResponse, AWSError>;
/**
* Lists the rules for the listener.
*/
listRules(callback?: (err: AWSError, data: VPCLattice.Types.ListRulesResponse) => void): Request<VPCLattice.Types.ListRulesResponse, AWSError>;
/**
* Lists the associations between the service network and the service. You can filter the list either by service or service network. You must provide either the service network identifier or the service identifier. Every association in Amazon VPC Lattice is given a unique Amazon Resource Name (ARN), such as when a service network is associated with a VPC or when a service is associated with a service network. If the association is for a resource that is shared with another account, the association includes the local account ID as the prefix in the ARN for each account the resource is shared with.
*/
listServiceNetworkServiceAssociations(params: VPCLattice.Types.ListServiceNetworkServiceAssociationsRequest, callback?: (err: AWSError, data: VPCLattice.Types.ListServiceNetworkServiceAssociationsResponse) => void): Request<VPCLattice.Types.ListServiceNetworkServiceAssociationsResponse, AWSError>;
/**
* Lists the associations between the service network and the service. You can filter the list either by service or service network. You must provide either the service network identifier or the service identifier. Every association in Amazon VPC Lattice is given a unique Amazon Resource Name (ARN), such as when a service network is associated with a VPC or when a service is associated with a service network. If the association is for a resource that is shared with another account, the association includes the local account ID as the prefix in the ARN for each account the resource is shared with.
*/
listServiceNetworkServiceAssociations(callback?: (err: AWSError, data: VPCLattice.Types.ListServiceNetworkServiceAssociationsResponse) => void): Request<VPCLattice.Types.ListServiceNetworkServiceAssociationsResponse, AWSError>;
/**
* Lists the service network and VPC associations. You can filter the list either by VPC or service network. You must provide either the service network identifier or the VPC identifier.
*/
listServiceNetworkVpcAssociations(params: VPCLattice.Types.ListServiceNetworkVpcAssociationsRequest, callback?: (err: AWSError, data: VPCLattice.Types.ListServiceNetworkVpcAssociationsResponse) => void): Request<VPCLattice.Types.ListServiceNetworkVpcAssociationsResponse, AWSError>;
/**
* Lists the service network and VPC associations. You can filter the list either by VPC or service network. You must provide either the service network identifier or the VPC identifier.
*/
listServiceNetworkVpcAssociations(callback?: (err: AWSError, data: VPCLattice.Types.ListServiceNetworkVpcAssociationsResponse) => void): Request<VPCLattice.Types.ListServiceNetworkVpcAssociationsResponse, AWSError>;
/**
* Lists the service networks owned by the caller account or shared with the caller account. Also includes the account ID in the ARN to show which account owns the service network.
*/
listServiceNetworks(params: VPCLattice.Types.ListServiceNetworksRequest, callback?: (err: AWSError, data: VPCLattice.Types.ListServiceNetworksResponse) => void): Request<VPCLattice.Types.ListServiceNetworksResponse, AWSError>;
/**
* Lists the service networks owned by the caller account or shared with the caller account. Also includes the account ID in the ARN to show which account owns the service network.
*/
listServiceNetworks(callback?: (err: AWSError, data: VPCLattice.Types.ListServiceNetworksResponse) => void): Request<VPCLattice.Types.ListServiceNetworksResponse, AWSError>;
/**
* Lists the services owned by the caller account or shared with the caller account.
*/
listServices(params: VPCLattice.Types.ListServicesRequest, callback?: (err: AWSError, data: VPCLattice.Types.ListServicesResponse) => void): Request<VPCLattice.Types.ListServicesResponse, AWSError>;
/**
* Lists the services owned by the caller account or shared with the caller account.
*/
listServices(callback?: (err: AWSError, data: VPCLattice.Types.ListServicesResponse) => void): Request<VPCLattice.Types.ListServicesResponse, AWSError>;
/**
* Lists the tags for the specified resource.
*/
listTagsForResource(params: VPCLattice.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: VPCLattice.Types.ListTagsForResourceResponse) => void): Request<VPCLattice.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags for the specified resource.
*/
listTagsForResource(callback?: (err: AWSError, data: VPCLattice.Types.ListTagsForResourceResponse) => void): Request<VPCLattice.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists your target groups. You can narrow your search by using the filters below in your request.
*/
listTargetGroups(params: VPCLattice.Types.ListTargetGroupsRequest, callback?: (err: AWSError, data: VPCLattice.Types.ListTargetGroupsResponse) => void): Request<VPCLattice.Types.ListTargetGroupsResponse, AWSError>;
/**
* Lists your target groups. You can narrow your search by using the filters below in your request.
*/
listTargetGroups(callback?: (err: AWSError, data: VPCLattice.Types.ListTargetGroupsResponse) => void): Request<VPCLattice.Types.ListTargetGroupsResponse, AWSError>;
/**
* Lists the targets for the target group. By default, all targets are included. You can use this API to check the health status of targets. You can also filter the results by target.
*/
listTargets(params: VPCLattice.Types.ListTargetsRequest, callback?: (err: AWSError, data: VPCLattice.Types.ListTargetsResponse) => void): Request<VPCLattice.Types.ListTargetsResponse, AWSError>;
/**
* Lists the targets for the target group. By default, all targets are included. You can use this API to check the health status of targets. You can also filter the results by target.
*/
listTargets(callback?: (err: AWSError, data: VPCLattice.Types.ListTargetsResponse) => void): Request<VPCLattice.Types.ListTargetsResponse, AWSError>;
/**
* Creates or updates the auth policy. The policy string in JSON must not contain newlines or blank lines. For more information, see Auth policies in the Amazon VPC Lattice User Guide.
*/
putAuthPolicy(params: VPCLattice.Types.PutAuthPolicyRequest, callback?: (err: AWSError, data: VPCLattice.Types.PutAuthPolicyResponse) => void): Request<VPCLattice.Types.PutAuthPolicyResponse, AWSError>;
/**
* Creates or updates the auth policy. The policy string in JSON must not contain newlines or blank lines. For more information, see Auth policies in the Amazon VPC Lattice User Guide.
*/
putAuthPolicy(callback?: (err: AWSError, data: VPCLattice.Types.PutAuthPolicyResponse) => void): Request<VPCLattice.Types.PutAuthPolicyResponse, AWSError>;
/**
* Attaches a resource-based permission policy to a service or service network. The policy must contain the same actions and condition statements as the Amazon Web Services Resource Access Manager permission for sharing services and service networks.
*/
putResourcePolicy(params: VPCLattice.Types.PutResourcePolicyRequest, callback?: (err: AWSError, data: VPCLattice.Types.PutResourcePolicyResponse) => void): Request<VPCLattice.Types.PutResourcePolicyResponse, AWSError>;
/**
* Attaches a resource-based permission policy to a service or service network. The policy must contain the same actions and condition statements as the Amazon Web Services Resource Access Manager permission for sharing services and service networks.
*/
putResourcePolicy(callback?: (err: AWSError, data: VPCLattice.Types.PutResourcePolicyResponse) => void): Request<VPCLattice.Types.PutResourcePolicyResponse, AWSError>;
/**
* Registers the targets with the target group. If it's a Lambda target, you can only have one target in a target group.
*/
registerTargets(params: VPCLattice.Types.RegisterTargetsRequest, callback?: (err: AWSError, data: VPCLattice.Types.RegisterTargetsResponse) => void): Request<VPCLattice.Types.RegisterTargetsResponse, AWSError>;
/**
* Registers the targets with the target group. If it's a Lambda target, you can only have one target in a target group.
*/
registerTargets(callback?: (err: AWSError, data: VPCLattice.Types.RegisterTargetsResponse) => void): Request<VPCLattice.Types.RegisterTargetsResponse, AWSError>;
/**
* Adds the specified tags to the specified resource.
*/
tagResource(params: VPCLattice.Types.TagResourceRequest, callback?: (err: AWSError, data: VPCLattice.Types.TagResourceResponse) => void): Request<VPCLattice.Types.TagResourceResponse, AWSError>;
/**
* Adds the specified tags to the specified resource.
*/
tagResource(callback?: (err: AWSError, data: VPCLattice.Types.TagResourceResponse) => void): Request<VPCLattice.Types.TagResourceResponse, AWSError>;
/**
* Removes the specified tags from the specified resource.
*/
untagResource(params: VPCLattice.Types.UntagResourceRequest, callback?: (err: AWSError, data: VPCLattice.Types.UntagResourceResponse) => void): Request<VPCLattice.Types.UntagResourceResponse, AWSError>;
/**
* Removes the specified tags from the specified resource.
*/
untagResource(callback?: (err: AWSError, data: VPCLattice.Types.UntagResourceResponse) => void): Request<VPCLattice.Types.UntagResourceResponse, AWSError>;
/**
* Updates the specified access log subscription.
*/
updateAccessLogSubscription(params: VPCLattice.Types.UpdateAccessLogSubscriptionRequest, callback?: (err: AWSError, data: VPCLattice.Types.UpdateAccessLogSubscriptionResponse) => void): Request<VPCLattice.Types.UpdateAccessLogSubscriptionResponse, AWSError>;
/**
* Updates the specified access log subscription.
*/
updateAccessLogSubscription(callback?: (err: AWSError, data: VPCLattice.Types.UpdateAccessLogSubscriptionResponse) => void): Request<VPCLattice.Types.UpdateAccessLogSubscriptionResponse, AWSError>;
/**
* Updates the specified listener for the specified service.
*/
updateListener(params: VPCLattice.Types.UpdateListenerRequest, callback?: (err: AWSError, data: VPCLattice.Types.UpdateListenerResponse) => void): Request<VPCLattice.Types.UpdateListenerResponse, AWSError>;
/**
* Updates the specified listener for the specified service.
*/
updateListener(callback?: (err: AWSError, data: VPCLattice.Types.UpdateListenerResponse) => void): Request<VPCLattice.Types.UpdateListenerResponse, AWSError>;
/**
* Updates a rule for the listener. You can't modify a default listener rule. To modify a default listener rule, use UpdateListener.
*/
updateRule(params: VPCLattice.Types.UpdateRuleRequest, callback?: (err: AWSError, data: VPCLattice.Types.UpdateRuleResponse) => void): Request<VPCLattice.Types.UpdateRuleResponse, AWSError>;
/**
* Updates a rule for the listener. You can't modify a default listener rule. To modify a default listener rule, use UpdateListener.
*/
updateRule(callback?: (err: AWSError, data: VPCLattice.Types.UpdateRuleResponse) => void): Request<VPCLattice.Types.UpdateRuleResponse, AWSError>;
/**
* Updates the specified service.
*/
updateService(params: VPCLattice.Types.UpdateServiceRequest, callback?: (err: AWSError, data: VPCLattice.Types.UpdateServiceResponse) => void): Request<VPCLattice.Types.UpdateServiceResponse, AWSError>;
/**
* Updates the specified service.
*/
updateService(callback?: (err: AWSError, data: VPCLattice.Types.UpdateServiceResponse) => void): Request<VPCLattice.Types.UpdateServiceResponse, AWSError>;
/**
* Updates the specified service network.
*/
updateServiceNetwork(params: VPCLattice.Types.UpdateServiceNetworkRequest, callback?: (err: AWSError, data: VPCLattice.Types.UpdateServiceNetworkResponse) => void): Request<VPCLattice.Types.UpdateServiceNetworkResponse, AWSError>;
/**
* Updates the specified service network.
*/
updateServiceNetwork(callback?: (err: AWSError, data: VPCLattice.Types.UpdateServiceNetworkResponse) => void): Request<VPCLattice.Types.UpdateServiceNetworkResponse, AWSError>;
/**
* Updates the service network and VPC association. If you add a security group to the service network and VPC association, the association must continue to always have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and recreate it without security groups.
*/
updateServiceNetworkVpcAssociation(params: VPCLattice.Types.UpdateServiceNetworkVpcAssociationRequest, callback?: (err: AWSError, data: VPCLattice.Types.UpdateServiceNetworkVpcAssociationResponse) => void): Request<VPCLattice.Types.UpdateServiceNetworkVpcAssociationResponse, AWSError>;
/**
* Updates the service network and VPC association. If you add a security group to the service network and VPC association, the association must continue to always have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and recreate it without security groups.
*/
updateServiceNetworkVpcAssociation(callback?: (err: AWSError, data: VPCLattice.Types.UpdateServiceNetworkVpcAssociationResponse) => void): Request<VPCLattice.Types.UpdateServiceNetworkVpcAssociationResponse, AWSError>;
/**
* Updates the specified target group.
*/
updateTargetGroup(params: VPCLattice.Types.UpdateTargetGroupRequest, callback?: (err: AWSError, data: VPCLattice.Types.UpdateTargetGroupResponse) => void): Request<VPCLattice.Types.UpdateTargetGroupResponse, AWSError>;
/**
* Updates the specified target group.
*/
updateTargetGroup(callback?: (err: AWSError, data: VPCLattice.Types.UpdateTargetGroupResponse) => void): Request<VPCLattice.Types.UpdateTargetGroupResponse, AWSError>;
}
declare namespace VPCLattice {
export type AccessLogDestinationArn = string;
export type AccessLogSubscriptionArn = string;
export type AccessLogSubscriptionId = string;
export type AccessLogSubscriptionIdentifier = string;
export type AccessLogSubscriptionList = AccessLogSubscriptionSummary[];
export interface AccessLogSubscriptionSummary {
/**
* The Amazon Resource Name (ARN) of the access log subscription
*/
arn: AccessLogSubscriptionArn;
/**
* The date and time that the access log subscription was created, specified in ISO-8601 format.
*/
createdAt: Timestamp;
/**
* The Amazon Resource Name (ARN) of the destination.
*/
destinationArn: AccessLogDestinationArn;
/**
* The ID of the access log subscription.
*/
id: AccessLogSubscriptionId;
/**
* The date and time that the access log subscription was last updated, specified in ISO-8601 format.
*/
lastUpdatedAt: Timestamp;
/**
* The Amazon Resource Name (ARN) of the service or service network.
*/
resourceArn: ResourceArn;
/**
* The ID of the service or service network.
*/
resourceId: ResourceId;
}
export type AccountId = string;
export type Arn = string;
export type AuthPolicyState = "Active"|"Inactive"|string;
export type AuthPolicyString = string;
export type AuthType = "NONE"|"AWS_IAM"|string;
export interface BatchUpdateRuleRequest {
/**
* The ID or Amazon Resource Name (ARN) of the listener.
*/
listenerIdentifier: ListenerIdentifier;
/**
* The rules for the specified listener.
*/
rules: RuleUpdateList;
/**
* The ID or Amazon Resource Name (ARN) of the service.
*/
serviceIdentifier: ServiceIdentifier;
}
export interface BatchUpdateRuleResponse {
/**
* The rules that were successfully updated.
*/
successful?: RuleUpdateSuccessList;
/**
* The rules that the operation couldn't update.
*/
unsuccessful?: RuleUpdateFailureList;
}
export type Boolean = boolean;
export type CertificateArn = string;
export type ClientToken = string;
export interface CreateAccessLogSubscriptionRequest {
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the destination. The supported destination types are CloudWatch Log groups, Kinesis Data Firehose delivery streams, and Amazon S3 buckets.
*/
destinationArn: AccessLogDestinationArn;
/**
* The ID or Amazon Resource Name (ARN) of the service network or service.
*/
resourceIdentifier: ResourceIdentifier;
/**
* The tags for the access log subscription.
*/
tags?: TagMap;
}
export interface CreateAccessLogSubscriptionResponse {
/**
* The Amazon Resource Name (ARN) of the access log subscription.
*/
arn: AccessLogSubscriptionArn;
/**
* The Amazon Resource Name (ARN) of the log destination.
*/
destinationArn: AccessLogDestinationArn;
/**
* The ID of the access log subscription.
*/
id: AccessLogSubscriptionId;
/**
* The Amazon Resource Name (ARN) of the service network or service.
*/
resourceArn: ResourceArn;
/**
* The ID of the service network or service.
*/
resourceId: ResourceId;
}
export interface CreateListenerRequest {
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
*/
clientToken?: ClientToken;
/**
* The action for the default rule. Each listener has a default rule. The default rule is used if no other rules match.
*/
defaultAction: RuleAction;
/**
* The name of the listener. A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
*/
name: ListenerName;
/**
* The listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443.
*/
port?: Port;
/**
* The listener protocol.
*/
protocol: ListenerProtocol;
/**
* The ID or Amazon Resource Name (ARN) of the service.
*/
serviceIdentifier: ServiceIdentifier;
/**
* The tags for the listener.
*/
tags?: TagMap;
}
export interface CreateListenerResponse {
/**
* The Amazon Resource Name (ARN) of the listener.
*/
arn?: ListenerArn;
/**
* The action for the default rule.
*/
defaultAction?: RuleAction;
/**
* The ID of the listener.
*/
id?: ListenerId;
/**
* The name of the listener.
*/
name?: ListenerName;
/**
* The port number of the listener.
*/
port?: Port;
/**
* The protocol of the listener.
*/
protocol?: ListenerProtocol;
/**
* The Amazon Resource Name (ARN) of the service.
*/
serviceArn?: ServiceArn;
/**
* The ID of the service.
*/
serviceId?: ServiceId;
}
export interface CreateRuleRequest {
/**
* The action for the default rule.
*/
action: RuleAction;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
*/
clientToken?: ClientToken;
/**
* The ID or Amazon Resource Name (ARN) of the listener.
*/
listenerIdentifier: ListenerIdentifier;
/**
* The rule match.
*/
match: RuleMatch;
/**
* The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
*/
name: RuleName;
/**
* The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.
*/
priority: RulePriority;
/**
* The ID or Amazon Resource Name (ARN) of the service.
*/
serviceIdentifier: ServiceIdentifier;
/**
* The tags for the rule.
*/
tags?: TagMap;
}
export interface CreateRuleResponse {
/**
* The rule action.
*/
action?: RuleAction;
/**
* The Amazon Resource Name (ARN) of the rule.
*/
arn?: RuleArn;
/**
* The ID of the rule.
*/
id?: RuleId;
/**
* The rule match. The RuleMatch must be an HttpMatch. This means that the rule should be an exact match on HTTP constraints which are made up of the HTTP method, path, and header.
*/
match?: RuleMatch;
/**
* The name of the rule.
*/
name?: RuleName;
/**
* The priority assigned to the rule. The lower the priority number the higher the priority.
*/
priority?: RulePriority;
}
export interface CreateServiceNetworkRequest {
/**
* The type of IAM policy. NONE: The resourc