VPCLattice ********** Client ====== class VPCLattice.Client A low-level client representing Amazon VPC Lattice Amazon VPC Lattice is a fully managed application networking service that you use to connect, secure, and monitor all of your services across multiple accounts and virtual private clouds (VPCs). Amazon VPC Lattice interconnects your microservices and legacy services within a logical boundary, so that you can discover and manage them more efficiently. For more information, see the Amazon VPC Lattice User Guide import boto3 client = boto3.client('vpc-lattice') These are the available methods: * batch_update_rule * can_paginate * close * create_access_log_subscription * create_listener * create_resource_configuration * create_resource_gateway * create_rule * create_service * create_service_network * create_service_network_resource_association * create_service_network_service_association * create_service_network_vpc_association * create_target_group * delete_access_log_subscription * delete_auth_policy * delete_listener * delete_resource_configuration * delete_resource_endpoint_association * delete_resource_gateway * delete_resource_policy * delete_rule * delete_service * delete_service_network * delete_service_network_resource_association * delete_service_network_service_association * delete_service_network_vpc_association * delete_target_group * deregister_targets * get_access_log_subscription * get_auth_policy * get_listener * get_paginator * get_resource_configuration * get_resource_gateway * get_resource_policy * get_rule * get_service * get_service_network * get_service_network_resource_association * get_service_network_service_association * get_service_network_vpc_association * get_target_group * get_waiter * list_access_log_subscriptions * list_listeners * list_resource_configurations * list_resource_endpoint_associations * list_resource_gateways * list_rules * list_service_network_resource_associations * list_service_network_service_associations * list_service_network_vpc_associations * list_service_network_vpc_endpoint_associations * list_service_networks * list_services * list_tags_for_resource * list_target_groups * list_targets * put_auth_policy * put_resource_policy * register_targets * tag_resource * untag_resource * update_access_log_subscription * update_listener * update_resource_configuration * update_resource_gateway * update_rule * update_service * update_service_network * update_service_network_vpc_association * update_target_group Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListAccessLogSubscriptions * ListListeners * ListResourceConfigurations * ListResourceEndpointAssociations * ListResourceGateways * ListRules * ListServiceNetworkResourceAssociations * ListServiceNetworkServiceAssociations * ListServiceNetworkVpcAssociations * ListServiceNetworkVpcEndpointAssociations * ListServiceNetworks * ListServices * ListTargetGroups * ListTargets VPCLattice / Paginator / ListListeners ListListeners ************* class VPCLattice.Paginator.ListListeners paginator = client.get_paginator('list_listeners') paginate(**kwargs) Creates an iterator that will paginate through responses from "VPCLattice.Client.list_listeners()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( serviceIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TLS_PASSTHROUGH' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the listeners. * *(dict) --* Summary information about a listener. * **arn** *(string) --* The Amazon Resource Name (ARN) of the listener. * **createdAt** *(datetime) --* The date and time that the listener was created, in ISO-8601 format. * **id** *(string) --* The ID of the listener. * **lastUpdatedAt** *(datetime) --* The date and time that the listener was last updated, in ISO-8601 format. * **name** *(string) --* The name of the listener. * **port** *(integer) --* The listener port. * **protocol** *(string) --* The listener protocol. * **NextToken** *(string) --* A token to resume pagination. VPCLattice / Paginator / ListServiceNetworkVpcEndpointAssociations ListServiceNetworkVpcEndpointAssociations ***************************************** class VPCLattice.Paginator.ListServiceNetworkVpcEndpointAssociations paginator = client.get_paginator('list_service_network_vpc_endpoint_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from " VPCLattice.Client.list_service_network_vpc_endpoint_association s()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( serviceNetworkIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **serviceNetworkIdentifier** (*string*) -- **[REQUIRED]** The ID of the service network associated with the VPC endpoint. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'serviceNetworkArn': 'string', 'state': 'string', 'vpcEndpointId': 'string', 'vpcEndpointOwnerId': 'string', 'vpcId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the association between the VPC endpoint and service network. * *(dict) --* Describes the association between a service network and a VPC endpoint. * **createdAt** *(datetime) --* The date and time that the association was created, in ISO-8601 format. * **id** *(string) --* The ID of the association. * **serviceNetworkArn** *(string) --* The Amazon Resource Name (ARN) of the service network. * **state** *(string) --* The state of the association. * **vpcEndpointId** *(string) --* The ID of the VPC endpoint associated with the service network. * **vpcEndpointOwnerId** *(string) --* The owner of the VPC endpoint associated with the service network. * **vpcId** *(string) --* The ID of the VPC for the association. * **NextToken** *(string) --* A token to resume pagination. VPCLattice / Paginator / ListResourceEndpointAssociations ListResourceEndpointAssociations ******************************** class VPCLattice.Paginator.ListResourceEndpointAssociations paginator = client.get_paginator('list_resource_endpoint_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "VPCLattice.Client.list_resource_endpoint_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( resourceConfigurationIdentifier='string', resourceEndpointAssociationIdentifier='string', vpcEndpointId='string', vpcEndpointOwner='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **resourceConfigurationIdentifier** (*string*) -- **[REQUIRED]** The ID for the resource configuration associated with the VPC endpoint. * **resourceEndpointAssociationIdentifier** (*string*) -- The ID of the association. * **vpcEndpointId** (*string*) -- The ID of the VPC endpoint in the association. * **vpcEndpointOwner** (*string*) -- The owner of the VPC endpoint in the association. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'id': 'string', 'resourceConfigurationArn': 'string', 'resourceConfigurationId': 'string', 'resourceConfigurationName': 'string', 'vpcEndpointId': 'string', 'vpcEndpointOwner': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the VPC endpoint associations. * *(dict) --* Summary information about a VPC endpoint association. * **arn** *(string) --* The Amazon Resource Name (ARN) of the VPC endpoint association. * **createdAt** *(datetime) --* The date and time that the VPC endpoint association was created, in ISO-8601 format. * **createdBy** *(string) --* The account that created the association. * **id** *(string) --* The ID of the VPC endpoint association. * **resourceConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the resource configuration. * **resourceConfigurationId** *(string) --* The ID of the resource configuration. * **resourceConfigurationName** *(string) --* The name of the resource configuration. * **vpcEndpointId** *(string) --* The ID of the VPC endpoint. * **vpcEndpointOwner** *(string) --* The owner of the VPC endpoint. * **NextToken** *(string) --* A token to resume pagination. VPCLattice / Paginator / ListServiceNetworks ListServiceNetworks ******************* class VPCLattice.Paginator.ListServiceNetworks paginator = client.get_paginator('list_service_networks') paginate(**kwargs) Creates an iterator that will paginate through responses from "VPCLattice.Client.list_service_networks()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'numberOfAssociatedResourceConfigurations': 123, 'numberOfAssociatedServices': 123, 'numberOfAssociatedVPCs': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the service networks. * *(dict) --* Summary information about a service network. * **arn** *(string) --* The Amazon Resource Name (ARN) of the service network. * **createdAt** *(datetime) --* The date and time that the service network was created, in ISO-8601 format. * **id** *(string) --* The ID of the service network. * **lastUpdatedAt** *(datetime) --* The date and time that the service network was last updated, in ISO-8601 format. * **name** *(string) --* The name of the service network. * **numberOfAssociatedResourceConfigurations** *(integer) --* The number of resource configurations associated with a service network. * **numberOfAssociatedServices** *(integer) --* The number of services associated with the service network. * **numberOfAssociatedVPCs** *(integer) --* The number of VPCs associated with the service network. * **NextToken** *(string) --* A token to resume pagination. VPCLattice / Paginator / ListTargets ListTargets *********** class VPCLattice.Paginator.ListTargets paginator = client.get_paginator('list_targets') paginate(**kwargs) Creates an iterator that will paginate through responses from "VPCLattice.Client.list_targets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( targetGroupIdentifier='string', targets=[ { 'id': 'string', 'port': 123 }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **targetGroupIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the target group. * **targets** (*list*) -- The targets. * *(dict) --* Describes a target. * **id** *(string) --* **[REQUIRED]** The ID of the target. If the target group type is "INSTANCE", this is an instance ID. If the target group type is "IP", this is an IP address. If the target group type is "LAMBDA", this is the ARN of a Lambda function. If the target group type is "ALB", this is the ARN of an Application Load Balancer. * **port** *(integer) --* The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'id': 'string', 'port': 123, 'reasonCode': 'string', 'status': 'DRAINING'|'UNAVAILABLE'|'HEALTHY'|'UNHEALTHY'|'INITIAL'|'UNUSED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the targets. * *(dict) --* Summary information about a target. * **id** *(string) --* The ID of the target. If the target group type is "INSTANCE", this is an instance ID. If the target group type is "IP", this is an IP address. If the target group type is "LAMBDA", this is the ARN of a Lambda function. If the target type is "ALB", this is the ARN of an Application Load Balancer. * **port** *(integer) --* The port on which the target is listening. * **reasonCode** *(string) --* The code for why the target status is what it is. * **status** *(string) --* The status of the target. * "DRAINING": The target is being deregistered. No new connections are sent to this target while current connections are being drained. The default draining time is 5 minutes. * "UNAVAILABLE": Health checks are unavailable for the target group. * "HEALTHY": The target is healthy. * "UNHEALTHY": The target is unhealthy. * "INITIAL": Initial health checks on the target are being performed. * "UNUSED": Target group is not used in a service. * **NextToken** *(string) --* A token to resume pagination. VPCLattice / Paginator / ListResourceConfigurations ListResourceConfigurations ************************** class VPCLattice.Paginator.ListResourceConfigurations paginator = client.get_paginator('list_resource_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from "VPCLattice.Client.list_resource_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( resourceConfigurationGroupIdentifier='string', resourceGatewayIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **resourceConfigurationGroupIdentifier** (*string*) -- The ID of the group resource configuration. * **resourceGatewayIdentifier** (*string*) -- The ID of the resource gateway for the resource configuration. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'amazonManaged': True|False, 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'resourceConfigurationGroupId': 'string', 'resourceGatewayId': 'string', 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED', 'type': 'GROUP'|'CHILD'|'SINGLE'|'ARN' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the resource configurations. * *(dict) --* Summary information about a resource configuration. * **amazonManaged** *(boolean) --* Indicates whether the resource configuration was created and is managed by Amazon. * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource configuration. * **createdAt** *(datetime) --* The date and time that the resource configuration was created, in ISO-8601 format. * **id** *(string) --* The ID of the resource configuration. * **lastUpdatedAt** *(datetime) --* The most recent date and time that the resource configuration was updated, in ISO-8601 format. * **name** *(string) --* The name of the resource configuration. * **resourceConfigurationGroupId** *(string) --* The ID of the group resource configuration. * **resourceGatewayId** *(string) --* The ID of the resource gateway. * **status** *(string) --* The status of the resource configuration. * **type** *(string) --* The type of resource configuration. * "SINGLE" - A single resource. * "GROUP" - A group of resources. * "CHILD" - A single resource that is part of a group resource configuration. * "ARN" - An Amazon Web Services resource. * **NextToken** *(string) --* A token to resume pagination. VPCLattice / Paginator / ListResourceGateways ListResourceGateways ******************** class VPCLattice.Paginator.ListResourceGateways paginator = client.get_paginator('list_resource_gateways') paginate(**kwargs) Creates an iterator that will paginate through responses from "VPCLattice.Client.list_resource_gateways()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'securityGroupIds': [ 'string', ], 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED', 'subnetIds': [ 'string', ], 'vpcIdentifier': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the resource gateways. * *(dict) --* Summary information about a resource gateway. * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource gateway. * **createdAt** *(datetime) --* The date and time that the VPC endpoint association was created, in ISO-8601 format. * **id** *(string) --* The ID of the resource gateway. * **ipAddressType** *(string) --* The type of IP address used by the resource gateway. * **lastUpdatedAt** *(datetime) --* The most recent date and time that the resource gateway was updated, in ISO-8601 format. * **name** *(string) --* The name of the resource gateway. * **securityGroupIds** *(list) --* The IDs of the security groups applied to the resource gateway. * *(string) --* * **status** *(string) --* The name of the resource gateway. * **subnetIds** *(list) --* The IDs of the VPC subnets for the resource gateway. * *(string) --* * **vpcIdentifier** *(string) --* The ID of the VPC for the resource gateway. * **NextToken** *(string) --* A token to resume pagination. VPCLattice / Paginator / ListServiceNetworkServiceAssociations ListServiceNetworkServiceAssociations ************************************* class VPCLattice.Paginator.ListServiceNetworkServiceAssociations paginator = client.get_paginator('list_service_network_service_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "VPCLattice.Client.list_service_network_service_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( serviceIdentifier='string', serviceNetworkIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **serviceIdentifier** (*string*) -- The ID or ARN of the service. * **serviceNetworkIdentifier** (*string*) -- The ID or ARN of the service network. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'customDomainName': 'string', 'dnsEntry': { 'domainName': 'string', 'hostedZoneId': 'string' }, 'id': 'string', 'serviceArn': 'string', 'serviceId': 'string', 'serviceName': 'string', 'serviceNetworkArn': 'string', 'serviceNetworkId': 'string', 'serviceNetworkName': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the associations. * *(dict) --* Summary information about an association between a service network and a service. * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **createdAt** *(datetime) --* The date and time that the association was created, in ISO-8601 format. * **createdBy** *(string) --* The account that created the association. * **customDomainName** *(string) --* The custom domain name of the service. * **dnsEntry** *(dict) --* The DNS information. * **domainName** *(string) --* The domain name of the service. * **hostedZoneId** *(string) --* The ID of the hosted zone. * **id** *(string) --* The ID of the association. * **serviceArn** *(string) --* The Amazon Resource Name (ARN) of the service. * **serviceId** *(string) --* The ID of the service. * **serviceName** *(string) --* The name of the service. * **serviceNetworkArn** *(string) --* The Amazon Resource Name (ARN) of the service network. * **serviceNetworkId** *(string) --* The ID of the service network. * **serviceNetworkName** *(string) --* The name of the service network. * **status** *(string) --* The status. If the deletion fails, try to delete again. * **NextToken** *(string) --* A token to resume pagination. VPCLattice / Paginator / ListServices ListServices ************ class VPCLattice.Paginator.ListServices paginator = client.get_paginator('list_services') paginate(**kwargs) Creates an iterator that will paginate through responses from "VPCLattice.Client.list_services()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'customDomainName': 'string', 'dnsEntry': { 'domainName': 'string', 'hostedZoneId': 'string' }, 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the services. * *(dict) --* Summary information about a service. * **arn** *(string) --* The Amazon Resource Name (ARN) of the service. * **createdAt** *(datetime) --* The date and time that the service was created, in ISO-8601 format. * **customDomainName** *(string) --* The custom domain name of the service. * **dnsEntry** *(dict) --* The DNS information. * **domainName** *(string) --* The domain name of the service. * **hostedZoneId** *(string) --* The ID of the hosted zone. * **id** *(string) --* The ID of the service. * **lastUpdatedAt** *(datetime) --* The date and time that the service was last updated, in ISO-8601 format. * **name** *(string) --* The name of the service. * **status** *(string) --* The status. * **NextToken** *(string) --* A token to resume pagination. VPCLattice / Paginator / ListServiceNetworkResourceAssociations ListServiceNetworkResourceAssociations ************************************** class VPCLattice.Paginator.ListServiceNetworkResourceAssociations paginator = client.get_paginator('list_service_network_resource_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from " VPCLattice.Client.list_service_network_resource_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( resourceConfigurationIdentifier='string', serviceNetworkIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **resourceConfigurationIdentifier** (*string*) -- The ID of the resource configurationk. * **serviceNetworkIdentifier** (*string*) -- The ID of the service network. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'dnsEntry': { 'domainName': 'string', 'hostedZoneId': 'string' }, 'failureCode': 'string', 'id': 'string', 'isManagedAssociation': True|False, 'privateDnsEntry': { 'domainName': 'string', 'hostedZoneId': 'string' }, 'resourceConfigurationArn': 'string', 'resourceConfigurationId': 'string', 'resourceConfigurationName': 'string', 'serviceNetworkArn': 'string', 'serviceNetworkId': 'string', 'serviceNetworkName': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'PARTIAL'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the associations. * *(dict) --* Summary information about an association between a service network and a resource configuration. * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **createdAt** *(datetime) --* The date and time that the association was created, in ISO-8601 format. * **createdBy** *(string) --* The account that created the association. * **dnsEntry** *(dict) --* The DNS entry for the service. * **domainName** *(string) --* The domain name of the service. * **hostedZoneId** *(string) --* The ID of the hosted zone. * **failureCode** *(string) --* The failure code. * **id** *(string) --* The ID of the association between the service network and resource configuration. * **isManagedAssociation** *(boolean) --* Specifies whether the association is managed by Amazon. * **privateDnsEntry** *(dict) --* The private DNS entry for the service. * **domainName** *(string) --* The domain name of the service. * **hostedZoneId** *(string) --* The ID of the hosted zone. * **resourceConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the association. * **resourceConfigurationId** *(string) --* The ID of the resource configuration associated with the service network. * **resourceConfigurationName** *(string) --* The name of the resource configuration associated with the service network. * **serviceNetworkArn** *(string) --* The Amazon Resource Name (ARN) of the service network associated with the resource configuration. * **serviceNetworkId** *(string) --* The ID of the service network associated with the resource configuration. * **serviceNetworkName** *(string) --* The name of the service network associated with the resource configuration. * **status** *(string) --* The status of the service network associated with the resource configuration. * **NextToken** *(string) --* A token to resume pagination. VPCLattice / Paginator / ListAccessLogSubscriptions ListAccessLogSubscriptions ************************** class VPCLattice.Paginator.ListAccessLogSubscriptions paginator = client.get_paginator('list_access_log_subscriptions') paginate(**kwargs) Creates an iterator that will paginate through responses from "VPCLattice.Client.list_access_log_subscriptions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( resourceIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **resourceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service network or service. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'destinationArn': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'resourceArn': 'string', 'resourceId': 'string', 'serviceNetworkLogType': 'SERVICE'|'RESOURCE' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the access log subscriptions. * *(dict) --* Summary information about an access log subscription. * **arn** *(string) --* The Amazon Resource Name (ARN) of the access log subscription * **createdAt** *(datetime) --* The date and time that the access log subscription was created, in ISO-8601 format. * **destinationArn** *(string) --* The Amazon Resource Name (ARN) of the destination. * **id** *(string) --* The ID of the access log subscription. * **lastUpdatedAt** *(datetime) --* The date and time that the access log subscription was last updated, in ISO-8601 format. * **resourceArn** *(string) --* The Amazon Resource Name (ARN) of the service or service network. * **resourceId** *(string) --* The ID of the service or service network. * **serviceNetworkLogType** *(string) --* Log type of the service network. * **NextToken** *(string) --* A token to resume pagination. VPCLattice / Paginator / ListServiceNetworkVpcAssociations ListServiceNetworkVpcAssociations ********************************* class VPCLattice.Paginator.ListServiceNetworkVpcAssociations paginator = client.get_paginator('list_service_network_vpc_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "VPCLattice.Client.list_service_network_vpc_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( serviceNetworkIdentifier='string', vpcIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **serviceNetworkIdentifier** (*string*) -- The ID or ARN of the service network. * **vpcIdentifier** (*string*) -- The ID or ARN of the VPC. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'serviceNetworkArn': 'string', 'serviceNetworkId': 'string', 'serviceNetworkName': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED'|'UPDATE_FAILED', 'vpcId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the associations. * *(dict) --* Summary information about an association between a service network and a VPC. * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **createdAt** *(datetime) --* The date and time that the association was created, in ISO-8601 format. * **createdBy** *(string) --* The account that created the association. * **id** *(string) --* The ID of the association. * **lastUpdatedAt** *(datetime) --* The date and time that the association was last updated, in ISO-8601 format. * **serviceNetworkArn** *(string) --* The Amazon Resource Name (ARN) of the service network. * **serviceNetworkId** *(string) --* The ID of the service network. * **serviceNetworkName** *(string) --* The name of the service network. * **status** *(string) --* The status. * **vpcId** *(string) --* The ID of the VPC. * **NextToken** *(string) --* A token to resume pagination. VPCLattice / Paginator / ListTargetGroups ListTargetGroups **************** class VPCLattice.Paginator.ListTargetGroups paginator = client.get_paginator('list_target_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "VPCLattice.Client.list_target_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( targetGroupType='IP'|'LAMBDA'|'INSTANCE'|'ALB', vpcIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **targetGroupType** (*string*) -- The target group type. * **vpcIdentifier** (*string*) -- The ID or ARN of the VPC. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'ipAddressType': 'IPV4'|'IPV6', 'lambdaEventStructureVersion': 'V1'|'V2', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TCP', 'serviceArns': [ 'string', ], 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED', 'type': 'IP'|'LAMBDA'|'INSTANCE'|'ALB', 'vpcIdentifier': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the target groups. * *(dict) --* Summary information about a target group. For more information, see Target groups in the *Amazon VPC Lattice User Guide*. * **arn** *(string) --* The ARN (Amazon Resource Name) of the target group. * **createdAt** *(datetime) --* The date and time that the target group was created, in ISO-8601 format. * **id** *(string) --* The ID of the target group. * **ipAddressType** *(string) --* The type of IP address used for the target group. The possible values are "IPV4" and "IPV6". This is an optional parameter. If not specified, the default is "IPV4". * **lambdaEventStructureVersion** *(string) --* The version of the event structure that your Lambda function receives. Supported only if the target group type is "LAMBDA". * **lastUpdatedAt** *(datetime) --* The date and time that the target group was last updated, in ISO-8601 format. * **name** *(string) --* The name of the target group. * **port** *(integer) --* The port of the target group. * **protocol** *(string) --* The protocol of the target group. * **serviceArns** *(list) --* The Amazon Resource Names (ARNs) of the service. * *(string) --* * **status** *(string) --* The status. * **type** *(string) --* The target group type. * **vpcIdentifier** *(string) --* The ID of the VPC of the target group. * **NextToken** *(string) --* A token to resume pagination. VPCLattice / Paginator / ListRules ListRules ********* class VPCLattice.Paginator.ListRules paginator = client.get_paginator('list_rules') paginate(**kwargs) Creates an iterator that will paginate through responses from "VPCLattice.Client.list_rules()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( listenerIdentifier='string', serviceIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **listenerIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the listener. * **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'isDefault': True|False, 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'priority': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the rules. * *(dict) --* Summary information about a listener rule. * **arn** *(string) --* The Amazon Resource Name (ARN) of the rule. * **createdAt** *(datetime) --* The date and time that the listener rule was created, in ISO-8601 format. * **id** *(string) --* The ID of the rule. * **isDefault** *(boolean) --* Indicates whether this is the default listener rule. * **lastUpdatedAt** *(datetime) --* The date and time that the listener rule was last updated, in ISO-8601 format. * **name** *(string) --* The name of the rule. * **priority** *(integer) --* The priority of the rule. * **NextToken** *(string) --* A token to resume pagination. VPCLattice / Client / put_auth_policy put_auth_policy *************** VPCLattice.Client.put_auth_policy(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.put_auth_policy( policy='string', resourceIdentifier='string' ) Parameters: * **policy** (*string*) -- **[REQUIRED]** The auth policy. The policy string in JSON must not contain newlines or blank lines. * **resourceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service network or service for which the policy is created. Return type: dict Returns: **Response Syntax** { 'policy': 'string', 'state': 'Active'|'Inactive' } **Response Structure** * *(dict) --* * **policy** *(string) --* The auth policy. The policy string in JSON must not contain newlines or blank lines. * **state** *(string) --* The state of the auth policy. The auth policy is only active when the auth type is set to "AWS_IAM". If you provide a policy, then authentication and authorization decisions are made based on this policy and the client's IAM policy. If the Auth type is "NONE", then, any auth policy that you provide remains inactive. For more information, see Create a service network in the *Amazon VPC Lattice User Guide*. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / get_target_group get_target_group **************** VPCLattice.Client.get_target_group(**kwargs) Retrieves information about the specified target group. See also: AWS API Documentation **Request Syntax** response = client.get_target_group( targetGroupIdentifier='string' ) Parameters: **targetGroupIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the target group. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'config': { 'healthCheck': { 'enabled': True|False, 'healthCheckIntervalSeconds': 123, 'healthCheckTimeoutSeconds': 123, 'healthyThresholdCount': 123, 'matcher': { 'httpCode': 'string' }, 'path': 'string', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TCP', 'protocolVersion': 'HTTP1'|'HTTP2', 'unhealthyThresholdCount': 123 }, 'ipAddressType': 'IPV4'|'IPV6', 'lambdaEventStructureVersion': 'V1'|'V2', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TCP', 'protocolVersion': 'HTTP1'|'HTTP2'|'GRPC', 'vpcIdentifier': 'string' }, 'createdAt': datetime(2015, 1, 1), 'failureCode': 'string', 'failureMessage': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'serviceArns': [ 'string', ], 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED', 'type': 'IP'|'LAMBDA'|'INSTANCE'|'ALB' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the target group. * **config** *(dict) --* The target group configuration. * **healthCheck** *(dict) --* The health check configuration. Not supported if the target group type is "LAMBDA" or "ALB". * **enabled** *(boolean) --* Indicates whether health checking is enabled. * **healthCheckIntervalSeconds** *(integer) --* The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds. * **healthCheckTimeoutSeconds** *(integer) --* The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds. * **healthyThresholdCount** *(integer) --* The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5. * **matcher** *(dict) --* The codes to use when checking for a successful response from a target. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "httpCode". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **httpCode** *(string) --* The HTTP code to use when checking for a successful response from a target. * **path** *(string) --* The destination for health checks on the targets. If the protocol version is "HTTP/1.1" or "HTTP/2", specify a valid URI (for example, "/path?query"). The default path is "/". Health checks are not supported if the protocol version is "gRPC", however, you can choose "HTTP/1.1" or "HTTP/2" and specify a valid URI. * **port** *(integer) --* The port used when performing health checks on targets. The default setting is the port that a target receives traffic on. * **protocol** *(string) --* The protocol used when performing health checks on targets. The possible protocols are "HTTP" and "HTTPS". The default is "HTTP". * **protocolVersion** *(string) --* The protocol version used when performing health checks on targets. The possible protocol versions are "HTTP1" and "HTTP2". * **unhealthyThresholdCount** *(integer) --* The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2. * **ipAddressType** *(string) --* The type of IP address used for the target group. Supported only if the target group type is "IP". The default is "IPV4". * **lambdaEventStructureVersion** *(string) --* The version of the event structure that your Lambda function receives. Supported only if the target group type is "LAMBDA". The default is "V1". * **port** *(integer) --* The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is "LAMBDA". * **protocol** *(string) --* The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is "LAMBDA". * **protocolVersion** *(string) --* The protocol version. The default is "HTTP1". Not supported if the target group type is "LAMBDA". * **vpcIdentifier** *(string) --* The ID of the VPC. Not supported if the target group type is "LAMBDA". * **createdAt** *(datetime) --* The date and time that the target group was created, in ISO-8601 format. * **failureCode** *(string) --* The failure code. * **failureMessage** *(string) --* The failure message. * **id** *(string) --* The ID of the target group. * **lastUpdatedAt** *(datetime) --* The date and time that the target group was last updated, in ISO-8601 format. * **name** *(string) --* The name of the target group. * **serviceArns** *(list) --* The Amazon Resource Names (ARNs) of the service. * *(string) --* * **status** *(string) --* The status. * **type** *(string) --* The target group type. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / deregister_targets deregister_targets ****************** VPCLattice.Client.deregister_targets(**kwargs) Deregisters the specified targets from the specified target group. See also: AWS API Documentation **Request Syntax** response = client.deregister_targets( targetGroupIdentifier='string', targets=[ { 'id': 'string', 'port': 123 }, ] ) Parameters: * **targetGroupIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the target group. * **targets** (*list*) -- **[REQUIRED]** The targets to deregister. * *(dict) --* Describes a target. * **id** *(string) --* **[REQUIRED]** The ID of the target. If the target group type is "INSTANCE", this is an instance ID. If the target group type is "IP", this is an IP address. If the target group type is "LAMBDA", this is the ARN of a Lambda function. If the target group type is "ALB", this is the ARN of an Application Load Balancer. * **port** *(integer) --* The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443. Return type: dict Returns: **Response Syntax** { 'successful': [ { 'id': 'string', 'port': 123 }, ], 'unsuccessful': [ { 'failureCode': 'string', 'failureMessage': 'string', 'id': 'string', 'port': 123 }, ] } **Response Structure** * *(dict) --* * **successful** *(list) --* The targets that were successfully deregistered. * *(dict) --* Describes a target. * **id** *(string) --* The ID of the target. If the target group type is "INSTANCE", this is an instance ID. If the target group type is "IP", this is an IP address. If the target group type is "LAMBDA", this is the ARN of a Lambda function. If the target group type is "ALB", this is the ARN of an Application Load Balancer. * **port** *(integer) --* The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443. * **unsuccessful** *(list) --* The targets that the operation couldn't deregister. * *(dict) --* Describes a target failure. * **failureCode** *(string) --* The failure code. * **failureMessage** *(string) --* The failure message. * **id** *(string) --* The ID of the target. If the target group type is "INSTANCE", this is an instance ID. If the target group type is "IP", this is an IP address. If the target group type is "LAMBDA", this is the ARN of a Lambda function. If the target group type is "ALB", this is the ARN of an Application Load Balancer. * **port** *(integer) --* The port on which the target is listening. This parameter doesn't apply if the target is a Lambda function. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / get_paginator get_paginator ************* VPCLattice.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. VPCLattice / Client / create_target_group create_target_group ******************* VPCLattice.Client.create_target_group(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.create_target_group( clientToken='string', config={ 'healthCheck': { 'enabled': True|False, 'healthCheckIntervalSeconds': 123, 'healthCheckTimeoutSeconds': 123, 'healthyThresholdCount': 123, 'matcher': { 'httpCode': 'string' }, 'path': 'string', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TCP', 'protocolVersion': 'HTTP1'|'HTTP2', 'unhealthyThresholdCount': 123 }, 'ipAddressType': 'IPV4'|'IPV6', 'lambdaEventStructureVersion': 'V1'|'V2', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TCP', 'protocolVersion': 'HTTP1'|'HTTP2'|'GRPC', 'vpcIdentifier': 'string' }, name='string', tags={ 'string': 'string' }, type='IP'|'LAMBDA'|'INSTANCE'|'ALB' ) Parameters: * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **config** (*dict*) -- The target group configuration. * **healthCheck** *(dict) --* The health check configuration. Not supported if the target group type is "LAMBDA" or "ALB". * **enabled** *(boolean) --* Indicates whether health checking is enabled. * **healthCheckIntervalSeconds** *(integer) --* The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds. * **healthCheckTimeoutSeconds** *(integer) --* The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds. * **healthyThresholdCount** *(integer) --* The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5. * **matcher** *(dict) --* The codes to use when checking for a successful response from a target. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "httpCode". * **httpCode** *(string) --* The HTTP code to use when checking for a successful response from a target. * **path** *(string) --* The destination for health checks on the targets. If the protocol version is "HTTP/1.1" or "HTTP/2", specify a valid URI (for example, "/path?query"). The default path is "/". Health checks are not supported if the protocol version is "gRPC", however, you can choose "HTTP/1.1" or "HTTP/2" and specify a valid URI. * **port** *(integer) --* The port used when performing health checks on targets. The default setting is the port that a target receives traffic on. * **protocol** *(string) --* The protocol used when performing health checks on targets. The possible protocols are "HTTP" and "HTTPS". The default is "HTTP". * **protocolVersion** *(string) --* The protocol version used when performing health checks on targets. The possible protocol versions are "HTTP1" and "HTTP2". * **unhealthyThresholdCount** *(integer) --* The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2. * **ipAddressType** *(string) --* The type of IP address used for the target group. Supported only if the target group type is "IP". The default is "IPV4". * **lambdaEventStructureVersion** *(string) --* The version of the event structure that your Lambda function receives. Supported only if the target group type is "LAMBDA". The default is "V1". * **port** *(integer) --* The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is "LAMBDA". * **protocol** *(string) --* The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is "LAMBDA". * **protocolVersion** *(string) --* The protocol version. The default is "HTTP1". Not supported if the target group type is "LAMBDA". * **vpcIdentifier** *(string) --* The ID of the VPC. Not supported if the target group type is "LAMBDA". * **name** (*string*) -- **[REQUIRED]** The name of the target group. The name must be unique within the account. 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. * **tags** (*dict*) -- The tags for the target group. * *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with "aws:". * *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ * **type** (*string*) -- **[REQUIRED]** The type of target group. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'config': { 'healthCheck': { 'enabled': True|False, 'healthCheckIntervalSeconds': 123, 'healthCheckTimeoutSeconds': 123, 'healthyThresholdCount': 123, 'matcher': { 'httpCode': 'string' }, 'path': 'string', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TCP', 'protocolVersion': 'HTTP1'|'HTTP2', 'unhealthyThresholdCount': 123 }, 'ipAddressType': 'IPV4'|'IPV6', 'lambdaEventStructureVersion': 'V1'|'V2', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TCP', 'protocolVersion': 'HTTP1'|'HTTP2'|'GRPC', 'vpcIdentifier': 'string' }, 'id': 'string', 'name': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED', 'type': 'IP'|'LAMBDA'|'INSTANCE'|'ALB' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the target group. * **config** *(dict) --* The target group configuration. * **healthCheck** *(dict) --* The health check configuration. Not supported if the target group type is "LAMBDA" or "ALB". * **enabled** *(boolean) --* Indicates whether health checking is enabled. * **healthCheckIntervalSeconds** *(integer) --* The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds. * **healthCheckTimeoutSeconds** *(integer) --* The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds. * **healthyThresholdCount** *(integer) --* The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5. * **matcher** *(dict) --* The codes to use when checking for a successful response from a target. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "httpCode". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **httpCode** *(string) --* The HTTP code to use when checking for a successful response from a target. * **path** *(string) --* The destination for health checks on the targets. If the protocol version is "HTTP/1.1" or "HTTP/2", specify a valid URI (for example, "/path?query"). The default path is "/". Health checks are not supported if the protocol version is "gRPC", however, you can choose "HTTP/1.1" or "HTTP/2" and specify a valid URI. * **port** *(integer) --* The port used when performing health checks on targets. The default setting is the port that a target receives traffic on. * **protocol** *(string) --* The protocol used when performing health checks on targets. The possible protocols are "HTTP" and "HTTPS". The default is "HTTP". * **protocolVersion** *(string) --* The protocol version used when performing health checks on targets. The possible protocol versions are "HTTP1" and "HTTP2". * **unhealthyThresholdCount** *(integer) --* The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2. * **ipAddressType** *(string) --* The type of IP address used for the target group. Supported only if the target group type is "IP". The default is "IPV4". * **lambdaEventStructureVersion** *(string) --* The version of the event structure that your Lambda function receives. Supported only if the target group type is "LAMBDA". The default is "V1". * **port** *(integer) --* The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is "LAMBDA". * **protocol** *(string) --* The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is "LAMBDA". * **protocolVersion** *(string) --* The protocol version. The default is "HTTP1". Not supported if the target group type is "LAMBDA". * **vpcIdentifier** *(string) --* The ID of the VPC. Not supported if the target group type is "LAMBDA". * **id** *(string) --* The ID of the target group. * **name** *(string) --* The name of the target group. * **status** *(string) --* The status. You can retry the operation if the status is "CREATE_FAILED". However, if you retry it while the status is "CREATE_IN_PROGRESS", there is no change in the status. * **type** *(string) --* The type of target group. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / update_listener update_listener *************** VPCLattice.Client.update_listener(**kwargs) Updates the specified listener for the specified service. See also: AWS API Documentation **Request Syntax** response = client.update_listener( defaultAction={ 'fixedResponse': { 'statusCode': 123 }, 'forward': { 'targetGroups': [ { 'targetGroupIdentifier': 'string', 'weight': 123 }, ] } }, listenerIdentifier='string', serviceIdentifier='string' ) Parameters: * **defaultAction** (*dict*) -- **[REQUIRED]** The action for the default rule. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixedResponse", "forward". * **fixedResponse** *(dict) --* The fixed response action. The rule returns a custom HTTP response. * **statusCode** *(integer) --* **[REQUIRED]** The HTTP response code. * **forward** *(dict) --* The forward action. Traffic that matches the rule is forwarded to the specified target groups. * **targetGroups** *(list) --* **[REQUIRED]** The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic. The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group. * *(dict) --* Describes the weight of a target group. * **targetGroupIdentifier** *(string) --* **[REQUIRED]** The ID or ARN of the target group. * **weight** *(integer) --* Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100. * **listenerIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the listener. * **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'defaultAction': { 'fixedResponse': { 'statusCode': 123 }, 'forward': { 'targetGroups': [ { 'targetGroupIdentifier': 'string', 'weight': 123 }, ] } }, 'id': 'string', 'name': 'string', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TLS_PASSTHROUGH', 'serviceArn': 'string', 'serviceId': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the listener. * **defaultAction** *(dict) --* The action for the default rule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixedResponse", "forward". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **fixedResponse** *(dict) --* The fixed response action. The rule returns a custom HTTP response. * **statusCode** *(integer) --* The HTTP response code. * **forward** *(dict) --* The forward action. Traffic that matches the rule is forwarded to the specified target groups. * **targetGroups** *(list) --* The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic. The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group. * *(dict) --* Describes the weight of a target group. * **targetGroupIdentifier** *(string) --* The ID or ARN of the target group. * **weight** *(integer) --* Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100. * **id** *(string) --* The ID of the listener. * **name** *(string) --* The name of the listener. * **port** *(integer) --* The listener port. * **protocol** *(string) --* The protocol of the listener. * **serviceArn** *(string) --* The Amazon Resource Name (ARN) of the service. * **serviceId** *(string) --* The ID of the service. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / get_service_network_resource_association get_service_network_resource_association **************************************** VPCLattice.Client.get_service_network_resource_association(**kwargs) Retrieves information about the specified association between a service network and a resource configuration. See also: AWS API Documentation **Request Syntax** response = client.get_service_network_resource_association( serviceNetworkResourceAssociationIdentifier='string' ) Parameters: **serviceNetworkResourceAssociationIdentifier** (*string*) -- **[REQUIRED]** The ID of the association. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'dnsEntry': { 'domainName': 'string', 'hostedZoneId': 'string' }, 'failureCode': 'string', 'failureReason': 'string', 'id': 'string', 'isManagedAssociation': True|False, 'lastUpdatedAt': datetime(2015, 1, 1), 'privateDnsEntry': { 'domainName': 'string', 'hostedZoneId': 'string' }, 'resourceConfigurationArn': 'string', 'resourceConfigurationId': 'string', 'resourceConfigurationName': 'string', 'serviceNetworkArn': 'string', 'serviceNetworkId': 'string', 'serviceNetworkName': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'PARTIAL'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **createdAt** *(datetime) --* The date and time that the association was created, in ISO-8601 format. * **createdBy** *(string) --* The account that created the association. * **dnsEntry** *(dict) --* The DNS entry for the service. * **domainName** *(string) --* The domain name of the service. * **hostedZoneId** *(string) --* The ID of the hosted zone. * **failureCode** *(string) --* The failure code. * **failureReason** *(string) --* The reason the association request failed. * **id** *(string) --* The ID of the association. * **isManagedAssociation** *(boolean) --* Indicates whether the association is managed by Amazon. * **lastUpdatedAt** *(datetime) --* The most recent date and time that the association was updated, in ISO-8601 format. * **privateDnsEntry** *(dict) --* The private DNS entry for the service. * **domainName** *(string) --* The domain name of the service. * **hostedZoneId** *(string) --* The ID of the hosted zone. * **resourceConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the association. * **resourceConfigurationId** *(string) --* The ID of the resource configuration that is associated with the service network. * **resourceConfigurationName** *(string) --* The name of the resource configuration that is associated with the service network. * **serviceNetworkArn** *(string) --* The Amazon Resource Name (ARN) of the service network that is associated with the resource configuration. * **serviceNetworkId** *(string) --* The ID of the service network that is associated with the resource configuration. * **serviceNetworkName** *(string) --* The name of the service network that is associated with the resource configuration. * **status** *(string) --* The status of the association. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / create_rule create_rule *********** VPCLattice.Client.create_rule(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.create_rule( action={ 'fixedResponse': { 'statusCode': 123 }, 'forward': { 'targetGroups': [ { 'targetGroupIdentifier': 'string', 'weight': 123 }, ] } }, clientToken='string', listenerIdentifier='string', match={ 'httpMatch': { 'headerMatches': [ { 'caseSensitive': True|False, 'match': { 'contains': 'string', 'exact': 'string', 'prefix': 'string' }, 'name': 'string' }, ], 'method': 'string', 'pathMatch': { 'caseSensitive': True|False, 'match': { 'exact': 'string', 'prefix': 'string' } } } }, name='string', priority=123, serviceIdentifier='string', tags={ 'string': 'string' } ) Parameters: * **action** (*dict*) -- **[REQUIRED]** The action for the default rule. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixedResponse", "forward". * **fixedResponse** *(dict) --* The fixed response action. The rule returns a custom HTTP response. * **statusCode** *(integer) --* **[REQUIRED]** The HTTP response code. * **forward** *(dict) --* The forward action. Traffic that matches the rule is forwarded to the specified target groups. * **targetGroups** *(list) --* **[REQUIRED]** The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic. The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group. * *(dict) --* Describes the weight of a target group. * **targetGroupIdentifier** *(string) --* **[REQUIRED]** The ID or ARN of the target group. * **weight** *(integer) --* Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100. * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **listenerIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the listener. * **match** (*dict*) -- **[REQUIRED]** The rule match. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "httpMatch". * **httpMatch** *(dict) --* The HTTP criteria that a rule must match. * **headerMatches** *(list) --* The header matches. Matches incoming requests with rule based on request header value before applying rule action. * *(dict) --* Describes the constraints for a header match. Matches incoming requests with rule based on request header value before applying rule action. * **caseSensitive** *(boolean) --* Indicates whether the match is case sensitive. * **match** *(dict) --* **[REQUIRED]** The header match type. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "contains", "exact", "prefix". * **contains** *(string) --* A contains type match. * **exact** *(string) --* An exact type match. * **prefix** *(string) --* A prefix type match. Matches the value with the prefix. * **name** *(string) --* **[REQUIRED]** The name of the header. * **method** *(string) --* The HTTP method type. * **pathMatch** *(dict) --* The path match. * **caseSensitive** *(boolean) --* Indicates whether the match is case sensitive. * **match** *(dict) --* **[REQUIRED]** The type of path match. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "exact", "prefix". * **exact** *(string) --* An exact match of the path. * **prefix** *(string) --* A prefix match of the path. * **name** (*string*) -- **[REQUIRED]** 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. * **priority** (*integer*) -- **[REQUIRED]** 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. * **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. * **tags** (*dict*) -- The tags for the rule. * *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with "aws:". * *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ Return type: dict Returns: **Response Syntax** { 'action': { 'fixedResponse': { 'statusCode': 123 }, 'forward': { 'targetGroups': [ { 'targetGroupIdentifier': 'string', 'weight': 123 }, ] } }, 'arn': 'string', 'id': 'string', 'match': { 'httpMatch': { 'headerMatches': [ { 'caseSensitive': True|False, 'match': { 'contains': 'string', 'exact': 'string', 'prefix': 'string' }, 'name': 'string' }, ], 'method': 'string', 'pathMatch': { 'caseSensitive': True|False, 'match': { 'exact': 'string', 'prefix': 'string' } } } }, 'name': 'string', 'priority': 123 } **Response Structure** * *(dict) --* * **action** *(dict) --* The rule action. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixedResponse", "forward". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **fixedResponse** *(dict) --* The fixed response action. The rule returns a custom HTTP response. * **statusCode** *(integer) --* The HTTP response code. * **forward** *(dict) --* The forward action. Traffic that matches the rule is forwarded to the specified target groups. * **targetGroups** *(list) --* The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic. The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group. * *(dict) --* Describes the weight of a target group. * **targetGroupIdentifier** *(string) --* The ID or ARN of the target group. * **weight** *(integer) --* Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100. * **arn** *(string) --* The Amazon Resource Name (ARN) of the rule. * **id** *(string) --* The ID of the rule. * **match** *(dict) --* 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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "httpMatch". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **httpMatch** *(dict) --* The HTTP criteria that a rule must match. * **headerMatches** *(list) --* The header matches. Matches incoming requests with rule based on request header value before applying rule action. * *(dict) --* Describes the constraints for a header match. Matches incoming requests with rule based on request header value before applying rule action. * **caseSensitive** *(boolean) --* Indicates whether the match is case sensitive. * **match** *(dict) --* The header match type. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "contains", "exact", "prefix". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **contains** *(string) --* A contains type match. * **exact** *(string) --* An exact type match. * **prefix** *(string) --* A prefix type match. Matches the value with the prefix. * **name** *(string) --* The name of the header. * **method** *(string) --* The HTTP method type. * **pathMatch** *(dict) --* The path match. * **caseSensitive** *(boolean) --* Indicates whether the match is case sensitive. * **match** *(dict) --* The type of path match. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "exact", "prefix". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **exact** *(string) --* An exact match of the path. * **prefix** *(string) --* A prefix match of the path. * **name** *(string) --* The name of the rule. * **priority** *(integer) --* The priority assigned to the rule. The lower the priority number the higher the priority. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / can_paginate can_paginate ************ VPCLattice.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. VPCLattice / Client / delete_service_network_service_association delete_service_network_service_association ****************************************** VPCLattice.Client.delete_service_network_service_association(**kwargs) Deletes the association between a service and a service network. This operation fails if an association is still in progress. See also: AWS API Documentation **Request Syntax** response = client.delete_service_network_service_association( serviceNetworkServiceAssociationIdentifier='string' ) Parameters: **serviceNetworkServiceAssociationIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the association. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'id': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **id** *(string) --* The ID of the association. * **status** *(string) --* The status. You can retry the operation if the status is "DELETE_FAILED". However, if you retry it when the status is "DELETE_IN_PROGRESS", there is no change in the status. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / get_access_log_subscription get_access_log_subscription *************************** VPCLattice.Client.get_access_log_subscription(**kwargs) Retrieves information about the specified access log subscription. See also: AWS API Documentation **Request Syntax** response = client.get_access_log_subscription( accessLogSubscriptionIdentifier='string' ) Parameters: **accessLogSubscriptionIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the access log subscription. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'destinationArn': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'resourceArn': 'string', 'resourceId': 'string', 'serviceNetworkLogType': 'SERVICE'|'RESOURCE' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the access log subscription. * **createdAt** *(datetime) --* The date and time that the access log subscription was created, in ISO-8601 format. * **destinationArn** *(string) --* The Amazon Resource Name (ARN) of the access log destination. * **id** *(string) --* The ID of the access log subscription. * **lastUpdatedAt** *(datetime) --* The date and time that the access log subscription was last updated, in ISO-8601 format. * **resourceArn** *(string) --* The Amazon Resource Name (ARN) of the service network or service. * **resourceId** *(string) --* The ID of the service network or service. * **serviceNetworkLogType** *(string) --* The log type for the service network. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / delete_rule delete_rule *********** VPCLattice.Client.delete_rule(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.delete_rule( listenerIdentifier='string', ruleIdentifier='string', serviceIdentifier='string' ) Parameters: * **listenerIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the listener. * **ruleIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the rule. * **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / create_access_log_subscription create_access_log_subscription ****************************** VPCLattice.Client.create_access_log_subscription(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.create_access_log_subscription( clientToken='string', destinationArn='string', resourceIdentifier='string', serviceNetworkLogType='SERVICE'|'RESOURCE', tags={ 'string': 'string' } ) Parameters: * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **destinationArn** (*string*) -- **[REQUIRED]** 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. * **resourceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service network or service. * **serviceNetworkLogType** (*string*) -- The type of log that monitors your Amazon VPC Lattice service networks. * **tags** (*dict*) -- The tags for the access log subscription. * *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with "aws:". * *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'destinationArn': 'string', 'id': 'string', 'resourceArn': 'string', 'resourceId': 'string', 'serviceNetworkLogType': 'SERVICE'|'RESOURCE' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the access log subscription. * **destinationArn** *(string) --* The Amazon Resource Name (ARN) of the log destination. * **id** *(string) --* The ID of the access log subscription. * **resourceArn** *(string) --* The Amazon Resource Name (ARN) of the service network or service. * **resourceId** *(string) --* The ID of the service network or service. * **serviceNetworkLogType** *(string) --* The type of log that monitors your Amazon VPC Lattice service networks. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / create_listener create_listener *************** VPCLattice.Client.create_listener(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.create_listener( clientToken='string', defaultAction={ 'fixedResponse': { 'statusCode': 123 }, 'forward': { 'targetGroups': [ { 'targetGroupIdentifier': 'string', 'weight': 123 }, ] } }, name='string', port=123, protocol='HTTP'|'HTTPS'|'TLS_PASSTHROUGH', serviceIdentifier='string', tags={ 'string': 'string' } ) Parameters: * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **defaultAction** (*dict*) -- **[REQUIRED]** The action for the default rule. Each listener has a default rule. The default rule is used if no other rules match. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixedResponse", "forward". * **fixedResponse** *(dict) --* The fixed response action. The rule returns a custom HTTP response. * **statusCode** *(integer) --* **[REQUIRED]** The HTTP response code. * **forward** *(dict) --* The forward action. Traffic that matches the rule is forwarded to the specified target groups. * **targetGroups** *(list) --* **[REQUIRED]** The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic. The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group. * *(dict) --* Describes the weight of a target group. * **targetGroupIdentifier** *(string) --* **[REQUIRED]** The ID or ARN of the target group. * **weight** *(integer) --* Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100. * **name** (*string*) -- **[REQUIRED]** 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. * **port** (*integer*) -- The listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443. * **protocol** (*string*) -- **[REQUIRED]** The listener protocol. * **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. * **tags** (*dict*) -- The tags for the listener. * *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with "aws:". * *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'defaultAction': { 'fixedResponse': { 'statusCode': 123 }, 'forward': { 'targetGroups': [ { 'targetGroupIdentifier': 'string', 'weight': 123 }, ] } }, 'id': 'string', 'name': 'string', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TLS_PASSTHROUGH', 'serviceArn': 'string', 'serviceId': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the listener. * **defaultAction** *(dict) --* The action for the default rule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixedResponse", "forward". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **fixedResponse** *(dict) --* The fixed response action. The rule returns a custom HTTP response. * **statusCode** *(integer) --* The HTTP response code. * **forward** *(dict) --* The forward action. Traffic that matches the rule is forwarded to the specified target groups. * **targetGroups** *(list) --* The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic. The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group. * *(dict) --* Describes the weight of a target group. * **targetGroupIdentifier** *(string) --* The ID or ARN of the target group. * **weight** *(integer) --* Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100. * **id** *(string) --* The ID of the listener. * **name** *(string) --* The name of the listener. * **port** *(integer) --* The port number of the listener. * **protocol** *(string) --* The protocol of the listener. * **serviceArn** *(string) --* The Amazon Resource Name (ARN) of the service. * **serviceId** *(string) --* The ID of the service. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / list_service_networks list_service_networks ********************* VPCLattice.Client.list_service_networks(**kwargs) Lists the service networks owned by or shared with this account. The account ID in the ARN shows which account owns the service network. See also: AWS API Documentation **Request Syntax** response = client.list_service_networks( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return. * **nextToken** (*string*) -- A pagination token for the next page of results. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'numberOfAssociatedResourceConfigurations': 123, 'numberOfAssociatedServices': 123, 'numberOfAssociatedVPCs': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the service networks. * *(dict) --* Summary information about a service network. * **arn** *(string) --* The Amazon Resource Name (ARN) of the service network. * **createdAt** *(datetime) --* The date and time that the service network was created, in ISO-8601 format. * **id** *(string) --* The ID of the service network. * **lastUpdatedAt** *(datetime) --* The date and time that the service network was last updated, in ISO-8601 format. * **name** *(string) --* The name of the service network. * **numberOfAssociatedResourceConfigurations** *(integer) --* The number of resource configurations associated with a service network. * **numberOfAssociatedServices** *(integer) --* The number of services associated with the service network. * **numberOfAssociatedVPCs** *(integer) --* The number of VPCs associated with the service network. * **nextToken** *(string) --* If there are additional results, a pagination token for the next page of results. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / update_service update_service ************** VPCLattice.Client.update_service(**kwargs) Updates the specified service. See also: AWS API Documentation **Request Syntax** response = client.update_service( authType='NONE'|'AWS_IAM', certificateArn='string', serviceIdentifier='string' ) Parameters: * **authType** (*string*) -- The type of IAM policy. * "NONE": The resource does not use an IAM policy. This is the default. * "AWS_IAM": The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required. * **certificateArn** (*string*) -- The Amazon Resource Name (ARN) of the certificate. * **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'authType': 'NONE'|'AWS_IAM', 'certificateArn': 'string', 'customDomainName': 'string', 'id': 'string', 'name': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the service. * **authType** *(string) --* The type of IAM policy. * **certificateArn** *(string) --* The Amazon Resource Name (ARN) of the certificate. * **customDomainName** *(string) --* The custom domain name of the service. * **id** *(string) --* The ID of the service. * **name** *(string) --* The name of the service. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / update_resource_gateway update_resource_gateway *********************** VPCLattice.Client.update_resource_gateway(**kwargs) Updates the specified resource gateway. See also: AWS API Documentation **Request Syntax** response = client.update_resource_gateway( resourceGatewayIdentifier='string', securityGroupIds=[ 'string', ] ) Parameters: * **resourceGatewayIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the resource gateway. * **securityGroupIds** (*list*) -- The IDs of the security groups associated with the resource gateway. * *(string) --* Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'id': 'string', 'ipAddressType': 'IPV4'|'IPV6', 'name': 'string', 'securityGroupIds': [ 'string', ], 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED', 'subnetIds': [ 'string', ], 'vpcId': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource gateway. * **id** *(string) --* The ID of the resource gateway. * **ipAddressType** *(string) --* The type of IP address used by the resource gateway. * **name** *(string) --* The name of the resource gateway. * **securityGroupIds** *(list) --* The IDs of the security groups associated with the resource gateway. * *(string) --* * **status** *(string) --* The status of the resource gateway. * **subnetIds** *(list) --* The IDs of the VPC subnets for the resource gateway. * *(string) --* * **vpcId** *(string) --* The ID of the VPC for the resource gateway. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / create_resource_gateway create_resource_gateway *********************** VPCLattice.Client.create_resource_gateway(**kwargs) Creates a resource gateway. See also: AWS API Documentation **Request Syntax** response = client.create_resource_gateway( clientToken='string', ipAddressType='IPV4'|'IPV6'|'DUALSTACK', name='string', securityGroupIds=[ 'string', ], subnetIds=[ 'string', ], tags={ 'string': 'string' }, vpcIdentifier='string' ) Parameters: * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **ipAddressType** (*string*) -- The type of IP address used by the resource gateway. * **name** (*string*) -- **[REQUIRED]** The name of the resource gateway. * **securityGroupIds** (*list*) -- The IDs of the security groups to apply to the resource gateway. The security groups must be in the same VPC. * *(string) --* * **subnetIds** (*list*) -- **[REQUIRED]** The IDs of the VPC subnets in which to create the resource gateway. * *(string) --* * **tags** (*dict*) -- The tags for the resource gateway. * *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with "aws:". * *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ * **vpcIdentifier** (*string*) -- **[REQUIRED]** The ID of the VPC for the resource gateway. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'id': 'string', 'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK', 'name': 'string', 'securityGroupIds': [ 'string', ], 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED', 'subnetIds': [ 'string', ], 'vpcIdentifier': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource gateway. * **id** *(string) --* The ID of the resource gateway. * **ipAddressType** *(string) --* The type of IP address for the resource gateway. * **name** *(string) --* The name of the resource gateway. * **securityGroupIds** *(list) --* The IDs of the security groups for the resource gateway. * *(string) --* * **status** *(string) --* The status of the resource gateway. * **subnetIds** *(list) --* The IDs of the resource gateway subnets. * *(string) --* * **vpcIdentifier** *(string) --* The ID of the VPC. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / list_targets list_targets ************ VPCLattice.Client.list_targets(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.list_targets( maxResults=123, nextToken='string', targetGroupIdentifier='string', targets=[ { 'id': 'string', 'port': 123 }, ] ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return. * **nextToken** (*string*) -- A pagination token for the next page of results. * **targetGroupIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the target group. * **targets** (*list*) -- The targets. * *(dict) --* Describes a target. * **id** *(string) --* **[REQUIRED]** The ID of the target. If the target group type is "INSTANCE", this is an instance ID. If the target group type is "IP", this is an IP address. If the target group type is "LAMBDA", this is the ARN of a Lambda function. If the target group type is "ALB", this is the ARN of an Application Load Balancer. * **port** *(integer) --* The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443. Return type: dict Returns: **Response Syntax** { 'items': [ { 'id': 'string', 'port': 123, 'reasonCode': 'string', 'status': 'DRAINING'|'UNAVAILABLE'|'HEALTHY'|'UNHEALTHY'|'INITIAL'|'UNUSED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the targets. * *(dict) --* Summary information about a target. * **id** *(string) --* The ID of the target. If the target group type is "INSTANCE", this is an instance ID. If the target group type is "IP", this is an IP address. If the target group type is "LAMBDA", this is the ARN of a Lambda function. If the target type is "ALB", this is the ARN of an Application Load Balancer. * **port** *(integer) --* The port on which the target is listening. * **reasonCode** *(string) --* The code for why the target status is what it is. * **status** *(string) --* The status of the target. * "DRAINING": The target is being deregistered. No new connections are sent to this target while current connections are being drained. The default draining time is 5 minutes. * "UNAVAILABLE": Health checks are unavailable for the target group. * "HEALTHY": The target is healthy. * "UNHEALTHY": The target is unhealthy. * "INITIAL": Initial health checks on the target are being performed. * "UNUSED": Target group is not used in a service. * **nextToken** *(string) --* If there are additional results, a pagination token for the next page of results. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / list_services list_services ************* VPCLattice.Client.list_services(**kwargs) Lists the services owned by the caller account or shared with the caller account. See also: AWS API Documentation **Request Syntax** response = client.list_services( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return. * **nextToken** (*string*) -- A pagination token for the next page of results. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'customDomainName': 'string', 'dnsEntry': { 'domainName': 'string', 'hostedZoneId': 'string' }, 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the services. * *(dict) --* Summary information about a service. * **arn** *(string) --* The Amazon Resource Name (ARN) of the service. * **createdAt** *(datetime) --* The date and time that the service was created, in ISO-8601 format. * **customDomainName** *(string) --* The custom domain name of the service. * **dnsEntry** *(dict) --* The DNS information. * **domainName** *(string) --* The domain name of the service. * **hostedZoneId** *(string) --* The ID of the hosted zone. * **id** *(string) --* The ID of the service. * **lastUpdatedAt** *(datetime) --* The date and time that the service was last updated, in ISO-8601 format. * **name** *(string) --* The name of the service. * **status** *(string) --* The status. * **nextToken** *(string) --* If there are additional results, a pagination token for the next page of results. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / get_resource_gateway get_resource_gateway ******************** VPCLattice.Client.get_resource_gateway(**kwargs) Retrieves information about the specified resource gateway. See also: AWS API Documentation **Request Syntax** response = client.get_resource_gateway( resourceGatewayIdentifier='string' ) Parameters: **resourceGatewayIdentifier** (*string*) -- **[REQUIRED]** The ID of the resource gateway. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'securityGroupIds': [ 'string', ], 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED', 'subnetIds': [ 'string', ], 'vpcId': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource gateway. * **createdAt** *(datetime) --* The date and time that the resource gateway was created, in ISO-8601 format. * **id** *(string) --* The ID of the resource gateway. * **ipAddressType** *(string) --* The type of IP address for the resource gateway. * **lastUpdatedAt** *(datetime) --* The date and time that the resource gateway was last updated, in ISO-8601 format. * **name** *(string) --* The name of the resource gateway. * **securityGroupIds** *(list) --* The security group IDs associated with the resource gateway. * *(string) --* * **status** *(string) --* The status for the resource gateway. * **subnetIds** *(list) --* The IDs of the VPC subnets for resource gateway. * *(string) --* * **vpcId** *(string) --* The ID of the VPC for the resource gateway. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / delete_service delete_service ************** VPCLattice.Client.delete_service(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.delete_service( serviceIdentifier='string' ) Parameters: **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'id': 'string', 'name': 'string', 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the service. * **id** *(string) --* The ID of the service. * **name** *(string) --* The name of the service. * **status** *(string) --* The status. You can retry the operation if the status is "DELETE_FAILED". However, if you retry it while the status is "DELETE_IN_PROGRESS", the status doesn't change. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / update_target_group update_target_group ******************* VPCLattice.Client.update_target_group(**kwargs) Updates the specified target group. See also: AWS API Documentation **Request Syntax** response = client.update_target_group( healthCheck={ 'enabled': True|False, 'healthCheckIntervalSeconds': 123, 'healthCheckTimeoutSeconds': 123, 'healthyThresholdCount': 123, 'matcher': { 'httpCode': 'string' }, 'path': 'string', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TCP', 'protocolVersion': 'HTTP1'|'HTTP2', 'unhealthyThresholdCount': 123 }, targetGroupIdentifier='string' ) Parameters: * **healthCheck** (*dict*) -- **[REQUIRED]** The health check configuration. * **enabled** *(boolean) --* Indicates whether health checking is enabled. * **healthCheckIntervalSeconds** *(integer) --* The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds. * **healthCheckTimeoutSeconds** *(integer) --* The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds. * **healthyThresholdCount** *(integer) --* The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5. * **matcher** *(dict) --* The codes to use when checking for a successful response from a target. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "httpCode". * **httpCode** *(string) --* The HTTP code to use when checking for a successful response from a target. * **path** *(string) --* The destination for health checks on the targets. If the protocol version is "HTTP/1.1" or "HTTP/2", specify a valid URI (for example, "/path?query"). The default path is "/". Health checks are not supported if the protocol version is "gRPC", however, you can choose "HTTP/1.1" or "HTTP/2" and specify a valid URI. * **port** *(integer) --* The port used when performing health checks on targets. The default setting is the port that a target receives traffic on. * **protocol** *(string) --* The protocol used when performing health checks on targets. The possible protocols are "HTTP" and "HTTPS". The default is "HTTP". * **protocolVersion** *(string) --* The protocol version used when performing health checks on targets. The possible protocol versions are "HTTP1" and "HTTP2". * **unhealthyThresholdCount** *(integer) --* The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2. * **targetGroupIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the target group. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'config': { 'healthCheck': { 'enabled': True|False, 'healthCheckIntervalSeconds': 123, 'healthCheckTimeoutSeconds': 123, 'healthyThresholdCount': 123, 'matcher': { 'httpCode': 'string' }, 'path': 'string', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TCP', 'protocolVersion': 'HTTP1'|'HTTP2', 'unhealthyThresholdCount': 123 }, 'ipAddressType': 'IPV4'|'IPV6', 'lambdaEventStructureVersion': 'V1'|'V2', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TCP', 'protocolVersion': 'HTTP1'|'HTTP2'|'GRPC', 'vpcIdentifier': 'string' }, 'id': 'string', 'name': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED', 'type': 'IP'|'LAMBDA'|'INSTANCE'|'ALB' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the target group. * **config** *(dict) --* The target group configuration. * **healthCheck** *(dict) --* The health check configuration. Not supported if the target group type is "LAMBDA" or "ALB". * **enabled** *(boolean) --* Indicates whether health checking is enabled. * **healthCheckIntervalSeconds** *(integer) --* The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds. * **healthCheckTimeoutSeconds** *(integer) --* The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds. * **healthyThresholdCount** *(integer) --* The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5. * **matcher** *(dict) --* The codes to use when checking for a successful response from a target. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "httpCode". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **httpCode** *(string) --* The HTTP code to use when checking for a successful response from a target. * **path** *(string) --* The destination for health checks on the targets. If the protocol version is "HTTP/1.1" or "HTTP/2", specify a valid URI (for example, "/path?query"). The default path is "/". Health checks are not supported if the protocol version is "gRPC", however, you can choose "HTTP/1.1" or "HTTP/2" and specify a valid URI. * **port** *(integer) --* The port used when performing health checks on targets. The default setting is the port that a target receives traffic on. * **protocol** *(string) --* The protocol used when performing health checks on targets. The possible protocols are "HTTP" and "HTTPS". The default is "HTTP". * **protocolVersion** *(string) --* The protocol version used when performing health checks on targets. The possible protocol versions are "HTTP1" and "HTTP2". * **unhealthyThresholdCount** *(integer) --* The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2. * **ipAddressType** *(string) --* The type of IP address used for the target group. Supported only if the target group type is "IP". The default is "IPV4". * **lambdaEventStructureVersion** *(string) --* The version of the event structure that your Lambda function receives. Supported only if the target group type is "LAMBDA". The default is "V1". * **port** *(integer) --* The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is "LAMBDA". * **protocol** *(string) --* The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is "LAMBDA". * **protocolVersion** *(string) --* The protocol version. The default is "HTTP1". Not supported if the target group type is "LAMBDA". * **vpcIdentifier** *(string) --* The ID of the VPC. Not supported if the target group type is "LAMBDA". * **id** *(string) --* The ID of the target group. * **name** *(string) --* The name of the target group. * **status** *(string) --* The status. * **type** *(string) --* The target group type. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / list_tags_for_resource list_tags_for_resource ********************** VPCLattice.Client.list_tags_for_resource(**kwargs) Lists the tags for the specified resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* Information about the tags. * *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with "aws:". * *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / get_service_network_service_association get_service_network_service_association *************************************** VPCLattice.Client.get_service_network_service_association(**kwargs) Retrieves information about the specified association between a service network and a service. See also: AWS API Documentation **Request Syntax** response = client.get_service_network_service_association( serviceNetworkServiceAssociationIdentifier='string' ) Parameters: **serviceNetworkServiceAssociationIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the association. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'customDomainName': 'string', 'dnsEntry': { 'domainName': 'string', 'hostedZoneId': 'string' }, 'failureCode': 'string', 'failureMessage': 'string', 'id': 'string', 'serviceArn': 'string', 'serviceId': 'string', 'serviceName': 'string', 'serviceNetworkArn': 'string', 'serviceNetworkId': 'string', 'serviceNetworkName': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **createdAt** *(datetime) --* The date and time that the association was created, in ISO-8601 format. * **createdBy** *(string) --* The account that created the association. * **customDomainName** *(string) --* The custom domain name of the service. * **dnsEntry** *(dict) --* The DNS name of the service. * **domainName** *(string) --* The domain name of the service. * **hostedZoneId** *(string) --* The ID of the hosted zone. * **failureCode** *(string) --* The failure code. * **failureMessage** *(string) --* The failure message. * **id** *(string) --* The ID of the service network and service association. * **serviceArn** *(string) --* The Amazon Resource Name (ARN) of the service. * **serviceId** *(string) --* The ID of the service. * **serviceName** *(string) --* The name of the service. * **serviceNetworkArn** *(string) --* The Amazon Resource Name (ARN) of the service network. * **serviceNetworkId** *(string) --* The ID of the service network. * **serviceNetworkName** *(string) --* The name of the service network. * **status** *(string) --* The status of the association. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / create_resource_configuration create_resource_configuration ***************************** VPCLattice.Client.create_resource_configuration(**kwargs) Creates a resource configuration. A resource configuration defines a specific resource. You can associate a resource configuration with a service network or a VPC endpoint. See also: AWS API Documentation **Request Syntax** response = client.create_resource_configuration( allowAssociationToShareableServiceNetwork=True|False, clientToken='string', name='string', portRanges=[ 'string', ], protocol='TCP', resourceConfigurationDefinition={ 'arnResource': { 'arn': 'string' }, 'dnsResource': { 'domainName': 'string', 'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK' }, 'ipResource': { 'ipAddress': 'string' } }, resourceConfigurationGroupIdentifier='string', resourceGatewayIdentifier='string', tags={ 'string': 'string' }, type='GROUP'|'CHILD'|'SINGLE'|'ARN' ) Parameters: * **allowAssociationToShareableServiceNetwork** (*boolean*) -- (SINGLE, GROUP, ARN) Specifies whether the resource configuration can be associated with a sharable service network. The default is false. * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **name** (*string*) -- **[REQUIRED]** The name of the resource configuration. The name must be unique within the account. 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. * **portRanges** (*list*) -- (SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration (for example: 1-65535). You can separate port ranges using commas (for example: 1,2,22-30). * *(string) --* * **protocol** (*string*) -- (SINGLE, GROUP) The protocol accepted by the resource configuration. * **resourceConfigurationDefinition** (*dict*) -- (SINGLE, CHILD, ARN) The resource configuration. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "arnResource", "dnsResource", "ipResource". * **arnResource** *(dict) --* The Amazon Resource Name (ARN) of the resource. * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **dnsResource** *(dict) --* The DNS name of the resource. * **domainName** *(string) --* The domain name of the resource. * **ipAddressType** *(string) --* The type of IP address. * **ipResource** *(dict) --* The IP resource. * **ipAddress** *(string) --* The IP address of the IP resource. * **resourceConfigurationGroupIdentifier** (*string*) -- (CHILD) The ID or ARN of the parent resource configuration (type is "GROUP"). This is used to associate a child resource configuration with a group resource configuration. * **resourceGatewayIdentifier** (*string*) -- (SINGLE, GROUP, ARN) The ID or ARN of the resource gateway used to connect to the resource configuration. For a child resource configuration, this value is inherited from the parent resource configuration. * **tags** (*dict*) -- The tags for the resource configuration. * *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with "aws:". * *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ * **type** (*string*) -- **[REQUIRED]** The type of resource configuration. * "SINGLE" - A single resource. * "GROUP" - A group of resources. You must create a group resource configuration before you create a child resource configuration. * "CHILD" - A single resource that is part of a group resource configuration. * "ARN" - An Amazon Web Services resource. Return type: dict Returns: **Response Syntax** { 'allowAssociationToShareableServiceNetwork': True|False, 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'failureReason': 'string', 'id': 'string', 'name': 'string', 'portRanges': [ 'string', ], 'protocol': 'TCP', 'resourceConfigurationDefinition': { 'arnResource': { 'arn': 'string' }, 'dnsResource': { 'domainName': 'string', 'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK' }, 'ipResource': { 'ipAddress': 'string' } }, 'resourceConfigurationGroupId': 'string', 'resourceGatewayId': 'string', 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED', 'type': 'GROUP'|'CHILD'|'SINGLE'|'ARN' } **Response Structure** * *(dict) --* * **allowAssociationToShareableServiceNetwork** *(boolean) --* Specifies whether the resource configuration can be associated with a sharable service network. * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource configuration. * **createdAt** *(datetime) --* The date and time that the resource configuration was created, in ISO-8601 format. * **failureReason** *(string) --* The reason that the request failed. * **id** *(string) --* The ID of the resource configuration. * **name** *(string) --* The name of the resource configuration. * **portRanges** *(list) --* The port range. * *(string) --* * **protocol** *(string) --* The protocol. * **resourceConfigurationDefinition** *(dict) --* The resource configuration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "arnResource", "dnsResource", "ipResource". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **arnResource** *(dict) --* The Amazon Resource Name (ARN) of the resource. * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **dnsResource** *(dict) --* The DNS name of the resource. * **domainName** *(string) --* The domain name of the resource. * **ipAddressType** *(string) --* The type of IP address. * **ipResource** *(dict) --* The IP resource. * **ipAddress** *(string) --* The IP address of the IP resource. * **resourceConfigurationGroupId** *(string) --* The ID of the parent resource configuration (type is GROUP). * **resourceGatewayId** *(string) --* The ID of the resource gateway associated with the resource configuration. * **status** *(string) --* The current status of the resource configuration. * **type** *(string) --* The type of resource configuration. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / create_service create_service ************** VPCLattice.Client.create_service(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.create_service( authType='NONE'|'AWS_IAM', certificateArn='string', clientToken='string', customDomainName='string', name='string', tags={ 'string': 'string' } ) Parameters: * **authType** (*string*) -- The type of IAM policy. * "NONE": The resource does not use an IAM policy. This is the default. * "AWS_IAM": The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required. * **certificateArn** (*string*) -- The Amazon Resource Name (ARN) of the certificate. * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **customDomainName** (*string*) -- The custom domain name of the service. * **name** (*string*) -- **[REQUIRED]** The name of the service. The name must be unique within the account. 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. * **tags** (*dict*) -- The tags for the service. * *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with "aws:". * *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'authType': 'NONE'|'AWS_IAM', 'certificateArn': 'string', 'customDomainName': 'string', 'dnsEntry': { 'domainName': 'string', 'hostedZoneId': 'string' }, 'id': 'string', 'name': 'string', 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the service. * **authType** *(string) --* The type of IAM policy. * **certificateArn** *(string) --* The Amazon Resource Name (ARN) of the certificate. * **customDomainName** *(string) --* The custom domain name of the service. * **dnsEntry** *(dict) --* The public DNS name of the service. * **domainName** *(string) --* The domain name of the service. * **hostedZoneId** *(string) --* The ID of the hosted zone. * **id** *(string) --* The ID of the service. * **name** *(string) --* The name of the service. * **status** *(string) --* The status. If the status is "CREATE_FAILED", you must delete and recreate the service. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / get_rule get_rule ******** VPCLattice.Client.get_rule(**kwargs) Retrieves information about the specified 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*. See also: AWS API Documentation **Request Syntax** response = client.get_rule( listenerIdentifier='string', ruleIdentifier='string', serviceIdentifier='string' ) Parameters: * **listenerIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the listener. * **ruleIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the listener rule. * **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. Return type: dict Returns: **Response Syntax** { 'action': { 'fixedResponse': { 'statusCode': 123 }, 'forward': { 'targetGroups': [ { 'targetGroupIdentifier': 'string', 'weight': 123 }, ] } }, 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'isDefault': True|False, 'lastUpdatedAt': datetime(2015, 1, 1), 'match': { 'httpMatch': { 'headerMatches': [ { 'caseSensitive': True|False, 'match': { 'contains': 'string', 'exact': 'string', 'prefix': 'string' }, 'name': 'string' }, ], 'method': 'string', 'pathMatch': { 'caseSensitive': True|False, 'match': { 'exact': 'string', 'prefix': 'string' } } } }, 'name': 'string', 'priority': 123 } **Response Structure** * *(dict) --* * **action** *(dict) --* The action for the default rule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixedResponse", "forward". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **fixedResponse** *(dict) --* The fixed response action. The rule returns a custom HTTP response. * **statusCode** *(integer) --* The HTTP response code. * **forward** *(dict) --* The forward action. Traffic that matches the rule is forwarded to the specified target groups. * **targetGroups** *(list) --* The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic. The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group. * *(dict) --* Describes the weight of a target group. * **targetGroupIdentifier** *(string) --* The ID or ARN of the target group. * **weight** *(integer) --* Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100. * **arn** *(string) --* The Amazon Resource Name (ARN) of the listener. * **createdAt** *(datetime) --* The date and time that the listener rule was created, in ISO-8601 format. * **id** *(string) --* The ID of the listener. * **isDefault** *(boolean) --* Indicates whether this is the default rule. * **lastUpdatedAt** *(datetime) --* The date and time that the listener rule was last updated, in ISO-8601 format. * **match** *(dict) --* The rule match. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "httpMatch". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **httpMatch** *(dict) --* The HTTP criteria that a rule must match. * **headerMatches** *(list) --* The header matches. Matches incoming requests with rule based on request header value before applying rule action. * *(dict) --* Describes the constraints for a header match. Matches incoming requests with rule based on request header value before applying rule action. * **caseSensitive** *(boolean) --* Indicates whether the match is case sensitive. * **match** *(dict) --* The header match type. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "contains", "exact", "prefix". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **contains** *(string) --* A contains type match. * **exact** *(string) --* An exact type match. * **prefix** *(string) --* A prefix type match. Matches the value with the prefix. * **name** *(string) --* The name of the header. * **method** *(string) --* The HTTP method type. * **pathMatch** *(dict) --* The path match. * **caseSensitive** *(boolean) --* Indicates whether the match is case sensitive. * **match** *(dict) --* The type of path match. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "exact", "prefix". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **exact** *(string) --* An exact match of the path. * **prefix** *(string) --* A prefix match of the path. * **name** *(string) --* The name of the listener. * **priority** *(integer) --* The priority level for the specified rule. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / delete_resource_gateway delete_resource_gateway *********************** VPCLattice.Client.delete_resource_gateway(**kwargs) Deletes the specified resource gateway. See also: AWS API Documentation **Request Syntax** response = client.delete_resource_gateway( resourceGatewayIdentifier='string' ) Parameters: **resourceGatewayIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the resource gateway. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'id': 'string', 'name': 'string', 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource gateway. * **id** *(string) --* The ID of the resource gateway. * **name** *(string) --* The name of the resource gateway. * **status** *(string) --* The status of the resource gateway. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / untag_resource untag_resource ************** VPCLattice.Client.untag_resource(**kwargs) Removes the specified tags from the specified resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. * **tagKeys** (*list*) -- **[REQUIRED]** The tag keys of the tags to remove. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / update_service_network_vpc_association update_service_network_vpc_association ************************************** VPCLattice.Client.update_service_network_vpc_association(**kwargs) 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 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 then recreate it without security groups. See also: AWS API Documentation **Request Syntax** response = client.update_service_network_vpc_association( securityGroupIds=[ 'string', ], serviceNetworkVpcAssociationIdentifier='string' ) Parameters: * **securityGroupIds** (*list*) -- **[REQUIRED]** The IDs of the security groups. * *(string) --* * **serviceNetworkVpcAssociationIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the association. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'createdBy': 'string', 'id': 'string', 'securityGroupIds': [ 'string', ], 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED'|'UPDATE_FAILED' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **createdBy** *(string) --* The account that created the association. * **id** *(string) --* The ID of the association. * **securityGroupIds** *(list) --* The IDs of the security groups. * *(string) --* * **status** *(string) --* The status. You can retry the operation if the status is "DELETE_FAILED". However, if you retry it while the status is "DELETE_IN_PROGRESS", there is no change in the status. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / update_access_log_subscription update_access_log_subscription ****************************** VPCLattice.Client.update_access_log_subscription(**kwargs) Updates the specified access log subscription. See also: AWS API Documentation **Request Syntax** response = client.update_access_log_subscription( accessLogSubscriptionIdentifier='string', destinationArn='string' ) Parameters: * **accessLogSubscriptionIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the access log subscription. * **destinationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the access log destination. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'destinationArn': 'string', 'id': 'string', 'resourceArn': 'string', 'resourceId': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the access log subscription. * **destinationArn** *(string) --* The Amazon Resource Name (ARN) of the access log destination. * **id** *(string) --* The ID of the access log subscription. * **resourceArn** *(string) --* The Amazon Resource Name (ARN) of the access log subscription. * **resourceId** *(string) --* The ID of the resource. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / get_waiter get_waiter ********** VPCLattice.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" VPCLattice / Client / list_service_network_service_associations list_service_network_service_associations ***************************************** VPCLattice.Client.list_service_network_service_associations(**kwargs) Lists the associations between a service network and a 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 has 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 is shared with another account, the association includes the local account ID as the prefix in the ARN. See also: AWS API Documentation **Request Syntax** response = client.list_service_network_service_associations( maxResults=123, nextToken='string', serviceIdentifier='string', serviceNetworkIdentifier='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return. * **nextToken** (*string*) -- A pagination token for the next page of results. * **serviceIdentifier** (*string*) -- The ID or ARN of the service. * **serviceNetworkIdentifier** (*string*) -- The ID or ARN of the service network. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'customDomainName': 'string', 'dnsEntry': { 'domainName': 'string', 'hostedZoneId': 'string' }, 'id': 'string', 'serviceArn': 'string', 'serviceId': 'string', 'serviceName': 'string', 'serviceNetworkArn': 'string', 'serviceNetworkId': 'string', 'serviceNetworkName': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the associations. * *(dict) --* Summary information about an association between a service network and a service. * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **createdAt** *(datetime) --* The date and time that the association was created, in ISO-8601 format. * **createdBy** *(string) --* The account that created the association. * **customDomainName** *(string) --* The custom domain name of the service. * **dnsEntry** *(dict) --* The DNS information. * **domainName** *(string) --* The domain name of the service. * **hostedZoneId** *(string) --* The ID of the hosted zone. * **id** *(string) --* The ID of the association. * **serviceArn** *(string) --* The Amazon Resource Name (ARN) of the service. * **serviceId** *(string) --* The ID of the service. * **serviceName** *(string) --* The name of the service. * **serviceNetworkArn** *(string) --* The Amazon Resource Name (ARN) of the service network. * **serviceNetworkId** *(string) --* The ID of the service network. * **serviceNetworkName** *(string) --* The name of the service network. * **status** *(string) --* The status. If the deletion fails, try to delete again. * **nextToken** *(string) --* If there are additional results, a pagination token for the next page of results. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / update_rule update_rule *********** VPCLattice.Client.update_rule(**kwargs) Updates a specified rule for the listener. You can't modify a default listener rule. To modify a default listener rule, use "UpdateListener". See also: AWS API Documentation **Request Syntax** response = client.update_rule( action={ 'fixedResponse': { 'statusCode': 123 }, 'forward': { 'targetGroups': [ { 'targetGroupIdentifier': 'string', 'weight': 123 }, ] } }, listenerIdentifier='string', match={ 'httpMatch': { 'headerMatches': [ { 'caseSensitive': True|False, 'match': { 'contains': 'string', 'exact': 'string', 'prefix': 'string' }, 'name': 'string' }, ], 'method': 'string', 'pathMatch': { 'caseSensitive': True|False, 'match': { 'exact': 'string', 'prefix': 'string' } } } }, priority=123, ruleIdentifier='string', serviceIdentifier='string' ) Parameters: * **action** (*dict*) -- Information about the action for the specified listener rule. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixedResponse", "forward". * **fixedResponse** *(dict) --* The fixed response action. The rule returns a custom HTTP response. * **statusCode** *(integer) --* **[REQUIRED]** The HTTP response code. * **forward** *(dict) --* The forward action. Traffic that matches the rule is forwarded to the specified target groups. * **targetGroups** *(list) --* **[REQUIRED]** The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic. The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group. * *(dict) --* Describes the weight of a target group. * **targetGroupIdentifier** *(string) --* **[REQUIRED]** The ID or ARN of the target group. * **weight** *(integer) --* Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100. * **listenerIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the listener. * **match** (*dict*) -- The rule match. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "httpMatch". * **httpMatch** *(dict) --* The HTTP criteria that a rule must match. * **headerMatches** *(list) --* The header matches. Matches incoming requests with rule based on request header value before applying rule action. * *(dict) --* Describes the constraints for a header match. Matches incoming requests with rule based on request header value before applying rule action. * **caseSensitive** *(boolean) --* Indicates whether the match is case sensitive. * **match** *(dict) --* **[REQUIRED]** The header match type. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "contains", "exact", "prefix". * **contains** *(string) --* A contains type match. * **exact** *(string) --* An exact type match. * **prefix** *(string) --* A prefix type match. Matches the value with the prefix. * **name** *(string) --* **[REQUIRED]** The name of the header. * **method** *(string) --* The HTTP method type. * **pathMatch** *(dict) --* The path match. * **caseSensitive** *(boolean) --* Indicates whether the match is case sensitive. * **match** *(dict) --* **[REQUIRED]** The type of path match. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "exact", "prefix". * **exact** *(string) --* An exact match of the path. * **prefix** *(string) --* A prefix match of the path. * **priority** (*integer*) -- The rule priority. A listener can't have multiple rules with the same priority. * **ruleIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the rule. * **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. Return type: dict Returns: **Response Syntax** { 'action': { 'fixedResponse': { 'statusCode': 123 }, 'forward': { 'targetGroups': [ { 'targetGroupIdentifier': 'string', 'weight': 123 }, ] } }, 'arn': 'string', 'id': 'string', 'isDefault': True|False, 'match': { 'httpMatch': { 'headerMatches': [ { 'caseSensitive': True|False, 'match': { 'contains': 'string', 'exact': 'string', 'prefix': 'string' }, 'name': 'string' }, ], 'method': 'string', 'pathMatch': { 'caseSensitive': True|False, 'match': { 'exact': 'string', 'prefix': 'string' } } } }, 'name': 'string', 'priority': 123 } **Response Structure** * *(dict) --* * **action** *(dict) --* Information about the action for the specified listener rule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixedResponse", "forward". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **fixedResponse** *(dict) --* The fixed response action. The rule returns a custom HTTP response. * **statusCode** *(integer) --* The HTTP response code. * **forward** *(dict) --* The forward action. Traffic that matches the rule is forwarded to the specified target groups. * **targetGroups** *(list) --* The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic. The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group. * *(dict) --* Describes the weight of a target group. * **targetGroupIdentifier** *(string) --* The ID or ARN of the target group. * **weight** *(integer) --* Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100. * **arn** *(string) --* The Amazon Resource Name (ARN) of the listener. * **id** *(string) --* The ID of the listener. * **isDefault** *(boolean) --* Indicates whether this is the default rule. * **match** *(dict) --* The rule match. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "httpMatch". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **httpMatch** *(dict) --* The HTTP criteria that a rule must match. * **headerMatches** *(list) --* The header matches. Matches incoming requests with rule based on request header value before applying rule action. * *(dict) --* Describes the constraints for a header match. Matches incoming requests with rule based on request header value before applying rule action. * **caseSensitive** *(boolean) --* Indicates whether the match is case sensitive. * **match** *(dict) --* The header match type. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "contains", "exact", "prefix". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **contains** *(string) --* A contains type match. * **exact** *(string) --* An exact type match. * **prefix** *(string) --* A prefix type match. Matches the value with the prefix. * **name** *(string) --* The name of the header. * **method** *(string) --* The HTTP method type. * **pathMatch** *(dict) --* The path match. * **caseSensitive** *(boolean) --* Indicates whether the match is case sensitive. * **match** *(dict) --* The type of path match. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "exact", "prefix". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **exact** *(string) --* An exact match of the path. * **prefix** *(string) --* A prefix match of the path. * **name** *(string) --* The name of the listener. * **priority** *(integer) --* The rule priority. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / batch_update_rule batch_update_rule ***************** VPCLattice.Client.batch_update_rule(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.batch_update_rule( listenerIdentifier='string', rules=[ { 'action': { 'fixedResponse': { 'statusCode': 123 }, 'forward': { 'targetGroups': [ { 'targetGroupIdentifier': 'string', 'weight': 123 }, ] } }, 'match': { 'httpMatch': { 'headerMatches': [ { 'caseSensitive': True|False, 'match': { 'contains': 'string', 'exact': 'string', 'prefix': 'string' }, 'name': 'string' }, ], 'method': 'string', 'pathMatch': { 'caseSensitive': True|False, 'match': { 'exact': 'string', 'prefix': 'string' } } } }, 'priority': 123, 'ruleIdentifier': 'string' }, ], serviceIdentifier='string' ) Parameters: * **listenerIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the listener. * **rules** (*list*) -- **[REQUIRED]** The rules for the specified listener. * *(dict) --* Describes a rule update. * **action** *(dict) --* The rule action. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fixedResponse", "forward". * **fixedResponse** *(dict) --* The fixed response action. The rule returns a custom HTTP response. * **statusCode** *(integer) --* **[REQUIRED]** The HTTP response code. * **forward** *(dict) --* The forward action. Traffic that matches the rule is forwarded to the specified target groups. * **targetGroups** *(list) --* **[REQUIRED]** The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic. The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group. * *(dict) --* Describes the weight of a target group. * **targetGroupIdentifier** *(string) --* **[REQUIRED]** The ID or ARN of the target group. * **weight** *(integer) --* Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100. * **match** *(dict) --* The rule match. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "httpMatch". * **httpMatch** *(dict) --* The HTTP criteria that a rule must match. * **headerMatches** *(list) --* The header matches. Matches incoming requests with rule based on request header value before applying rule action. * *(dict) --* Describes the constraints for a header match. Matches incoming requests with rule based on request header value before applying rule action. * **caseSensitive** *(boolean) --* Indicates whether the match is case sensitive. * **match** *(dict) --* **[REQUIRED]** The header match type. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "contains", "exact", "prefix". * **contains** *(string) --* A contains type match. * **exact** *(string) --* An exact type match. * **prefix** *(string) --* A prefix type match. Matches the value with the prefix. * **name** *(string) --* **[REQUIRED]** The name of the header. * **method** *(string) --* The HTTP method type. * **pathMatch** *(dict) --* The path match. * **caseSensitive** *(boolean) --* Indicates whether the match is case sensitive. * **match** *(dict) --* **[REQUIRED]** The type of path match. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "exact", "prefix". * **exact** *(string) --* An exact match of the path. * **prefix** *(string) --* A prefix match of the path. * **priority** *(integer) --* The rule priority. A listener can't have multiple rules with the same priority. * **ruleIdentifier** *(string) --* **[REQUIRED]** The ID or ARN of the rule. * **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. Return type: dict Returns: **Response Syntax** { 'successful': [ { 'action': { 'fixedResponse': { 'statusCode': 123 }, 'forward': { 'targetGroups': [ { 'targetGroupIdentifier': 'string', 'weight': 123 }, ] } }, 'arn': 'string', 'id': 'string', 'isDefault': True|False, 'match': { 'httpMatch': { 'headerMatches': [ { 'caseSensitive': True|False, 'match': { 'contains': 'string', 'exact': 'string', 'prefix': 'string' }, 'name': 'string' }, ], 'method': 'string', 'pathMatch': { 'caseSensitive': True|False, 'match': { 'exact': 'string', 'prefix': 'string' } } } }, 'name': 'string', 'priority': 123 }, ], 'unsuccessful': [ { 'failureCode': 'string', 'failureMessage': 'string', 'ruleIdentifier': 'string' }, ] } **Response Structure** * *(dict) --* * **successful** *(list) --* The rules that were successfully updated. * *(dict) --* Describes a successful rule update. * **action** *(dict) --* The action for the rule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixedResponse", "forward". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **fixedResponse** *(dict) --* The fixed response action. The rule returns a custom HTTP response. * **statusCode** *(integer) --* The HTTP response code. * **forward** *(dict) --* The forward action. Traffic that matches the rule is forwarded to the specified target groups. * **targetGroups** *(list) --* The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic. The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group. * *(dict) --* Describes the weight of a target group. * **targetGroupIdentifier** *(string) --* The ID or ARN of the target group. * **weight** *(integer) --* Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100. * **arn** *(string) --* The Amazon Resource Name (ARN) of the listener. * **id** *(string) --* The ID of the listener. * **isDefault** *(boolean) --* Indicates whether this is the default rule. * **match** *(dict) --* The rule match. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "httpMatch". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **httpMatch** *(dict) --* The HTTP criteria that a rule must match. * **headerMatches** *(list) --* The header matches. Matches incoming requests with rule based on request header value before applying rule action. * *(dict) --* Describes the constraints for a header match. Matches incoming requests with rule based on request header value before applying rule action. * **caseSensitive** *(boolean) --* Indicates whether the match is case sensitive. * **match** *(dict) --* The header match type. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "contains", "exact", "prefix". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **contains** *(string) --* A contains type match. * **exact** *(string) --* An exact type match. * **prefix** *(string) --* A prefix type match. Matches the value with the prefix. * **name** *(string) --* The name of the header. * **method** *(string) --* The HTTP method type. * **pathMatch** *(dict) --* The path match. * **caseSensitive** *(boolean) --* Indicates whether the match is case sensitive. * **match** *(dict) --* The type of path match. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "exact", "prefix". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **exact** *(string) --* An exact match of the path. * **prefix** *(string) --* A prefix match of the path. * **name** *(string) --* The name of the listener. * **priority** *(integer) --* The rule priority. * **unsuccessful** *(list) --* The rules that the operation couldn't update. * *(dict) --* Describes a rule update that failed. * **failureCode** *(string) --* The failure code. * **failureMessage** *(string) --* The failure message. * **ruleIdentifier** *(string) --* The ID or ARN of the rule. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / delete_resource_configuration delete_resource_configuration ***************************** VPCLattice.Client.delete_resource_configuration(**kwargs) Deletes the specified resource configuration. See also: AWS API Documentation **Request Syntax** response = client.delete_resource_configuration( resourceConfigurationIdentifier='string' ) Parameters: **resourceConfigurationIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the resource configuration. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / create_service_network_service_association create_service_network_service_association ****************************************** VPCLattice.Client.create_service_network_service_association(**kwargs) Associates the specified service with the specified 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. See also: AWS API Documentation **Request Syntax** response = client.create_service_network_service_association( clientToken='string', serviceIdentifier='string', serviceNetworkIdentifier='string', tags={ 'string': 'string' } ) Parameters: * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. * **serviceNetworkIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service network. You must use an ARN if the resources are in different accounts. * **tags** (*dict*) -- The tags for the association. * *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with "aws:". * *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'createdBy': 'string', 'customDomainName': 'string', 'dnsEntry': { 'domainName': 'string', 'hostedZoneId': 'string' }, 'id': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **createdBy** *(string) --* The account that created the association. * **customDomainName** *(string) --* The custom domain name of the service. * **dnsEntry** *(dict) --* The DNS name of the service. * **domainName** *(string) --* The domain name of the service. * **hostedZoneId** *(string) --* The ID of the hosted zone. * **id** *(string) --* The ID of the association. * **status** *(string) --* The association status. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / list_resource_configurations list_resource_configurations **************************** VPCLattice.Client.list_resource_configurations(**kwargs) Lists the resource configurations owned by or shared with this account. See also: AWS API Documentation **Request Syntax** response = client.list_resource_configurations( maxResults=123, nextToken='string', resourceConfigurationGroupIdentifier='string', resourceGatewayIdentifier='string' ) Parameters: * **maxResults** (*integer*) -- The maximum page size. * **nextToken** (*string*) -- A pagination token for the next page of results. * **resourceConfigurationGroupIdentifier** (*string*) -- The ID of the group resource configuration. * **resourceGatewayIdentifier** (*string*) -- The ID of the resource gateway for the resource configuration. Return type: dict Returns: **Response Syntax** { 'items': [ { 'amazonManaged': True|False, 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'resourceConfigurationGroupId': 'string', 'resourceGatewayId': 'string', 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED', 'type': 'GROUP'|'CHILD'|'SINGLE'|'ARN' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the resource configurations. * *(dict) --* Summary information about a resource configuration. * **amazonManaged** *(boolean) --* Indicates whether the resource configuration was created and is managed by Amazon. * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource configuration. * **createdAt** *(datetime) --* The date and time that the resource configuration was created, in ISO-8601 format. * **id** *(string) --* The ID of the resource configuration. * **lastUpdatedAt** *(datetime) --* The most recent date and time that the resource configuration was updated, in ISO-8601 format. * **name** *(string) --* The name of the resource configuration. * **resourceConfigurationGroupId** *(string) --* The ID of the group resource configuration. * **resourceGatewayId** *(string) --* The ID of the resource gateway. * **status** *(string) --* The status of the resource configuration. * **type** *(string) --* The type of resource configuration. * "SINGLE" - A single resource. * "GROUP" - A group of resources. * "CHILD" - A single resource that is part of a group resource configuration. * "ARN" - An Amazon Web Services resource. * **nextToken** *(string) --* If there are additional results, a pagination token for the next page of results. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / create_service_network create_service_network ********************** VPCLattice.Client.create_service_network(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.create_service_network( authType='NONE'|'AWS_IAM', clientToken='string', name='string', sharingConfig={ 'enabled': True|False }, tags={ 'string': 'string' } ) Parameters: * **authType** (*string*) -- The type of IAM policy. * "NONE": The resource does not use an IAM policy. This is the default. * "AWS_IAM": The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required. * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **name** (*string*) -- **[REQUIRED]** The name of the service network. The name must be unique to the account. 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. * **sharingConfig** (*dict*) -- Specify if the service network should be enabled for sharing. * **enabled** *(boolean) --* Specifies if the service network is enabled for sharing. * **tags** (*dict*) -- The tags for the service network. * *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with "aws:". * *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'authType': 'NONE'|'AWS_IAM', 'id': 'string', 'name': 'string', 'sharingConfig': { 'enabled': True|False } } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the service network. * **authType** *(string) --* The type of IAM policy. * **id** *(string) --* The ID of the service network. * **name** *(string) --* The name of the service network. * **sharingConfig** *(dict) --* Specifies if the service network is enabled for sharing. * **enabled** *(boolean) --* Specifies if the service network is enabled for sharing. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / list_resource_endpoint_associations list_resource_endpoint_associations *********************************** VPCLattice.Client.list_resource_endpoint_associations(**kwargs) Lists the associations for the specified VPC endpoint. See also: AWS API Documentation **Request Syntax** response = client.list_resource_endpoint_associations( maxResults=123, nextToken='string', resourceConfigurationIdentifier='string', resourceEndpointAssociationIdentifier='string', vpcEndpointId='string', vpcEndpointOwner='string' ) Parameters: * **maxResults** (*integer*) -- The maximum page size. * **nextToken** (*string*) -- A pagination token for the next page of results. * **resourceConfigurationIdentifier** (*string*) -- **[REQUIRED]** The ID for the resource configuration associated with the VPC endpoint. * **resourceEndpointAssociationIdentifier** (*string*) -- The ID of the association. * **vpcEndpointId** (*string*) -- The ID of the VPC endpoint in the association. * **vpcEndpointOwner** (*string*) -- The owner of the VPC endpoint in the association. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'id': 'string', 'resourceConfigurationArn': 'string', 'resourceConfigurationId': 'string', 'resourceConfigurationName': 'string', 'vpcEndpointId': 'string', 'vpcEndpointOwner': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the VPC endpoint associations. * *(dict) --* Summary information about a VPC endpoint association. * **arn** *(string) --* The Amazon Resource Name (ARN) of the VPC endpoint association. * **createdAt** *(datetime) --* The date and time that the VPC endpoint association was created, in ISO-8601 format. * **createdBy** *(string) --* The account that created the association. * **id** *(string) --* The ID of the VPC endpoint association. * **resourceConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the resource configuration. * **resourceConfigurationId** *(string) --* The ID of the resource configuration. * **resourceConfigurationName** *(string) --* The name of the resource configuration. * **vpcEndpointId** *(string) --* The ID of the VPC endpoint. * **vpcEndpointOwner** *(string) --* The owner of the VPC endpoint. * **nextToken** *(string) --* If there are additional results, a pagination token for the next page of results. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / get_service get_service *********** VPCLattice.Client.get_service(**kwargs) Retrieves information about the specified service. See also: AWS API Documentation **Request Syntax** response = client.get_service( serviceIdentifier='string' ) Parameters: **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'authType': 'NONE'|'AWS_IAM', 'certificateArn': 'string', 'createdAt': datetime(2015, 1, 1), 'customDomainName': 'string', 'dnsEntry': { 'domainName': 'string', 'hostedZoneId': 'string' }, 'failureCode': 'string', 'failureMessage': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the service. * **authType** *(string) --* The type of IAM policy. * **certificateArn** *(string) --* The Amazon Resource Name (ARN) of the certificate. * **createdAt** *(datetime) --* The date and time that the service was created, in ISO-8601 format. * **customDomainName** *(string) --* The custom domain name of the service. * **dnsEntry** *(dict) --* The DNS name of the service. * **domainName** *(string) --* The domain name of the service. * **hostedZoneId** *(string) --* The ID of the hosted zone. * **failureCode** *(string) --* The failure code. * **failureMessage** *(string) --* The failure message. * **id** *(string) --* The ID of the service. * **lastUpdatedAt** *(datetime) --* The date and time that the service was last updated, in ISO-8601 format. * **name** *(string) --* The name of the service. * **status** *(string) --* The status of the service. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / list_target_groups list_target_groups ****************** VPCLattice.Client.list_target_groups(**kwargs) Lists your target groups. You can narrow your search by using the filters below in your request. See also: AWS API Documentation **Request Syntax** response = client.list_target_groups( maxResults=123, nextToken='string', targetGroupType='IP'|'LAMBDA'|'INSTANCE'|'ALB', vpcIdentifier='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return. * **nextToken** (*string*) -- A pagination token for the next page of results. * **targetGroupType** (*string*) -- The target group type. * **vpcIdentifier** (*string*) -- The ID or ARN of the VPC. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'ipAddressType': 'IPV4'|'IPV6', 'lambdaEventStructureVersion': 'V1'|'V2', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TCP', 'serviceArns': [ 'string', ], 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED', 'type': 'IP'|'LAMBDA'|'INSTANCE'|'ALB', 'vpcIdentifier': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the target groups. * *(dict) --* Summary information about a target group. For more information, see Target groups in the *Amazon VPC Lattice User Guide*. * **arn** *(string) --* The ARN (Amazon Resource Name) of the target group. * **createdAt** *(datetime) --* The date and time that the target group was created, in ISO-8601 format. * **id** *(string) --* The ID of the target group. * **ipAddressType** *(string) --* The type of IP address used for the target group. The possible values are "IPV4" and "IPV6". This is an optional parameter. If not specified, the default is "IPV4". * **lambdaEventStructureVersion** *(string) --* The version of the event structure that your Lambda function receives. Supported only if the target group type is "LAMBDA". * **lastUpdatedAt** *(datetime) --* The date and time that the target group was last updated, in ISO-8601 format. * **name** *(string) --* The name of the target group. * **port** *(integer) --* The port of the target group. * **protocol** *(string) --* The protocol of the target group. * **serviceArns** *(list) --* The Amazon Resource Names (ARNs) of the service. * *(string) --* * **status** *(string) --* The status. * **type** *(string) --* The target group type. * **vpcIdentifier** *(string) --* The ID of the VPC of the target group. * **nextToken** *(string) --* If there are additional results, a pagination token for the next page of results. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / update_resource_configuration update_resource_configuration ***************************** VPCLattice.Client.update_resource_configuration(**kwargs) Updates the specified resource configuration. See also: AWS API Documentation **Request Syntax** response = client.update_resource_configuration( allowAssociationToShareableServiceNetwork=True|False, portRanges=[ 'string', ], resourceConfigurationDefinition={ 'arnResource': { 'arn': 'string' }, 'dnsResource': { 'domainName': 'string', 'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK' }, 'ipResource': { 'ipAddress': 'string' } }, resourceConfigurationIdentifier='string' ) Parameters: * **allowAssociationToShareableServiceNetwork** (*boolean*) -- Indicates whether to add the resource configuration to service networks that are shared with other accounts. * **portRanges** (*list*) -- The TCP port ranges that a consumer can use to access a resource configuration. You can separate port ranges with a comma. Example: 1-65535 or 1,2,22-30 * *(string) --* * **resourceConfigurationDefinition** (*dict*) -- The resource configuration. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "arnResource", "dnsResource", "ipResource". * **arnResource** *(dict) --* The Amazon Resource Name (ARN) of the resource. * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **dnsResource** *(dict) --* The DNS name of the resource. * **domainName** *(string) --* The domain name of the resource. * **ipAddressType** *(string) --* The type of IP address. * **ipResource** *(dict) --* The IP resource. * **ipAddress** *(string) --* The IP address of the IP resource. * **resourceConfigurationIdentifier** (*string*) -- **[REQUIRED]** The ID of the resource configuration. Return type: dict Returns: **Response Syntax** { 'allowAssociationToShareableServiceNetwork': True|False, 'arn': 'string', 'id': 'string', 'name': 'string', 'portRanges': [ 'string', ], 'protocol': 'TCP', 'resourceConfigurationDefinition': { 'arnResource': { 'arn': 'string' }, 'dnsResource': { 'domainName': 'string', 'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK' }, 'ipResource': { 'ipAddress': 'string' } }, 'resourceConfigurationGroupId': 'string', 'resourceGatewayId': 'string', 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED', 'type': 'GROUP'|'CHILD'|'SINGLE'|'ARN' } **Response Structure** * *(dict) --* * **allowAssociationToShareableServiceNetwork** *(boolean) --* Indicates whether to add the resource configuration to service networks that are shared with other accounts. * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource configuration. * **id** *(string) --* The ID of the resource configuration. * **name** *(string) --* The name of the resource configuration. * **portRanges** *(list) --* The TCP port ranges that a consumer can use to access a resource configuration. You can separate port ranges with a comma. Example: 1-65535 or 1,2,22-30 * *(string) --* * **protocol** *(string) --* The TCP protocol accepted by the specified resource configuration. * **resourceConfigurationDefinition** *(dict) --* The resource configuration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "arnResource", "dnsResource", "ipResource". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **arnResource** *(dict) --* The Amazon Resource Name (ARN) of the resource. * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **dnsResource** *(dict) --* The DNS name of the resource. * **domainName** *(string) --* The domain name of the resource. * **ipAddressType** *(string) --* The type of IP address. * **ipResource** *(dict) --* The IP resource. * **ipAddress** *(string) --* The IP address of the IP resource. * **resourceConfigurationGroupId** *(string) --* The ID of the group resource configuration. * **resourceGatewayId** *(string) --* The ID of the resource gateway associated with the resource configuration. * **status** *(string) --* The status of the resource configuration. * **type** *(string) --* The type of resource configuration. * "SINGLE" - A single resource. * "GROUP" - A group of resources. * "CHILD" - A single resource that is part of a group resource configuration. * "ARN" - An Amazon Web Services resource. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / create_service_network_vpc_association create_service_network_vpc_association ************************************** VPCLattice.Client.create_service_network_vpc_association(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_service_network_vpc_association( clientToken='string', securityGroupIds=[ 'string', ], serviceNetworkIdentifier='string', tags={ 'string': 'string' }, vpcIdentifier='string' ) Parameters: * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **securityGroupIds** (*list*) -- The IDs of the security groups. Security groups aren't added by default. You can add a security group to apply network level controls to control which resources in a VPC are allowed to access the service network and its services. For more information, see Control traffic to resources using security groups in the *Amazon VPC User Guide*. * *(string) --* * **serviceNetworkIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service network. You must use an ARN if the resources are in different accounts. * **tags** (*dict*) -- The tags for the association. * *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with "aws:". * *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ * **vpcIdentifier** (*string*) -- **[REQUIRED]** The ID of the VPC. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'createdBy': 'string', 'id': 'string', 'securityGroupIds': [ 'string', ], 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED'|'UPDATE_FAILED' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **createdBy** *(string) --* The account that created the association. * **id** *(string) --* The ID of the association. * **securityGroupIds** *(list) --* The IDs of the security groups. * *(string) --* * **status** *(string) --* The association status. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / delete_service_network delete_service_network ********************** VPCLattice.Client.delete_service_network(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.delete_service_network( serviceNetworkIdentifier='string' ) Parameters: **serviceNetworkIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service network. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / delete_listener delete_listener *************** VPCLattice.Client.delete_listener(**kwargs) Deletes the specified listener. See also: AWS API Documentation **Request Syntax** response = client.delete_listener( listenerIdentifier='string', serviceIdentifier='string' ) Parameters: * **listenerIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the listener. * **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / list_service_network_vpc_associations list_service_network_vpc_associations ************************************* VPCLattice.Client.list_service_network_vpc_associations(**kwargs) Lists the associations between a service network and a VPC. You can filter the list either by VPC or service network. You must provide either the ID of the service network identifier or the ID of the VPC. See also: AWS API Documentation **Request Syntax** response = client.list_service_network_vpc_associations( maxResults=123, nextToken='string', serviceNetworkIdentifier='string', vpcIdentifier='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return. * **nextToken** (*string*) -- A pagination token for the next page of results. * **serviceNetworkIdentifier** (*string*) -- The ID or ARN of the service network. * **vpcIdentifier** (*string*) -- The ID or ARN of the VPC. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'serviceNetworkArn': 'string', 'serviceNetworkId': 'string', 'serviceNetworkName': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED'|'UPDATE_FAILED', 'vpcId': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the associations. * *(dict) --* Summary information about an association between a service network and a VPC. * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **createdAt** *(datetime) --* The date and time that the association was created, in ISO-8601 format. * **createdBy** *(string) --* The account that created the association. * **id** *(string) --* The ID of the association. * **lastUpdatedAt** *(datetime) --* The date and time that the association was last updated, in ISO-8601 format. * **serviceNetworkArn** *(string) --* The Amazon Resource Name (ARN) of the service network. * **serviceNetworkId** *(string) --* The ID of the service network. * **serviceNetworkName** *(string) --* The name of the service network. * **status** *(string) --* The status. * **vpcId** *(string) --* The ID of the VPC. * **nextToken** *(string) --* If there are additional results, a pagination token for the next page of results. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / get_service_network_vpc_association get_service_network_vpc_association *********************************** VPCLattice.Client.get_service_network_vpc_association(**kwargs) Retrieves information about the specified association between a service network and a VPC. See also: AWS API Documentation **Request Syntax** response = client.get_service_network_vpc_association( serviceNetworkVpcAssociationIdentifier='string' ) Parameters: **serviceNetworkVpcAssociationIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the association. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'failureCode': 'string', 'failureMessage': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'securityGroupIds': [ 'string', ], 'serviceNetworkArn': 'string', 'serviceNetworkId': 'string', 'serviceNetworkName': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED'|'UPDATE_FAILED', 'vpcId': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **createdAt** *(datetime) --* The date and time that the association was created, in ISO-8601 format. * **createdBy** *(string) --* The account that created the association. * **failureCode** *(string) --* The failure code. * **failureMessage** *(string) --* The failure message. * **id** *(string) --* The ID of the association. * **lastUpdatedAt** *(datetime) --* The date and time that the association was last updated, in ISO-8601 format. * **securityGroupIds** *(list) --* The IDs of the security groups. * *(string) --* * **serviceNetworkArn** *(string) --* The Amazon Resource Name (ARN) of the service network. * **serviceNetworkId** *(string) --* The ID of the service network. * **serviceNetworkName** *(string) --* The name of the service network. * **status** *(string) --* The status of the association. * **vpcId** *(string) --* The ID of the VPC. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / list_access_log_subscriptions list_access_log_subscriptions ***************************** VPCLattice.Client.list_access_log_subscriptions(**kwargs) Lists the access log subscriptions for the specified service network or service. See also: AWS API Documentation **Request Syntax** response = client.list_access_log_subscriptions( maxResults=123, nextToken='string', resourceIdentifier='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return. * **nextToken** (*string*) -- A pagination token for the next page of results. * **resourceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service network or service. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'destinationArn': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'resourceArn': 'string', 'resourceId': 'string', 'serviceNetworkLogType': 'SERVICE'|'RESOURCE' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the access log subscriptions. * *(dict) --* Summary information about an access log subscription. * **arn** *(string) --* The Amazon Resource Name (ARN) of the access log subscription * **createdAt** *(datetime) --* The date and time that the access log subscription was created, in ISO-8601 format. * **destinationArn** *(string) --* The Amazon Resource Name (ARN) of the destination. * **id** *(string) --* The ID of the access log subscription. * **lastUpdatedAt** *(datetime) --* The date and time that the access log subscription was last updated, in ISO-8601 format. * **resourceArn** *(string) --* The Amazon Resource Name (ARN) of the service or service network. * **resourceId** *(string) --* The ID of the service or service network. * **serviceNetworkLogType** *(string) --* Log type of the service network. * **nextToken** *(string) --* A pagination token for the next page of results. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / delete_access_log_subscription delete_access_log_subscription ****************************** VPCLattice.Client.delete_access_log_subscription(**kwargs) Deletes the specified access log subscription. See also: AWS API Documentation **Request Syntax** response = client.delete_access_log_subscription( accessLogSubscriptionIdentifier='string' ) Parameters: **accessLogSubscriptionIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the access log subscription. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / close close ***** VPCLattice.Client.close() Closes underlying endpoint connections. VPCLattice / Client / put_resource_policy put_resource_policy ******************* VPCLattice.Client.put_resource_policy(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.put_resource_policy( policy='string', resourceArn='string' ) Parameters: * **policy** (*string*) -- **[REQUIRED]** An IAM policy. The policy string in JSON must not contain newlines or blank lines. * **resourceArn** (*string*) -- **[REQUIRED]** The ID or ARN of the service network or service for which the policy is created. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / create_service_network_resource_association create_service_network_resource_association ******************************************* VPCLattice.Client.create_service_network_resource_association(**kwargs) Associates the specified service network with the specified resource configuration. This allows the resource configuration to receive connections through the service network, including through a service network VPC endpoint. See also: AWS API Documentation **Request Syntax** response = client.create_service_network_resource_association( clientToken='string', resourceConfigurationIdentifier='string', serviceNetworkIdentifier='string', tags={ 'string': 'string' } ) Parameters: * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **resourceConfigurationIdentifier** (*string*) -- **[REQUIRED]** The ID of the resource configuration to associate with the service network. * **serviceNetworkIdentifier** (*string*) -- **[REQUIRED]** The ID of the service network to associate with the resource configuration. * **tags** (*dict*) -- The tags for the association. * *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with "aws:". * *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'createdBy': 'string', 'id': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'PARTIAL'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **createdBy** *(string) --* The ID of the account that created the association. * **id** *(string) --* The ID of the association. * **status** *(string) --* The status of the association. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / get_resource_policy get_resource_policy ******************* VPCLattice.Client.get_resource_policy(**kwargs) Retrieves information about the specified resource policy. The resource policy is an IAM policy created on behalf of the resource owner when they share a resource. See also: AWS API Documentation **Request Syntax** response = client.get_resource_policy( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the service network or service. Return type: dict Returns: **Response Syntax** { 'policy': 'string' } **Response Structure** * *(dict) --* * **policy** *(string) --* An IAM policy. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / list_resource_gateways list_resource_gateways ********************** VPCLattice.Client.list_resource_gateways(**kwargs) Lists the resource gateways that you own or that were shared with you. See also: AWS API Documentation **Request Syntax** response = client.list_resource_gateways( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum page size. * **nextToken** (*string*) -- If there are additional results, a pagination token for the next page of results. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'securityGroupIds': [ 'string', ], 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED', 'subnetIds': [ 'string', ], 'vpcIdentifier': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the resource gateways. * *(dict) --* Summary information about a resource gateway. * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource gateway. * **createdAt** *(datetime) --* The date and time that the VPC endpoint association was created, in ISO-8601 format. * **id** *(string) --* The ID of the resource gateway. * **ipAddressType** *(string) --* The type of IP address used by the resource gateway. * **lastUpdatedAt** *(datetime) --* The most recent date and time that the resource gateway was updated, in ISO-8601 format. * **name** *(string) --* The name of the resource gateway. * **securityGroupIds** *(list) --* The IDs of the security groups applied to the resource gateway. * *(string) --* * **status** *(string) --* The name of the resource gateway. * **subnetIds** *(list) --* The IDs of the VPC subnets for the resource gateway. * *(string) --* * **vpcIdentifier** *(string) --* The ID of the VPC for the resource gateway. * **nextToken** *(string) --* If there are additional results, a pagination token for the next page of results. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / delete_resource_endpoint_association delete_resource_endpoint_association ************************************ VPCLattice.Client.delete_resource_endpoint_association(**kwargs) Disassociates the resource configuration from the resource VPC endpoint. See also: AWS API Documentation **Request Syntax** response = client.delete_resource_endpoint_association( resourceEndpointAssociationIdentifier='string' ) Parameters: **resourceEndpointAssociationIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the association. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'id': 'string', 'resourceConfigurationArn': 'string', 'resourceConfigurationId': 'string', 'vpcEndpointId': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **id** *(string) --* The ID of the association. * **resourceConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the resource configuration associated with the VPC endpoint of type resource. * **resourceConfigurationId** *(string) --* The ID of the resource configuration. * **vpcEndpointId** *(string) --* The ID of the resource VPC endpoint that is associated with the resource configuration. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / delete_target_group delete_target_group ******************* VPCLattice.Client.delete_target_group(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_target_group( targetGroupIdentifier='string' ) Parameters: **targetGroupIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the target group. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'id': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the target group. * **id** *(string) --* The ID of the target group. * **status** *(string) --* The status. You can retry the operation if the status is "DELETE_FAILED". However, if you retry it while the status is "DELETE_IN_PROGRESS", the status doesn't change. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / get_auth_policy get_auth_policy *************** VPCLattice.Client.get_auth_policy(**kwargs) Retrieves information about the auth policy for the specified service or service network. See also: AWS API Documentation **Request Syntax** response = client.get_auth_policy( resourceIdentifier='string' ) Parameters: **resourceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service network or service. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'lastUpdatedAt': datetime(2015, 1, 1), 'policy': 'string', 'state': 'Active'|'Inactive' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The date and time that the auth policy was created, in ISO-8601 format. * **lastUpdatedAt** *(datetime) --* The date and time that the auth policy was last updated, in ISO-8601 format. * **policy** *(string) --* The auth policy. * **state** *(string) --* The state of the auth policy. The auth policy is only active when the auth type is set to "AWS_IAM". If you provide a policy, then authentication and authorization decisions are made based on this policy and the client's IAM policy. If the auth type is "NONE", then any auth policy that you provide remains inactive. For more information, see Create a service network in the *Amazon VPC Lattice User Guide*. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / update_service_network update_service_network ********************** VPCLattice.Client.update_service_network(**kwargs) Updates the specified service network. See also: AWS API Documentation **Request Syntax** response = client.update_service_network( authType='NONE'|'AWS_IAM', serviceNetworkIdentifier='string' ) Parameters: * **authType** (*string*) -- **[REQUIRED]** The type of IAM policy. * "NONE": The resource does not use an IAM policy. This is the default. * "AWS_IAM": The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required. * **serviceNetworkIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service network. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'authType': 'NONE'|'AWS_IAM', 'id': 'string', 'name': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the service network. * **authType** *(string) --* The type of IAM policy. * **id** *(string) --* The ID of the service network. * **name** *(string) --* The name of the service network. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / get_listener get_listener ************ VPCLattice.Client.get_listener(**kwargs) Retrieves information about the specified listener for the specified service. See also: AWS API Documentation **Request Syntax** response = client.get_listener( listenerIdentifier='string', serviceIdentifier='string' ) Parameters: * **listenerIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the listener. * **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'defaultAction': { 'fixedResponse': { 'statusCode': 123 }, 'forward': { 'targetGroups': [ { 'targetGroupIdentifier': 'string', 'weight': 123 }, ] } }, 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TLS_PASSTHROUGH', 'serviceArn': 'string', 'serviceId': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the listener. * **createdAt** *(datetime) --* The date and time that the listener was created, in ISO-8601 format. * **defaultAction** *(dict) --* The actions for the default listener rule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fixedResponse", "forward". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **fixedResponse** *(dict) --* The fixed response action. The rule returns a custom HTTP response. * **statusCode** *(integer) --* The HTTP response code. * **forward** *(dict) --* The forward action. Traffic that matches the rule is forwarded to the specified target groups. * **targetGroups** *(list) --* The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic. The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group. * *(dict) --* Describes the weight of a target group. * **targetGroupIdentifier** *(string) --* The ID or ARN of the target group. * **weight** *(integer) --* Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100. * **id** *(string) --* The ID of the listener. * **lastUpdatedAt** *(datetime) --* The date and time that the listener was last updated, in ISO-8601 format. * **name** *(string) --* The name of the listener. * **port** *(integer) --* The listener port. * **protocol** *(string) --* The listener protocol. * **serviceArn** *(string) --* The Amazon Resource Name (ARN) of the service. * **serviceId** *(string) --* The ID of the service. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / delete_service_network_resource_association delete_service_network_resource_association ******************************************* VPCLattice.Client.delete_service_network_resource_association(**kwargs) Deletes the association between a service network and a resource configuration. See also: AWS API Documentation **Request Syntax** response = client.delete_service_network_resource_association( serviceNetworkResourceAssociationIdentifier='string' ) Parameters: **serviceNetworkResourceAssociationIdentifier** (*string*) -- **[REQUIRED]** The ID of the association. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'id': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'PARTIAL'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **id** *(string) --* The ID of the association. * **status** *(string) --* The status of the association. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / list_rules list_rules ********** VPCLattice.Client.list_rules(**kwargs) Lists the rules for the specified listener. See also: AWS API Documentation **Request Syntax** response = client.list_rules( listenerIdentifier='string', maxResults=123, nextToken='string', serviceIdentifier='string' ) Parameters: * **listenerIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the listener. * **maxResults** (*integer*) -- The maximum number of results to return. * **nextToken** (*string*) -- A pagination token for the next page of results. * **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'isDefault': True|False, 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'priority': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the rules. * *(dict) --* Summary information about a listener rule. * **arn** *(string) --* The Amazon Resource Name (ARN) of the rule. * **createdAt** *(datetime) --* The date and time that the listener rule was created, in ISO-8601 format. * **id** *(string) --* The ID of the rule. * **isDefault** *(boolean) --* Indicates whether this is the default listener rule. * **lastUpdatedAt** *(datetime) --* The date and time that the listener rule was last updated, in ISO-8601 format. * **name** *(string) --* The name of the rule. * **priority** *(integer) --* The priority of the rule. * **nextToken** *(string) --* If there are additional results, a pagination token for the next page of results. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / get_service_network get_service_network ******************* VPCLattice.Client.get_service_network(**kwargs) Retrieves information about the specified service network. See also: AWS API Documentation **Request Syntax** response = client.get_service_network( serviceNetworkIdentifier='string' ) Parameters: **serviceNetworkIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service network. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'authType': 'NONE'|'AWS_IAM', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'numberOfAssociatedServices': 123, 'numberOfAssociatedVPCs': 123, 'sharingConfig': { 'enabled': True|False } } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the service network. * **authType** *(string) --* The type of IAM policy. * **createdAt** *(datetime) --* The date and time that the service network was created, in ISO-8601 format. * **id** *(string) --* The ID of the service network. * **lastUpdatedAt** *(datetime) --* The date and time of the last update, in ISO-8601 format. * **name** *(string) --* The name of the service network. * **numberOfAssociatedServices** *(integer) --* The number of services associated with the service network. * **numberOfAssociatedVPCs** *(integer) --* The number of VPCs associated with the service network. * **sharingConfig** *(dict) --* Specifies if the service network is enabled for sharing. * **enabled** *(boolean) --* Specifies if the service network is enabled for sharing. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / list_service_network_vpc_endpoint_associations list_service_network_vpc_endpoint_associations ********************************************** VPCLattice.Client.list_service_network_vpc_endpoint_associations(**kwargs) Lists the associations between a service network and a VPC endpoint. See also: AWS API Documentation **Request Syntax** response = client.list_service_network_vpc_endpoint_associations( maxResults=123, nextToken='string', serviceNetworkIdentifier='string' ) Parameters: * **maxResults** (*integer*) -- The maximum page size. * **nextToken** (*string*) -- If there are additional results, a pagination token for the next page of results. * **serviceNetworkIdentifier** (*string*) -- **[REQUIRED]** The ID of the service network associated with the VPC endpoint. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'serviceNetworkArn': 'string', 'state': 'string', 'vpcEndpointId': 'string', 'vpcEndpointOwnerId': 'string', 'vpcId': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the association between the VPC endpoint and service network. * *(dict) --* Describes the association between a service network and a VPC endpoint. * **createdAt** *(datetime) --* The date and time that the association was created, in ISO-8601 format. * **id** *(string) --* The ID of the association. * **serviceNetworkArn** *(string) --* The Amazon Resource Name (ARN) of the service network. * **state** *(string) --* The state of the association. * **vpcEndpointId** *(string) --* The ID of the VPC endpoint associated with the service network. * **vpcEndpointOwnerId** *(string) --* The owner of the VPC endpoint associated with the service network. * **vpcId** *(string) --* The ID of the VPC for the association. * **nextToken** *(string) --* If there are additional results, a pagination token for the next page of results. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / tag_resource tag_resource ************ VPCLattice.Client.tag_resource(**kwargs) Adds the specified tags to the specified resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. * **tags** (*dict*) -- **[REQUIRED]** The tags for the resource. * *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with "aws:". * *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / delete_auth_policy delete_auth_policy ****************** VPCLattice.Client.delete_auth_policy(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_auth_policy( resourceIdentifier='string' ) Parameters: **resourceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the resource. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / register_targets register_targets **************** VPCLattice.Client.register_targets(**kwargs) Registers the targets with the target group. If it's a Lambda target, you can only have one target in a target group. See also: AWS API Documentation **Request Syntax** response = client.register_targets( targetGroupIdentifier='string', targets=[ { 'id': 'string', 'port': 123 }, ] ) Parameters: * **targetGroupIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the target group. * **targets** (*list*) -- **[REQUIRED]** The targets. * *(dict) --* Describes a target. * **id** *(string) --* **[REQUIRED]** The ID of the target. If the target group type is "INSTANCE", this is an instance ID. If the target group type is "IP", this is an IP address. If the target group type is "LAMBDA", this is the ARN of a Lambda function. If the target group type is "ALB", this is the ARN of an Application Load Balancer. * **port** *(integer) --* The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443. Return type: dict Returns: **Response Syntax** { 'successful': [ { 'id': 'string', 'port': 123 }, ], 'unsuccessful': [ { 'failureCode': 'string', 'failureMessage': 'string', 'id': 'string', 'port': 123 }, ] } **Response Structure** * *(dict) --* * **successful** *(list) --* The targets that were successfully registered. * *(dict) --* Describes a target. * **id** *(string) --* The ID of the target. If the target group type is "INSTANCE", this is an instance ID. If the target group type is "IP", this is an IP address. If the target group type is "LAMBDA", this is the ARN of a Lambda function. If the target group type is "ALB", this is the ARN of an Application Load Balancer. * **port** *(integer) --* The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443. * **unsuccessful** *(list) --* The targets that were not registered. * *(dict) --* Describes a target failure. * **failureCode** *(string) --* The failure code. * **failureMessage** *(string) --* The failure message. * **id** *(string) --* The ID of the target. If the target group type is "INSTANCE", this is an instance ID. If the target group type is "IP", this is an IP address. If the target group type is "LAMBDA", this is the ARN of a Lambda function. If the target group type is "ALB", this is the ARN of an Application Load Balancer. * **port** *(integer) --* The port on which the target is listening. This parameter doesn't apply if the target is a Lambda function. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.ServiceQuotaExceededException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / delete_service_network_vpc_association delete_service_network_vpc_association ************************************** VPCLattice.Client.delete_service_network_vpc_association(**kwargs) Disassociates the VPC from the service network. You can't disassociate the VPC if there is a create or update association in progress. See also: AWS API Documentation **Request Syntax** response = client.delete_service_network_vpc_association( serviceNetworkVpcAssociationIdentifier='string' ) Parameters: **serviceNetworkVpcAssociationIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the association. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'id': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED'|'UPDATE_FAILED' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **id** *(string) --* The ID of the association. * **status** *(string) --* The status. You can retry the operation if the status is "DELETE_FAILED". However, if you retry it while the status is "DELETE_IN_PROGRESS", there is no change in the status. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.ConflictException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / get_resource_configuration get_resource_configuration ************************** VPCLattice.Client.get_resource_configuration(**kwargs) Retrieves information about the specified resource configuration. See also: AWS API Documentation **Request Syntax** response = client.get_resource_configuration( resourceConfigurationIdentifier='string' ) Parameters: **resourceConfigurationIdentifier** (*string*) -- **[REQUIRED]** The ID of the resource configuration. Return type: dict Returns: **Response Syntax** { 'allowAssociationToShareableServiceNetwork': True|False, 'amazonManaged': True|False, 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'customDomainName': 'string', 'failureReason': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'portRanges': [ 'string', ], 'protocol': 'TCP', 'resourceConfigurationDefinition': { 'arnResource': { 'arn': 'string' }, 'dnsResource': { 'domainName': 'string', 'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK' }, 'ipResource': { 'ipAddress': 'string' } }, 'resourceConfigurationGroupId': 'string', 'resourceGatewayId': 'string', 'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED', 'type': 'GROUP'|'CHILD'|'SINGLE'|'ARN' } **Response Structure** * *(dict) --* * **allowAssociationToShareableServiceNetwork** *(boolean) --* Specifies whether the resource configuration is associated with a sharable service network. * **amazonManaged** *(boolean) --* Indicates whether the resource configuration was created and is managed by Amazon. * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource configuration. * **createdAt** *(datetime) --* The date and time that the resource configuration was created, in ISO-8601 format. * **customDomainName** *(string) --* The custom domain name of the resource configuration. * **failureReason** *(string) --* The reason the create-resource-configuration request failed. * **id** *(string) --* The ID of the resource configuration. * **lastUpdatedAt** *(datetime) --* The most recent date and time that the resource configuration was updated, in ISO-8601 format. * **name** *(string) --* The name of the resource configuration. * **portRanges** *(list) --* The TCP port ranges that a consumer can use to access a resource configuration. You can separate port ranges with a comma. Example: 1-65535 or 1,2,22-30 * *(string) --* * **protocol** *(string) --* The TCP protocol accepted by the specified resource configuration. * **resourceConfigurationDefinition** *(dict) --* The resource configuration. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "arnResource", "dnsResource", "ipResource". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **arnResource** *(dict) --* The Amazon Resource Name (ARN) of the resource. * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource. * **dnsResource** *(dict) --* The DNS name of the resource. * **domainName** *(string) --* The domain name of the resource. * **ipAddressType** *(string) --* The type of IP address. * **ipResource** *(dict) --* The IP resource. * **ipAddress** *(string) --* The IP address of the IP resource. * **resourceConfigurationGroupId** *(string) --* The ID of the group resource configuration. * **resourceGatewayId** *(string) --* The ID of the resource gateway used to connect to the resource configuration in a given VPC. You can specify the resource gateway identifier only for resource configurations with type SINGLE, GROUP, or ARN. * **status** *(string) --* The status of the resource configuration. * **type** *(string) --* The type of resource configuration. * "SINGLE" - A single resource. * "GROUP" - A group of resources. * "CHILD" - A single resource that is part of a group resource configuration. * "ARN" - An Amazon Web Services resource. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / delete_resource_policy delete_resource_policy ********************** VPCLattice.Client.delete_resource_policy(**kwargs) Deletes the specified resource policy. See also: AWS API Documentation **Request Syntax** response = client.delete_resource_policy( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / list_listeners list_listeners ************** VPCLattice.Client.list_listeners(**kwargs) Lists the listeners for the specified service. See also: AWS API Documentation **Request Syntax** response = client.list_listeners( maxResults=123, nextToken='string', serviceIdentifier='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return. * **nextToken** (*string*) -- A pagination token for the next page of results. * **serviceIdentifier** (*string*) -- **[REQUIRED]** The ID or ARN of the service. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TLS_PASSTHROUGH' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the listeners. * *(dict) --* Summary information about a listener. * **arn** *(string) --* The Amazon Resource Name (ARN) of the listener. * **createdAt** *(datetime) --* The date and time that the listener was created, in ISO-8601 format. * **id** *(string) --* The ID of the listener. * **lastUpdatedAt** *(datetime) --* The date and time that the listener was last updated, in ISO-8601 format. * **name** *(string) --* The name of the listener. * **port** *(integer) --* The listener port. * **protocol** *(string) --* The listener protocol. * **nextToken** *(string) --* If there are additional results, a pagination token for the next page of results. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.ResourceNotFoundException" * "VPCLattice.Client.exceptions.InternalServerException" VPCLattice / Client / list_service_network_resource_associations list_service_network_resource_associations ****************************************** VPCLattice.Client.list_service_network_resource_associations(**kwargs) Lists the associations between a service network and a resource configuration. See also: AWS API Documentation **Request Syntax** response = client.list_service_network_resource_associations( maxResults=123, nextToken='string', resourceConfigurationIdentifier='string', serviceNetworkIdentifier='string' ) Parameters: * **maxResults** (*integer*) -- The maximum page size. * **nextToken** (*string*) -- If there are additional results, a pagination token for the next page of results. * **resourceConfigurationIdentifier** (*string*) -- The ID of the resource configurationk. * **serviceNetworkIdentifier** (*string*) -- The ID of the service network. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'dnsEntry': { 'domainName': 'string', 'hostedZoneId': 'string' }, 'failureCode': 'string', 'id': 'string', 'isManagedAssociation': True|False, 'privateDnsEntry': { 'domainName': 'string', 'hostedZoneId': 'string' }, 'resourceConfigurationArn': 'string', 'resourceConfigurationId': 'string', 'resourceConfigurationName': 'string', 'serviceNetworkArn': 'string', 'serviceNetworkId': 'string', 'serviceNetworkName': 'string', 'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'PARTIAL'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Information about the associations. * *(dict) --* Summary information about an association between a service network and a resource configuration. * **arn** *(string) --* The Amazon Resource Name (ARN) of the association. * **createdAt** *(datetime) --* The date and time that the association was created, in ISO-8601 format. * **createdBy** *(string) --* The account that created the association. * **dnsEntry** *(dict) --* The DNS entry for the service. * **domainName** *(string) --* The domain name of the service. * **hostedZoneId** *(string) --* The ID of the hosted zone. * **failureCode** *(string) --* The failure code. * **id** *(string) --* The ID of the association between the service network and resource configuration. * **isManagedAssociation** *(boolean) --* Specifies whether the association is managed by Amazon. * **privateDnsEntry** *(dict) --* The private DNS entry for the service. * **domainName** *(string) --* The domain name of the service. * **hostedZoneId** *(string) --* The ID of the hosted zone. * **resourceConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the association. * **resourceConfigurationId** *(string) --* The ID of the resource configuration associated with the service network. * **resourceConfigurationName** *(string) --* The name of the resource configuration associated with the service network. * **serviceNetworkArn** *(string) --* The Amazon Resource Name (ARN) of the service network associated with the resource configuration. * **serviceNetworkId** *(string) --* The ID of the service network associated with the resource configuration. * **serviceNetworkName** *(string) --* The name of the service network associated with the resource configuration. * **status** *(string) --* The status of the service network associated with the resource configuration. * **nextToken** *(string) --* If there are additional results, a pagination token for the next page of results. **Exceptions** * "VPCLattice.Client.exceptions.ValidationException" * "VPCLattice.Client.exceptions.AccessDeniedException" * "VPCLattice.Client.exceptions.ThrottlingException" * "VPCLattice.Client.exceptions.InternalServerException"