0% found this document useful (0 votes)

55 views231 pages

VPC Lattice API

The Amazon VPC Lattice API Reference document provides detailed information on the API version 2022-11-30, including various actions such as creating, deleting, and retrieving resources related to VPC Lattice. Each action includes sections on request syntax, URI parameters, request body, response syntax, response elements, and potential errors. The document serves as a comprehensive guide for developers to interact with the Amazon VPC Lattice API effectively.

Uploaded by

Himanshu Patel

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

55 views231 pages

VPC Lattice API

Uploaded by

Himanshu Patel

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 231

Amazon VPC Lattice

API Reference
API Version 2022-11-30
Amazon VPC Lattice API Reference

Amazon VPC Lattice: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not
Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or
discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may
or may not be aﬃliated with, connected to, or sponsored by Amazon.
Amazon VPC Lattice API Reference

Table of Contents
Welcome ........................................................................................................................................... 1
Actions ............................................................................................................................................. 2
BatchUpdateRule ....................................................................................................................... 4
Request Syntax .................................................................................................................. 4
URI Request Parameters ...................................................................................................... 4
Request Body .................................................................................................................... 4
Response Syntax ................................................................................................................ 5
Response Elements ............................................................................................................. 5
Errors ............................................................................................................................... 5
See Also ............................................................................................................................ 6
CreateAccessLogSubscription ....................................................................................................... 7
Request Syntax .................................................................................................................. 7
URI Request Parameters ...................................................................................................... 7
Request Body .................................................................................................................... 7
Response Syntax ................................................................................................................ 8
Response Elements ............................................................................................................. 8
Errors ............................................................................................................................... 9
See Also .......................................................................................................................... 10
CreateListener .......................................................................................................................... 11
Request Syntax ................................................................................................................ 11
URI Request Parameters .................................................................................................... 11
Request Body ................................................................................................................... 11
Response Syntax .............................................................................................................. 12
Response Elements ........................................................................................................... 13
Errors .............................................................................................................................. 14
See Also .......................................................................................................................... 15
CreateRule ............................................................................................................................... 16
Request Syntax ................................................................................................................ 16
URI Request Parameters .................................................................................................... 16
Request Body ................................................................................................................... 16
Response Syntax .............................................................................................................. 18
Response Elements ........................................................................................................... 18
Errors .............................................................................................................................. 19
See Also .......................................................................................................................... 20
CreateService ........................................................................................................................... 21
Request Syntax ................................................................................................................ 21
URI Request Parameters .................................................................................................... 21
Request Body ................................................................................................................... 21
Response Syntax .............................................................................................................. 22
Response Elements ........................................................................................................... 23
Errors .............................................................................................................................. 24
See Also .......................................................................................................................... 25
CreateServiceNetwork ............................................................................................................... 26
Request Syntax ................................................................................................................ 26
URI Request Parameters .................................................................................................... 26
Request Body ................................................................................................................... 26
Response Syntax .............................................................................................................. 27
Response Elements ........................................................................................................... 27
Errors .............................................................................................................................. 28
See Also .......................................................................................................................... 29
CreateServiceNetworkServiceAssociation ..................................................................................... 30
Request Syntax ................................................................................................................ 30
URI Request Parameters .................................................................................................... 30
Request Body ................................................................................................................... 30

API Version 2022-11-30

iii
Amazon VPC Lattice API Reference

Response Syntax .............................................................................................................. 31

Response Elements ........................................................................................................... 31
Errors .............................................................................................................................. 32
See Also .......................................................................................................................... 33
CreateServiceNetworkVpcAssociation .......................................................................................... 34
Request Syntax ................................................................................................................ 34
URI Request Parameters .................................................................................................... 34
Request Body ................................................................................................................... 34
Response Syntax .............................................................................................................. 35
Response Elements ........................................................................................................... 36
Errors .............................................................................................................................. 36
See Also .......................................................................................................................... 37
CreateTargetGroup ................................................................................................................... 38
Request Syntax ................................................................................................................ 38
URI Request Parameters .................................................................................................... 38
Request Body ................................................................................................................... 38
Response Syntax .............................................................................................................. 39
Response Elements ........................................................................................................... 40
Errors .............................................................................................................................. 41
See Also .......................................................................................................................... 41
DeleteAccessLogSubscription ..................................................................................................... 43
Request Syntax ................................................................................................................ 43
URI Request Parameters .................................................................................................... 43
Request Body ................................................................................................................... 43
Response Syntax .............................................................................................................. 43
Response Elements ........................................................................................................... 43
Errors .............................................................................................................................. 43
See Also .......................................................................................................................... 44
DeleteAuthPolicy ...................................................................................................................... 45
Request Syntax ................................................................................................................ 45
URI Request Parameters .................................................................................................... 45
Request Body ................................................................................................................... 45
Response Syntax .............................................................................................................. 45
Response Elements ........................................................................................................... 45
Errors .............................................................................................................................. 45
See Also .......................................................................................................................... 46
DeleteListener .......................................................................................................................... 47
Request Syntax ................................................................................................................ 47
URI Request Parameters .................................................................................................... 47
Request Body ................................................................................................................... 47
Response Syntax .............................................................................................................. 47
Response Elements ........................................................................................................... 47
Errors .............................................................................................................................. 47
See Also .......................................................................................................................... 48
DeleteResourcePolicy ................................................................................................................ 49
Request Syntax ................................................................................................................ 49
URI Request Parameters .................................................................................................... 49
Request Body ................................................................................................................... 49
Response Syntax .............................................................................................................. 49
Response Elements ........................................................................................................... 49
Errors .............................................................................................................................. 49
See Also .......................................................................................................................... 50
DeleteRule ............................................................................................................................... 51
Request Syntax ................................................................................................................ 51
URI Request Parameters .................................................................................................... 51
Request Body ................................................................................................................... 51
Response Syntax .............................................................................................................. 52

API Version 2022-11-30

iv
Amazon VPC Lattice API Reference

Response Elements ........................................................................................................... 52

Errors .............................................................................................................................. 52
See Also .......................................................................................................................... 52
DeleteService ........................................................................................................................... 54
Request Syntax ................................................................................................................ 54
URI Request Parameters .................................................................................................... 54
Request Body ................................................................................................................... 54
Response Syntax .............................................................................................................. 54
Response Elements ........................................................................................................... 54
Errors .............................................................................................................................. 55
See Also .......................................................................................................................... 56
DeleteServiceNetwork ............................................................................................................... 57
Request Syntax ................................................................................................................ 57
URI Request Parameters .................................................................................................... 57
Request Body ................................................................................................................... 57
Response Syntax .............................................................................................................. 57
Response Elements ........................................................................................................... 57
Errors .............................................................................................................................. 57
See Also .......................................................................................................................... 58
DeleteServiceNetworkServiceAssociation ..................................................................................... 59
Request Syntax ................................................................................................................ 59
URI Request Parameters .................................................................................................... 59
Request Body ................................................................................................................... 59
Response Syntax .............................................................................................................. 59
Response Elements ........................................................................................................... 59
Errors .............................................................................................................................. 60
See Also .......................................................................................................................... 61
DeleteServiceNetworkVpcAssociation .......................................................................................... 62
Request Syntax ................................................................................................................ 62
URI Request Parameters .................................................................................................... 62
Request Body ................................................................................................................... 62
Response Syntax .............................................................................................................. 62
Response Elements ........................................................................................................... 62
Errors .............................................................................................................................. 63
See Also .......................................................................................................................... 64
DeleteTargetGroup ................................................................................................................... 65
Request Syntax ................................................................................................................ 65
URI Request Parameters .................................................................................................... 65
Request Body ................................................................................................................... 65
Response Syntax .............................................................................................................. 65
Response Elements ........................................................................................................... 65
Errors .............................................................................................................................. 66
See Also .......................................................................................................................... 66
DeregisterTargets ..................................................................................................................... 68
Request Syntax ................................................................................................................ 68
URI Request Parameters .................................................................................................... 68
Request Body ................................................................................................................... 68
Response Syntax .............................................................................................................. 68
Response Elements ........................................................................................................... 69
Errors .............................................................................................................................. 69
See Also .......................................................................................................................... 70
GetAccessLogSubscription .......................................................................................................... 71
Request Syntax ................................................................................................................ 71
URI Request Parameters .................................................................................................... 71
Request Body ................................................................................................................... 71
Response Syntax .............................................................................................................. 71
Response Elements ........................................................................................................... 71

API Version 2022-11-30

v
Amazon VPC Lattice API Reference

Errors .............................................................................................................................. 72
See Also .......................................................................................................................... 73
GetAuthPolicy .......................................................................................................................... 74
Request Syntax ................................................................................................................ 74
URI Request Parameters .................................................................................................... 74
Request Body ................................................................................................................... 74
Response Syntax .............................................................................................................. 74
Response Elements ........................................................................................................... 74
Errors .............................................................................................................................. 75
See Also .......................................................................................................................... 75
GetListener .............................................................................................................................. 77
Request Syntax ................................................................................................................ 77
URI Request Parameters .................................................................................................... 77
Request Body ................................................................................................................... 77
Response Syntax .............................................................................................................. 77
Response Elements ........................................................................................................... 78
Errors .............................................................................................................................. 79
See Also .......................................................................................................................... 80
GetResourcePolicy .................................................................................................................... 81
Request Syntax ................................................................................................................ 81
URI Request Parameters .................................................................................................... 81
Request Body ................................................................................................................... 81
Response Syntax .............................................................................................................. 81
Response Elements ........................................................................................................... 81
Errors .............................................................................................................................. 82
See Also .......................................................................................................................... 82
GetRule ................................................................................................................................... 83
Request Syntax ................................................................................................................ 83
URI Request Parameters .................................................................................................... 83
Request Body ................................................................................................................... 83
Response Syntax .............................................................................................................. 83
Response Elements ........................................................................................................... 84
Errors .............................................................................................................................. 85
See Also .......................................................................................................................... 85
GetService ............................................................................................................................... 87
Request Syntax ................................................................................................................ 87
URI Request Parameters .................................................................................................... 87
Request Body ................................................................................................................... 87
Response Syntax .............................................................................................................. 87
Response Elements ........................................................................................................... 87
Errors .............................................................................................................................. 89
See Also .......................................................................................................................... 90
GetServiceNetwork ................................................................................................................... 91
Request Syntax ................................................................................................................ 91
URI Request Parameters .................................................................................................... 91
Request Body ................................................................................................................... 91
Response Syntax .............................................................................................................. 91
Response Elements ........................................................................................................... 91
Errors .............................................................................................................................. 92
See Also .......................................................................................................................... 93
GetServiceNetworkServiceAssociation ......................................................................................... 94
Request Syntax ................................................................................................................ 94
URI Request Parameters .................................................................................................... 94
Request Body ................................................................................................................... 94
Response Syntax .............................................................................................................. 94
Response Elements ........................................................................................................... 94
Errors .............................................................................................................................. 97

API Version 2022-11-30

vi
Amazon VPC Lattice API Reference

API Version 2022-11-30

vii
Amazon VPC Lattice API Reference

ListServiceNetworkVpcAssociations ........................................................................................... 120

Request Syntax .............................................................................................................. 120
URI Request Parameters .................................................................................................. 120
Request Body ................................................................................................................. 120
Response Syntax ............................................................................................................ 120
Response Elements ......................................................................................................... 121
Errors ............................................................................................................................ 121
See Also ........................................................................................................................ 122
ListServices ............................................................................................................................ 123
Request Syntax .............................................................................................................. 123
URI Request Parameters .................................................................................................. 123
Request Body ................................................................................................................. 123
Response Syntax ............................................................................................................ 123
Response Elements ......................................................................................................... 123
Errors ............................................................................................................................ 124
See Also ........................................................................................................................ 124
ListTagsForResource ................................................................................................................ 125
Request Syntax .............................................................................................................. 125
URI Request Parameters .................................................................................................. 125
Request Body ................................................................................................................. 125
Response Syntax ............................................................................................................ 125
Response Elements ......................................................................................................... 125
Errors ............................................................................................................................ 126
See Also ........................................................................................................................ 126
ListTargetGroups .................................................................................................................... 127
Request Syntax .............................................................................................................. 127
URI Request Parameters .................................................................................................. 127
Request Body ................................................................................................................. 127
Response Syntax ............................................................................................................ 127
Response Elements ......................................................................................................... 128
Errors ............................................................................................................................ 128
See Also ........................................................................................................................ 129
ListTargets ............................................................................................................................. 130
Request Syntax .............................................................................................................. 130
URI Request Parameters .................................................................................................. 130
Request Body ................................................................................................................. 130
Response Syntax ............................................................................................................ 131
Response Elements ......................................................................................................... 131
Errors ............................................................................................................................ 131
See Also ........................................................................................................................ 132
PutAuthPolicy ........................................................................................................................ 133
Request Syntax .............................................................................................................. 133
URI Request Parameters .................................................................................................. 133
Request Body ................................................................................................................. 133
Response Syntax ............................................................................................................ 133
Response Elements ......................................................................................................... 134
Errors ............................................................................................................................ 134
See Also ........................................................................................................................ 135
PutResourcePolicy ................................................................................................................... 136
Request Syntax .............................................................................................................. 136
URI Request Parameters .................................................................................................. 136
Request Body ................................................................................................................. 136
Response Syntax ............................................................................................................ 136
Response Elements ......................................................................................................... 136
Errors ............................................................................................................................ 137
See Also ........................................................................................................................ 137
RegisterTargets ....................................................................................................................... 138

API Version 2022-11-30

viii
Amazon VPC Lattice API Reference

Request Syntax .............................................................................................................. 138

URI Request Parameters .................................................................................................. 138
Request Body ................................................................................................................. 138
Response Syntax ............................................................................................................ 138
Response Elements ......................................................................................................... 139
Errors ............................................................................................................................ 139
See Also ........................................................................................................................ 140
TagResource ........................................................................................................................... 141
Request Syntax .............................................................................................................. 141
URI Request Parameters .................................................................................................. 141
Request Body ................................................................................................................. 141
Response Syntax ............................................................................................................ 141
Response Elements ......................................................................................................... 142
Errors ............................................................................................................................ 142
See Also ........................................................................................................................ 142
UntagResource ....................................................................................................................... 143
Request Syntax .............................................................................................................. 143
URI Request Parameters .................................................................................................. 143
Request Body ................................................................................................................. 143
Response Syntax ............................................................................................................ 143
Response Elements ......................................................................................................... 143
Errors ............................................................................................................................ 143
See Also ........................................................................................................................ 144
UpdateAccessLogSubscription .................................................................................................. 145
Request Syntax .............................................................................................................. 145
URI Request Parameters .................................................................................................. 145
Request Body ................................................................................................................. 145
Response Syntax ............................................................................................................ 145
Response Elements ......................................................................................................... 146
Errors ............................................................................................................................ 147
See Also ........................................................................................................................ 147
UpdateListener ....................................................................................................................... 148
Request Syntax .............................................................................................................. 148
URI Request Parameters .................................................................................................. 148
Request Body ................................................................................................................. 148
Response Syntax ............................................................................................................ 148
Response Elements ......................................................................................................... 149
Errors ............................................................................................................................ 150
See Also ........................................................................................................................ 151
UpdateRule ............................................................................................................................ 152
Request Syntax .............................................................................................................. 152
URI Request Parameters .................................................................................................. 152
Request Body ................................................................................................................. 152
Response Syntax ............................................................................................................ 153
Response Elements ......................................................................................................... 153
Errors ............................................................................................................................ 154
See Also ........................................................................................................................ 155
UpdateService ........................................................................................................................ 156
Request Syntax .............................................................................................................. 156
URI Request Parameters .................................................................................................. 156
Request Body ................................................................................................................. 156
Response Syntax ............................................................................................................ 157
Response Elements ......................................................................................................... 157
Errors ............................................................................................................................ 158
See Also ........................................................................................................................ 158
UpdateServiceNetwork ............................................................................................................ 160
Request Syntax .............................................................................................................. 160

API Version 2022-11-30

ix
Amazon VPC Lattice API Reference

URI Request Parameters .................................................................................................. 160

Request Body ................................................................................................................. 160
Response Syntax ............................................................................................................ 160
Response Elements ......................................................................................................... 161
Errors ............................................................................................................................ 161
See Also ........................................................................................................................ 162
UpdateServiceNetworkVpcAssociation ....................................................................................... 163
Request Syntax .............................................................................................................. 163
URI Request Parameters .................................................................................................. 163
Request Body ................................................................................................................. 163
Response Syntax ............................................................................................................ 163
Response Elements ......................................................................................................... 164
Errors ............................................................................................................................ 165
See Also ........................................................................................................................ 165
UpdateTargetGroup ................................................................................................................ 166
Request Syntax .............................................................................................................. 166
URI Request Parameters .................................................................................................. 166
Request Body ................................................................................................................. 166
Response Syntax ............................................................................................................ 166
Response Elements ......................................................................................................... 167
Errors ............................................................................................................................ 168
See Also ........................................................................................................................ 168
Data Types .................................................................................................................................... 170
AccessLogSubscriptionSummary ............................................................................................... 171
Contents ........................................................................................................................ 171
See Also ........................................................................................................................ 172
DnsEntry ............................................................................................................................... 173
Contents ........................................................................................................................ 173
See Also ........................................................................................................................ 173
FixedResponseAction ............................................................................................................... 174
Contents ........................................................................................................................ 174
See Also ........................................................................................................................ 174
ForwardAction ........................................................................................................................ 175
Contents ........................................................................................................................ 175
See Also ........................................................................................................................ 175
HeaderMatch .......................................................................................................................... 176
Contents ........................................................................................................................ 176
See Also ........................................................................................................................ 176
HeaderMatchType ................................................................................................................... 177
Contents ........................................................................................................................ 177
See Also ........................................................................................................................ 177
HealthCheckConﬁg ................................................................................................................. 178
Contents ........................................................................................................................ 178
See Also ........................................................................................................................ 179
HttpMatch ............................................................................................................................. 181
Contents ........................................................................................................................ 181
See Also ........................................................................................................................ 181
ListenerSummary .................................................................................................................... 182
Contents ........................................................................................................................ 182
See Also ........................................................................................................................ 183
Matcher ................................................................................................................................. 184
Contents ........................................................................................................................ 184
See Also ........................................................................................................................ 184
PathMatch ............................................................................................................................. 185
Contents ........................................................................................................................ 185
See Also ........................................................................................................................ 185
PathMatchType ...................................................................................................................... 186

API Version 2022-11-30

x
Amazon VPC Lattice API Reference

Contents ........................................................................................................................ 186

See Also ........................................................................................................................ 186
RuleAction ............................................................................................................................. 187
Contents ........................................................................................................................ 187
See Also ........................................................................................................................ 187
RuleMatch ............................................................................................................................. 188
Contents ........................................................................................................................ 188
See Also ........................................................................................................................ 188
RuleSummary ......................................................................................................................... 189
Contents ........................................................................................................................ 189
See Also ........................................................................................................................ 190
RuleUpdate ............................................................................................................................ 191
Contents ........................................................................................................................ 191
See Also ........................................................................................................................ 191
RuleUpdateFailure .................................................................................................................. 193
Contents ........................................................................................................................ 193
See Also ........................................................................................................................ 193
RuleUpdateSuccess ................................................................................................................. 194
Contents ........................................................................................................................ 194
See Also ........................................................................................................................ 195
ServiceNetworkServiceAssociationSummary ............................................................................... 196
Contents ........................................................................................................................ 196
See Also ........................................................................................................................ 198
ServiceNetworkSummary ......................................................................................................... 199
Contents ........................................................................................................................ 199
See Also ........................................................................................................................ 200
ServiceNetworkVpcAssociationSummary .................................................................................... 201
Contents ........................................................................................................................ 201
See Also ........................................................................................................................ 202
ServiceSummary ..................................................................................................................... 204
Contents ........................................................................................................................ 204
See Also ........................................................................................................................ 205
Target ................................................................................................................................... 206
Contents ........................................................................................................................ 206
See Also ........................................................................................................................ 206
TargetFailure .......................................................................................................................... 207
Contents ........................................................................................................................ 207
See Also ........................................................................................................................ 207
TargetGroupConﬁg ................................................................................................................. 208
Contents ........................................................................................................................ 208
See Also ........................................................................................................................ 209
TargetGroupSummary ............................................................................................................. 210
Contents ........................................................................................................................ 210
See Also ........................................................................................................................ 212
TargetSummary ...................................................................................................................... 213
Contents ........................................................................................................................ 213
See Also ........................................................................................................................ 213
ValidationExceptionField .......................................................................................................... 215
Contents ........................................................................................................................ 215
See Also ........................................................................................................................ 215
WeightedTargetGroup ............................................................................................................. 216
Contents ........................................................................................................................ 216
See Also ........................................................................................................................ 216
Common Parameters ...................................................................................................................... 217
Common Errors .............................................................................................................................. 219

API Version 2022-11-30

xi
Amazon VPC Lattice API Reference

Welcome
Amazon VPC Lattice is a fully managed application networking service that you use to connect, secure,
and monitor all of your services across multiple accounts and virtual private clouds (VPCs). Amazon VPC
Lattice interconnects your microservices and legacy services within a logical boundary, so that you can
discover and manage them more eﬃciently. For more information, see the Amazon VPC Lattice User
Guide

This document was last published on August 24, 2023.

API Version 2022-11-30

1
Amazon VPC Lattice API Reference

Actions
The following actions are supported:

• BatchUpdateRule (p. 4)
• CreateAccessLogSubscription (p. 7)
• CreateListener (p. 11)
• CreateRule (p. 16)
• CreateService (p. 21)
• CreateServiceNetwork (p. 26)
• CreateServiceNetworkServiceAssociation (p. 30)
• CreateServiceNetworkVpcAssociation (p. 34)
• CreateTargetGroup (p. 38)
• DeleteAccessLogSubscription (p. 43)
• DeleteAuthPolicy (p. 45)
• DeleteListener (p. 47)
• DeleteResourcePolicy (p. 49)
• DeleteRule (p. 51)
• DeleteService (p. 54)
• DeleteServiceNetwork (p. 57)
• DeleteServiceNetworkServiceAssociation (p. 59)
• DeleteServiceNetworkVpcAssociation (p. 62)
• DeleteTargetGroup (p. 65)
• DeregisterTargets (p. 68)
• GetAccessLogSubscription (p. 71)
• GetAuthPolicy (p. 74)
• GetListener (p. 77)
• GetResourcePolicy (p. 81)
• GetRule (p. 83)
• GetService (p. 87)
• GetServiceNetwork (p. 91)
• GetServiceNetworkServiceAssociation (p. 94)
• GetServiceNetworkVpcAssociation (p. 98)
• GetTargetGroup (p. 102)
• ListAccessLogSubscriptions (p. 106)
• ListListeners (p. 109)
• ListRules (p. 112)
• ListServiceNetworks (p. 115)
• ListServiceNetworkServiceAssociations (p. 117)
• ListServiceNetworkVpcAssociations (p. 120)
• ListServices (p. 123)
• ListTagsForResource (p. 125)
• ListTargetGroups (p. 127)
• ListTargets (p. 130)

API Version 2022-11-30

2
Amazon VPC Lattice API Reference

• PutAuthPolicy (p. 133)

• PutResourcePolicy (p. 136)
• RegisterTargets (p. 138)
• TagResource (p. 141)
• UntagResource (p. 143)
• UpdateAccessLogSubscription (p. 145)
• UpdateListener (p. 148)
• UpdateRule (p. 152)
• UpdateService (p. 156)
• UpdateServiceNetwork (p. 160)
• UpdateServiceNetworkVpcAssociation (p. 163)
• UpdateTargetGroup (p. 166)

API Version 2022-11-30

3
Amazon VPC Lattice API Reference
BatchUpdateRule

BatchUpdateRule
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.

Request Syntax
PATCH /services/serviceIdentifier/listeners/listenerIdentifier/rules HTTP/1.1
Content-type: application/json

{
"rules": [
{
"action": { ... },
"match": { ... },
"priority": number,
"ruleIdentifier": "string"
}
]
}

URI Request Parameters

The request uses the following URI parameters.

listenerIdentiﬁer (p. 4)

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((listener-[0-9a-z]{17})|(^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-
Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}$))$

Required: Yes
serviceIdentiﬁer (p. 4)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes

Request Body
The request accepts the following data in JSON format.

API Version 2022-11-30

4
Amazon VPC Lattice API Reference
Response Syntax

rules (p. 4)

The rules for the speciﬁed listener.

Type: Array of RuleUpdate (p. 191) objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"successful": [
{
"action": { ... },
"arn": "string",
"id": "string",
"isDefault": boolean,
"match": { ... },
"name": "string",
"priority": number
}
],
"unsuccessful": [
{
"failureCode": "string",
"failureMessage": "string",
"ruleIdentifier": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

successful (p. 5)

The rules that were successfully updated.

Type: Array of RuleUpdateSuccess (p. 194) objects

unsuccessful (p. 5)

The rules that the operation couldn't update.

Type: Array of RuleUpdateFailure (p. 193) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

API Version 2022-11-30

5
Amazon VPC Lattice API Reference
See Also

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

6
Amazon VPC Lattice API Reference
CreateAccessLogSubscription

CreateAccessLogSubscription
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 traﬃc originated from VPCs associated with that network. For
more information, see Access logs in the Amazon VPC Lattice User Guide.

Request Syntax
POST /accesslogsubscriptions HTTP/1.1
Content-type: application/json

{
"clientToken": "string",
"destinationArn": "string",
"resourceIdentifier": "string",
"tags": {
"string" : "string"
}
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

clientToken (p. 7)

A unique, case-sensitive identiﬁer that you provide to ensure the idempotency of the request. If you
retry a request that completed successfully using the same client token and parameters, the retry
succeeds without performing any actions. If the parameters aren't identical, the retry fails.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]+

Required: No
destinationArn (p. 7)

The Amazon Resource Name (ARN) of the destination. The supported destination types are
CloudWatch Log groups, Kinesis Data Firehose delivery streams, and Amazon S3 buckets.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:([^/].*)?$

Required: Yes

API Version 2022-11-30

7
Amazon VPC Lattice API Reference
Response Syntax

resourceIdentiﬁer (p. 7)

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

Type: String

Length Constraints: Minimum length of 17. Maximum length of 200.

Pattern: ^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:
([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-
z]{17}))$

Required: Yes
tags (p. 7)

The tags for the access log subscription.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"arn": "string",
"destinationArn": "string",
"id": "string",
"resourceArn": "string",
"resourceId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

arn (p. 8)

The Amazon Resource Name (ARN) of the access log subscription.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:accesslogsubscription/als-[0-9a-z]{17}$
destinationArn (p. 8)

The Amazon Resource Name (ARN) of the log destination.

API Version 2022-11-30

8
Amazon VPC Lattice API Reference
Errors

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:([^/].*)?$
id (p. 8)

The ID of the access log subscription.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^als-[0-9a-z]{17}$
resourceArn (p. 8)

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 200.

Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}$
resourceId (p. 8)

The ID of the service network or service.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 50.

Pattern: ^((sn)|(svc))-[0-9a-z]{17}$

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

API Version 2022-11-30

9
Amazon VPC Lattice API Reference
See Also

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

10
Amazon VPC Lattice API Reference
CreateListener

CreateListener
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.

Request Syntax
POST /services/serviceIdentifier/listeners HTTP/1.1
Content-type: application/json

{
"clientToken": "string",
"defaultAction": { ... },
"name": "string",
"port": number,
"protocol": "string",
"tags": {
"string" : "string"
}
}

URI Request Parameters

The request uses the following URI parameters.

serviceIdentiﬁer (p. 11)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes

Request Body
The request accepts the following data in JSON format.

clientToken (p. 11)

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]+

Required: No
defaultAction (p. 11)

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

API Version 2022-11-30

11
Amazon VPC Lattice API Reference
Response Syntax

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.

Type: RuleAction (p. 187) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.

Required: Yes
name (p. 11)

The name of the listener. A listener name must be unique within a service. The valid characters are
a-z, 0-9, and hyphens (-). You can't use a hyphen as the ﬁrst or last character, or immediately after
another hyphen.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!listener-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Required: Yes
port (p. 11)

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

Required: No
protocol (p. 11)

The listener protocol HTTP or HTTPS.

Type: String

Valid Values: HTTP | HTTPS

Required: Yes
tags (p. 11)

The tags for the listener.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

API Version 2022-11-30

12
Amazon VPC Lattice API Reference
Response Elements

{
"arn": "string",
"defaultAction": { ... },
"id": "string",
"name": "string",
"port": number,
"protocol": "string",
"serviceArn": "string",
"serviceId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

arn (p. 12)

The Amazon Resource Name (ARN) of the listener.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}/listener/listener-[0-9a-z]{17}$
defaultAction (p. 12)

The action for the default rule.

Type: RuleAction (p. 187) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.
id (p. 12)

The ID of the listener.

Type: String

Length Constraints: Fixed length of 26.

Pattern: ^listener-[0-9a-z]{17}$
name (p. 12)

The name of the listener.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!listener-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
port (p. 12)

The port number of the listener.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

API Version 2022-11-30

13
Amazon VPC Lattice API Reference
Errors

protocol (p. 12)

The protocol of the listener.

Type: String

Valid Values: HTTP | HTTPS

serviceArn (p. 12)

The Amazon Resource Name (ARN) of the service.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}$
serviceId (p. 12)

The ID of the service.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^svc-[0-9a-z]{17}$

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

API Version 2022-11-30

14
Amazon VPC Lattice API Reference
See Also

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

15
Amazon VPC Lattice API Reference
CreateRule

CreateRule
Creates a listener rule. Each listener has a default rule for checking connection requests, but you can
deﬁne 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.

Request Syntax
POST /services/serviceIdentifier/listeners/listenerIdentifier/rules HTTP/1.1
Content-type: application/json

{
"action": { ... },
"clientToken": "string",
"match": { ... },
"name": "string",
"priority": number,
"tags": {
"string" : "string"
}
}

URI Request Parameters

The request uses the following URI parameters.

listenerIdentiﬁer (p. 16)

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((listener-[0-9a-z]{17})|(^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-
Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}$))$

Required: Yes
serviceIdentiﬁer (p. 16)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes

Request Body
The request accepts the following data in JSON format.

action (p. 16)

The action for the default rule.

Type: RuleAction (p. 187) object

API Version 2022-11-30

16
Amazon VPC Lattice API Reference
Request Body

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.

Required: Yes
clientToken (p. 16)

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]+

Required: No
match (p. 16)

The rule match.

Type: RuleMatch (p. 188) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.

Required: Yes
name (p. 16)

The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9,
and hyphens (-). You can't use a hyphen as the ﬁrst or last character, or immediately after another
hyphen.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!rule-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Required: Yes
priority (p. 16)

The priority assigned to the rule. Each rule for a speciﬁc listener must have a unique priority. The
lower the priority number the higher the priority.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: Yes
tags (p. 16)

The tags for the rule.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

API Version 2022-11-30

17
Amazon VPC Lattice API Reference
Response Syntax

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"action": { ... },
"arn": "string",
"id": "string",
"match": { ... },
"name": "string",
"priority": number
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

action (p. 18)

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.

Type: RuleAction (p. 187) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.
arn (p. 18)

The Amazon Resource Name (ARN) of the rule.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}/listener/listener-[0-9a-z]{17}/rule/rule-[0-9a-z]{17}$
id (p. 18)

The ID of the rule.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 22.

Pattern: ^rule-[0-9a-z]{17}$
match (p. 18)

The rule match. The RuleMatch must be an HttpMatch. This means that the rule should be an
exact match on HTTP constraints which are made up of the HTTP method, path, and header.

Type: RuleMatch (p. 188) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.

API Version 2022-11-30

18
Amazon VPC Lattice API Reference
Errors

name (p. 18)

The name of the rule.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!rule-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
priority (p. 18)

The priority assigned to the rule. The lower the priority number the higher the priority.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

API Version 2022-11-30

19
Amazon VPC Lattice API Reference
See Also

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

20
Amazon VPC Lattice API Reference
CreateService

CreateService
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.

Request Syntax
POST /services HTTP/1.1
Content-type: application/json

{
"authType": "string",
"certificateArn": "string",
"clientToken": "string",
"customDomainName": "string",
"name": "string",
"tags": {
"string" : "string"
}
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

authType (p. 21)

The type of IAM policy.

• NONE: The resource does not use an IAM policy. This is the default.
• AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth
policy is required.

Type: String

Valid Values: NONE | AWS_IAM

Required: No
certiﬁcateArn (p. 21)

The Amazon Resource Name (ARN) of the certiﬁcate.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: ^(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:certificate/[0-9a-z-]+)?$

Required: No

API Version 2022-11-30

21
Amazon VPC Lattice API Reference
Response Syntax

clientToken (p. 21)

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]+

Required: No
customDomainName (p. 21)

The custom domain name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Required: No
name (p. 21)

The name of the service. The name must be unique within the account. The valid characters are a-
z, 0-9, and hyphens (-). You can't use a hyphen as the ﬁrst or last character, or immediately after
another hyphen.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: ^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Required: Yes
tags (p. 21)

The tags for the service.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"arn": "string",
"authType": "string",
"certificateArn": "string",
"customDomainName": "string",
"dnsEntry": {

API Version 2022-11-30

22
Amazon VPC Lattice API Reference
Response Elements

"domainName": "string",
"hostedZoneId": "string"
},
"id": "string",
"name": "string",
"status": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

arn (p. 22)

The Amazon Resource Name (ARN) of the service.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}$
authType (p. 22)

The type of IAM policy.

Type: String

Valid Values: NONE | AWS_IAM

certiﬁcateArn (p. 22)

The Amazon Resource Name (ARN) of the certiﬁcate.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: ^(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:certificate/[0-9a-z-]+)?$
customDomainName (p. 22)

The custom domain name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

dnsEntry (p. 22)

The public DNS name of the service.

Type: DnsEntry (p. 173) object

id (p. 22)

The ID of the service.

Type: String

Length Constraints: Fixed length of 21.

API Version 2022-11-30

23
Amazon VPC Lattice API Reference
Errors

Pattern: ^svc-[0-9a-z]{17}$
name (p. 22)

The name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: ^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
status (p. 22)

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

Type: String

Valid Values: ACTIVE | CREATE_IN_PROGRESS | DELETE_IN_PROGRESS | CREATE_FAILED |

DELETE_FAILED

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

API Version 2022-11-30

24
Amazon VPC Lattice API Reference
See Also

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

25
Amazon VPC Lattice API Reference
CreateServiceNetwork

CreateServiceNetwork
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.

Request Syntax
POST /servicenetworks HTTP/1.1
Content-type: application/json

{
"authType": "string",
"clientToken": "string",
"name": "string",
"tags": {
"string" : "string"
}
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

authType (p. 26)

The type of IAM policy.

• NONE: The resource does not use an IAM policy. This is the default.
• AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth
policy is required.

Type: String

Valid Values: NONE | AWS_IAM

Required: No
clientToken (p. 26)

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]+

Required: No

API Version 2022-11-30

26
Amazon VPC Lattice API Reference
Response Syntax

name (p. 26)

The name of the service network. The name must be unique to the account. The valid characters are
a-z, 0-9, and hyphens (-). You can't use a hyphen as the ﬁrst or last character, or immediately after
another hyphen.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Required: Yes
tags (p. 26)

The tags for the service network.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"arn": "string",
"authType": "string",
"id": "string",
"name": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

arn (p. 27)

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-
[0-9a-z]{17}$
authType (p. 27)

The type of IAM policy.

API Version 2022-11-30

27
Amazon VPC Lattice API Reference
Errors

Type: String

Valid Values: NONE | AWS_IAM

id (p. 27)

The ID of the service network.

Type: String

Length Constraints: Fixed length of 32.

Pattern: ^servicenetwork-[0-9a-z]{17}$
name (p. 27)

The name of the service network.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

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

HTTP Status Code: 429

API Version 2022-11-30

28
Amazon VPC Lattice API Reference
See Also

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

29
Amazon VPC Lattice API Reference
CreateServiceNetworkServiceAssociation

CreateServiceNetworkServiceAssociation
Associates a service with a service network.

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.

Request Syntax
POST /servicenetworkserviceassociations HTTP/1.1
Content-type: application/json

{
"clientToken": "string",
"serviceIdentifier": "string",
"serviceNetworkIdentifier": "string",
"tags": {
"string" : "string"
}
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

clientToken (p. 30)

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]+

Required: No
serviceIdentiﬁer (p. 30)

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

Type: String

Length Constraints: Minimum length of 17. Maximum length of 2048.

API Version 2022-11-30

30
Amazon VPC Lattice API Reference
Response Syntax

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes
serviceNetworkIdentiﬁer (p. 30)

The ID or Amazon Resource Name (ARN) of the service network. You must use the ARN if the
resources speciﬁed in the operation are in diﬀerent accounts.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 2048.

Pattern: ^((sn-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetwork/sn-[0-9a-z]{17}))$

Required: Yes
tags (p. 30)

The tags for the association.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"createdBy": "string",
"customDomainName": "string",
"dnsEntry": {
"domainName": "string",
"hostedZoneId": "string"
},
"id": "string",
"status": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 31)

The Amazon Resource Name (ARN) of the association.

Type: String

API Version 2022-11-30

31
Amazon VPC Lattice API Reference
Errors

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkserviceassociation/snsa-[0-9a-z]{17}$
createdBy (p. 31)

The account that created the association.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 12.

Pattern: ^[0-9]{12}$
customDomainName (p. 31)

The custom domain name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

dnsEntry (p. 31)

The DNS name of the service.

Type: DnsEntry (p. 173) object

id (p. 31)

The ID of the association.

Type: String

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((snsa-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkserviceassociation/snsa-[0-9a-z]{17}))$
status (p. 31)

The operation's status.

Type: String

Valid Values: CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED |

DELETE_FAILED

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

API Version 2022-11-30

32
Amazon VPC Lattice API Reference
See Also

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

33
Amazon VPC Lattice API Reference
CreateServiceNetworkVpcAssociation

CreateServiceNetworkVpcAssociation
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 ﬁrst delete the association and recreate it without security groups.

Request Syntax
POST /servicenetworkvpcassociations HTTP/1.1
Content-type: application/json

{
"clientToken": "string",
"securityGroupIds": [ "string" ],
"serviceNetworkIdentifier": "string",
"tags": {
"string" : "string"
},
"vpcIdentifier": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

clientToken (p. 34)

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]+

Required: No
securityGroupIds (p. 34)

The IDs of the security groups. Security groups aren't added by default. You can add a security group
to apply network level controls to control which resources in a VPC are allowed to access the service

API Version 2022-11-30

34
Amazon VPC Lattice API Reference
Response Syntax

network and its services. For more information, see Control traﬃc to resources using security groups
in the Amazon VPC User Guide.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Length Constraints: Minimum length of 5. Maximum length of 200.

Pattern: ^sg-(([0-9a-z]{8})|([0-9a-z]{17}))$

Required: No
serviceNetworkIdentiﬁer (p. 34)

The ID or Amazon Resource Name (ARN) of the service network. You must use the ARN when the
resources speciﬁed in the operation are in diﬀerent accounts.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 2048.

Pattern: ^((sn-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetwork/sn-[0-9a-z]{17}))$

Required: Yes
tags (p. 34)

The tags for the association.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No
vpcIdentiﬁer (p. 34)

The ID of the VPC.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 50.

Pattern: ^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"createdBy": "string",
"id": "string",
"securityGroupIds": [ "string" ],

API Version 2022-11-30

35
Amazon VPC Lattice API Reference
Response Elements

"status": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 35)

The Amazon Resource Name (ARN) of the association.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkvpcassociation/snva-[0-9a-z]{17}$
createdBy (p. 35)

The account that created the association.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 12.

Pattern: ^[0-9]{12}$
id (p. 35)

The ID of the association.

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^snva-[0-9a-z]{17}$
securityGroupIds (p. 35)

The IDs of the security groups.

Type: Array of strings

Length Constraints: Minimum length of 5. Maximum length of 200.

Pattern: ^sg-(([0-9a-z]{8})|([0-9a-z]{17}))$
status (p. 35)

The operation's status.

Type: String

Valid Values: CREATE_IN_PROGRESS | ACTIVE | UPDATE_IN_PROGRESS |

DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED | UPDATE_FAILED

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

API Version 2022-11-30

36
Amazon VPC Lattice API Reference
See Also

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

37
Amazon VPC Lattice API Reference
CreateTargetGroup

CreateTargetGroup
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.

Request Syntax
POST /targetgroups HTTP/1.1
Content-type: application/json

{
"clientToken": "string",
"config": {
"healthCheck": {
"enabled": boolean,
"healthCheckIntervalSeconds": number,
"healthCheckTimeoutSeconds": number,
"healthyThresholdCount": number,
"matcher": { ... },
"path": "string",
"port": number,
"protocol": "string",
"protocolVersion": "string",
"unhealthyThresholdCount": number
},
"ipAddressType": "string",
"port": number,
"protocol": "string",
"protocolVersion": "string",
"vpcIdentifier": "string"
},
"name": "string",
"tags": {
"string" : "string"
},
"type": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

clientToken (p. 38)

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]+

API Version 2022-11-30

38
Amazon VPC Lattice API Reference
Response Syntax

Required: No
conﬁg (p. 38)

The target group conﬁguration. If the target group type is LAMBDA, this parameter doesn't apply.

Type: TargetGroupConﬁg (p. 208) object

Required: No
name (p. 38)

The name of the target group. The name must be unique within the account. The valid characters are
a-z, 0-9, and hyphens (-). You can't use a hyphen as the ﬁrst or last character, or immediately after
another hyphen.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ^(?!tg-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Required: Yes
tags (p. 38)

The tags for the target group.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No
type (p. 38)

The type of target group.

Type: String

Valid Values: IP | LAMBDA | INSTANCE | ALB

Required: Yes

Response Syntax
HTTP/1.1 201
Content-type: application/json

API Version 2022-11-30

39
Amazon VPC Lattice API Reference
Response Elements

"port": number,
"protocol": "string",
"protocolVersion": "string",
"unhealthyThresholdCount": number
},
"ipAddressType": "string",
"port": number,
"protocol": "string",
"protocolVersion": "string",
"vpcIdentifier": "string"
},
"id": "string",
"name": "string",
"status": "string",
"type": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

arn (p. 39)

The Amazon Resource Name (ARN) of the target group.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:targetgroup/tg-
[0-9a-z]{17}$
conﬁg (p. 39)

The target group conﬁguration. If the target group type is LAMBDA, this parameter doesn't apply.

Type: TargetGroupConﬁg (p. 208) object

id (p. 39)

The ID of the target group.

Type: String

Length Constraints: Fixed length of 20.

Pattern: ^tg-[0-9a-z]{17}$
name (p. 39)

The name of the target group.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ^(?!tg-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
status (p. 39)

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.

API Version 2022-11-30

40
Amazon VPC Lattice API Reference
Errors

Type: String

Valid Values: CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED |

DELETE_FAILED
type (p. 39)

The type of target group.

Type: String

Valid Values: IP | LAMBDA | INSTANCE | ALB

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

API Version 2022-11-30

41
Amazon VPC Lattice API Reference
See Also

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

42
Amazon VPC Lattice API Reference
DeleteAccessLogSubscription

DeleteAccessLogSubscription
Deletes the speciﬁed access log subscription.

Request Syntax
DELETE /accesslogsubscriptions/accessLogSubscriptionIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accessLogSubscriptionIdentiﬁer (p. 43)

The ID or Amazon Resource Name (ARN) of the access log subscription.

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((als-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:accesslogsubscription/als-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

API Version 2022-11-30

43
Amazon VPC Lattice API Reference
See Also

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

44
Amazon VPC Lattice API Reference
DeleteAuthPolicy

DeleteAuthPolicy
Deletes the speciﬁed 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.

Request Syntax
DELETE /authpolicy/resourceIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceIdentiﬁer (p. 45)

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

Length Constraints: Minimum length of 17. Maximum length of 200.

Pattern: ^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:
([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-
z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

API Version 2022-11-30

45
Amazon VPC Lattice API Reference
See Also

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

46
Amazon VPC Lattice API Reference
DeleteListener

DeleteListener
Deletes the speciﬁed listener.

Request Syntax
DELETE /services/serviceIdentifier/listeners/listenerIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

listenerIdentiﬁer (p. 47)

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((listener-[0-9a-z]{17})|(^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-
Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}$))$

Required: Yes
serviceIdentiﬁer (p. 47)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

API Version 2022-11-30

47
Amazon VPC Lattice API Reference
See Also

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

48
Amazon VPC Lattice API Reference
DeleteResourcePolicy

DeleteResourcePolicy
Deletes the speciﬁed resource policy.

Request Syntax
DELETE /resourcepolicy/resourceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceArn (p. 49)

The Amazon Resource Name (ARN) of the resource.

Length Constraints: Minimum length of 20. Maximum length of 200.

Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

API Version 2022-11-30

49
Amazon VPC Lattice API Reference
See Also

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

50
Amazon VPC Lattice API Reference
DeleteRule

DeleteRule
Deletes a listener rule. Each listener has a default rule for checking connection requests, but you can
deﬁne 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.

Request Syntax
DELETE /services/serviceIdentifier/listeners/listenerIdentifier/rules/ruleIdentifier
HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

listenerIdentiﬁer (p. 51)

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((listener-[0-9a-z]{17})|(^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-
Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}$))$

Required: Yes
ruleIdentiﬁer (p. 51)

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((rule-[0-9a-z]{17})|(^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}/rule/rule-
[0-9a-z]{17}$))$

Required: Yes
serviceIdentiﬁer (p. 51)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

API Version 2022-11-30

51
Amazon VPC Lattice API Reference
Response Syntax

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2

API Version 2022-11-30

52
Amazon VPC Lattice API Reference
See Also

• AWS SDK for JavaScript

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

53
Amazon VPC Lattice API Reference
DeleteService

DeleteService
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.

Request Syntax
DELETE /services/serviceIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

serviceIdentiﬁer (p. 54)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"id": "string",
"name": "string",
"status": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 54)

The Amazon Resource Name (ARN) of the service.

Type: String

API Version 2022-11-30

54
Amazon VPC Lattice API Reference
Errors

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}$
id (p. 54)

The ID of the service.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^svc-[0-9a-z]{17}$
name (p. 54)

The name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: ^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
status (p. 54)

The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it
while the status is DELETE_IN_PROGRESS, the status doesn't change.

Type: String

Valid Values: ACTIVE | CREATE_IN_PROGRESS | DELETE_IN_PROGRESS | CREATE_FAILED |

DELETE_FAILED

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

API Version 2022-11-30

55
Amazon VPC Lattice API Reference
See Also

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

56
Amazon VPC Lattice API Reference
DeleteServiceNetwork

DeleteServiceNetwork
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.

Request Syntax
DELETE /servicenetworks/serviceNetworkIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

serviceNetworkIdentiﬁer (p. 57)

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

Length Constraints: Minimum length of 3. Maximum length of 2048.

Pattern: ^((sn-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetwork/sn-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

API Version 2022-11-30

57
Amazon VPC Lattice API Reference
See Also

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

58
Amazon VPC Lattice API Reference
DeleteServiceNetworkServiceAssociation

DeleteServiceNetworkServiceAssociation
Deletes the association between a speciﬁed service and the speciﬁc service network. This operation fails
if an association is still in progress.

Request Syntax
DELETE /servicenetworkserviceassociations/serviceNetworkServiceAssociationIdentifier
HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

serviceNetworkServiceAssociationIdentiﬁer (p. 59)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((snsa-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkserviceassociation/snsa-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"id": "string",
"status": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 59)

The Amazon Resource Name (ARN) of the association.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

API Version 2022-11-30

59
Amazon VPC Lattice API Reference
Errors

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkserviceassociation/snsa-[0-9a-z]{17}$
id (p. 59)

The ID of the association.

Type: String

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((snsa-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkserviceassociation/snsa-[0-9a-z]{17}))$
status (p. 59)

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.

Type: String

Valid Values: CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED |

DELETE_FAILED

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

API Version 2022-11-30

60
Amazon VPC Lattice API Reference
See Also

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

61
Amazon VPC Lattice API Reference
DeleteServiceNetworkVpcAssociation

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

Request Syntax
DELETE /servicenetworkvpcassociations/serviceNetworkVpcAssociationIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

serviceNetworkVpcAssociationIdentiﬁer (p. 62)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((snva-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkvpcassociation/snva-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"id": "string",
"status": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 62)

The Amazon Resource Name (ARN) of the association.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

API Version 2022-11-30

62
Amazon VPC Lattice API Reference
Errors

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkvpcassociation/snva-[0-9a-z]{17}$
id (p. 62)

The ID of the association.

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^snva-[0-9a-z]{17}$
status (p. 62)

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.

Type: String

Valid Values: CREATE_IN_PROGRESS | ACTIVE | UPDATE_IN_PROGRESS |

DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED | UPDATE_FAILED

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

API Version 2022-11-30

63
Amazon VPC Lattice API Reference
See Also

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

64
Amazon VPC Lattice API Reference
DeleteTargetGroup

DeleteTargetGroup
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.

Request Syntax
DELETE /targetgroups/targetGroupIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

targetGroupIdentiﬁer (p. 65)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((tg-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:targetgroup/tg-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"id": "string",
"status": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 65)

The Amazon Resource Name (ARN) of the target group.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

API Version 2022-11-30

65
Amazon VPC Lattice API Reference
Errors

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:targetgroup/tg-
[0-9a-z]{17}$
id (p. 65)

The ID of the target group.

Type: String

Length Constraints: Fixed length of 20.

Pattern: ^tg-[0-9a-z]{17}$
status (p. 65)

The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it
while the status is DELETE_IN_PROGRESS, the status doesn't change.

Type: String

Valid Values: CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED |

DELETE_FAILED

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

API Version 2022-11-30

66
Amazon VPC Lattice API Reference
See Also

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

67
Amazon VPC Lattice API Reference
DeregisterTargets

DeregisterTargets
Deregisters the speciﬁed targets from the speciﬁed target group.

Request Syntax
POST /targetgroups/targetGroupIdentifier/deregistertargets HTTP/1.1
Content-type: application/json

{
"targets": [
{
"id": "string",
"port": number
}
]
}

URI Request Parameters

The request uses the following URI parameters.

targetGroupIdentiﬁer (p. 68)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((tg-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:targetgroup/tg-[0-9a-z]{17}))$

Required: Yes

Request Body
The request accepts the following data in JSON format.

targets (p. 68)

The targets to deregister.

Type: Array of Target (p. 206) objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"successful": [

API Version 2022-11-30

68
Amazon VPC Lattice API Reference
Response Elements

{
"id": "string",
"port": number
}
],
"unsuccessful": [
{
"failureCode": "string",
"failureMessage": "string",
"id": "string",
"port": number
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

successful (p. 68)

The targets that were successfully deregistered.

Type: Array of Target (p. 206) objects

unsuccessful (p. 68)

The targets that the operation couldn't deregister.

Type: Array of TargetFailure (p. 207) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

API Version 2022-11-30

69
Amazon VPC Lattice API Reference
See Also

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

70
Amazon VPC Lattice API Reference
GetAccessLogSubscription

GetAccessLogSubscription
Retrieves information about the speciﬁed access log subscription.

Request Syntax
GET /accesslogsubscriptions/accessLogSubscriptionIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

accessLogSubscriptionIdentiﬁer (p. 71)

The ID or Amazon Resource Name (ARN) of the access log subscription.

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((als-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:accesslogsubscription/als-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"createdAt": "string",
"destinationArn": "string",
"id": "string",
"lastUpdatedAt": "string",
"resourceArn": "string",
"resourceId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 71)

The Amazon Resource Name (ARN) of the access log subscription.

Type: String

API Version 2022-11-30

71
Amazon VPC Lattice API Reference
Errors

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:accesslogsubscription/als-[0-9a-z]{17}$
createdAt (p. 71)

The date and time that the access log subscription was created, speciﬁed in ISO-8601 format.

Type: Timestamp
destinationArn (p. 71)

The Amazon Resource Name (ARN) of the access log destination.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:([^/].*)?$
id (p. 71)

The ID of the access log subscription.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^als-[0-9a-z]{17}$
lastUpdatedAt (p. 71)

The date and time that the access log subscription was last updated, speciﬁed in ISO-8601 format.

Type: Timestamp
resourceArn (p. 71)

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 200.

Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}$
resourceId (p. 71)

The ID of the service network or service.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 50.

Pattern: ^((sn)|(svc))-[0-9a-z]{17}$

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

API Version 2022-11-30

72
Amazon VPC Lattice API Reference
See Also

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

73
Amazon VPC Lattice API Reference
GetAuthPolicy

GetAuthPolicy
Retrieves information about the auth policy for the speciﬁed service or service network.

Request Syntax
GET /authpolicy/resourceIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceIdentiﬁer (p. 74)

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

Length Constraints: Minimum length of 17. Maximum length of 200.

Pattern: ^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:
([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-
z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"createdAt": "string",
"lastUpdatedAt": "string",
"policy": "string",
"state": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

createdAt (p. 74)

The date and time that the auth policy was created, speciﬁed in ISO-8601 format.

Type: Timestamp
lastUpdatedAt (p. 74)

The date and time that the auth policy was last updated, speciﬁed in ISO-8601 format.

API Version 2022-11-30

74
Amazon VPC Lattice API Reference
Errors

Type: Timestamp
policy (p. 74)

The auth policy.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10000.

Pattern: ^.*\S.*$
state (p. 74)

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

Type: String

Valid Values: Active | Inactive

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2022-11-30

75
Amazon VPC Lattice API Reference
See Also

• AWS SDK for .NET

• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

76
Amazon VPC Lattice API Reference
GetListener

GetListener
Retrieves information about the speciﬁed listener for the speciﬁed service.

Request Syntax
GET /services/serviceIdentifier/listeners/listenerIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

listenerIdentiﬁer (p. 77)

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((listener-[0-9a-z]{17})|(^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-
Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}$))$

Required: Yes
serviceIdentiﬁer (p. 77)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"createdAt": "string",
"defaultAction": { ... },
"id": "string",
"lastUpdatedAt": "string",
"name": "string",
"port": number,
"protocol": "string",
"serviceArn": "string",
"serviceId": "string"
}

API Version 2022-11-30

77
Amazon VPC Lattice API Reference
Response Elements

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 77)

The Amazon Resource Name (ARN) of the listener.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}/listener/listener-[0-9a-z]{17}$
createdAt (p. 77)

The date and time that the listener was created, speciﬁed in ISO-8601 format.

Type: Timestamp
defaultAction (p. 77)

The actions for the default listener rule.

Type: RuleAction (p. 187) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.
id (p. 77)

The ID of the listener.

Type: String

Length Constraints: Fixed length of 26.

Pattern: ^listener-[0-9a-z]{17}$
lastUpdatedAt (p. 77)

The date and time that the listener was last updated, speciﬁed in ISO-8601 format.

Type: Timestamp
name (p. 77)

The name of the listener.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!listener-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
port (p. 77)

The listener port.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

API Version 2022-11-30

78
Amazon VPC Lattice API Reference
Errors

protocol (p. 77)

The listener protocol.

Type: String

Valid Values: HTTP | HTTPS

serviceArn (p. 77)

The Amazon Resource Name (ARN) of the service.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}$
serviceId (p. 77)

The ID of the service.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^svc-[0-9a-z]{17}$

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

API Version 2022-11-30

79
Amazon VPC Lattice API Reference
See Also

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

80
Amazon VPC Lattice API Reference
GetResourcePolicy

GetResourcePolicy
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.

Request Syntax
GET /resourcepolicy/resourceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceArn (p. 81)

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

Length Constraints: Minimum length of 20. Maximum length of 200.

Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"policy": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

policy (p. 81)

An IAM policy.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10000.

Pattern: ^.*\S.*$

API Version 2022-11-30

81
Amazon VPC Lattice API Reference
Errors

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

82
Amazon VPC Lattice API Reference
GetRule

GetRule
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.

Request Syntax
GET /services/serviceIdentifier/listeners/listenerIdentifier/rules/ruleIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

listenerIdentiﬁer (p. 83)

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((listener-[0-9a-z]{17})|(^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-
Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}$))$

Required: Yes
ruleIdentiﬁer (p. 83)

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((rule-[0-9a-z]{17})|(^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}/rule/rule-
[0-9a-z]{17}$))$

Required: Yes
serviceIdentiﬁer (p. 83)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

API Version 2022-11-30

83
Amazon VPC Lattice API Reference
Response Elements

{
"action": { ... },
"arn": "string",
"createdAt": "string",
"id": "string",
"isDefault": boolean,
"lastUpdatedAt": "string",
"match": { ... },
"name": "string",
"priority": number
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

action (p. 83)

The action for the default rule.

Type: RuleAction (p. 187) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.
arn (p. 83)

The Amazon Resource Name (ARN) of the listener.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}/listener/listener-[0-9a-z]{17}/rule/rule-[0-9a-z]{17}$
createdAt (p. 83)

The date and time that the listener rule was created, speciﬁed in ISO-8601 format.

Type: Timestamp
id (p. 83)

The ID of the listener.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 22.

Pattern: ^rule-[0-9a-z]{17}$
isDefault (p. 83)

Indicates whether this is the default rule.

Type: Boolean
lastUpdatedAt (p. 83)

The date and time that the listener rule was last updated, speciﬁed in ISO-8601 format.

Type: Timestamp

API Version 2022-11-30

84
Amazon VPC Lattice API Reference
Errors

match (p. 83)

The rule match.

Type: RuleMatch (p. 188) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.
name (p. 83)

The name of the listener.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!rule-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
priority (p. 83)

The priority level for the speciﬁed rule.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

API Version 2022-11-30

85
Amazon VPC Lattice API Reference
See Also

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

86
Amazon VPC Lattice API Reference
GetService

GetService
Retrieves information about the speciﬁed service.

Request Syntax
GET /services/serviceIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

serviceIdentiﬁer (p. 87)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"authType": "string",
"certificateArn": "string",
"createdAt": "string",
"customDomainName": "string",
"dnsEntry": {
"domainName": "string",
"hostedZoneId": "string"
},
"failureCode": "string",
"failureMessage": "string",
"id": "string",
"lastUpdatedAt": "string",
"name": "string",
"status": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

API Version 2022-11-30

87
Amazon VPC Lattice API Reference
Response Elements

The following data is returned in JSON format by the service.

arn (p. 87)

The Amazon Resource Name (ARN) of the service.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}$
authType (p. 87)

The type of IAM policy.

Type: String

Valid Values: NONE | AWS_IAM

certiﬁcateArn (p. 87)

The Amazon Resource Name (ARN) of the certiﬁcate.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: ^(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:certificate/[0-9a-z-]+)?$
createdAt (p. 87)

The date and time that the service was created, speciﬁed in ISO-8601 format.

Type: Timestamp
customDomainName (p. 87)

The custom domain name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

dnsEntry (p. 87)

The DNS name of the service.

Type: DnsEntry (p. 173) object

failureCode (p. 87)

The failure code.

Type: String
failureMessage (p. 87)

The failure message.

Type: String
id (p. 87)

The ID of the service.

API Version 2022-11-30

88
Amazon VPC Lattice API Reference
Errors

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^svc-[0-9a-z]{17}$
lastUpdatedAt (p. 87)

The date and time that the service was last updated, speciﬁed in ISO-8601 format.

Type: Timestamp
name (p. 87)

The name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: ^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
status (p. 87)

The status of the service.

Type: String

Valid Values: ACTIVE | CREATE_IN_PROGRESS | DELETE_IN_PROGRESS | CREATE_FAILED |

DELETE_FAILED

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

API Version 2022-11-30

89
Amazon VPC Lattice API Reference
See Also

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

90
Amazon VPC Lattice API Reference
GetServiceNetwork

GetServiceNetwork
Retrieves information about the speciﬁed service network.

Request Syntax
GET /servicenetworks/serviceNetworkIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

serviceNetworkIdentiﬁer (p. 91)

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

Length Constraints: Minimum length of 3. Maximum length of 2048.

Pattern: ^((sn-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetwork/sn-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"authType": "string",
"createdAt": "string",
"id": "string",
"lastUpdatedAt": "string",
"name": "string",
"numberOfAssociatedServices": number,
"numberOfAssociatedVPCs": number
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 91)

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

Type: String

API Version 2022-11-30

91
Amazon VPC Lattice API Reference
Errors

Length Constraints: Minimum length of 32. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-
[0-9a-z]{17}$
authType (p. 91)

The type of IAM policy.

Type: String

Valid Values: NONE | AWS_IAM

createdAt (p. 91)

The date and time that the service network was created, speciﬁed in ISO-8601 format.

Type: Timestamp
id (p. 91)

The ID of the service network.

Type: String

Length Constraints: Fixed length of 32.

Pattern: ^servicenetwork-[0-9a-z]{17}$
lastUpdatedAt (p. 91)

The date and time of the last update, speciﬁed in ISO-8601 format.

Type: Timestamp
name (p. 91)

The name of the service network.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
numberOfAssociatedServices (p. 91)

The number of services associated with the service network.

Type: Long
numberOfAssociatedVPCs (p. 91)

The number of VPCs associated with the service network.

Type: Long

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

API Version 2022-11-30

92
Amazon VPC Lattice API Reference
See Also

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

93
Amazon VPC Lattice API Reference
GetServiceNetworkServiceAssociation

GetServiceNetworkServiceAssociation
Retrieves information about the speciﬁed association between a service network and a service.

Request Syntax
GET /servicenetworkserviceassociations/serviceNetworkServiceAssociationIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

serviceNetworkServiceAssociationIdentiﬁer (p. 94)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((snsa-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkserviceassociation/snsa-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"createdAt": "string",
"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": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

API Version 2022-11-30

94
Amazon VPC Lattice API Reference
Response Elements

The following data is returned in JSON format by the service.

arn (p. 94)

The Amazon Resource Name (ARN) of the association.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkserviceassociation/snsa-[0-9a-z]{17}$
createdAt (p. 94)

The date and time that the association was created, speciﬁed in ISO-8601 format.

Type: Timestamp
createdBy (p. 94)

The account that created the association.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 12.

Pattern: ^[0-9]{12}$
customDomainName (p. 94)

The custom domain name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

dnsEntry (p. 94)

The DNS name of the service.

Type: DnsEntry (p. 173) object

failureCode (p. 94)

The failure code.

Type: String
failureMessage (p. 94)

The failure message.

Type: String
id (p. 94)

The ID of the service network and service association.

Type: String

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((snsa-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkserviceassociation/snsa-[0-9a-z]{17}))$

API Version 2022-11-30

95
Amazon VPC Lattice API Reference
Response Elements

serviceArn (p. 94)

The Amazon Resource Name (ARN) of the service.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}$
serviceId (p. 94)

The ID of the service.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^svc-[0-9a-z]{17}$
serviceName (p. 94)

The name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: ^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
serviceNetworkArn (p. 94)

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-
[0-9a-z]{17}$
serviceNetworkId (p. 94)

The ID of the service network.

Type: String

Length Constraints: Fixed length of 32.

Pattern: ^servicenetwork-[0-9a-z]{17}$
serviceNetworkName (p. 94)

The name of the service network.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
status (p. 94)

The status of the association.

API Version 2022-11-30

96
Amazon VPC Lattice API Reference
Errors

Type: String

Valid Values: CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED |

DELETE_FAILED

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

97
Amazon VPC Lattice API Reference
GetServiceNetworkVpcAssociation

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

Request Syntax
GET /servicenetworkvpcassociations/serviceNetworkVpcAssociationIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

serviceNetworkVpcAssociationIdentiﬁer (p. 98)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((snva-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkvpcassociation/snva-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"createdAt": "string",
"createdBy": "string",
"failureCode": "string",
"failureMessage": "string",
"id": "string",
"lastUpdatedAt": "string",
"securityGroupIds": [ "string" ],
"serviceNetworkArn": "string",
"serviceNetworkId": "string",
"serviceNetworkName": "string",
"status": "string",
"vpcId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

API Version 2022-11-30

98
Amazon VPC Lattice API Reference
Response Elements

arn (p. 98)

The Amazon Resource Name (ARN) of the association.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkvpcassociation/snva-[0-9a-z]{17}$
createdAt (p. 98)

The date and time that the association was created, speciﬁed in ISO-8601 format.

Type: Timestamp
createdBy (p. 98)

The account that created the association.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 12.

Pattern: ^[0-9]{12}$
failureCode (p. 98)

The failure code.

Type: String
failureMessage (p. 98)

The failure message.

Type: String
id (p. 98)

The ID of the speciﬁed association between the service network and the VPC.

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^snva-[0-9a-z]{17}$
lastUpdatedAt (p. 98)

The date and time that the association was last updated, speciﬁed in ISO-8601 format.

Type: Timestamp
securityGroupIds (p. 98)

The IDs of the security groups.

Type: Array of strings

Length Constraints: Minimum length of 5. Maximum length of 200.

Pattern: ^sg-(([0-9a-z]{8})|([0-9a-z]{17}))$
serviceNetworkArn (p. 98)

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

API Version 2022-11-30

99
Amazon VPC Lattice API Reference
Errors

Type: String

Length Constraints: Minimum length of 32. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-
[0-9a-z]{17}$
serviceNetworkId (p. 98)

The ID of the service network.

Type: String

Length Constraints: Fixed length of 32.

Pattern: ^servicenetwork-[0-9a-z]{17}$
serviceNetworkName (p. 98)

The name of the service network.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
status (p. 98)

The status of the association.

Type: String

Valid Values: CREATE_IN_PROGRESS | ACTIVE | UPDATE_IN_PROGRESS |

DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED | UPDATE_FAILED
vpcId (p. 98)

The ID of the VPC.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 50.

Pattern: ^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

API Version 2022-11-30

100
Amazon VPC Lattice API Reference
See Also

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

101
Amazon VPC Lattice API Reference
GetTargetGroup

GetTargetGroup
Retrieves information about the speciﬁed target group.

Request Syntax
GET /targetgroups/targetGroupIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

targetGroupIdentiﬁer (p. 102)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((tg-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:targetgroup/tg-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"config": {
"healthCheck": {
"enabled": boolean,
"healthCheckIntervalSeconds": number,
"healthCheckTimeoutSeconds": number,
"healthyThresholdCount": number,
"matcher": { ... },
"path": "string",
"port": number,
"protocol": "string",
"protocolVersion": "string",
"unhealthyThresholdCount": number
},
"ipAddressType": "string",
"port": number,
"protocol": "string",
"protocolVersion": "string",
"vpcIdentifier": "string"
},
"createdAt": "string",
"failureCode": "string",
"failureMessage": "string",

API Version 2022-11-30

102
Amazon VPC Lattice API Reference
Response Elements

"id": "string",
"lastUpdatedAt": "string",
"name": "string",
"serviceArns": [ "string" ],
"status": "string",
"type": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 102)

The Amazon Resource Name (ARN) of the target group.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:targetgroup/tg-
[0-9a-z]{17}$
conﬁg (p. 102)

The target group conﬁguration.

Type: TargetGroupConﬁg (p. 208) object

createdAt (p. 102)

The date and time that the target group was created, speciﬁed in ISO-8601 format.

Type: Timestamp
failureCode (p. 102)

The failure code.

Type: String
failureMessage (p. 102)

The failure message.

Type: String
id (p. 102)

The ID of the target group.

Type: String

Length Constraints: Fixed length of 20.

Pattern: ^tg-[0-9a-z]{17}$
lastUpdatedAt (p. 102)

The date and time that the target group was last updated, speciﬁed in ISO-8601 format.

Type: Timestamp

API Version 2022-11-30

103
Amazon VPC Lattice API Reference
Errors

name (p. 102)

The name of the target group.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ^(?!tg-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
serviceArns (p. 102)

The Amazon Resource Names (ARNs) of the service.

Type: Array of strings

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}$
status (p. 102)

The status.

Type: String

Valid Values: CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED |

DELETE_FAILED
type (p. 102)

The target group type.

Type: String

Valid Values: IP | LAMBDA | INSTANCE | ALB

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

API Version 2022-11-30

104
Amazon VPC Lattice API Reference
See Also

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

105
Amazon VPC Lattice API Reference
ListAccessLogSubscriptions

ListAccessLogSubscriptions
Lists all access log subscriptions for the speciﬁed service network or service.

Request Syntax
GET /accesslogsubscriptions?
maxResults=maxResults&nextToken=nextToken&resourceIdentifier=resourceIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults (p. 106)

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken (p. 106)

A pagination token for the next page of results.

Length Constraints: Minimum length of 1. Maximum length of 2048.

resourceIdentiﬁer (p. 106)

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

Length Constraints: Minimum length of 17. Maximum length of 200.

Pattern: ^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:
([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-
z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"items": [
{
"arn": "string",
"createdAt": "string",
"destinationArn": "string",
"id": "string",
"lastUpdatedAt": "string",
"resourceArn": "string",
"resourceId": "string"

API Version 2022-11-30

106
Amazon VPC Lattice API Reference
Response Elements

}
],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items (p. 106)

The access log subscriptions.

Type: Array of AccessLogSubscriptionSummary (p. 171) objects

nextToken (p. 106)

A pagination token for the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript

API Version 2022-11-30

107
Amazon VPC Lattice API Reference
See Also

• AWS SDK for PHP V3

• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

108
Amazon VPC Lattice API Reference
ListListeners

ListListeners
Lists the listeners for the speciﬁed service.

Request Syntax
GET /services/serviceIdentifier/listeners?maxResults=maxResults&nextToken=nextToken
HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults (p. 109)

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken (p. 109)

A pagination token for the next page of results.

Length Constraints: Minimum length of 1. Maximum length of 2048.

serviceIdentiﬁer (p. 109)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"items": [
{
"arn": "string",
"createdAt": "string",
"id": "string",
"lastUpdatedAt": "string",
"name": "string",
"port": number,
"protocol": "string"
}
],

API Version 2022-11-30

109
Amazon VPC Lattice API Reference
Response Elements

"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items (p. 109)

Information about the listeners.

Type: Array of ListenerSummary (p. 182) objects

nextToken (p. 109)

If there are additional results, a pagination token for the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

API Version 2022-11-30

110
Amazon VPC Lattice API Reference
See Also

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

111
Amazon VPC Lattice API Reference
ListRules

ListRules
Lists the rules for the listener.

Request Syntax
GET /services/serviceIdentifier/listeners/listenerIdentifier/rules?
maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

listenerIdentiﬁer (p. 112)

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((listener-[0-9a-z]{17})|(^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-
Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}$))$

Required: Yes
maxResults (p. 112)

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken (p. 112)

A pagination token for the next page of results.

Length Constraints: Minimum length of 1. Maximum length of 2048.

serviceIdentiﬁer (p. 112)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

API Version 2022-11-30

112
Amazon VPC Lattice API Reference
Response Elements

{
"items": [
{
"arn": "string",
"createdAt": "string",
"id": "string",
"isDefault": boolean,
"lastUpdatedAt": "string",
"name": "string",
"priority": number
}
],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items (p. 112)

Information about the rules.

Type: Array of RuleSummary (p. 189) objects

nextToken (p. 112)

If there are additional results, a pagination token for the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

API Version 2022-11-30

113
Amazon VPC Lattice API Reference
See Also

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

114
Amazon VPC Lattice API Reference
ListServiceNetworks

ListServiceNetworks
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.

Request Syntax
GET /servicenetworks?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults (p. 115)

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken (p. 115)

A pagination token for the next page of results.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"items": [
{
"arn": "string",
"createdAt": "string",
"id": "string",
"lastUpdatedAt": "string",
"name": "string",
"numberOfAssociatedServices": number,
"numberOfAssociatedVPCs": number
}
],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

API Version 2022-11-30

115
Amazon VPC Lattice API Reference
Errors

items (p. 115)

Information about the service networks.

Type: Array of ServiceNetworkSummary (p. 199) objects

nextToken (p. 115)

If there are additional results, a pagination token for the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

116
Amazon VPC Lattice API Reference
ListServiceNetworkServiceAssociations

ListServiceNetworkServiceAssociations
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 preﬁx in the ARN for each account the resource is shared with.

Request Syntax
GET /servicenetworkserviceassociations?
maxResults=maxResults&nextToken=nextToken&serviceIdentifier=serviceIdentifier&serviceNetworkIdentifier=
HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults (p. 117)

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken (p. 117)

A pagination token for the next page of results.

Length Constraints: Minimum length of 1. Maximum length of 2048.

serviceIdentiﬁer (p. 117)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$
serviceNetworkIdentiﬁer (p. 117)

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

Length Constraints: Minimum length of 3. Maximum length of 2048.

Pattern: ^((sn-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetwork/sn-[0-9a-z]{17}))$

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

API Version 2022-11-30

117
Amazon VPC Lattice API Reference
Response Elements

Content-type: application/json

{
"items": [
{
"arn": "string",
"createdAt": "string",
"createdBy": "string",
"customDomainName": "string",
"dnsEntry": {
"domainName": "string",
"hostedZoneId": "string"
},
"id": "string",
"serviceArn": "string",
"serviceId": "string",
"serviceName": "string",
"serviceNetworkArn": "string",
"serviceNetworkId": "string",
"serviceNetworkName": "string",
"status": "string"
}
],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items (p. 117)

Information about the associations.

Type: Array of ServiceNetworkServiceAssociationSummary (p. 196) objects

nextToken (p. 117)

If there are additional results, a pagination token for the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

API Version 2022-11-30

118
Amazon VPC Lattice API Reference
See Also

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

119
Amazon VPC Lattice API Reference
ListServiceNetworkVpcAssociations

ListServiceNetworkVpcAssociations
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.

Request Syntax
GET /servicenetworkvpcassociations?
maxResults=maxResults&nextToken=nextToken&serviceNetworkIdentifier=serviceNetworkIdentifier&vpcIdentifi
HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults (p. 120)

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken (p. 120)

A pagination token for the next page of results.

Length Constraints: Minimum length of 1. Maximum length of 2048.

serviceNetworkIdentiﬁer (p. 120)

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

Length Constraints: Minimum length of 3. Maximum length of 2048.

Pattern: ^((sn-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetwork/sn-[0-9a-z]{17}))$
vpcIdentiﬁer (p. 120)

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

Length Constraints: Minimum length of 5. Maximum length of 50.

Pattern: ^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"items": [
{

API Version 2022-11-30

120
Amazon VPC Lattice API Reference
Response Elements

"arn": "string",
"createdAt": "string",
"createdBy": "string",
"id": "string",
"lastUpdatedAt": "string",
"serviceNetworkArn": "string",
"serviceNetworkId": "string",
"serviceNetworkName": "string",
"status": "string",
"vpcId": "string"
}
],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items (p. 120)

Information about the associations.

Type: Array of ServiceNetworkVpcAssociationSummary (p. 201) objects

nextToken (p. 120)

If there are additional results, a pagination token for the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

API Version 2022-11-30

121
Amazon VPC Lattice API Reference
See Also

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

122
Amazon VPC Lattice API Reference
ListServices

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

Request Syntax
GET /services?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults (p. 123)

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken (p. 123)

A pagination token for the next page of results.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"items": [
{
"arn": "string",
"createdAt": "string",
"customDomainName": "string",
"dnsEntry": {
"domainName": "string",
"hostedZoneId": "string"
},
"id": "string",
"lastUpdatedAt": "string",
"name": "string",
"status": "string"
}
],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

API Version 2022-11-30

123
Amazon VPC Lattice API Reference
Errors

The following data is returned in JSON format by the service.

items (p. 123)

The services.

Type: Array of ServiceSummary (p. 204) objects

nextToken (p. 123)

If there are additional results, a pagination token for the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

124
Amazon VPC Lattice API Reference
ListTagsForResource

ListTagsForResource
Lists the tags for the speciﬁed resource.

Request Syntax
GET /tags/resourceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceArn (p. 125)

The Amazon Resource Name (ARN) of the resource.

Length Constraints: Minimum length of 0. Maximum length of 1224.

Pattern: ^arn:[a-z0-9][-.a-z0-9]{0,62}:vpc-lattice:([a-z0-9][-.a-z0-9]
{0,62})?:\d{12}?:[^/].{0,1023}$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"tags": {
"string" : "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

tags (p. 125)

The tags.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

API Version 2022-11-30

125
Amazon VPC Lattice API Reference
Errors

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

126
Amazon VPC Lattice API Reference
ListTargetGroups

ListTargetGroups
Lists your target groups. You can narrow your search by using the ﬁlters below in your request.

Request Syntax
GET /targetgroups?
maxResults=maxResults&nextToken=nextToken&targetGroupType=targetGroupType&vpcIdentifier=vpcIdentifier
HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults (p. 127)

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken (p. 127)

A pagination token for the next page of results.

Length Constraints: Minimum length of 1. Maximum length of 2048.

targetGroupType (p. 127)

The target group type.

Valid Values: IP | LAMBDA | INSTANCE | ALB

vpcIdentiﬁer (p. 127)

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

Length Constraints: Minimum length of 5. Maximum length of 50.

Pattern: ^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"items": [
{
"arn": "string",
"createdAt": "string",
"id": "string",
"ipAddressType": "string",

API Version 2022-11-30

127
Amazon VPC Lattice API Reference
Response Elements

"lastUpdatedAt": "string",
"name": "string",
"port": number,
"protocol": "string",
"serviceArns": [ "string" ],
"status": "string",
"type": "string",
"vpcIdentifier": "string"
}
],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items (p. 127)

Information about the target groups.

Type: Array of TargetGroupSummary (p. 210) objects

nextToken (p. 127)

If there are additional results, a pagination token for the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

API Version 2022-11-30

128
Amazon VPC Lattice API Reference
See Also

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

129
Amazon VPC Lattice API Reference
ListTargets

ListTargets
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 ﬁlter the results by target.

Request Syntax
POST /targetgroups/targetGroupIdentifier/listtargets?
maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
"targets": [
{
"id": "string",
"port": number
}
]
}

URI Request Parameters

The request uses the following URI parameters.

maxResults (p. 130)

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken (p. 130)

A pagination token for the next page of results.

Length Constraints: Minimum length of 1. Maximum length of 2048.

targetGroupIdentiﬁer (p. 130)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((tg-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:targetgroup/tg-[0-9a-z]{17}))$

Required: Yes

Request Body
The request accepts the following data in JSON format.

targets (p. 130)

The targets to list.

Type: Array of Target (p. 206) objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

API Version 2022-11-30

130
Amazon VPC Lattice API Reference
Response Syntax

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"items": [
{
"id": "string",
"port": number,
"reasonCode": "string",
"status": "string"
}
],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items (p. 131)

Information about the targets.

Type: Array of TargetSummary (p. 213) objects

nextToken (p. 131)

If there are additional results, a pagination token for the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

API Version 2022-11-30

131
Amazon VPC Lattice API Reference
See Also

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

132
Amazon VPC Lattice API Reference
PutAuthPolicy

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

Request Syntax
PUT /authpolicy/resourceIdentifier HTTP/1.1
Content-type: application/json

{
"policy": "string"
}

URI Request Parameters

The request uses the following URI parameters.

resourceIdentiﬁer (p. 133)

The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is
created.

Length Constraints: Minimum length of 17. Maximum length of 200.

Pattern: ^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:
([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-
z]{17}))$

Required: Yes

Request Body
The request accepts the following data in JSON format.

policy (p. 133)

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10000.

Pattern: ^.*\S.*$

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"policy": "string",
"state": "string"

API Version 2022-11-30

133
Amazon VPC Lattice API Reference
Response Elements

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

policy (p. 133)

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10000.

Pattern: ^.*\S.*$
state (p. 133)

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

Type: String

Valid Values: Active | Inactive

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

API Version 2022-11-30

134
Amazon VPC Lattice API Reference
See Also

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

135
Amazon VPC Lattice API Reference
PutResourcePolicy

PutResourcePolicy
Attaches a resource-based permission policy to a service or service network. The policy must contain
the same actions and condition statements as the AWS Resource Access Manager permission for sharing
services and service networks.

Request Syntax
PUT /resourcepolicy/resourceArn HTTP/1.1
Content-type: application/json

{
"policy": "string"
}

URI Request Parameters

The request uses the following URI parameters.

resourceArn (p. 136)

The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is
created.

Length Constraints: Minimum length of 20. Maximum length of 200.

Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}$

Required: Yes

Request Body
The request accepts the following data in JSON format.

policy (p. 136)

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10000.

Pattern: ^.*\S.*$

Required: Yes

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

API Version 2022-11-30

136
Amazon VPC Lattice API Reference
Errors

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

137
Amazon VPC Lattice API Reference
RegisterTargets

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

Request Syntax
POST /targetgroups/targetGroupIdentifier/registertargets HTTP/1.1
Content-type: application/json

{
"targets": [
{
"id": "string",
"port": number
}
]
}

URI Request Parameters

The request uses the following URI parameters.

targetGroupIdentiﬁer (p. 138)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((tg-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:targetgroup/tg-[0-9a-z]{17}))$

Required: Yes

Request Body
The request accepts the following data in JSON format.

targets (p. 138)

The targets.

Type: Array of Target (p. 206) objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

API Version 2022-11-30

138
Amazon VPC Lattice API Reference
Response Elements

"successful": [
{
"id": "string",
"port": number
}
],
"unsuccessful": [
{
"failureCode": "string",
"failureMessage": "string",
"id": "string",
"port": number
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

successful (p. 138)

The targets that were successfully registered.

Type: Array of Target (p. 206) objects

unsuccessful (p. 138)

The targets that were not registered.

Type: Array of TargetFailure (p. 207) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

API Version 2022-11-30

139
Amazon VPC Lattice API Reference
See Also

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

140
Amazon VPC Lattice API Reference
TagResource

TagResource
Adds the speciﬁed tags to the speciﬁed resource.

Request Syntax
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
"tags": {
"string" : "string"
}
}

URI Request Parameters

The request uses the following URI parameters.

resourceArn (p. 141)

The Amazon Resource Name (ARN) of the resource.

Length Constraints: Minimum length of 0. Maximum length of 1224.

Pattern: ^arn:[a-z0-9][-.a-z0-9]{0,62}:vpc-lattice:([a-z0-9][-.a-z0-9]
{0,62})?:\d{12}?:[^/].{0,1023}$

Required: Yes

Request Body
The request accepts the following data in JSON format.

tags (p. 141)

The tags for the resource.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

Response Syntax
HTTP/1.1 200

API Version 2022-11-30

141
Amazon VPC Lattice API Reference
Response Elements

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

142
Amazon VPC Lattice API Reference
UntagResource

UntagResource
Removes the speciﬁed tags from the speciﬁed resource.

Request Syntax
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceArn (p. 143)

The Amazon Resource Name (ARN) of the resource.

Length Constraints: Minimum length of 0. Maximum length of 1224.

Pattern: ^arn:[a-z0-9][-.a-z0-9]{0,62}:vpc-lattice:([a-z0-9][-.a-z0-9]
{0,62})?:\d{12}?:[^/].{0,1023}$

Required: Yes
tagKeys (p. 143)

The tag keys of the tags to remove.

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

InternalServerException

An unexpected error occurred while processing the request.

API Version 2022-11-30

143
Amazon VPC Lattice API Reference
See Also

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

144
Amazon VPC Lattice API Reference
UpdateAccessLogSubscription

UpdateAccessLogSubscription
Updates the speciﬁed access log subscription.

Request Syntax
PATCH /accesslogsubscriptions/accessLogSubscriptionIdentifier HTTP/1.1
Content-type: application/json

{
"destinationArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

accessLogSubscriptionIdentiﬁer (p. 145)

The ID or Amazon Resource Name (ARN) of the access log subscription.

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((als-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:accesslogsubscription/als-[0-9a-z]{17}))$

Required: Yes

Request Body
The request accepts the following data in JSON format.

destinationArn (p. 145)

The Amazon Resource Name (ARN) of the access log destination.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:([^/].*)?$

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"destinationArn": "string",
"id": "string",

API Version 2022-11-30

145
Amazon VPC Lattice API Reference
Response Elements

"resourceArn": "string",
"resourceId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 145)

The Amazon Resource Name (ARN) of the access log subscription.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:accesslogsubscription/als-[0-9a-z]{17}$
destinationArn (p. 145)

The Amazon Resource Name (ARN) of the access log destination.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:([^/].*)?$
id (p. 145)

The ID of the access log subscription.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^als-[0-9a-z]{17}$
resourceArn (p. 145)

The Amazon Resource Name (ARN) of the access log subscription.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 200.

Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}$
resourceId (p. 145)

The ID of the resource.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 50.

Pattern: ^((sn)|(svc))-[0-9a-z]{17}$

API Version 2022-11-30

146
Amazon VPC Lattice API Reference
Errors

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

147
Amazon VPC Lattice API Reference
UpdateListener

UpdateListener
Updates the speciﬁed listener for the speciﬁed service.

Request Syntax
PATCH /services/serviceIdentifier/listeners/listenerIdentifier HTTP/1.1
Content-type: application/json

{
"defaultAction": { ... }
}

URI Request Parameters

The request uses the following URI parameters.

listenerIdentiﬁer (p. 148)

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((listener-[0-9a-z]{17})|(^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-
Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}$))$

Required: Yes
serviceIdentiﬁer (p. 148)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes

Request Body
The request accepts the following data in JSON format.

defaultAction (p. 148)

The action for the default rule.

Type: RuleAction (p. 187) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.

Required: Yes

Response Syntax
HTTP/1.1 200

API Version 2022-11-30

148
Amazon VPC Lattice API Reference
Response Elements

Content-type: application/json

{
"arn": "string",
"defaultAction": { ... },
"id": "string",
"name": "string",
"port": number,
"protocol": "string",
"serviceArn": "string",
"serviceId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 148)

The Amazon Resource Name (ARN) of the listener.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}/listener/listener-[0-9a-z]{17}$
defaultAction (p. 148)

The action for the default rule.

Type: RuleAction (p. 187) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.
id (p. 148)

The ID of the listener.

Type: String

Length Constraints: Fixed length of 26.

Pattern: ^listener-[0-9a-z]{17}$
name (p. 148)

The name of the listener.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!listener-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
port (p. 148)

The listener port.

Type: Integer

API Version 2022-11-30

149
Amazon VPC Lattice API Reference
Errors

Valid Range: Minimum value of 1. Maximum value of 65535.

protocol (p. 148)

The protocol of the listener.

Type: String

Valid Values: HTTP | HTTPS

serviceArn (p. 148)

The Amazon Resource Name (ARN) of the service.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}$
serviceId (p. 148)

The ID of the service.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^svc-[0-9a-z]{17}$

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

API Version 2022-11-30

150
Amazon VPC Lattice API Reference
See Also

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

151
Amazon VPC Lattice API Reference
UpdateRule

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

Request Syntax
PATCH /services/serviceIdentifier/listeners/listenerIdentifier/rules/ruleIdentifier
HTTP/1.1
Content-type: application/json

{
"action": { ... },
"match": { ... },
"priority": number
}

URI Request Parameters

The request uses the following URI parameters.

listenerIdentiﬁer (p. 152)

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((listener-[0-9a-z]{17})|(^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-
Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}$))$

Required: Yes
ruleIdentiﬁer (p. 152)

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((rule-[0-9a-z]{17})|(^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}/rule/rule-
[0-9a-z]{17}$))$

Required: Yes
serviceIdentiﬁer (p. 152)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes

Request Body
The request accepts the following data in JSON format.

API Version 2022-11-30

152
Amazon VPC Lattice API Reference
Response Syntax

action (p. 152)

Information about the action for the speciﬁed listener rule.

Type: RuleAction (p. 187) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.

Required: No
match (p. 152)

The rule match.

Type: RuleMatch (p. 188) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.

Required: No
priority (p. 152)

The rule priority. A listener can't have multiple rules with the same priority.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"action": { ... },
"arn": "string",
"id": "string",
"isDefault": boolean,
"match": { ... },
"name": "string",
"priority": number
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

action (p. 153)

Information about the action for the speciﬁed listener rule.

Type: RuleAction (p. 187) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.
arn (p. 153)

The Amazon Resource Name (ARN) of the listener.

API Version 2022-11-30

153
Amazon VPC Lattice API Reference
Errors

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}/listener/listener-[0-9a-z]{17}/rule/rule-[0-9a-z]{17}$
id (p. 153)

The ID of the listener.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 22.

Pattern: ^rule-[0-9a-z]{17}$
isDefault (p. 153)

Indicates whether this is the default rule.

Type: Boolean
match (p. 153)

The rule match.

Type: RuleMatch (p. 188) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.
name (p. 153)

The name of the listener.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!rule-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
priority (p. 153)

The rule priority.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

API Version 2022-11-30

154
Amazon VPC Lattice API Reference
See Also

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

155
Amazon VPC Lattice API Reference
UpdateService

UpdateService
Updates the speciﬁed service.

Request Syntax
PATCH /services/serviceIdentifier HTTP/1.1
Content-type: application/json

{
"authType": "string",
"certificateArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

serviceIdentiﬁer (p. 156)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}))$

Required: Yes

Request Body
The request accepts the following data in JSON format.

authType (p. 156)

The type of IAM policy.

• NONE: The resource does not use an IAM policy. This is the default.
• AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth
policy is required.

Type: String

Valid Values: NONE | AWS_IAM

Required: No
certiﬁcateArn (p. 156)

The Amazon Resource Name (ARN) of the certiﬁcate.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: ^(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:certificate/[0-9a-z-]+)?$

API Version 2022-11-30

156
Amazon VPC Lattice API Reference
Response Syntax

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"authType": "string",
"certificateArn": "string",
"customDomainName": "string",
"id": "string",
"name": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 157)

The Amazon Resource Name (ARN) of the service.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}$
authType (p. 157)

The type of IAM policy.

Type: String

Valid Values: NONE | AWS_IAM

certiﬁcateArn (p. 157)

The Amazon Resource Name (ARN) of the certiﬁcate.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: ^(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:certificate/[0-9a-z-]+)?$
customDomainName (p. 157)

The custom domain name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

API Version 2022-11-30

157
Amazon VPC Lattice API Reference
Errors

id (p. 157)

The ID of the service.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^svc-[0-9a-z]{17}$
name (p. 157)

The name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: ^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

API Version 2022-11-30

158
Amazon VPC Lattice API Reference
See Also

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

159
Amazon VPC Lattice API Reference
UpdateServiceNetwork

UpdateServiceNetwork
Updates the speciﬁed service network.

Request Syntax
PATCH /servicenetworks/serviceNetworkIdentifier HTTP/1.1
Content-type: application/json

{
"authType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

serviceNetworkIdentiﬁer (p. 160)

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

Length Constraints: Minimum length of 3. Maximum length of 2048.

Pattern: ^((sn-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetwork/sn-[0-9a-z]{17}))$

Required: Yes

Request Body
The request accepts the following data in JSON format.

authType (p. 160)

The type of IAM policy.

• NONE: The resource does not use an IAM policy. This is the default.
• AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth
policy is required.

Type: String

Valid Values: NONE | AWS_IAM

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"authType": "string",
"id": "string",

API Version 2022-11-30

160
Amazon VPC Lattice API Reference
Response Elements

"name": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 160)

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-
[0-9a-z]{17}$
authType (p. 160)

The type of IAM policy.

Type: String

Valid Values: NONE | AWS_IAM

id (p. 160)

The ID of the service network.

Type: String

Length Constraints: Fixed length of 32.

Pattern: ^servicenetwork-[0-9a-z]{17}$
name (p. 160)

The name of the service network.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

API Version 2022-11-30

161
Amazon VPC Lattice API Reference
See Also

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

162
Amazon VPC Lattice API Reference
UpdateServiceNetworkVpcAssociation

UpdateServiceNetworkVpcAssociation
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 ﬁrst delete the
association and recreate it without security groups.

Request Syntax
PATCH /servicenetworkvpcassociations/serviceNetworkVpcAssociationIdentifier HTTP/1.1
Content-type: application/json

{
"securityGroupIds": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

serviceNetworkVpcAssociationIdentiﬁer (p. 163)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((snva-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkvpcassociation/snva-[0-9a-z]{17}))$

Required: Yes

Request Body
The request accepts the following data in JSON format.

securityGroupIds (p. 163)

The IDs of the security groups.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Minimum length of 5. Maximum length of 200.

Pattern: ^sg-(([0-9a-z]{8})|([0-9a-z]{17}))$

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

API Version 2022-11-30

163
Amazon VPC Lattice API Reference
Response Elements

{
"arn": "string",
"createdBy": "string",
"id": "string",
"securityGroupIds": [ "string" ],
"status": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 163)

The Amazon Resource Name (ARN) of the association.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkvpcassociation/snva-[0-9a-z]{17}$
createdBy (p. 163)

The account that created the association.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 12.

Pattern: ^[0-9]{12}$
id (p. 163)

The ID of the association.

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^snva-[0-9a-z]{17}$
securityGroupIds (p. 163)

The IDs of the security groups.

Type: Array of strings

Length Constraints: Minimum length of 5. Maximum length of 200.

Pattern: ^sg-(([0-9a-z]{8})|([0-9a-z]{17}))$
status (p. 163)

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

Type: String

Valid Values: CREATE_IN_PROGRESS | ACTIVE | UPDATE_IN_PROGRESS |

DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED | UPDATE_FAILED

API Version 2022-11-30

164
Amazon VPC Lattice API Reference
Errors

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

AccessDeniedException

The user does not have suﬃcient access to perform this action.

HTTP Status Code: 403

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

165
Amazon VPC Lattice API Reference
UpdateTargetGroup

UpdateTargetGroup
Updates the speciﬁed target group.

Request Syntax
PATCH /targetgroups/targetGroupIdentifier HTTP/1.1
Content-type: application/json

{
"healthCheck": {
"enabled": boolean,
"healthCheckIntervalSeconds": number,
"healthCheckTimeoutSeconds": number,
"healthyThresholdCount": number,
"matcher": { ... },
"path": "string",
"port": number,
"protocol": "string",
"protocolVersion": "string",
"unhealthyThresholdCount": number
}
}

URI Request Parameters

The request uses the following URI parameters.

targetGroupIdentiﬁer (p. 166)

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((tg-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:targetgroup/tg-[0-9a-z]{17}))$

Required: Yes

Request Body
The request accepts the following data in JSON format.

healthCheck (p. 166)

The health check conﬁguration.

Type: HealthCheckConﬁg (p. 178) object

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

API Version 2022-11-30

166
Amazon VPC Lattice API Reference
Response Elements

{
"arn": "string",
"config": {
"healthCheck": {
"enabled": boolean,
"healthCheckIntervalSeconds": number,
"healthCheckTimeoutSeconds": number,
"healthyThresholdCount": number,
"matcher": { ... },
"path": "string",
"port": number,
"protocol": "string",
"protocolVersion": "string",
"unhealthyThresholdCount": number
},
"ipAddressType": "string",
"port": number,
"protocol": "string",
"protocolVersion": "string",
"vpcIdentifier": "string"
},
"id": "string",
"name": "string",
"status": "string",
"type": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn (p. 166)

The Amazon Resource Name (ARN) of the target group.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:targetgroup/tg-
[0-9a-z]{17}$
conﬁg (p. 166)

The target group conﬁguration.

Type: TargetGroupConﬁg (p. 208) object

id (p. 166)

The ID of the target group.

Type: String

Length Constraints: Fixed length of 20.

Pattern: ^tg-[0-9a-z]{17}$
name (p. 166)

The name of the target group.

API Version 2022-11-30

167
Amazon VPC Lattice API Reference
Errors

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ^(?!tg-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
status (p. 166)

The status.

Type: String

Valid Values: CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED |

DELETE_FAILED
type (p. 166)

The target group type.

Type: String

Valid Values: IP | LAMBDA | INSTANCE | ALB

Errors
For information about the errors that are common to all actions, see Common Errors (p. 219).

ConﬂictException

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

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2022-11-30

168
Amazon VPC Lattice API Reference
See Also

• AWS SDK for .NET

• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

API Version 2022-11-30

169
Amazon VPC Lattice API Reference

Data Types
The Amazon VPC Lattice API contains several data types that various actions use. This section describes
each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not
assume a particular order.

The following data types are supported:

• AccessLogSubscriptionSummary (p. 171)

• DnsEntry (p. 173)
• FixedResponseAction (p. 174)
• ForwardAction (p. 175)
• HeaderMatch (p. 176)
• HeaderMatchType (p. 177)
• HealthCheckConﬁg (p. 178)
• HttpMatch (p. 181)
• ListenerSummary (p. 182)
• Matcher (p. 184)
• PathMatch (p. 185)
• PathMatchType (p. 186)
• RuleAction (p. 187)
• RuleMatch (p. 188)
• RuleSummary (p. 189)
• RuleUpdate (p. 191)
• RuleUpdateFailure (p. 193)
• RuleUpdateSuccess (p. 194)
• ServiceNetworkServiceAssociationSummary (p. 196)
• ServiceNetworkSummary (p. 199)
• ServiceNetworkVpcAssociationSummary (p. 201)
• ServiceSummary (p. 204)
• Target (p. 206)
• TargetFailure (p. 207)
• TargetGroupConﬁg (p. 208)
• TargetGroupSummary (p. 210)
• TargetSummary (p. 213)
• ValidationExceptionField (p. 215)
• WeightedTargetGroup (p. 216)

API Version 2022-11-30

170
Amazon VPC Lattice API Reference
AccessLogSubscriptionSummary

AccessLogSubscriptionSummary
Summary information about an access log subscription.

Contents
arn

The Amazon Resource Name (ARN) of the access log subscription

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:accesslogsubscription/als-[0-9a-z]{17}$

Required: Yes
createdAt

The date and time that the access log subscription was created, speciﬁed in ISO-8601 format.

Type: Timestamp

Required: Yes
destinationArn

The Amazon Resource Name (ARN) of the destination.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:([^/].*)?$

Required: Yes
id

The ID of the access log subscription.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^als-[0-9a-z]{17}$

Required: Yes
lastUpdatedAt

The date and time that the access log subscription was last updated, speciﬁed in ISO-8601 format.

Type: Timestamp

Required: Yes
resourceArn

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

API Version 2022-11-30

171
Amazon VPC Lattice API Reference
See Also

Type: String

Length Constraints: Minimum length of 20. Maximum length of 200.

Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?)
{2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}$

Required: Yes
resourceId

The ID of the service or service network.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 50.

Pattern: ^((sn)|(svc))-[0-9a-z]{17}$

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

172
Amazon VPC Lattice API Reference
DnsEntry

DnsEntry
Describes the DNS information of a service.

Contents
domainName

The domain name of the service.

Type: String

Required: No
hostedZoneId

The ID of the hosted zone.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

173
Amazon VPC Lattice API Reference
FixedResponseAction

FixedResponseAction
Information about an action that returns a custom HTTP response.

Contents
statusCode

The HTTP response code.

Type: Integer

Valid Range: Minimum value of 100. Maximum value of 599.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

174
Amazon VPC Lattice API Reference
ForwardAction

ForwardAction
Describes a forward action. You can use forward actions to route requests to one or more target groups.

Contents
targetGroups

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

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

Type: Array of WeightedTargetGroup (p. 216) objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

175
Amazon VPC Lattice API Reference
HeaderMatch

HeaderMatch
Describes the constraints for a header match. Matches incoming requests with rule based on request
header value before applying rule action.

Contents
match

The header match type.

Type: HeaderMatchType (p. 177) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.

Required: Yes
name

The name of the header.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes
caseSensitive

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

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

176
Amazon VPC Lattice API Reference
HeaderMatchType

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

Contents
Important
This data type is a UNION, so only one of the following members can be speciﬁed when used or
returned.

contains

Speciﬁes a contains type match.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No
exact

Speciﬁes an exact type match.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No
preﬁx

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

177
Amazon VPC Lattice API Reference
HealthCheckConﬁg

HealthCheckConfig
The health check configuration of a target group. Health check configurations aren't used for target
groups of type LAMBDA or ALB.

Contents
enabled

Indicates whether health checking is enabled.

Type: Boolean

Required: No
healthCheckIntervalSeconds

The approximate amount of time, in seconds, between health checks of an individual target. The
range is 5–300 seconds. The default is 30 seconds.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 300.

Required: No
healthCheckTimeoutSeconds

The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120
seconds. The default is 5 seconds.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 120.

Required: No
healthyThresholdCount

The number of consecutive successful health checks required before considering an unhealthy target
healthy. The range is 2–10. The default is 5.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 10.

Required: No
matcher

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

Type: Matcher (p. 184) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.

Required: No
path

The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2,
specify a valid URI (for example, /path?query). The default path is /. Health checks are not

API Version 2022-11-30

178
Amazon VPC Lattice API Reference
See Also

supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and
specify a valid URI.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: (^/[a-zA-Z0-9@:%_+.~#?&/=-]*$|(^$))

Required: No
port

The port used when performing health checks on targets. The default setting is the port that a
target receives traﬃc on.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 65535.

Required: No
protocol

The protocol used when performing health checks on targets. The possible protocols are HTTP and
HTTPS. The default is HTTP.

Type: String

Valid Values: HTTP | HTTPS

Required: No
protocolVersion

The protocol version used when performing health checks on targets. The possible protocol versions
are HTTP1 and HTTP2.

Type: String

Valid Values: HTTP1 | HTTP2

Required: No
unhealthyThresholdCount

The number of consecutive failed health checks required before considering a target unhealthy. The
range is 2–10. The default is 2.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 10.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2

API Version 2022-11-30

179
Amazon VPC Lattice API Reference
See Also

• AWS SDK for Ruby V3

API Version 2022-11-30

180
Amazon VPC Lattice API Reference
HttpMatch

HttpMatch
Describes criteria that can be applied to incoming requests.

Contents
headerMatches

The header matches. Matches incoming requests with rule based on request header value before
applying rule action.

Type: Array of HeaderMatch (p. 176) objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Required: No
method

The HTTP method type.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 16.

Required: No
pathMatch

The path match.

Type: PathMatch (p. 185) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

181
Amazon VPC Lattice API Reference
ListenerSummary

ListenerSummary
Summary information about a listener.

Contents
arn

The Amazon Resource Name (ARN) of the listener.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}/listener/listener-[0-9a-z]{17}$

Required: No
createdAt

The date and time that the listener was created, speciﬁed in ISO-8601 format.

Type: Timestamp

Required: No
id

The ID of the listener.

Type: String

Length Constraints: Fixed length of 26.

Pattern: ^listener-[0-9a-z]{17}$

Required: No
lastUpdatedAt

The date and time that the listener was last updated, speciﬁed in ISO-8601 format.

Type: Timestamp

Required: No
name

The name of the listener.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!listener-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Required: No
port

The listener port.

Type: Integer

API Version 2022-11-30

182
Amazon VPC Lattice API Reference
See Also

Valid Range: Minimum value of 1. Maximum value of 65535.

Required: No
protocol

The listener protocol.

Type: String

Valid Values: HTTP | HTTPS

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

183
Amazon VPC Lattice API Reference
Matcher

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

Contents
Important
This data type is a UNION, so only one of the following members can be speciﬁed when used or
returned.

httpCode

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2000.

Pattern: (^[0-9-,]+$|(^$))

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

184
Amazon VPC Lattice API Reference
PathMatch

PathMatch
Describes the conditions that can be applied when matching a path for incoming requests.

Contents
match

The type of path match.

Type: PathMatchType (p. 186) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.

Required: Yes
caseSensitive

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

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

185
Amazon VPC Lattice API Reference
PathMatchType

PathMatchType
Describes a path match type. Each rule can include only one of the following types of paths.

Contents
Important
This data type is a UNION, so only one of the following members can be speciﬁed when used or
returned.

exact

An exact match of the path.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^/[a-zA-Z0-9@:%_+.~#?&/=-]*$

Required: No
preﬁx

A preﬁx match of the path.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^/[a-zA-Z0-9@:%_+.~#?&/=-]*$

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

186
Amazon VPC Lattice API Reference
RuleAction

RuleAction
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.

Contents
Important
This data type is a UNION, so only one of the following members can be speciﬁed when used or
returned.

ﬁxedResponse

Describes the rule action that returns a custom HTTP response.

Type: FixedResponseAction (p. 174) object

Required: No
forward

The forward action. Traﬃc that matches the rule is forwarded to the speciﬁed target groups.

Type: ForwardAction (p. 175) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

187
Amazon VPC Lattice API Reference
RuleMatch

RuleMatch
Describes a rule match.

Contents
Important
This data type is a UNION, so only one of the following members can be speciﬁed when used or
returned.

httpMatch

The HTTP criteria that a rule must match.

Type: HttpMatch (p. 181) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

188
Amazon VPC Lattice API Reference
RuleSummary

RuleSummary
Summary information about the listener rule.

Contents
arn

The Amazon Resource Name (ARN) of the rule.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}/listener/listener-[0-9a-z]{17}/rule/rule-[0-9a-z]{17}$

Required: No
createdAt

The date and time that the listener rule was created, speciﬁed in ISO-8601 format.

Type: Timestamp

Required: No
id

The ID of the rule.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 22.

Pattern: ^rule-[0-9a-z]{17}$

Required: No
isDefault

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.

Type: Boolean

Required: No
lastUpdatedAt

The date and time that the listener rule was last updated, speciﬁed in ISO-8601 format.

Type: Timestamp

Required: No
name

The name of the rule.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

API Version 2022-11-30

189
Amazon VPC Lattice API Reference
See Also

Pattern: ^(?!rule-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Required: No
priority

The priority of the rule.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

190
Amazon VPC Lattice API Reference
RuleUpdate

RuleUpdate
Represents an object when updating a rule.

Contents
ruleIdentiﬁer

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((rule-[0-9a-z]{17})|(^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}/rule/rule-
[0-9a-z]{17}$))$

Required: Yes
action

The rule action.

Type: RuleAction (p. 187) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.

Required: No
match

The rule match.

Type: RuleMatch (p. 188) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.

Required: No
priority

The rule priority. A listener can't have multiple rules with the same priority.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

191
Amazon VPC Lattice API Reference
See Also

API Version 2022-11-30

192
Amazon VPC Lattice API Reference
RuleUpdateFailure

RuleUpdateFailure
Describes a rule update that failed.

Contents
failureCode

The failure code.

Type: String

Required: No
failureMessage

The failure message.

Type: String

Required: No
ruleIdentiﬁer

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((rule-[0-9a-z]{17})|(^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}/rule/rule-
[0-9a-z]{17}$))$

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

193
Amazon VPC Lattice API Reference
RuleUpdateSuccess

RuleUpdateSuccess
Describes a successful rule update.

Contents
action

The action for the default rule.

Type: RuleAction (p. 187) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.

Required: No
arn

The Amazon Resource Name (ARN) of the listener.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}/listener/listener-[0-9a-z]{17}/rule/rule-[0-9a-z]{17}$

Required: No
id

The ID of the listener.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 22.

Pattern: ^rule-[0-9a-z]{17}$

Required: No
isDefault

Indicates whether this is the default rule.

Type: Boolean

Required: No
match

The rule match.

Type: RuleMatch (p. 188) object

Note: This object is a Union. Only one member of this object can be speciﬁed or returned.

Required: No
name

The name of the listener.

Type: String

API Version 2022-11-30

194
Amazon VPC Lattice API Reference
See Also

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!rule-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Required: No
priority

The rule priority.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

195
Amazon VPC Lattice API Reference
ServiceNetworkServiceAssociationSummary

ServiceNetworkServiceAssociationSummary
Summary information about the association between a service network and a service.

Contents
arn

The Amazon Resource Name (ARN) of the association.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkserviceassociation/snsa-[0-9a-z]{17}$

Required: No
createdAt

The date and time that the association was created, speciﬁed in ISO-8601 format.

Type: Timestamp

Required: No
createdBy

The account that created the association.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 12.

Pattern: ^[0-9]{12}$

Required: No
customDomainName

The custom domain name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Required: No
dnsEntry

DNS information about the service.

Type: DnsEntry (p. 173) object

Required: No
id

The ID of the association.

Type: String

Length Constraints: Minimum length of 17. Maximum length of 2048.

API Version 2022-11-30

196
Amazon VPC Lattice API Reference
Contents

Pattern: ^((snsa-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkserviceassociation/snsa-[0-9a-z]{17}))$

Required: No
serviceArn

The Amazon Resource Name (ARN) of the service.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}$

Required: No
serviceId

The ID of the service.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^svc-[0-9a-z]{17}$

Required: No
serviceName

The name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: ^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Required: No
serviceNetworkArn

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-
[0-9a-z]{17}$

Required: No
serviceNetworkId

The ID of the service network.

Type: String

Length Constraints: Fixed length of 32.

Pattern: ^servicenetwork-[0-9a-z]{17}$

Required: No

API Version 2022-11-30

197
Amazon VPC Lattice API Reference
See Also

serviceNetworkName

The name of the service network.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Required: No
status

The status. If the deletion fails, try to delete again.

Type: String

Valid Values: CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED |

DELETE_FAILED

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

198
Amazon VPC Lattice API Reference
ServiceNetworkSummary

ServiceNetworkSummary
Summary information about a service network.

Contents
arn

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-
[0-9a-z]{17}$

Required: No
createdAt

The date and time that the service network was created, speciﬁed in ISO-8601 format.

Type: Timestamp

Required: No
id

The ID of the service network.

Type: String

Length Constraints: Fixed length of 32.

Pattern: ^servicenetwork-[0-9a-z]{17}$

Required: No
lastUpdatedAt

The date and time that the service network was last updated, speciﬁed in ISO-8601 format.

Type: Timestamp

Required: No
name

The name of the service network.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Required: No
numberOfAssociatedServices

The number of services associated with the service network.

Type: Long

API Version 2022-11-30

199
Amazon VPC Lattice API Reference
See Also

Required: No
numberOfAssociatedVPCs

The number of VPCs associated with the service network.

Type: Long

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

200
Amazon VPC Lattice API Reference
ServiceNetworkVpcAssociationSummary

ServiceNetworkVpcAssociationSummary
Summary information about an association between a service network and a VPC.

Contents
arn

The Amazon Resource Name (ARN) of the association.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:servicenetworkvpcassociation/snva-[0-9a-z]{17}$

Required: No
createdAt

The date and time that the association was created, speciﬁed in ISO-8601 format.

Type: Timestamp

Required: No
createdBy

The account that created the association.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 12.

Pattern: ^[0-9]{12}$

Required: No
id

The ID of the association.

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^snva-[0-9a-z]{17}$

Required: No
lastUpdatedAt

The date and time that the association was last updated, speciﬁed in ISO-8601 format.

Type: Timestamp

Required: No
serviceNetworkArn

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

Type: String

API Version 2022-11-30

201
Amazon VPC Lattice API Reference
See Also

Length Constraints: Minimum length of 32. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-
[0-9a-z]{17}$

Required: No
serviceNetworkId

The ID of the service network.

Type: String

Length Constraints: Fixed length of 32.

Pattern: ^servicenetwork-[0-9a-z]{17}$

Required: No
serviceNetworkName

The name of the service network.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Required: No
status

The status.

Type: String

Valid Values: CREATE_IN_PROGRESS | ACTIVE | UPDATE_IN_PROGRESS |

DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED | UPDATE_FAILED

Required: No
vpcId

The ID of the VPC.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 50.

Pattern: ^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

202
Amazon VPC Lattice API Reference
See Also

API Version 2022-11-30

203
Amazon VPC Lattice API Reference
ServiceSummary

ServiceSummary
Summary information about a service.

Contents
arn

The Amazon Resource Name (ARN) of the service.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}$

Required: No
createdAt

The date and time that the service was created, speciﬁed in ISO-8601 format.

Type: Timestamp

Required: No
customDomainName

The custom domain name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Required: No
dnsEntry

DNS information about the service.

Type: DnsEntry (p. 173) object

Required: No
id

The ID of the service.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^svc-[0-9a-z]{17}$

Required: No
lastUpdatedAt

The date and time that the service was last updated. The format is ISO-8601.

Type: Timestamp

Required: No

API Version 2022-11-30

204
Amazon VPC Lattice API Reference
See Also

name

The name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: ^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Required: No
status

The status.

Type: String

Valid Values: ACTIVE | CREATE_IN_PROGRESS | DELETE_IN_PROGRESS | CREATE_FAILED |

DELETE_FAILED

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

205
Amazon VPC Lattice API Reference
Target

Target
Describes a target.

Contents
id

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: Yes
port

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

206
Amazon VPC Lattice API Reference
TargetFailure

TargetFailure
Describes a target failure.

Contents
failureCode

The failure code.

Type: String

Required: No
failureMessage

The failure message.

Type: String

Required: No
id

Type: String

Required: No
port

The port on which the target is listening. This parameter doesn't apply if the target is a Lambda
function.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

207
Amazon VPC Lattice API Reference
TargetGroupConﬁg

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

Contents
port

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

Required: Yes
protocol

The protocol to use for routing traﬃc to the targets. Default is the protocol of a target group.

Type: String

Valid Values: HTTP | HTTPS

Required: Yes
vpcIdentiﬁer

The ID of the VPC.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 50.

Pattern: ^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$

Required: Yes
healthCheck

The health check conﬁguration.

Type: HealthCheckConﬁg (p. 178) object

Required: No
ipAddressType

The type of IP address used for the target group. The possible values are ipv4 and ipv6. This is an
optional parameter. If not speciﬁed, the default is ipv4.

Type: String

Valid Values: IPV4 | IPV6

Required: No
protocolVersion

The protocol version. Default value is HTTP1.

API Version 2022-11-30

208
Amazon VPC Lattice API Reference
See Also

Type: String

Valid Values: HTTP1 | HTTP2 | GRPC

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

209
Amazon VPC Lattice API Reference
TargetGroupSummary

TargetGroupSummary
Summary information about a target group.

Contents
arn

The ARN (Amazon Resource Name) of the target group.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:targetgroup/tg-
[0-9a-z]{17}$

Required: No
createdAt

The date and time that the target group was created, speciﬁed in ISO-8601 format.

Type: Timestamp

Required: No
id

The ID of the target group.

Type: String

Length Constraints: Fixed length of 20.

Pattern: ^tg-[0-9a-z]{17}$

Required: No
ipAddressType

The type of IP address used for the target group. The possible values are ipv4 and ipv6. This is an
optional parameter. If not speciﬁed, the default is ipv4.

Type: String

Valid Values: IPV4 | IPV6

Required: No
lastUpdatedAt

The date and time that the target group was last updated, speciﬁed in ISO-8601 format.

Type: Timestamp

Required: No
name

The name of the target group.

Type: String

API Version 2022-11-30

210
Amazon VPC Lattice API Reference
Contents

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ^(?!tg-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Required: No
port

The port of the target group.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

Required: No
protocol

The protocol of the target group.

Type: String

Valid Values: HTTP | HTTPS

Required: No
serviceArns

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

Type: Array of strings

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-
z]{17}$

Required: No
status

The status.

Type: String

Valid Values: CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED |

DELETE_FAILED

Required: No
type

The target group type.

Type: String

Valid Values: IP | LAMBDA | INSTANCE | ALB

Required: No
vpcIdentiﬁer

The ID of the VPC of the target group.

Type: String

API Version 2022-11-30

211
Amazon VPC Lattice API Reference
See Also

Length Constraints: Minimum length of 5. Maximum length of 50.

Pattern: ^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

212
Amazon VPC Lattice API Reference
TargetSummary

TargetSummary
Summary information about a target.

Contents
id

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.

Type: String

Required: No
port

The port on which the target is listening.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

Required: No
reasonCode

The code for why the target status is what it is.

Type: String

Required: No
status

The status of the target.

• Draining: The target is being deregistered. No new connections are sent to this target while
current connections are being drained. Default draining time is 5 minutes.
• Unavailable: Health checks are unavailable for the target group.
• Healthy: The target is healthy.
• Unhealthy: The target is unhealthy.
• Initial: Initial health checks on the target are being performed.
• Unused: Target group is not used in a service.

Type: String

Valid Values: DRAINING | UNAVAILABLE | HEALTHY | UNHEALTHY | INITIAL | UNUSED

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go

API Version 2022-11-30

213
Amazon VPC Lattice API Reference
See Also

• AWS SDK for Java V2

• AWS SDK for Ruby V3

API Version 2022-11-30

214
Amazon VPC Lattice API Reference
ValidationExceptionField

ValidationExceptionField
Describes a validation failure.

Contents
message

Additional details about why the validation failed.

Type: String

Required: Yes
name

The name of the validation exception.

Type: String

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

215
Amazon VPC Lattice API Reference
WeightedTargetGroup

WeightedTargetGroup
Describes the weight of a target group.

Contents
targetGroupIdentiﬁer

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

Type: String

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((tg-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:
\d{12}:targetgroup/tg-[0-9a-z]{17}))$

Required: Yes
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 group with a weight of 20
receives twice as many requests as the other target group. If there's only one target group speciﬁed,
then the default value is 100.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 999.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

API Version 2022-11-30

216
Amazon VPC Lattice API Reference

Common Parameters
The following list contains the parameters that all actions use for signing Signature Version 4 requests
with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more
information about Signature Version 4, see Signing AWS API requests in the IAM User Guide.

Action

The action to be performed.

Type: string

Required: Yes
Version

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: Yes
X-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query string
instead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: Conditional
X-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region you
are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is
expressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.

For more information, see Create a signed AWS API request in the IAM User Guide.

Condition: Specify this parameter when you include authentication information in a query string
instead of in the HTTP authorization header.

Type: string

Required: Conditional
X-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format
(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:
20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for
signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not
required. When X-Amz-Date is used, it always overrides the value of the Date header. For more
information, see Elements of an AWS API request signature in the IAM User Guide.

API Version 2022-11-30

217
Amazon VPC Lattice API Reference

Type: string

Required: Conditional
X-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWS
STS). For a list of services that support temporary security credentials from AWS STS, see AWS
services that work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from AWS STS, you must include the
security token.

Type: string

Required: Conditional
X-Amz-Signature

Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived
signing key.

Condition: Specify this parameter when you include authentication information in a query string
instead of in the HTTP authorization header.

Type: string

Required: Conditional
X-Amz-SignedHeaders

Speciﬁes all the HTTP headers that were included as part of the canonical request. For more
information about specifying signed headers, see Create a signed AWS API request in the IAM User
Guide.

Condition: Specify this parameter when you include authentication information in a query string
instead of in the HTTP authorization header.

Type: string

Required: Conditional

API Version 2022-11-30

218
Amazon VPC Lattice API Reference

Common Errors
This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API
action for this service, see the topic for that API action.

AccessDeniedException

You do not have suﬃcient access to perform this action.

HTTP Status Code: 403

ExpiredTokenException

The security token included in the request is expired

HTTP Status Code: 403

IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 403

InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

MalformedHttpRequestException

Problems with the request at the HTTP level, e.g. we can't decompress the body according to the
decompression algorithm speciﬁed by the content-encoding.

HTTP Status Code: 400

NotAuthorized

You do not have permission to perform this action.

HTTP Status Code: 401

OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403

RequestAbortedException

Convenient exception that can be used when a request is aborted before a reply is sent back (e.g.
client closed connection).

HTTP Status Code: 400

RequestEntityTooLargeException

Problems with the request at the HTTP level. The request entity is too large.

HTTP Status Code: 413

API Version 2022-11-30

219
Amazon VPC Lattice API Reference

RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or more
than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp
on the request is more than 15 minutes in the future.

HTTP Status Code: 400

RequestTimeoutException

Problems with the request at the HTTP level. Reading the Request timed out.

HTTP Status Code: 408

ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

UnrecognizedClientException

The X.509 certiﬁcate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403

UnknownOperationException

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 404

ValidationError

The input fails to satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

API Version 2022-11-30

220

VPC Lattice API
No ratings yet
VPC Lattice API
426 pages
Networkadvisor 1401 Rest API
No ratings yet
Networkadvisor 1401 Rest API
200 pages
Ec2 Api
No ratings yet
Ec2 Api
955 pages
Brocade API
No ratings yet
Brocade API
190 pages
Aws Iot Analytics API
No ratings yet
Aws Iot Analytics API
185 pages
TN - iVantageAPI - T0001403 - 31 - Oct - 2023 Rev3
No ratings yet
TN - iVantageAPI - T0001403 - 31 - Oct - 2023 Rev3
225 pages
Deploying NGINX As An API Gateway PDF
No ratings yet
Deploying NGINX As An API Gateway PDF
50 pages
TN iVantageAPI T0000960 RevC 12 11 18
No ratings yet
TN iVantageAPI T0000960 RevC 12 11 18
176 pages
IICS Spring2018April REST-APIReference en
No ratings yet
IICS Spring2018April REST-APIReference en
205 pages
CloudAPIGuide BusinessFlows
No ratings yet
CloudAPIGuide BusinessFlows
172 pages
API Management
100% (1)
API Management
568 pages
PizzaShack API Guide for Developers
No ratings yet
PizzaShack API Guide for Developers
9 pages
The NGINX Real-Time API Handbook
No ratings yet
The NGINX Real-Time API Handbook
26 pages
Best Practices For Enterprise APIs 61378 GB 54014 EnUS
No ratings yet
Best Practices For Enterprise APIs 61378 GB 54014 EnUS
42 pages
Describe Characteristics of REST
No ratings yet
Describe Characteristics of REST
12 pages
NS HTTP Api FS
No ratings yet
NS HTTP Api FS
32 pages
Express
100% (4)
Express
141 pages
B360 July2023 Business360 (REST-API) Reference en
No ratings yet
B360 July2023 Business360 (REST-API) Reference en
83 pages
Aws PDF
No ratings yet
Aws PDF
356 pages
EBOOK API Strategy Best Practices Platform Engineering Leaders
No ratings yet
EBOOK API Strategy Best Practices Platform Engineering Leaders
57 pages
SAP API Management
100% (1)
SAP API Management
690 pages
ONMSi Fiber Analytics User Manual Rev000 202302
No ratings yet
ONMSi Fiber Analytics User Manual Rev000 202302
74 pages
IMaster MAE-Access V100R021C10 Open API Developer Guide (Wireless Network)
No ratings yet
IMaster MAE-Access V100R021C10 Open API Developer Guide (Wireless Network)
91 pages
API Management
No ratings yet
API Management
848 pages
Draft Ietf Gnap Core Protocol 09
No ratings yet
Draft Ietf Gnap Core Protocol 09
192 pages
Websphere ESB
No ratings yet
Websphere ESB
550 pages
NET215 - NEW LAUNCH! Introducing Amazon VPC Lattice Simplifying Application Networking
No ratings yet
NET215 - NEW LAUNCH! Introducing Amazon VPC Lattice Simplifying Application Networking
67 pages
Master Thesis
No ratings yet
Master Thesis
70 pages
Ocelot 1.0.0 Documentation Guide
No ratings yet
Ocelot 1.0.0 Documentation Guide
104 pages
IC Spring2017 DeveloperGuide en
No ratings yet
IC Spring2017 DeveloperGuide en
201 pages
API Manager 170 PDF
No ratings yet
API Manager 170 PDF
318 pages
Coap Spec PDF
No ratings yet
Coap Spec PDF
112 pages
Layer 7 Api Management For Aws
No ratings yet
Layer 7 Api Management For Aws
2 pages
After Mid Unit 3
No ratings yet
After Mid Unit 3
76 pages
Metric Store Docs
No ratings yet
Metric Store Docs
18 pages
9.2.4.6 7 (API) S (SDK) SAndServices en
No ratings yet
9.2.4.6 7 (API) S (SDK) SAndServices en
162 pages
Apigateway DG
No ratings yet
Apigateway DG
842 pages
OCPI 2.1.1-d2
No ratings yet
OCPI 2.1.1-d2
76 pages
APIDesignAndFundamentals M2 APIFirstAndOpenAPISpecifications
No ratings yet
APIDesignAndFundamentals M2 APIFirstAndOpenAPISpecifications
37 pages
Sforce API Reference Manual
No ratings yet
Sforce API Reference Manual
138 pages
Hik-Partner Pro API Dev Guide
No ratings yet
Hik-Partner Pro API Dev Guide
222 pages
Draft Ietf Httpbis Http2 17
No ratings yet
Draft Ietf Httpbis Http2 17
92 pages
TCM Noobs 23 Web Architecture Basics API
No ratings yet
TCM Noobs 23 Web Architecture Basics API
58 pages
Huawei Usg6000 Series & NGFW Module v100r001c30spc300 Restful API Developer Guideuide
No ratings yet
Huawei Usg6000 Series & NGFW Module v100r001c30spc300 Restful API Developer Guideuide
200 pages
Apache CloudStack 4.0.0 Incubating API Developers Guide en US
No ratings yet
Apache CloudStack 4.0.0 Incubating API Developers Guide en US
44 pages
12fa Docker Golang Sample
No ratings yet
12fa Docker Golang Sample
29 pages
sip:provider CE Handbook Guide
No ratings yet
sip:provider CE Handbook Guide
197 pages
Cloud Computing - Theory and Practice (2019)
No ratings yet
Cloud Computing - Theory and Practice (2019)
255 pages
UD36994B - Hik-Partner Pro OpenAPI - Developer Guide - V2.0 - 20240315
No ratings yet
UD36994B - Hik-Partner Pro OpenAPI - Developer Guide - V2.0 - 20240315
234 pages
04 Building RESTful Services
No ratings yet
04 Building RESTful Services
78 pages
Microservices For Java Developers
No ratings yet
Microservices For Java Developers
160 pages
Codepipeline API
No ratings yet
Codepipeline API
353 pages
TIB BW 6.7 Refactoring Best Practices
No ratings yet
TIB BW 6.7 Refactoring Best Practices
88 pages
SOLIDserver API Reference Guide 5.0.4
No ratings yet
SOLIDserver API Reference Guide 5.0.4
778 pages
Amazon API Gateway
0% (1)
Amazon API Gateway
307 pages
Azure & Graph API Design Guide
No ratings yet
Azure & Graph API Design Guide
60 pages
Unit - 3
No ratings yet
Unit - 3
51 pages
NHBF Newsletter 24 April 2025
No ratings yet
NHBF Newsletter 24 April 2025
14 pages
NHAI Date Wise Policy Circulars
0% (2)
NHAI Date Wise Policy Circulars
137 pages
IRC SP 99-2013 Manual For Expressways PDF
80% (10)
IRC SP 99-2013 Manual For Expressways PDF
160 pages
Creating A S3 Buckets, Managing Objects, and Enabling Versioning
No ratings yet
Creating A S3 Buckets, Managing Objects, and Enabling Versioning
2 pages
Practitioner 1
100% (1)
Practitioner 1
74 pages
Conversion Factor
No ratings yet
Conversion Factor
33 pages
SOR Gov of Guj 2015-16 NH
0% (1)
SOR Gov of Guj 2015-16 NH
164 pages
5 Internet and Web
No ratings yet
5 Internet and Web
30 pages
Bloque4 - Az 400t00a Enu Trainerhandbook PDF Free
No ratings yet
Bloque4 - Az 400t00a Enu Trainerhandbook PDF Free
200 pages
API End - EndNotes V1.0
No ratings yet
API End - EndNotes V1.0
27 pages
Module1 - Web Programming Fundamentals
No ratings yet
Module1 - Web Programming Fundamentals
33 pages
Create Item Page in Oaf
No ratings yet
Create Item Page in Oaf
13 pages
RESTful API Design with Node.js
No ratings yet
RESTful API Design with Node.js
16 pages
REST and Web Services: in Theory and in Practice: Paul Adamczyk, Patrick H. Smith, Ralph E. Johnson, and Munawar Hafiz
No ratings yet
REST and Web Services: in Theory and in Practice: Paul Adamczyk, Patrick H. Smith, Ralph E. Johnson, and Munawar Hafiz
24 pages
Network Software Architecture Styles
No ratings yet
Network Software Architecture Styles
10 pages
Sap All 3.0 - Object Spy
No ratings yet
Sap All 3.0 - Object Spy
27 pages
Web Development MODULE 1
No ratings yet
Web Development MODULE 1
113 pages
b2mml v0401 Common
No ratings yet
b2mml v0401 Common
35 pages
Oracle Communications Cloud Native Core Policy User's Guide
No ratings yet
Oracle Communications Cloud Native Core Policy User's Guide
131 pages
Application Fundamentals - Android Developers
No ratings yet
Application Fundamentals - Android Developers
14 pages
Security Testing Tutorial
No ratings yet
Security Testing Tutorial
133 pages
An in Depth Guide To Mod - Rewrite For Apache
No ratings yet
An in Depth Guide To Mod - Rewrite For Apache
22 pages
Redfish Firmware Update White Paper
No ratings yet
Redfish Firmware Update White Paper
28 pages
Cs6501 Ip 2marks 16 Marks
No ratings yet
Cs6501 Ip 2marks 16 Marks
28 pages
SDG-UAEPASS SP Authentication Integration OAuth Version 1.0
50% (2)
SDG-UAEPASS SP Authentication Integration OAuth Version 1.0
23 pages
Lesson 1 Intro To Web Programming
No ratings yet
Lesson 1 Intro To Web Programming
35 pages
R2000 Ethernet Communication Protocol
No ratings yet
R2000 Ethernet Communication Protocol
74 pages
T3IRFX1 Architecture Overview 201809
No ratings yet
T3IRFX1 Architecture Overview 201809
29 pages
Einv Sandbox v1.7
No ratings yet
Einv Sandbox v1.7
54 pages
Controllers - Laravel 12.x - The PHP Framework For Web Artisans
No ratings yet
Controllers - Laravel 12.x - The PHP Framework For Web Artisans
21 pages
RESTful Web API Design
100% (5)
RESTful Web API Design
61 pages
GATE Exam: Web Tech MCQs
No ratings yet
GATE Exam: Web Tech MCQs
3 pages
Database Administration Insights
No ratings yet
Database Administration Insights
4 pages
Chapter 01 - Introduction To Web Applications
No ratings yet
Chapter 01 - Introduction To Web Applications
35 pages
The Multitarget Application Model
No ratings yet
The Multitarget Application Model
30 pages
Network-Programming in Java
No ratings yet
Network-Programming in Java
36 pages
YXC API Spec Advanced Rev1.0
No ratings yet
YXC API Spec Advanced Rev1.0
21 pages

VPC Lattice API

Uploaded by

VPC Lattice API

Uploaded by

Amazon VPC Lattice

Amazon VPC Lattice: API Reference

API Version 2022-11-30

Response Syntax .............................................................................................................. 31

API Version 2022-11-30

Response Elements ........................................................................................................... 52

API Version 2022-11-30

API Version 2022-11-30

See Also .......................................................................................................................... 97

API Version 2022-11-30

ListServiceNetworkVpcAssociations ........................................................................................... 120

API Version 2022-11-30

Request Syntax .............................................................................................................. 138

API Version 2022-11-30

URI Request Parameters .................................................................................................. 160

API Version 2022-11-30

Contents ........................................................................................................................ 186

API Version 2022-11-30

This document was last published on August 24, 2023.

API Version 2022-11-30

API Version 2022-11-30

• PutAuthPolicy (p. 133)

API Version 2022-11-30

Required permissions: vpc-lattice:UpdateRule

URI Request Parameters

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

Length Constraints: Minimum length of 20. Maximum length of 2048.

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

Length Constraints: Minimum length of 17. Maximum length of 2048.

API Version 2022-11-30

The rules for the speciﬁed listener.

Type: Array of RuleUpdate (p. 191) objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

The following data is returned in JSON format by the service.

The rules that were successfully updated.

Type: Array of RuleUpdateSuccess (p. 194) objects

The rules that the operation couldn't update.

Type: Array of RuleUpdateFailure (p. 193) objects

API Version 2022-11-30

HTTP Status Code: 403

HTTP Status Code: 409

An unexpected error occurred while processing the request.

HTTP Status Code: 500

The request references a resource that does not exist.

HTTP Status Code: 404

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

HTTP Status Code: 429

HTTP Status Code: 400

• AWS Command Line Interface

API Version 2022-11-30

URI Request Parameters

Length Constraints: Minimum length of 1. Maximum length of 64.

Length Constraints: Minimum length of 20. Maximum length of 2048.

API Version 2022-11-30

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

Length Constraints: Minimum length of 17. Maximum length of 200.

The tags for the access log subscription.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

The following data is returned in JSON format by the service.

The Amazon Resource Name (ARN) of the access log subscription.

Length Constraints: Minimum length of 20. Maximum length of 2048.

The Amazon Resource Name (ARN) of the log destination.

API Version 2022-11-30

Length Constraints: Minimum length of 20. Maximum length of 2048.

The ID of the access log subscription.

Length Constraints: Fixed length of 21.

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

Length Constraints: Minimum length of 20. Maximum length of 200.

The ID of the service network or service.

Length Constraints: Minimum length of 20. Maximum length of 50.

HTTP Status Code: 403

HTTP Status Code: 409

An unexpected error occurred while processing the request.