diff --git a/clients/client-vpc-lattice/src/commands/BatchUpdateRuleCommand.ts b/clients/client-vpc-lattice/src/commands/BatchUpdateRuleCommand.ts index 56684e9a9a13e..94191d322c958 100644 --- a/clients/client-vpc-lattice/src/commands/BatchUpdateRuleCommand.ts +++ b/clients/client-vpc-lattice/src/commands/BatchUpdateRuleCommand.ts @@ -28,7 +28,13 @@ export interface BatchUpdateRuleCommandOutput extends BatchUpdateRuleResponse, _ /** *

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.

+ * 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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-vpc-lattice/src/commands/CreateAccessLogSubscriptionCommand.ts b/clients/client-vpc-lattice/src/commands/CreateAccessLogSubscriptionCommand.ts index a10dcc41bc456..f74f976b6bb02 100644 --- a/clients/client-vpc-lattice/src/commands/CreateAccessLogSubscriptionCommand.ts +++ b/clients/client-vpc-lattice/src/commands/CreateAccessLogSubscriptionCommand.ts @@ -33,7 +33,7 @@ export interface CreateAccessLogSubscriptionCommandOutput /** *

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 will only + * 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 diff --git a/clients/client-vpc-lattice/src/commands/CreateServiceNetworkServiceAssociationCommand.ts b/clients/client-vpc-lattice/src/commands/CreateServiceNetworkServiceAssociationCommand.ts index a3a4c239a4044..46f667fd9b12c 100644 --- a/clients/client-vpc-lattice/src/commands/CreateServiceNetworkServiceAssociationCommand.ts +++ b/clients/client-vpc-lattice/src/commands/CreateServiceNetworkServiceAssociationCommand.ts @@ -36,7 +36,7 @@ export interface CreateServiceNetworkServiceAssociationCommandOutput __MetadataBearer {} /** - *

Associates a service with a service network.

+ *

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.

diff --git a/clients/client-vpc-lattice/src/commands/CreateServiceNetworkVpcAssociationCommand.ts b/clients/client-vpc-lattice/src/commands/CreateServiceNetworkVpcAssociationCommand.ts index 02aade459231c..be0feff93aefa 100644 --- a/clients/client-vpc-lattice/src/commands/CreateServiceNetworkVpcAssociationCommand.ts +++ b/clients/client-vpc-lattice/src/commands/CreateServiceNetworkVpcAssociationCommand.ts @@ -42,9 +42,10 @@ export interface CreateServiceNetworkVpcAssociationCommandOutput * 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.

- *

Once a security group is added to the VPC association it cannot be removed. You can add or - * update the security groups being used for the VPC association once a security group is attached. - * To remove all security groups you must reassociate the VPC.

+ *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-vpc-lattice/src/commands/DeleteAuthPolicyCommand.ts b/clients/client-vpc-lattice/src/commands/DeleteAuthPolicyCommand.ts index 17fa10d12d891..991842411a1d8 100644 --- a/clients/client-vpc-lattice/src/commands/DeleteAuthPolicyCommand.ts +++ b/clients/client-vpc-lattice/src/commands/DeleteAuthPolicyCommand.ts @@ -27,10 +27,10 @@ export interface DeleteAuthPolicyCommandInput extends DeleteAuthPolicyRequest {} export interface DeleteAuthPolicyCommandOutput extends DeleteAuthPolicyResponse, __MetadataBearer {} /** - *

Deletes the specified auth policy. If an auth is set to Amazon Web Services_IAM - * and the auth policy is deleted, all requests will be denied by default. 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 will be denied.

+ *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-vpc-lattice/src/commands/DeleteServiceNetworkServiceAssociationCommand.ts b/clients/client-vpc-lattice/src/commands/DeleteServiceNetworkServiceAssociationCommand.ts index e7be691e6c9e0..9bfc55e60acf1 100644 --- a/clients/client-vpc-lattice/src/commands/DeleteServiceNetworkServiceAssociationCommand.ts +++ b/clients/client-vpc-lattice/src/commands/DeleteServiceNetworkServiceAssociationCommand.ts @@ -37,7 +37,7 @@ export interface DeleteServiceNetworkServiceAssociationCommandOutput /** *

Deletes the association between a specified service and the specific service network. This - * request will fail if an association is still in progress.

+ * operation fails if an association is still in progress.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-vpc-lattice/src/commands/GetResourcePolicyCommand.ts b/clients/client-vpc-lattice/src/commands/GetResourcePolicyCommand.ts index 3b69432cb57cf..cfe86212de4d0 100644 --- a/clients/client-vpc-lattice/src/commands/GetResourcePolicyCommand.ts +++ b/clients/client-vpc-lattice/src/commands/GetResourcePolicyCommand.ts @@ -28,7 +28,7 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyRespons /** *

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

+ * created on behalf of the resource owner when they share a resource.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-vpc-lattice/src/commands/ListServiceNetworkServiceAssociationsCommand.ts b/clients/client-vpc-lattice/src/commands/ListServiceNetworkServiceAssociationsCommand.ts index b341a8e43a58b..f6dd3e1d39f04 100644 --- a/clients/client-vpc-lattice/src/commands/ListServiceNetworkServiceAssociationsCommand.ts +++ b/clients/client-vpc-lattice/src/commands/ListServiceNetworkServiceAssociationsCommand.ts @@ -41,8 +41,8 @@ export interface ListServiceNetworkServiceAssociationsCommandOutput * 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 will - * include the local account ID as the prefix in the ARN for each account the resource is shared + * 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.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-vpc-lattice/src/commands/ListTargetsCommand.ts b/clients/client-vpc-lattice/src/commands/ListTargetsCommand.ts index 5b17ecd9178bd..197c31bc822bc 100644 --- a/clients/client-vpc-lattice/src/commands/ListTargetsCommand.ts +++ b/clients/client-vpc-lattice/src/commands/ListTargetsCommand.ts @@ -28,7 +28,7 @@ export interface ListTargetsCommandOutput extends ListTargetsResponse, __Metadat /** *

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.

+ * this API to check the health status of targets. You can also filter the results by target.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-vpc-lattice/src/commands/PutAuthPolicyCommand.ts b/clients/client-vpc-lattice/src/commands/PutAuthPolicyCommand.ts index 5c200094e2399..bf9256b39e4c6 100644 --- a/clients/client-vpc-lattice/src/commands/PutAuthPolicyCommand.ts +++ b/clients/client-vpc-lattice/src/commands/PutAuthPolicyCommand.ts @@ -27,7 +27,10 @@ export interface PutAuthPolicyCommandInput extends PutAuthPolicyRequest {} export interface PutAuthPolicyCommandOutput extends PutAuthPolicyResponse, __MetadataBearer {} /** - *

Creates or updates the auth policy.

+ *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-vpc-lattice/src/commands/UpdateServiceNetworkVpcAssociationCommand.ts b/clients/client-vpc-lattice/src/commands/UpdateServiceNetworkVpcAssociationCommand.ts index 9af13dd862f69..2e468938dd877 100644 --- a/clients/client-vpc-lattice/src/commands/UpdateServiceNetworkVpcAssociationCommand.ts +++ b/clients/client-vpc-lattice/src/commands/UpdateServiceNetworkVpcAssociationCommand.ts @@ -35,8 +35,10 @@ export interface UpdateServiceNetworkVpcAssociationCommandOutput __MetadataBearer {} /** - *

Updates the service network and VPC association. Once you add a security group, it cannot be - * removed.

+ *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-vpc-lattice/src/models/models_0.ts b/clients/client-vpc-lattice/src/models/models_0.ts index c8c7c789c7564..eb082a772680e 100644 --- a/clients/client-vpc-lattice/src/models/models_0.ts +++ b/clients/client-vpc-lattice/src/models/models_0.ts @@ -244,7 +244,7 @@ export interface ValidationExceptionField { name: string | undefined; /** - *

Additional details about why the validation failed.

+ *

Additional information about why the validation failed.

* @public */ message: string | undefined; @@ -455,7 +455,7 @@ export interface AccessLogSubscriptionSummary { */ export interface ListAccessLogSubscriptionsResponse { /** - *

The access log subscriptions.

+ *

Information about the access log subscriptions.

* @public */ items: AccessLogSubscriptionSummary[] | undefined; @@ -548,7 +548,7 @@ export const AuthType = { export type AuthType = (typeof AuthType)[keyof typeof AuthType]; /** - *

Information about an action that returns a custom HTTP response.

+ *

Describes an action that returns a custom HTTP response.

* @public */ export interface FixedResponseAction { @@ -571,7 +571,7 @@ export interface WeightedTargetGroup { targetGroupIdentifier: string | undefined; /** - *

Only required if you specify multiple target groups for a forward action. The "weight" + *

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 @@ -596,16 +596,14 @@ export interface ForwardAction { * 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 traffic will go to that target group.

+ * need to set the weight; 100% of the traffic goes to that target group.

* @public */ targetGroups: WeightedTargetGroup[] | undefined; } /** - *

Describes the action for a rule. Each rule must include exactly one of the following types - * of actions: forward or fixed-response, and it must be the last action - * to be performed.

+ *

Describes the action for a rule.

* @public */ export type RuleAction = RuleAction.FixedResponseMember | RuleAction.ForwardMember | RuleAction.$UnknownMember; @@ -626,7 +624,7 @@ export namespace RuleAction { } /** - *

Describes the rule action that returns a custom HTTP response.

+ *

The fixed response action. The rule returns a custom HTTP response.

* @public */ export interface FixedResponseMember { @@ -658,7 +656,7 @@ export namespace RuleAction { } /** - *

Describes a header match type. Only one can be provided.

+ *

Describes a header match type.

* @public */ export type HeaderMatchType = @@ -672,7 +670,7 @@ export type HeaderMatchType = */ export namespace HeaderMatchType { /** - *

Specifies an exact type match.

+ *

An exact type match.

* @public */ export interface ExactMember { @@ -683,7 +681,7 @@ export namespace HeaderMatchType { } /** - *

Specifies a prefix type match. Matches the value with the prefix.

+ *

A prefix type match. Matches the value with the prefix.

* @public */ export interface PrefixMember { @@ -694,7 +692,7 @@ export namespace HeaderMatchType { } /** - *

Specifies a contains type match.

+ *

A contains type match.

* @public */ export interface ContainsMember { @@ -748,7 +746,7 @@ export interface HeaderMatch { match: HeaderMatchType | undefined; /** - *

Indicates whether the match is case sensitive. Defaults to false.

+ *

Indicates whether the match is case sensitive.

* @public */ caseSensitive?: boolean; @@ -820,7 +818,7 @@ export interface PathMatch { match: PathMatchType | undefined; /** - *

Indicates whether the match is case sensitive. Defaults to false.

+ *

Indicates whether the match is case sensitive.

* @public */ caseSensitive?: boolean; @@ -890,7 +888,7 @@ export namespace RuleMatch { } /** - *

Represents an object when updating a rule.

+ *

Describes a rule update.

* @public */ export interface RuleUpdate { @@ -984,7 +982,7 @@ export interface RuleUpdateSuccess { priority?: number; /** - *

The action for the default rule.

+ *

The action for the rule.

* @public */ action?: RuleAction; @@ -1044,6 +1042,10 @@ export const ListenerProtocol = { * Indicates HTTPS protocol */ HTTPS: "HTTPS", + /** + * Indicates TLS_PASSTHROUGH protocol + */ + TLS_PASSTHROUGH: "TLS_PASSTHROUGH", } as const; /** @@ -1069,24 +1071,21 @@ export interface CreateListenerRequest { name: string | undefined; /** - *

The listener protocol HTTP or HTTPS.

+ *

The listener protocol.

* @public */ protocol: ListenerProtocol | undefined; /** - *

The listener port. You can specify a value from 1 to 65535. For - * HTTP, the default is 80. For HTTPS, the default is 443.

+ *

The listener port. You can specify a value from 1 to 65535. For + * HTTP, the default is 80. For HTTPS, the default is 443.

* @public */ port?: number; /** - *

The action for the default rule. Each listener has a default rule. Each rule consists of a - * priority, one or more actions, and one or more conditions. The default rule is the rule that's - * used if no other rules match. Each rule must include exactly one of the following types of - * actions: forward or fixed-response, and it must be the last action to - * be performed.

+ *

The action for the default rule. Each listener has a default rule. The default rule is used + * if no other rules match.

* @public */ defaultAction: RuleAction | undefined; @@ -1304,9 +1303,7 @@ export interface CreateRuleResponse { priority?: number; /** - *

The rule action. Each rule must include exactly one of the following types of actions: - * forward or fixed-response, and it must be the last action to be - * performed.

+ *

The rule action.

* @public */ action?: RuleAction; @@ -1452,7 +1449,7 @@ export interface CreateServiceResponse { certificateArn?: string; /** - *

The status. If the status is CREATE_FAILED, you will have to delete and + *

The status. If the status is CREATE_FAILED, you must delete and * recreate the service.

* @public */ @@ -1620,7 +1617,7 @@ export interface CreateServiceNetworkServiceAssociationResponse { id?: string; /** - *

The operation's status.

+ *

The association status.

* @public */ status?: ServiceNetworkServiceAssociationStatus; @@ -1745,7 +1742,7 @@ export interface CreateServiceNetworkVpcAssociationResponse { id?: string; /** - *

The operation's status.

+ *

The association status.

* @public */ status?: ServiceNetworkVpcAssociationStatus; @@ -1770,7 +1767,7 @@ export interface CreateServiceNetworkVpcAssociationResponse { } /** - *

The codes to use when checking for a successful response from a target for health + *

Describes the codes to use when checking for a successful response from a target for health * checks.

* @public */ @@ -1821,6 +1818,10 @@ export const TargetGroupProtocol = { * Indicates HTTPS protocol */ HTTPS: "HTTPS", + /** + * Indicates TCP protocol + */ + TCP: "TCP", } as const; /** @@ -1849,8 +1850,8 @@ export const HealthCheckProtocolVersion = { export type HealthCheckProtocolVersion = (typeof HealthCheckProtocolVersion)[keyof typeof HealthCheckProtocolVersion]; /** - *

The health check configuration of a target group. Health check configurations aren't used - * for LAMBDA and ALB target groups.

+ *

Describes the health check configuration of a target group. Health check configurations aren't used + * for target groups of type LAMBDA or ALB.

* @public */ export interface HealthCheckConfig { @@ -1920,8 +1921,7 @@ export interface HealthCheckConfig { unhealthyThresholdCount?: number; /** - *

The codes to use when checking for a successful response from a target. These are called - * Success codes in the console.

+ *

The codes to use when checking for a successful response from a target.

* @public */ matcher?: Matcher; @@ -1993,53 +1993,56 @@ export const TargetGroupProtocolVersion = { export type TargetGroupProtocolVersion = (typeof TargetGroupProtocolVersion)[keyof typeof TargetGroupProtocolVersion]; /** - *

Describes the configuration of a target group. Lambda functions don't support target group - * configuration.

+ *

Describes the configuration of a target group.

+ *

For more information, see Target groups in the + * Amazon VPC Lattice User Guide.

* @public */ export interface TargetGroupConfig { /** - *

The port on which the targets are listening. For HTTP, the default is 80. For - * HTTPS, the default is 443 - *

+ *

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.

* @public */ port?: number; /** - *

The protocol to use for routing traffic to the targets. Default is the protocol of a target - * group.

+ *

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.

* @public */ protocol?: TargetGroupProtocol; /** - *

The protocol version. Default value is HTTP1.

+ *

The protocol version. The default is HTTP1. + * Not supported if the target group type is LAMBDA.

* @public */ protocolVersion?: TargetGroupProtocolVersion; /** - *

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 IP address type defaults to ipv4.

+ *

The type of IP address used for the target group. Supported only if the target group + * type is IP. The default is IPV4.

* @public */ ipAddressType?: IpAddressType; /** - *

The ID of the VPC.

+ *

The ID of the VPC. Not supported if the target group type is LAMBDA.

* @public */ vpcIdentifier?: string; /** - *

The health check configuration.

+ *

The health check configuration. Not supported if the target group type is + * LAMBDA or ALB.

* @public */ healthCheck?: HealthCheckConfig; /** - * Lambda event structure version + *

The version of the event structure that your Lambda function receives. + * Supported only if the target group type is LAMBDA. The default is V1.

* @public */ lambdaEventStructureVersion?: LambdaEventStructureVersion; @@ -2091,8 +2094,7 @@ export interface CreateTargetGroupRequest { type: TargetGroupType | undefined; /** - *

The target group configuration. If type is set to LAMBDA, this - * parameter doesn't apply.

+ *

The target group configuration.

* @public */ config?: TargetGroupConfig; @@ -2174,16 +2176,15 @@ export interface CreateTargetGroupResponse { type?: TargetGroupType; /** - *

The target group configuration. If type is set to LAMBDA, this - * parameter doesn't apply.

+ *

The target group configuration.

* @public */ config?: TargetGroupConfig; /** - *

The operation's 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.

+ *

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.

* @public */ status?: TargetGroupStatus; @@ -2351,9 +2352,9 @@ export interface DeleteServiceNetworkServiceAssociationResponse { id?: string; /** - *

The operation's 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.

+ *

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.

* @public */ status?: ServiceNetworkServiceAssociationStatus; @@ -2388,7 +2389,7 @@ export interface DeleteServiceNetworkVpcAssociationResponse { /** *

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 + * However, if you retry it while the status is DELETE_IN_PROGRESS, there is no change * in the status.

* @public */ @@ -2443,17 +2444,17 @@ export interface DeleteTargetGroupResponse { */ export interface Target { /** - *

The ID of the target. If the target type of the target group is INSTANCE, this - * is an instance ID. If the target type is IP , this is an IP address. If the target - * type is LAMBDA, this is the ARN of the Lambda function. If the target type is - * ALB, this is the ARN of the Application Load Balancer.

+ *

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.

* @public */ id: string | undefined; /** - *

The port on which the target is listening. For HTTP, the default is 80. For - * HTTPS, the default is 443.

+ *

The port on which the target is listening. For HTTP, the default is 80. For + * HTTPS, the default is 443.

* @public */ port?: number; @@ -2482,10 +2483,10 @@ export interface DeregisterTargetsRequest { */ export interface TargetFailure { /** - *

The ID of the target. If the target type of the target group is INSTANCE, this - * is an instance ID. If the target type is IP , this is an IP address. If the target - * type is LAMBDA, this is the ARN of the Lambda function. If the target type is - * ALB, this is the ARN of the Application Load Balancer.

+ *

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.

* @public */ id?: string; @@ -2550,11 +2551,9 @@ export interface GetAuthPolicyResponse { /** *

The state of the auth policy. The auth policy is only active when the auth type is set to - * Amazon Web Services_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 you provide will remain inactive. For more - * information, see Create a service - * network in the Amazon VPC Lattice User Guide.

+ * 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.

* @public */ state?: AuthPolicyState; @@ -2660,7 +2659,7 @@ export interface GetListenerResponse { */ export interface GetResourcePolicyRequest { /** - *

An IAM policy.

+ *

The Amazon Resource Name (ARN) of the service network or service.

* @public */ resourceArn: string | undefined; @@ -2671,7 +2670,7 @@ export interface GetResourcePolicyRequest { */ export interface GetResourcePolicyResponse { /** - *

The Amazon Resource Name (ARN) of the service network or service.

+ *

An IAM policy.

* @public */ policy?: string; @@ -3000,7 +2999,7 @@ export interface GetServiceNetworkServiceAssociationResponse { dnsEntry?: DnsEntry; /** - *

The custom domain name of the service.

+ *

The custom domain name of the service.

* @public */ customDomainName?: string; @@ -3413,15 +3412,13 @@ export interface RuleSummary { name?: string; /** - *

Indicates whether this is the default rule. Listener rules are created when you create a - * listener. Each listener has a default rule for checking connection requests. - *

+ *

Indicates whether this is the default listener rule.

* @public */ isDefault?: boolean; /** - *

The priority of the rule.

+ *

The priority of the rule.

* @public */ priority?: number; @@ -3641,13 +3638,13 @@ export interface ServiceNetworkServiceAssociationSummary { serviceNetworkArn?: string; /** - *

DNS information about the service.

+ *

The DNS information.

* @public */ dnsEntry?: DnsEntry; /** - *

The custom domain name of the service.

+ *

The custom domain name of the service.

* @public */ customDomainName?: string; @@ -3836,13 +3833,13 @@ export interface ServiceSummary { lastUpdatedAt?: Date; /** - *

DNS information about the service.

+ *

The DNS information.

* @public */ dnsEntry?: DnsEntry; /** - *

The custom domain name of the service.

+ *

The custom domain name of the service.

* @public */ customDomainName?: string; @@ -3859,7 +3856,7 @@ export interface ServiceSummary { */ export interface ListServicesResponse { /** - *

The services.

+ *

Information about the services.

* @public */ items?: ServiceSummary[]; @@ -3887,7 +3884,7 @@ export interface ListTagsForResourceRequest { */ export interface ListTagsForResourceResponse { /** - *

The tags.

+ *

Information about the tags.

* @public */ tags?: Record; @@ -3910,7 +3907,7 @@ export interface ListTargetGroupsRequest { nextToken?: string; /** - *

The ID or Amazon Resource Name (ARN) of the service.

+ *

The ID or Amazon Resource Name (ARN) of the VPC.

* @public */ vpcIdentifier?: string; @@ -3924,6 +3921,8 @@ export interface ListTargetGroupsRequest { /** *

Summary information about a target group.

+ *

For more information, see Target groups in the + * Amazon VPC Lattice User Guide.

* @public */ export interface TargetGroupSummary { @@ -3970,8 +3969,9 @@ export interface TargetGroupSummary { protocol?: TargetGroupProtocol; /** - *

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 IP address type defaults to ipv4.

+ *

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.

* @public */ ipAddressType?: IpAddressType; @@ -3996,13 +3996,14 @@ export interface TargetGroupSummary { status?: TargetGroupStatus; /** - *

The list of Amazon Resource Names (ARNs) of the service.

+ *

The Amazon Resource Names (ARNs) of the service.

* @public */ serviceArns?: string[]; /** - * Lambda event structure version + *

The version of the event structure that your Lambda function receives. + * Supported only if the target group type is LAMBDA.

* @public */ lambdaEventStructureVersion?: LambdaEventStructureVersion; @@ -4048,7 +4049,7 @@ export interface ListTargetsRequest { nextToken?: string; /** - *

The targets to list.

+ *

The targets.

* @public */ targets?: Target[]; @@ -4096,10 +4097,10 @@ export type TargetStatus = (typeof TargetStatus)[keyof typeof TargetStatus]; */ export interface TargetSummary { /** - *

The ID of the target. If the target type of the target group is INSTANCE, this - * is an instance ID. If the target type is IP , this is an IP address. If the target - * type is LAMBDA, this is the ARN of the Lambda function. If the target type is - * ALB, this is the ARN of the Application Load Balancer.

+ *

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.

* @public */ id?: string; @@ -4115,29 +4116,29 @@ export interface TargetSummary { * * @public @@ -4180,7 +4181,7 @@ export interface PutAuthPolicyRequest { resourceIdentifier: string | undefined; /** - *

The auth policy.

+ *

The auth policy. The policy string in JSON must not contain newlines or blank lines.

* @public */ policy: string | undefined; @@ -4191,18 +4192,16 @@ export interface PutAuthPolicyRequest { */ export interface PutAuthPolicyResponse { /** - *

The auth policy.

+ *

The auth policy. The policy string in JSON must not contain newlines or blank lines.

* @public */ policy?: string; /** *

The state of the auth policy. The auth policy is only active when the auth type is set to - * Amazon Web Services_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 you provide will remain inactive. For more - * information, see Create a service - * network in the Amazon VPC Lattice User Guide.

+ * 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.

* @public */ state?: AuthPolicyState; @@ -4220,7 +4219,8 @@ export interface PutResourcePolicyRequest { resourceArn: string | undefined; /** - *

An IAM policy.

+ *

An IAM policy. The policy string in JSON must not contain newlines or blank + * lines.

* @public */ policy: string | undefined; @@ -4330,7 +4330,7 @@ export interface UpdateServiceRequest { serviceIdentifier: string | undefined; /** - *

The Amazon Resource Name (ARN) of the certificate.

+ *

The Amazon Resource Name (ARN) of the certificate.

* @public */ certificateArn?: string; @@ -4381,7 +4381,7 @@ export interface UpdateServiceResponse { customDomainName?: string; /** - *

The Amazon Resource Name (ARN) of the certificate.

+ *

The Amazon Resource Name (ARN) of the certificate.

* @public */ certificateArn?: string; @@ -4460,7 +4460,7 @@ export interface UpdateServiceNetworkVpcAssociationRequest { serviceNetworkVpcAssociationIdentifier: string | undefined; /** - *

The IDs of the security groups. Once you add a security group, it cannot be removed.

+ *

The IDs of the security groups.

* @public */ securityGroupIds: string[] | undefined; diff --git a/codegen/sdk-codegen/aws-models/vpc-lattice.json b/codegen/sdk-codegen/aws-models/vpc-lattice.json index a528f5f9587df..38d477fe0a77c 100644 --- a/codegen/sdk-codegen/aws-models/vpc-lattice.json +++ b/codegen/sdk-codegen/aws-models/vpc-lattice.json @@ -229,7 +229,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the listener rules in a batch. You can use this operation to change the priority of\n listener rules. This can be useful when bulk updating or swapping rule priority.

", + "smithy.api#documentation": "

Updates the listener rules in a batch. You can use this operation to change the priority of\n listener rules. This can be useful when bulk updating or swapping rule priority.

\n

\n Required permissions:\n vpc-lattice:UpdateRule\n

\n

For more information, see How Amazon VPC Lattice works with\n IAM in the Amazon VPC Lattice User Guide.

", "smithy.api#http": { "code": 200, "method": "PATCH", @@ -364,7 +364,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner\n can use the access logs to audit the services in the network. The service network owner will only\n see access logs from clients and services that are associated with their service network. Access\n log entries represent traffic originated from VPCs associated with that network. For more\n information, see Access logs in the\n Amazon VPC Lattice User Guide.

", + "smithy.api#documentation": "

Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner\n can use the access logs to audit the services in the network. The service network owner can only\n see access logs from clients and services that are associated with their service network. Access\n log entries represent traffic originated from VPCs associated with that network. For more\n information, see Access logs in the\n Amazon VPC Lattice User Guide.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -507,20 +507,20 @@ "protocol": { "target": "com.amazonaws.vpclattice#ListenerProtocol", "traits": { - "smithy.api#documentation": "

The listener protocol HTTP or HTTPS.

", + "smithy.api#documentation": "

The listener protocol.

", "smithy.api#required": {} } }, "port": { "target": "com.amazonaws.vpclattice#Port", "traits": { - "smithy.api#documentation": "

The listener port. You can specify a value from 1 to 65535. For\n HTTP, the default is 80. For HTTPS, the default is 443.

" + "smithy.api#documentation": "

The listener port. You can specify a value from 1 to 65535. For\n HTTP, the default is 80. For HTTPS, the default is 443.

" } }, "defaultAction": { "target": "com.amazonaws.vpclattice#RuleAction", "traits": { - "smithy.api#documentation": "

The action for the default rule. Each listener has a default rule. Each rule consists of a\n priority, one or more actions, and one or more conditions. The default rule is the rule that's\n used if no other rules match. Each rule must include exactly one of the following types of\n actions: forward or fixed-response, and it must be the last action to\n be performed.

", + "smithy.api#documentation": "

The action for the default rule. Each listener has a default rule. The default rule is used \n if no other rules match.

", "smithy.api#required": {} } }, @@ -731,7 +731,7 @@ "action": { "target": "com.amazonaws.vpclattice#RuleAction", "traits": { - "smithy.api#documentation": "

The rule action. Each rule must include exactly one of the following types of actions:\n forward or fixed-response, and it must be the last action to be\n performed.

" + "smithy.api#documentation": "

The rule action.

" } } } @@ -910,7 +910,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a service with a service network.

\n

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

\n

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

\n

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

", + "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

", "smithy.api#http": { "code": 200, "uri": "/servicenetworkserviceassociations", @@ -963,7 +963,7 @@ "status": { "target": "com.amazonaws.vpclattice#ServiceNetworkServiceAssociationStatus", "traits": { - "smithy.api#documentation": "

The operation's status.

" + "smithy.api#documentation": "

The association status.

" } }, "arn": { @@ -1024,7 +1024,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a VPC with a service network. When you associate a VPC with the service network,\n it enables all the resources within that VPC to be clients and communicate with other services in\n the service network. For more information, see Manage VPC associations in the Amazon VPC Lattice User Guide.

\n

You can't use this operation if there is a disassociation in progress. If the association\n fails, retry by deleting the association and recreating it.

\n

As a result of this operation, the association gets created in the service network account\n and the VPC owner account.

\n

Once a security group is added to the VPC association it cannot be removed. You can add or\n update the security groups being used for the VPC association once a security group is attached.\n To remove all security groups you must reassociate the VPC.

", + "smithy.api#documentation": "

Associates a VPC with a service network. When you associate a VPC with the service network,\n it enables all the resources within that VPC to be clients and communicate with other services in\n the service network. For more information, see Manage VPC associations in the Amazon VPC Lattice User Guide.

\n

You can't use this operation if there is a disassociation in progress. If the association\n fails, retry by deleting the association and recreating it.

\n

As a result of this operation, the association gets created in the service network account\n and the VPC owner account.

\n

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

", "smithy.api#http": { "code": 200, "uri": "/servicenetworkvpcassociations", @@ -1087,7 +1087,7 @@ "status": { "target": "com.amazonaws.vpclattice#ServiceNetworkVpcAssociationStatus", "traits": { - "smithy.api#documentation": "

The operation's status.

" + "smithy.api#documentation": "

The association status.

" } }, "arn": { @@ -1189,7 +1189,7 @@ "status": { "target": "com.amazonaws.vpclattice#ServiceStatus", "traits": { - "smithy.api#documentation": "

The status. If the status is CREATE_FAILED, you will have to delete and\n recreate the service.

" + "smithy.api#documentation": "

The status. If the status is CREATE_FAILED, you must delete and\n recreate the service.

" } }, "authType": { @@ -1267,7 +1267,7 @@ "config": { "target": "com.amazonaws.vpclattice#TargetGroupConfig", "traits": { - "smithy.api#documentation": "

The target group configuration. If type is set to LAMBDA, this\n parameter doesn't apply.

" + "smithy.api#documentation": "

The target group configuration.

" } }, "clientToken": { @@ -1315,13 +1315,13 @@ "config": { "target": "com.amazonaws.vpclattice#TargetGroupConfig", "traits": { - "smithy.api#documentation": "

The target group configuration. If type is set to LAMBDA, this\n parameter doesn't apply.

" + "smithy.api#documentation": "

The target group configuration.

" } }, "status": { "target": "com.amazonaws.vpclattice#TargetGroupStatus", "traits": { - "smithy.api#documentation": "

The operation's status. You can retry the operation if the status is\n CREATE_FAILED. However, if you retry it while the status is\n CREATE_IN_PROGRESS, there is no change in the status.

" + "smithy.api#documentation": "

The status. You can retry the operation if the status is CREATE_FAILED. \n However, if you retry it while the status is CREATE_IN_PROGRESS, there is \n no change in the status.

" } } } @@ -1404,7 +1404,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified auth policy. If an auth is set to Amazon Web Services_IAM\n and the auth policy is deleted, all requests will be denied by default. If you are trying to\n remove the auth policy completely, you must set the auth_type to NONE. If auth is\n enabled on the resource, but no auth policy is set, all requests will be denied.

", + "smithy.api#documentation": "

Deletes the specified auth policy. If an auth is set to AWS_IAM and the auth\n policy is deleted, all requests are denied. If you are trying to remove the auth\n policy completely, you must set the auth type to NONE. If auth is enabled on the\n resource, but no auth policy is set, all requests are denied.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -1738,7 +1738,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the association between a specified service and the specific service network. This\n request will fail if an association is still in progress.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "uri": "/servicenetworkserviceassociations/{serviceNetworkServiceAssociationIdentifier}", @@ -1772,7 +1772,7 @@ "status": { "target": "com.amazonaws.vpclattice#ServiceNetworkServiceAssociationStatus", "traits": { - "smithy.api#documentation": "

The operation's status. You can retry the operation if the status is\n DELETE_FAILED. However, if you retry it when the status is\n DELETE_IN_PROGRESS, there is no change in the status.

" + "smithy.api#documentation": "

The status. You can retry the operation if the status is DELETE_FAILED. \n However, if you retry it when the status is DELETE_IN_PROGRESS, there is no \n change in the status.

" } }, "arn": { @@ -1846,7 +1846,7 @@ "status": { "target": "com.amazonaws.vpclattice#ServiceNetworkVpcAssociationStatus", "traits": { - "smithy.api#documentation": "

The status. You can retry the operation if the status is DELETE_FAILED.\n However, if you retry it when the status is DELETE_IN_PROGRESS, there is no change\n in the status.

" + "smithy.api#documentation": "

The status. You can retry the operation if the status is DELETE_FAILED.\n However, if you retry it while the status is DELETE_IN_PROGRESS, there is no change\n in the status.

" } }, "arn": { @@ -2087,7 +2087,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about an action that returns a custom HTTP response.

" + "smithy.api#documentation": "

Describes an action that returns a custom HTTP response.

" } }, "com.amazonaws.vpclattice#ForwardAction": { @@ -2096,7 +2096,7 @@ "targetGroups": { "target": "com.amazonaws.vpclattice#WeightedTargetGroupList", "traits": { - "smithy.api#documentation": "

The target groups. Traffic matching the rule is forwarded to the specified target groups.\n With forward actions, you can assign a weight that controls the prioritization and selection of\n each target group. This means that requests are distributed to individual target groups based on\n their weights. For example, if two target groups have the same weight, each target group receives\n half of the traffic.

\n

The default value is 1. This means that if only one target group is provided, there is no\n need to set the weight; 100% of traffic will go to that target group.

", + "smithy.api#documentation": "

The target groups. Traffic matching the rule is forwarded to the specified target groups.\n With forward actions, you can assign a weight that controls the prioritization and selection of\n each target group. This means that requests are distributed to individual target groups based on\n their weights. For example, if two target groups have the same weight, each target group receives\n half of the traffic.

\n

The default value is 1. This means that if only one target group is provided, there is no\n need to set the weight; 100% of the traffic goes to that target group.

", "smithy.api#required": {} } } @@ -2267,7 +2267,7 @@ "state": { "target": "com.amazonaws.vpclattice#AuthPolicyState", "traits": { - "smithy.api#documentation": "

The state of the auth policy. The auth policy is only active when the auth type is set to\n Amazon Web Services_IAM. If you provide a policy, then authentication and\n authorization decisions are made based on this policy and the client's IAM policy. If the auth\n type is NONE, then any auth policy you provide will remain inactive. For more\n information, see Create a service\n network in the Amazon VPC Lattice User Guide.

" + "smithy.api#documentation": "

The state of the auth policy. The auth policy is only active when the auth type is set to\n AWS_IAM. If you provide a policy, then authentication and authorization decisions\n are made based on this policy and the client's IAM policy. If the auth type is NONE,\n then any auth policy that you provide remains inactive. For more information, see Create a service network in the Amazon VPC Lattice User Guide.

" } }, "createdAt": { @@ -2431,7 +2431,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "GET", @@ -2446,7 +2446,7 @@ "resourceArn": { "target": "com.amazonaws.vpclattice#ResourceArn", "traits": { - "smithy.api#documentation": "

An IAM policy.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service network or service.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2459,7 +2459,7 @@ "policy": { "target": "com.amazonaws.vpclattice#PolicyString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service network or service.

" + "smithy.api#documentation": "

An IAM policy.

" } } } @@ -2849,7 +2849,7 @@ "customDomainName": { "target": "com.amazonaws.vpclattice#ServiceCustomDomainName", "traits": { - "smithy.api#documentation": "

The custom domain name of the service.

" + "smithy.api#documentation": "

The custom domain name of the service.

" } }, "failureMessage": { @@ -3226,7 +3226,7 @@ "caseSensitive": { "target": "com.amazonaws.vpclattice#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the match is case sensitive. Defaults to false.

" + "smithy.api#documentation": "

Indicates whether the match is case sensitive.

" } } }, @@ -3288,24 +3288,24 @@ "exact": { "target": "com.amazonaws.vpclattice#HeaderMatchExact", "traits": { - "smithy.api#documentation": "

Specifies an exact type match.

" + "smithy.api#documentation": "

An exact type match.

" } }, "prefix": { "target": "com.amazonaws.vpclattice#HeaderMatchPrefix", "traits": { - "smithy.api#documentation": "

Specifies a prefix type match. Matches the value with the prefix.

" + "smithy.api#documentation": "

A prefix type match. Matches the value with the prefix.

" } }, "contains": { "target": "com.amazonaws.vpclattice#HeaderMatchContains", "traits": { - "smithy.api#documentation": "

Specifies a contains type match.

" + "smithy.api#documentation": "

A contains type match.

" } } }, "traits": { - "smithy.api#documentation": "

Describes a header match type. Only one can be provided.

" + "smithy.api#documentation": "

Describes a header match type.

" } }, "com.amazonaws.vpclattice#HealthCheckConfig": { @@ -3368,12 +3368,12 @@ "matcher": { "target": "com.amazonaws.vpclattice#Matcher", "traits": { - "smithy.api#documentation": "

The codes to use when checking for a successful response from a target. These are called\n Success codes in the console.

" + "smithy.api#documentation": "

The codes to use when checking for a successful response from a target.

" } } }, "traits": { - "smithy.api#documentation": "

The health check configuration of a target group. Health check configurations aren't used\n for LAMBDA and ALB target groups.

" + "smithy.api#documentation": "

Describes the health check configuration of a target group. Health check configurations aren't used\n for target groups of type LAMBDA or ALB.

" } }, "com.amazonaws.vpclattice#HealthCheckIntervalSeconds": { @@ -3621,7 +3621,7 @@ "items": { "target": "com.amazonaws.vpclattice#AccessLogSubscriptionList", "traits": { - "smithy.api#documentation": "

The access log subscriptions.

", + "smithy.api#documentation": "

Information about the access log subscriptions.

", "smithy.api#required": {} } }, @@ -3836,7 +3836,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

\n

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

", + "smithy.api#documentation": "

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

\n

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

", "smithy.api#http": { "code": 200, "uri": "/servicenetworkserviceassociations", @@ -4129,7 +4129,7 @@ "items": { "target": "com.amazonaws.vpclattice#ServiceList", "traits": { - "smithy.api#documentation": "

The services.

" + "smithy.api#documentation": "

Information about the services.

" } }, "nextToken": { @@ -4190,7 +4190,7 @@ "tags": { "target": "com.amazonaws.vpclattice#TagMap", "traits": { - "smithy.api#documentation": "

The tags.

" + "smithy.api#documentation": "

Information about the tags.

" } } } @@ -4253,7 +4253,7 @@ "vpcIdentifier": { "target": "com.amazonaws.vpclattice#VpcId", "traits": { - "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the service.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the VPC.

", "smithy.api#httpQuery": "vpcIdentifier" } }, @@ -4309,7 +4309,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the targets for the target group. By default, all targets are included. You can use\n this API to check the health status of targets. You can also filter the results by target.

", + "smithy.api#documentation": "

Lists the targets for the target group. By default, all targets are included. You can use\n this API to check the health status of targets. You can also filter the results by target.

", "smithy.api#http": { "code": 200, "uri": "/targetgroups/{targetGroupIdentifier}/listtargets", @@ -4352,7 +4352,7 @@ "targets": { "target": "com.amazonaws.vpclattice#TargetList", "traits": { - "smithy.api#documentation": "

The targets to list.

", + "smithy.api#documentation": "

The targets.

", "smithy.api#length": { "min": 0, "max": 20 @@ -4458,6 +4458,11 @@ "name": "HTTPS", "value": "HTTPS", "documentation": "Indicates HTTPS protocol" + }, + { + "name": "TLS_PASSTHROUGH", + "value": "TLS_PASSTHROUGH", + "documentation": "Indicates TLS_PASSTHROUGH protocol" } ] } @@ -4529,7 +4534,7 @@ } }, "traits": { - "smithy.api#documentation": "

The codes to use when checking for a successful response from a target for health\n checks.

" + "smithy.api#documentation": "

Describes the codes to use when checking for a successful response from a target for health\n checks.

" } }, "com.amazonaws.vpclattice#MaxResults": { @@ -5314,7 +5319,7 @@ "caseSensitive": { "target": "com.amazonaws.vpclattice#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the match is case sensitive. Defaults to false.

" + "smithy.api#documentation": "

Indicates whether the match is case sensitive.

" } } }, @@ -5407,7 +5412,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates the auth policy.

", + "smithy.api#documentation": "

Creates or updates the auth policy. The policy string in JSON must not contain newlines or\n blank lines.

\n

For more information, see Auth policies \n in the Amazon VPC Lattice User Guide.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -5429,7 +5434,7 @@ "policy": { "target": "com.amazonaws.vpclattice#AuthPolicyString", "traits": { - "smithy.api#documentation": "

The auth policy.

", + "smithy.api#documentation": "

The auth policy. The policy string in JSON must not contain newlines or blank lines.

", "smithy.api#required": {} } } @@ -5441,13 +5446,13 @@ "policy": { "target": "com.amazonaws.vpclattice#AuthPolicyString", "traits": { - "smithy.api#documentation": "

The auth policy.

" + "smithy.api#documentation": "

The auth policy. The policy string in JSON must not contain newlines or blank lines.

" } }, "state": { "target": "com.amazonaws.vpclattice#AuthPolicyState", "traits": { - "smithy.api#documentation": "

The state of the auth policy. The auth policy is only active when the auth type is set to\n Amazon Web Services_IAM. If you provide a policy, then authentication and\n authorization decisions are made based on this policy and the client's IAM policy. If the Auth\n type is NONE, then, any auth policy you provide will remain inactive. For more\n information, see Create a service\n network in the Amazon VPC Lattice User Guide.

" + "smithy.api#documentation": "

The state of the auth policy. The auth policy is only active when the auth type is set to\n AWS_IAM. If you provide a policy, then authentication and authorization decisions\n are made based on this policy and the client's IAM policy. If the Auth type is NONE,\n then, any auth policy that you provide remains inactive. For more information, see Create a service network in the Amazon VPC Lattice User Guide.

" } } } @@ -5501,7 +5506,7 @@ "policy": { "target": "com.amazonaws.vpclattice#PolicyString", "traits": { - "smithy.api#documentation": "

An IAM policy.

", + "smithy.api#documentation": "

An IAM policy. The policy string in JSON must not contain newlines or blank\n lines.

", "smithy.api#required": {} } } @@ -5693,12 +5698,12 @@ "fixedResponse": { "target": "com.amazonaws.vpclattice#FixedResponseAction", "traits": { - "smithy.api#documentation": "

Describes the rule action that returns a custom HTTP response.

" + "smithy.api#documentation": "

The fixed response action. The rule returns a custom HTTP response.

" } } }, "traits": { - "smithy.api#documentation": "

Describes the action for a rule. Each rule must include exactly one of the following types\n of actions: forward or fixed-response, and it must be the last action\n to be performed.

" + "smithy.api#documentation": "

Describes the action for a rule.

" } }, "com.amazonaws.vpclattice#RuleArn": { @@ -5788,13 +5793,13 @@ "isDefault": { "target": "com.amazonaws.vpclattice#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether this is the default rule. Listener rules are created when you create a\n listener. Each listener has a default rule for checking connection requests.\n

" + "smithy.api#documentation": "

Indicates whether this is the default listener rule.

" } }, "priority": { "target": "com.amazonaws.vpclattice#RulePriority", "traits": { - "smithy.api#documentation": "

The priority of the rule.

" + "smithy.api#documentation": "

The priority of the rule.

" } }, "createdAt": { @@ -5850,7 +5855,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents an object when updating a rule.

" + "smithy.api#documentation": "

Describes a rule update.

" } }, "com.amazonaws.vpclattice#RuleUpdateFailure": { @@ -5939,7 +5944,7 @@ "action": { "target": "com.amazonaws.vpclattice#RuleAction", "traits": { - "smithy.api#documentation": "

The action for the default rule.

" + "smithy.api#documentation": "

The action for the rule.

" } } }, @@ -6272,13 +6277,13 @@ "dnsEntry": { "target": "com.amazonaws.vpclattice#DnsEntry", "traits": { - "smithy.api#documentation": "

DNS information about the service.

" + "smithy.api#documentation": "

The DNS information.

" } }, "customDomainName": { "target": "com.amazonaws.vpclattice#ServiceCustomDomainName", "traits": { - "smithy.api#documentation": "

The custom domain name of the service.

" + "smithy.api#documentation": "

The custom domain name of the service.

" } } }, @@ -6616,13 +6621,13 @@ "dnsEntry": { "target": "com.amazonaws.vpclattice#DnsEntry", "traits": { - "smithy.api#documentation": "

DNS information about the service.

" + "smithy.api#documentation": "

The DNS information.

" } }, "customDomainName": { "target": "com.amazonaws.vpclattice#ServiceCustomDomainName", "traits": { - "smithy.api#documentation": "

The custom domain name of the service.

" + "smithy.api#documentation": "

The custom domain name of the service.

" } }, "status": { @@ -6749,7 +6754,7 @@ "id": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ID of the target. If the target type of the target group is INSTANCE, this\n is an instance ID. If the target type is IP , this is an IP address. If the target\n type is LAMBDA, this is the ARN of the Lambda function. If the target type is\n ALB, this is the ARN of the Application Load Balancer.

", + "smithy.api#documentation": "

The ID of the target. If the target group type is INSTANCE, this is\n an instance ID. If the target group type is IP, this is an IP address. If the target\n group type is LAMBDA, this is the ARN of a Lambda function. If the target group type \n is ALB, this is the ARN of an Application Load Balancer.

", "smithy.api#length": { "min": 1, "max": 200 @@ -6760,7 +6765,7 @@ "port": { "target": "com.amazonaws.vpclattice#Port", "traits": { - "smithy.api#documentation": "

The port on which the target is listening. For HTTP, the default is 80. For\n HTTPS, the default is 443.

" + "smithy.api#documentation": "

The port on which the target is listening. For HTTP, the default is 80. For\n HTTPS, the default is 443.

" } } }, @@ -6774,7 +6779,7 @@ "id": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ID of the target. If the target type of the target group is INSTANCE, this\n is an instance ID. If the target type is IP , this is an IP address. If the target\n type is LAMBDA, this is the ARN of the Lambda function. If the target type is\n ALB, this is the ARN of the Application Load Balancer.

" + "smithy.api#documentation": "

The ID of the target. If the target group type is INSTANCE, this is\n an instance ID. If the target group type is IP, this is an IP address. If the target\n group type is LAMBDA, this is the ARN of a Lambda function. If the target group type is\n ALB, this is the ARN of an Application Load Balancer.

" } }, "port": { @@ -6856,48 +6861,48 @@ "port": { "target": "com.amazonaws.vpclattice#Port", "traits": { - "smithy.api#documentation": "

The port on which the targets are listening. For HTTP, the default is 80. For\n HTTPS, the default is 443\n

" + "smithy.api#documentation": "

The port on which the targets are listening. For HTTP, the default is 80. For\n HTTPS, the default is 443. Not supported if the target group type is LAMBDA.

" } }, "protocol": { "target": "com.amazonaws.vpclattice#TargetGroupProtocol", "traits": { - "smithy.api#documentation": "

The protocol to use for routing traffic to the targets. Default is the protocol of a target\n group.

" + "smithy.api#documentation": "

The protocol to use for routing traffic to the targets. The default is the protocol of the target\n group. Not supported if the target group type is LAMBDA.

" } }, "protocolVersion": { "target": "com.amazonaws.vpclattice#TargetGroupProtocolVersion", "traits": { - "smithy.api#documentation": "

The protocol version. Default value is HTTP1.

" + "smithy.api#documentation": "

The protocol version. The default is HTTP1.\n Not supported if the target group type is LAMBDA.

" } }, "ipAddressType": { "target": "com.amazonaws.vpclattice#IpAddressType", "traits": { - "smithy.api#documentation": "

The type of IP address used for the target group. The possible values are ipv4 and ipv6.\n This is an optional parameter. If not specified, the IP address type defaults to ipv4.

" + "smithy.api#documentation": "

The type of IP address used for the target group. Supported only if the target group\n type is IP. The default is IPV4.

" } }, "vpcIdentifier": { "target": "com.amazonaws.vpclattice#VpcId", "traits": { - "smithy.api#documentation": "

The ID of the VPC.

" + "smithy.api#documentation": "

The ID of the VPC. Not supported if the target group type is LAMBDA.

" } }, "healthCheck": { "target": "com.amazonaws.vpclattice#HealthCheckConfig", "traits": { - "smithy.api#documentation": "

The health check configuration.

" + "smithy.api#documentation": "

The health check configuration. Not supported if the target group type is\n LAMBDA or ALB.

" } }, "lambdaEventStructureVersion": { "target": "com.amazonaws.vpclattice#LambdaEventStructureVersion", "traits": { - "smithy.api#documentation": "Lambda event structure version" + "smithy.api#documentation": "

The version of the event structure that your Lambda function receives. \n Supported only if the target group type is LAMBDA. The default is V1.

" } } }, "traits": { - "smithy.api#documentation": "

Describes the configuration of a target group. Lambda functions don't support target group\n configuration.

" + "smithy.api#documentation": "

Describes the configuration of a target group.

\n

For more information, see Target groups in the\n Amazon VPC Lattice User Guide.

" } }, "com.amazonaws.vpclattice#TargetGroupId": { @@ -6949,6 +6954,11 @@ "name": "HTTPS", "value": "HTTPS", "documentation": "Indicates HTTPS protocol" + }, + { + "name": "TCP", + "value": "TCP", + "documentation": "Indicates TCP protocol" } ] } @@ -7055,7 +7065,7 @@ "ipAddressType": { "target": "com.amazonaws.vpclattice#IpAddressType", "traits": { - "smithy.api#documentation": "

The type of IP address used for the target group. The possible values are ipv4 and ipv6.\n This is an optional parameter. If not specified, the IP address type defaults to ipv4.

" + "smithy.api#documentation": "

The type of IP address used for the target group. The possible values are IPV4\n and IPV6. This is an optional parameter. If not specified, the default is\n IPV4.

" } }, "vpcIdentifier": { @@ -7079,18 +7089,18 @@ "serviceArns": { "target": "com.amazonaws.vpclattice#ServiceArnList", "traits": { - "smithy.api#documentation": "

The list of Amazon Resource Names (ARNs) of the service.

" + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the service.

" } }, "lambdaEventStructureVersion": { "target": "com.amazonaws.vpclattice#LambdaEventStructureVersion", "traits": { - "smithy.api#documentation": "Lambda event structure version" + "smithy.api#documentation": "

The version of the event structure that your Lambda function receives.\n Supported only if the target group type is LAMBDA.

" } } }, "traits": { - "smithy.api#documentation": "

Summary information about a target group.

" + "smithy.api#documentation": "

Summary information about a target group.

\n

For more information, see Target groups in the\n Amazon VPC Lattice User Guide.

" } }, "com.amazonaws.vpclattice#TargetGroupType": { @@ -7178,7 +7188,7 @@ "id": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ID of the target. If the target type of the target group is INSTANCE, this\n is an instance ID. If the target type is IP , this is an IP address. If the target\n type is LAMBDA, this is the ARN of the Lambda function. If the target type is\n ALB, this is the ARN of the Application Load Balancer.

" + "smithy.api#documentation": "

The ID of the target. If the target group type is INSTANCE, this is\n an instance ID. If the target group type is IP, this is an IP address. If the target\n group type is LAMBDA, this is the ARN of a Lambda function. If the target type is\n ALB, this is the ARN of an Application Load Balancer.

" } }, "port": { @@ -7190,7 +7200,7 @@ "status": { "target": "com.amazonaws.vpclattice#TargetStatus", "traits": { - "smithy.api#documentation": "

The status of the target.

\n " + "smithy.api#documentation": "

The status of the target.

\n " } }, "reasonCode": { @@ -7821,7 +7831,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the service network and VPC association. Once you add a security group, it cannot be\n removed.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "uri": "/servicenetworkvpcassociations/{serviceNetworkVpcAssociationIdentifier}", @@ -7844,7 +7854,7 @@ "securityGroupIds": { "target": "com.amazonaws.vpclattice#SecurityGroupList", "traits": { - "smithy.api#documentation": "

The IDs of the security groups. Once you add a security group, it cannot be removed.

", + "smithy.api#documentation": "

The IDs of the security groups.

", "smithy.api#length": { "min": 1, "max": 5 @@ -7903,7 +7913,7 @@ "certificateArn": { "target": "com.amazonaws.vpclattice#CertificateArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" } }, "authType": { @@ -7944,7 +7954,7 @@ "certificateArn": { "target": "com.amazonaws.vpclattice#CertificateArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" } }, "authType": { @@ -8096,7 +8106,7 @@ "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Additional details about why the validation failed.

", + "smithy.api#documentation": "

Additional information about why the validation failed.

", "smithy.api#required": {} } } @@ -8157,7 +8167,7 @@ "weight": { "target": "com.amazonaws.vpclattice#TargetGroupWeight", "traits": { - "smithy.api#documentation": "

Only required if you specify multiple target groups for a forward action. The \"weight\"\n determines how requests are distributed to the target group. For example, if you specify two\n target groups, each with a weight of 10, each target group receives half the requests. If you\n specify two target groups, one with a weight of 10 and the other with a weight of 20, the target\n group with a weight of 20 receives twice as many requests as the other target group. If there's\n only one target group specified, then the default value is 100.

" + "smithy.api#documentation": "

Only required if you specify multiple target groups for a forward action. The weight\n determines how requests are distributed to the target group. For example, if you specify two\n target groups, each with a weight of 10, each target group receives half the requests. If you\n specify two target groups, one with a weight of 10 and the other with a weight of 20, the target\n group with a weight of 20 receives twice as many requests as the other target group. If there's\n only one target group specified, then the default value is 100.

" } } }, @@ -8173,7 +8183,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 2 + "max": 10 } } }