BatchUpdateRule

$result = $client->batchUpdateRule([/* ... */]);
$promise = $client->batchUpdateRuleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->batchUpdateRule([
    'listenerIdentifier' => '<string>', // REQUIRED
    'rules' => [ // REQUIRED
        [
            'action' => [
                'fixedResponse' => [
                    'statusCode' => <integer>, // REQUIRED
                ],
                'forward' => [
                    'targetGroups' => [ // REQUIRED
                        [
                            'targetGroupIdentifier' => '<string>', // REQUIRED
                            'weight' => <integer>,
                        ],
                        // ...
                    ],
                ],
            ],
            'match' => [
                'httpMatch' => [
                    'headerMatches' => [
                        [
                            'caseSensitive' => true || false,
                            'match' => [ // REQUIRED
                                'contains' => '<string>',
                                'exact' => '<string>',
                                'prefix' => '<string>',
                            ],
                            'name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'method' => '<string>',
                    'pathMatch' => [
                        'caseSensitive' => true || false,
                        'match' => [ // REQUIRED
                            'exact' => '<string>',
                            'prefix' => '<string>',
                        ],
                    ],
                ],
            ],
            'priority' => <integer>,
            'ruleIdentifier' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'serviceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'successful' => [
        [
            'action' => [
                'fixedResponse' => [
                    'statusCode' => <integer>,
                ],
                'forward' => [
                    'targetGroups' => [
                        [
                            'targetGroupIdentifier' => '<string>',
                            'weight' => <integer>,
                        ],
                        // ...
                    ],
                ],
            ],
            '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' => <integer>,
        ],
        // ...
    ],
    'unsuccessful' => [
        [
            'failureCode' => '<string>',
            'failureMessage' => '<string>',
            'ruleIdentifier' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

CreateAccessLogSubscription

$result = $client->createAccessLogSubscription([/* ... */]);
$promise = $client->createAccessLogSubscriptionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createAccessLogSubscription([
    'clientToken' => '<string>',
    'destinationArn' => '<string>', // REQUIRED
    'resourceIdentifier' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'destinationArn' => '<string>',
    'id' => '<string>',
    'resourceArn' => '<string>',
    'resourceId' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

CreateListener

$result = $client->createListener([/* ... */]);
$promise = $client->createListenerAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createListener([
    'clientToken' => '<string>',
    'defaultAction' => [ // REQUIRED
        'fixedResponse' => [
            'statusCode' => <integer>, // REQUIRED
        ],
        'forward' => [
            'targetGroups' => [ // REQUIRED
                [
                    'targetGroupIdentifier' => '<string>', // REQUIRED
                    'weight' => <integer>,
                ],
                // ...
            ],
        ],
    ],
    'name' => '<string>', // REQUIRED
    'port' => <integer>,
    'protocol' => 'HTTP|HTTPS|TLS_PASSTHROUGH', // REQUIRED
    'serviceIdentifier' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'defaultAction' => [
        'fixedResponse' => [
            'statusCode' => <integer>,
        ],
        'forward' => [
            'targetGroups' => [
                [
                    'targetGroupIdentifier' => '<string>',
                    'weight' => <integer>,
                ],
                // ...
            ],
        ],
    ],
    'id' => '<string>',
    'name' => '<string>',
    'port' => <integer>,
    'protocol' => 'HTTP|HTTPS|TLS_PASSTHROUGH',
    'serviceArn' => '<string>',
    'serviceId' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

InternalServerException:

An unexpected error occurred while processing the request.

CreateRule

$result = $client->createRule([/* ... */]);
$promise = $client->createRuleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createRule([
    'action' => [ // REQUIRED
        'fixedResponse' => [
            'statusCode' => <integer>, // REQUIRED
        ],
        'forward' => [
            'targetGroups' => [ // REQUIRED
                [
                    'targetGroupIdentifier' => '<string>', // REQUIRED
                    'weight' => <integer>,
                ],
                // ...
            ],
        ],
    ],
    'clientToken' => '<string>',
    'listenerIdentifier' => '<string>', // REQUIRED
    'match' => [ // REQUIRED
        'httpMatch' => [
            'headerMatches' => [
                [
                    'caseSensitive' => true || false,
                    'match' => [ // REQUIRED
                        'contains' => '<string>',
                        'exact' => '<string>',
                        'prefix' => '<string>',
                    ],
                    'name' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'method' => '<string>',
            'pathMatch' => [
                'caseSensitive' => true || false,
                'match' => [ // REQUIRED
                    'exact' => '<string>',
                    'prefix' => '<string>',
                ],
            ],
        ],
    ],
    'name' => '<string>', // REQUIRED
    'priority' => <integer>, // REQUIRED
    'serviceIdentifier' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'action' => [
        'fixedResponse' => [
            'statusCode' => <integer>,
        ],
        'forward' => [
            'targetGroups' => [
                [
                    'targetGroupIdentifier' => '<string>',
                    'weight' => <integer>,
                ],
                // ...
            ],
        ],
    ],
    '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' => <integer>,
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

InternalServerException:

An unexpected error occurred while processing the request.

CreateService

$result = $client->createService([/* ... */]);
$promise = $client->createServiceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createService([
    'authType' => 'NONE|AWS_IAM',
    'certificateArn' => '<string>',
    'clientToken' => '<string>',
    'customDomainName' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result 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',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

InternalServerException:

An unexpected error occurred while processing the request.

CreateServiceNetwork

$result = $client->createServiceNetwork([/* ... */]);
$promise = $client->createServiceNetworkAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createServiceNetwork([
    'authType' => 'NONE|AWS_IAM',
    'clientToken' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'authType' => 'NONE|AWS_IAM',
    'id' => '<string>',
    'name' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

InternalServerException:

An unexpected error occurred while processing the request.

CreateServiceNetworkServiceAssociation

$result = $client->createServiceNetworkServiceAssociation([/* ... */]);
$promise = $client->createServiceNetworkServiceAssociationAsync([/* ... */]);

Associates a service with a service network. For more information, see Manage service associations in the Amazon VPC Lattice User Guide.

You can't use this operation if the service and service network are already associated or if there is a disassociation or deletion in progress. If the association fails, you can retry the operation by deleting the association and recreating it.

You cannot associate a service and service network that are shared with a caller. The caller must own either the service or the service network.

As a result of this operation, the association is created in the service network account and the association owner account.

Parameter Syntax

$result = $client->createServiceNetworkServiceAssociation([
    'clientToken' => '<string>',
    'serviceIdentifier' => '<string>', // REQUIRED
    'serviceNetworkIdentifier' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result 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',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

InternalServerException:

An unexpected error occurred while processing the request.

CreateServiceNetworkVpcAssociation

$result = $client->createServiceNetworkVpcAssociation([/* ... */]);
$promise = $client->createServiceNetworkVpcAssociationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createServiceNetworkVpcAssociation([
    'clientToken' => '<string>',
    'securityGroupIds' => ['<string>', ...],
    'serviceNetworkIdentifier' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'vpcIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result 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',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

InternalServerException:

An unexpected error occurred while processing the request.

CreateTargetGroup

$result = $client->createTargetGroup([/* ... */]);
$promise = $client->createTargetGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createTargetGroup([
    'clientToken' => '<string>',
    'config' => [
        'healthCheck' => [
            'enabled' => true || false,
            'healthCheckIntervalSeconds' => <integer>,
            'healthCheckTimeoutSeconds' => <integer>,
            'healthyThresholdCount' => <integer>,
            'matcher' => [
                'httpCode' => '<string>',
            ],
            'path' => '<string>',
            'port' => <integer>,
            'protocol' => 'HTTP|HTTPS|TCP',
            'protocolVersion' => 'HTTP1|HTTP2',
            'unhealthyThresholdCount' => <integer>,
        ],
        'ipAddressType' => 'IPV4|IPV6',
        'lambdaEventStructureVersion' => 'V1|V2',
        'port' => <integer>,
        'protocol' => 'HTTP|HTTPS|TCP',
        'protocolVersion' => 'HTTP1|HTTP2|GRPC',
        'vpcIdentifier' => '<string>',
    ],
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'type' => 'IP|LAMBDA|INSTANCE|ALB', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'config' => [
        'healthCheck' => [
            'enabled' => true || false,
            'healthCheckIntervalSeconds' => <integer>,
            'healthCheckTimeoutSeconds' => <integer>,
            'healthyThresholdCount' => <integer>,
            'matcher' => [
                'httpCode' => '<string>',
            ],
            'path' => '<string>',
            'port' => <integer>,
            'protocol' => 'HTTP|HTTPS|TCP',
            'protocolVersion' => 'HTTP1|HTTP2',
            'unhealthyThresholdCount' => <integer>,
        ],
        'ipAddressType' => 'IPV4|IPV6',
        'lambdaEventStructureVersion' => 'V1|V2',
        'port' => <integer>,
        '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',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

InternalServerException:

An unexpected error occurred while processing the request.

DeleteAccessLogSubscription

$result = $client->deleteAccessLogSubscription([/* ... */]);
$promise = $client->deleteAccessLogSubscriptionAsync([/* ... */]);

Deletes the specified access log subscription.

Parameter Syntax

$result = $client->deleteAccessLogSubscription([
    'accessLogSubscriptionIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

DeleteAuthPolicy

$result = $client->deleteAuthPolicy([/* ... */]);
$promise = $client->deleteAuthPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteAuthPolicy([
    'resourceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

DeleteListener

$result = $client->deleteListener([/* ... */]);
$promise = $client->deleteListenerAsync([/* ... */]);

Deletes the specified listener.

Parameter Syntax

$result = $client->deleteListener([
    'listenerIdentifier' => '<string>', // REQUIRED
    'serviceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes the specified resource policy.

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

DeleteRule

$result = $client->deleteRule([/* ... */]);
$promise = $client->deleteRuleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteRule([
    'listenerIdentifier' => '<string>', // REQUIRED
    'ruleIdentifier' => '<string>', // REQUIRED
    'serviceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

DeleteService

$result = $client->deleteService([/* ... */]);
$promise = $client->deleteServiceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteService([
    'serviceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'status' => 'ACTIVE|CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|CREATE_FAILED|DELETE_FAILED',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

DeleteServiceNetwork

$result = $client->deleteServiceNetwork([/* ... */]);
$promise = $client->deleteServiceNetworkAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteServiceNetwork([
    'serviceNetworkIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

DeleteServiceNetworkServiceAssociation

$result = $client->deleteServiceNetworkServiceAssociation([/* ... */]);
$promise = $client->deleteServiceNetworkServiceAssociationAsync([/* ... */]);

Deletes the association between a specified service and the specific service network. This operation fails if an association is still in progress.

Parameter Syntax

$result = $client->deleteServiceNetworkServiceAssociation([
    'serviceNetworkServiceAssociationIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'status' => 'CREATE_IN_PROGRESS|ACTIVE|DELETE_IN_PROGRESS|CREATE_FAILED|DELETE_FAILED',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

DeleteServiceNetworkVpcAssociation

$result = $client->deleteServiceNetworkVpcAssociation([/* ... */]);
$promise = $client->deleteServiceNetworkVpcAssociationAsync([/* ... */]);

Disassociates the VPC from the service network. You can't disassociate the VPC if there is a create or update association in progress.

Parameter Syntax

$result = $client->deleteServiceNetworkVpcAssociation([
    'serviceNetworkVpcAssociationIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'status' => 'CREATE_IN_PROGRESS|ACTIVE|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|CREATE_FAILED|DELETE_FAILED|UPDATE_FAILED',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

DeleteTargetGroup

$result = $client->deleteTargetGroup([/* ... */]);
$promise = $client->deleteTargetGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteTargetGroup([
    'targetGroupIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'status' => 'CREATE_IN_PROGRESS|ACTIVE|DELETE_IN_PROGRESS|CREATE_FAILED|DELETE_FAILED',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

DeregisterTargets

$result = $client->deregisterTargets([/* ... */]);
$promise = $client->deregisterTargetsAsync([/* ... */]);

Deregisters the specified targets from the specified target group.

Parameter Syntax

$result = $client->deregisterTargets([
    'targetGroupIdentifier' => '<string>', // REQUIRED
    'targets' => [ // REQUIRED
        [
            'id' => '<string>', // REQUIRED
            'port' => <integer>,
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'successful' => [
        [
            'id' => '<string>',
            'port' => <integer>,
        ],
        // ...
    ],
    'unsuccessful' => [
        [
            'failureCode' => '<string>',
            'failureMessage' => '<string>',
            'id' => '<string>',
            'port' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

GetAccessLogSubscription

$result = $client->getAccessLogSubscription([/* ... */]);
$promise = $client->getAccessLogSubscriptionAsync([/* ... */]);

Retrieves information about the specified access log subscription.

Parameter Syntax

$result = $client->getAccessLogSubscription([
    'accessLogSubscriptionIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'destinationArn' => '<string>',
    'id' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'resourceArn' => '<string>',
    'resourceId' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

GetAuthPolicy

$result = $client->getAuthPolicy([/* ... */]);
$promise = $client->getAuthPolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getAuthPolicy([
    'resourceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'lastUpdatedAt' => <DateTime>,
    'policy' => '<string>',
    'state' => 'Active|Inactive',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

GetListener

$result = $client->getListener([/* ... */]);
$promise = $client->getListenerAsync([/* ... */]);

Retrieves information about the specified listener for the specified service.

Parameter Syntax

$result = $client->getListener([
    'listenerIdentifier' => '<string>', // REQUIRED
    'serviceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'defaultAction' => [
        'fixedResponse' => [
            'statusCode' => <integer>,
        ],
        'forward' => [
            'targetGroups' => [
                [
                    'targetGroupIdentifier' => '<string>',
                    'weight' => <integer>,
                ],
                // ...
            ],
        ],
    ],
    'id' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'port' => <integer>,
    'protocol' => 'HTTP|HTTPS|TLS_PASSTHROUGH',
    'serviceArn' => '<string>',
    'serviceId' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

GetResourcePolicy

$result = $client->getResourcePolicy([/* ... */]);
$promise = $client->getResourcePolicyAsync([/* ... */]);

Retrieves information about the resource policy. The resource policy is an IAM policy created on behalf of the resource owner when they share a resource.

Parameter Syntax

$result = $client->getResourcePolicy([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policy' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

GetRule

$result = $client->getRule([/* ... */]);
$promise = $client->getRuleAsync([/* ... */]);

Retrieves information about listener rules. You can also retrieve information about the default listener rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

Parameter Syntax

$result = $client->getRule([
    'listenerIdentifier' => '<string>', // REQUIRED
    'ruleIdentifier' => '<string>', // REQUIRED
    'serviceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'action' => [
        'fixedResponse' => [
            'statusCode' => <integer>,
        ],
        'forward' => [
            'targetGroups' => [
                [
                    'targetGroupIdentifier' => '<string>',
                    'weight' => <integer>,
                ],
                // ...
            ],
        ],
    ],
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'id' => '<string>',
    'isDefault' => true || false,
    'lastUpdatedAt' => <DateTime>,
    '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' => <integer>,
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

GetService

$result = $client->getService([/* ... */]);
$promise = $client->getServiceAsync([/* ... */]);

Retrieves information about the specified service.

Parameter Syntax

$result = $client->getService([
    'serviceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'authType' => 'NONE|AWS_IAM',
    'certificateArn' => '<string>',
    'createdAt' => <DateTime>,
    'customDomainName' => '<string>',
    'dnsEntry' => [
        'domainName' => '<string>',
        'hostedZoneId' => '<string>',
    ],
    'failureCode' => '<string>',
    'failureMessage' => '<string>',
    'id' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'status' => 'ACTIVE|CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|CREATE_FAILED|DELETE_FAILED',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

GetServiceNetwork

$result = $client->getServiceNetwork([/* ... */]);
$promise = $client->getServiceNetworkAsync([/* ... */]);

Retrieves information about the specified service network.

Parameter Syntax

$result = $client->getServiceNetwork([
    'serviceNetworkIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'authType' => 'NONE|AWS_IAM',
    'createdAt' => <DateTime>,
    'id' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'numberOfAssociatedServices' => <integer>,
    'numberOfAssociatedVPCs' => <integer>,
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

GetServiceNetworkServiceAssociation

$result = $client->getServiceNetworkServiceAssociation([/* ... */]);
$promise = $client->getServiceNetworkServiceAssociationAsync([/* ... */]);

Retrieves information about the specified association between a service network and a service.

Parameter Syntax

$result = $client->getServiceNetworkServiceAssociation([
    'serviceNetworkServiceAssociationIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    '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',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

GetServiceNetworkVpcAssociation

$result = $client->getServiceNetworkVpcAssociation([/* ... */]);
$promise = $client->getServiceNetworkVpcAssociationAsync([/* ... */]);

Retrieves information about the association between a service network and a VPC.

Parameter Syntax

$result = $client->getServiceNetworkVpcAssociation([
    'serviceNetworkVpcAssociationIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'failureCode' => '<string>',
    'failureMessage' => '<string>',
    'id' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    '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>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

GetTargetGroup

$result = $client->getTargetGroup([/* ... */]);
$promise = $client->getTargetGroupAsync([/* ... */]);

Retrieves information about the specified target group.

Parameter Syntax

$result = $client->getTargetGroup([
    'targetGroupIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'config' => [
        'healthCheck' => [
            'enabled' => true || false,
            'healthCheckIntervalSeconds' => <integer>,
            'healthCheckTimeoutSeconds' => <integer>,
            'healthyThresholdCount' => <integer>,
            'matcher' => [
                'httpCode' => '<string>',
            ],
            'path' => '<string>',
            'port' => <integer>,
            'protocol' => 'HTTP|HTTPS|TCP',
            'protocolVersion' => 'HTTP1|HTTP2',
            'unhealthyThresholdCount' => <integer>,
        ],
        'ipAddressType' => 'IPV4|IPV6',
        'lambdaEventStructureVersion' => 'V1|V2',
        'port' => <integer>,
        'protocol' => 'HTTP|HTTPS|TCP',
        'protocolVersion' => 'HTTP1|HTTP2|GRPC',
        'vpcIdentifier' => '<string>',
    ],
    'createdAt' => <DateTime>,
    'failureCode' => '<string>',
    'failureMessage' => '<string>',
    'id' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'serviceArns' => ['<string>', ...],
    'status' => 'CREATE_IN_PROGRESS|ACTIVE|DELETE_IN_PROGRESS|CREATE_FAILED|DELETE_FAILED',
    'type' => 'IP|LAMBDA|INSTANCE|ALB',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ListAccessLogSubscriptions

$result = $client->listAccessLogSubscriptions([/* ... */]);
$promise = $client->listAccessLogSubscriptionsAsync([/* ... */]);

Lists all access log subscriptions for the specified service network or service.

Parameter Syntax

$result = $client->listAccessLogSubscriptions([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'destinationArn' => '<string>',
            'id' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'resourceArn' => '<string>',
            'resourceId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

An unexpected error occurred while processing the request.

ListListeners

$result = $client->listListeners([/* ... */]);
$promise = $client->listListenersAsync([/* ... */]);

Lists the listeners for the specified service.

Parameter Syntax

$result = $client->listListeners([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'serviceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'port' => <integer>,
            'protocol' => 'HTTP|HTTPS|TLS_PASSTHROUGH',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ListRules

$result = $client->listRules([/* ... */]);
$promise = $client->listRulesAsync([/* ... */]);

Lists the rules for the listener.

Parameter Syntax

$result = $client->listRules([
    'listenerIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'serviceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'isDefault' => true || false,
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'priority' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ListServiceNetworkServiceAssociations

$result = $client->listServiceNetworkServiceAssociations([/* ... */]);
$promise = $client->listServiceNetworkServiceAssociationsAsync([/* ... */]);

Lists the associations between the service network and the service. You can filter the list either by service or service network. You must provide either the service network identifier or the service identifier.

Every association in Amazon VPC Lattice is given a unique Amazon Resource Name (ARN), such as when a service network is associated with a VPC or when a service is associated with a service network. If the association is for a resource that is shared with another account, the association includes the local account ID as the prefix in the ARN for each account the resource is shared with.

Parameter Syntax

$result = $client->listServiceNetworkServiceAssociations([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'serviceIdentifier' => '<string>',
    'serviceNetworkIdentifier' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            '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>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

An unexpected error occurred while processing the request.

ListServiceNetworkVpcAssociations

$result = $client->listServiceNetworkVpcAssociations([/* ... */]);
$promise = $client->listServiceNetworkVpcAssociationsAsync([/* ... */]);

Lists the service network and VPC associations. You can filter the list either by VPC or service network. You must provide either the service network identifier or the VPC identifier.

Parameter Syntax

$result = $client->listServiceNetworkVpcAssociations([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'serviceNetworkIdentifier' => '<string>',
    'vpcIdentifier' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'id' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            '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>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

An unexpected error occurred while processing the request.

ListServiceNetworks

$result = $client->listServiceNetworks([/* ... */]);
$promise = $client->listServiceNetworksAsync([/* ... */]);

Lists the service networks owned by the caller account or shared with the caller account. Also includes the account ID in the ARN to show which account owns the service network.

Parameter Syntax

$result = $client->listServiceNetworks([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'numberOfAssociatedServices' => <integer>,
            'numberOfAssociatedVPCs' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

An unexpected error occurred while processing the request.

ListServices

$result = $client->listServices([/* ... */]);
$promise = $client->listServicesAsync([/* ... */]);

Lists the services owned by the caller account or shared with the caller account.

Parameter Syntax

$result = $client->listServices([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'customDomainName' => '<string>',
            'dnsEntry' => [
                'domainName' => '<string>',
                'hostedZoneId' => '<string>',
            ],
            'id' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'status' => 'ACTIVE|CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|CREATE_FAILED|DELETE_FAILED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

An unexpected error occurred while processing the request.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags for the specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

ListTargetGroups

$result = $client->listTargetGroups([/* ... */]);
$promise = $client->listTargetGroupsAsync([/* ... */]);

Lists your target groups. You can narrow your search by using the filters below in your request.

Parameter Syntax

$result = $client->listTargetGroups([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'targetGroupType' => 'IP|LAMBDA|INSTANCE|ALB',
    'vpcIdentifier' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'ipAddressType' => 'IPV4|IPV6',
            'lambdaEventStructureVersion' => 'V1|V2',
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'port' => <integer>,
            '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>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

InternalServerException:

An unexpected error occurred while processing the request.

ListTargets

$result = $client->listTargets([/* ... */]);
$promise = $client->listTargetsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listTargets([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'targetGroupIdentifier' => '<string>', // REQUIRED
    'targets' => [
        [
            'id' => '<string>', // REQUIRED
            'port' => <integer>,
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'id' => '<string>',
            'port' => <integer>,
            'reasonCode' => '<string>',
            'status' => 'DRAINING|UNAVAILABLE|HEALTHY|UNHEALTHY|INITIAL|UNUSED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

PutAuthPolicy

$result = $client->putAuthPolicy([/* ... */]);
$promise = $client->putAuthPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putAuthPolicy([
    'policy' => '<string>', // REQUIRED
    'resourceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policy' => '<string>',
    'state' => 'Active|Inactive',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putResourcePolicy([
    'policy' => '<string>', // REQUIRED
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

RegisterTargets

$result = $client->registerTargets([/* ... */]);
$promise = $client->registerTargetsAsync([/* ... */]);

Registers the targets with the target group. If it's a Lambda target, you can only have one target in a target group.

Parameter Syntax

$result = $client->registerTargets([
    'targetGroupIdentifier' => '<string>', // REQUIRED
    'targets' => [ // REQUIRED
        [
            'id' => '<string>', // REQUIRED
            'port' => <integer>,
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'successful' => [
        [
            'id' => '<string>',
            'port' => <integer>,
        ],
        // ...
    ],
    'unsuccessful' => [
        [
            'failureCode' => '<string>',
            'failureMessage' => '<string>',
            'id' => '<string>',
            'port' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

InternalServerException:

An unexpected error occurred while processing the request.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds the specified tags to the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ResourceNotFoundException:

The request references a resource that does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

UpdateAccessLogSubscription

$result = $client->updateAccessLogSubscription([/* ... */]);
$promise = $client->updateAccessLogSubscriptionAsync([/* ... */]);

Updates the specified access log subscription.

Parameter Syntax

$result = $client->updateAccessLogSubscription([
    'accessLogSubscriptionIdentifier' => '<string>', // REQUIRED
    'destinationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'destinationArn' => '<string>',
    'id' => '<string>',
    'resourceArn' => '<string>',
    'resourceId' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

UpdateListener

$result = $client->updateListener([/* ... */]);
$promise = $client->updateListenerAsync([/* ... */]);

Updates the specified listener for the specified service.

Parameter Syntax

$result = $client->updateListener([
    'defaultAction' => [ // REQUIRED
        'fixedResponse' => [
            'statusCode' => <integer>, // REQUIRED
        ],
        'forward' => [
            'targetGroups' => [ // REQUIRED
                [
                    'targetGroupIdentifier' => '<string>', // REQUIRED
                    'weight' => <integer>,
                ],
                // ...
            ],
        ],
    ],
    'listenerIdentifier' => '<string>', // REQUIRED
    'serviceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'defaultAction' => [
        'fixedResponse' => [
            'statusCode' => <integer>,
        ],
        'forward' => [
            'targetGroups' => [
                [
                    'targetGroupIdentifier' => '<string>',
                    'weight' => <integer>,
                ],
                // ...
            ],
        ],
    ],
    'id' => '<string>',
    'name' => '<string>',
    'port' => <integer>,
    'protocol' => 'HTTP|HTTPS|TLS_PASSTHROUGH',
    'serviceArn' => '<string>',
    'serviceId' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

UpdateRule

$result = $client->updateRule([/* ... */]);
$promise = $client->updateRuleAsync([/* ... */]);

Updates a rule for the listener. You can't modify a default listener rule. To modify a default listener rule, use UpdateListener.

Parameter Syntax

$result = $client->updateRule([
    'action' => [
        'fixedResponse' => [
            'statusCode' => <integer>, // REQUIRED
        ],
        'forward' => [
            'targetGroups' => [ // REQUIRED
                [
                    'targetGroupIdentifier' => '<string>', // REQUIRED
                    'weight' => <integer>,
                ],
                // ...
            ],
        ],
    ],
    'listenerIdentifier' => '<string>', // REQUIRED
    'match' => [
        'httpMatch' => [
            'headerMatches' => [
                [
                    'caseSensitive' => true || false,
                    'match' => [ // REQUIRED
                        'contains' => '<string>',
                        'exact' => '<string>',
                        'prefix' => '<string>',
                    ],
                    'name' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'method' => '<string>',
            'pathMatch' => [
                'caseSensitive' => true || false,
                'match' => [ // REQUIRED
                    'exact' => '<string>',
                    'prefix' => '<string>',
                ],
            ],
        ],
    ],
    'priority' => <integer>,
    'ruleIdentifier' => '<string>', // REQUIRED
    'serviceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'action' => [
        'fixedResponse' => [
            'statusCode' => <integer>,
        ],
        'forward' => [
            'targetGroups' => [
                [
                    'targetGroupIdentifier' => '<string>',
                    'weight' => <integer>,
                ],
                // ...
            ],
        ],
    ],
    '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' => <integer>,
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

UpdateService

$result = $client->updateService([/* ... */]);
$promise = $client->updateServiceAsync([/* ... */]);

Updates the specified service.

Parameter Syntax

$result = $client->updateService([
    'authType' => 'NONE|AWS_IAM',
    'certificateArn' => '<string>',
    'serviceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'authType' => 'NONE|AWS_IAM',
    'certificateArn' => '<string>',
    'customDomainName' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

UpdateServiceNetwork

$result = $client->updateServiceNetwork([/* ... */]);
$promise = $client->updateServiceNetworkAsync([/* ... */]);

Updates the specified service network.

Parameter Syntax

$result = $client->updateServiceNetwork([
    'authType' => 'NONE|AWS_IAM', // REQUIRED
    'serviceNetworkIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'authType' => 'NONE|AWS_IAM',
    'id' => '<string>',
    'name' => '<string>',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

UpdateServiceNetworkVpcAssociation

$result = $client->updateServiceNetworkVpcAssociation([/* ... */]);
$promise = $client->updateServiceNetworkVpcAssociationAsync([/* ... */]);

Updates the service network and VPC association. If you add a security group to the service network and VPC association, the association must continue to always have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and recreate it without security groups.

Parameter Syntax

$result = $client->updateServiceNetworkVpcAssociation([
    'securityGroupIds' => ['<string>', ...], // REQUIRED
    'serviceNetworkVpcAssociationIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result 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',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.

UpdateTargetGroup

$result = $client->updateTargetGroup([/* ... */]);
$promise = $client->updateTargetGroupAsync([/* ... */]);

Updates the specified target group.

Parameter Syntax

$result = $client->updateTargetGroup([
    'healthCheck' => [ // REQUIRED
        'enabled' => true || false,
        'healthCheckIntervalSeconds' => <integer>,
        'healthCheckTimeoutSeconds' => <integer>,
        'healthyThresholdCount' => <integer>,
        'matcher' => [
            'httpCode' => '<string>',
        ],
        'path' => '<string>',
        'port' => <integer>,
        'protocol' => 'HTTP|HTTPS|TCP',
        'protocolVersion' => 'HTTP1|HTTP2',
        'unhealthyThresholdCount' => <integer>,
    ],
    'targetGroupIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'config' => [
        'healthCheck' => [
            'enabled' => true || false,
            'healthCheckIntervalSeconds' => <integer>,
            'healthCheckTimeoutSeconds' => <integer>,
            'healthyThresholdCount' => <integer>,
            'matcher' => [
                'httpCode' => '<string>',
            ],
            'path' => '<string>',
            'port' => <integer>,
            'protocol' => 'HTTP|HTTPS|TCP',
            'protocolVersion' => 'HTTP1|HTTP2',
            'unhealthyThresholdCount' => <integer>,
        ],
        'ipAddressType' => 'IPV4|IPV6',
        'lambdaEventStructureVersion' => 'V1|V2',
        'port' => <integer>,
        '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',
]

Result Details

Errors

ValidationException:

The input does not satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

The user does not have sufficient access to perform this action.

ThrottlingException:

The limit on the number of requests per second was exceeded.

ResourceNotFoundException:

The request references a resource that does not exist.

ConflictException:

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An unexpected error occurred while processing the request.