1{
2  "version":"2.0",
3  "metadata":{
4    "apiVersion":"2023-11-26",
5    "endpointPrefix":"eks-auth",
6    "jsonVersion":"1.1",
7    "protocol":"rest-json",
8    "serviceFullName":"Amazon EKS Auth",
9    "serviceId":"EKS Auth",
10    "signatureVersion":"v4",
11    "signingName":"eks-auth",
12    "uid":"eks-auth-2023-11-26"
13  },
14  "operations":{
15    "AssumeRoleForPodIdentity":{
16      "name":"AssumeRoleForPodIdentity",
17      "http":{
18        "method":"POST",
19        "requestUri":"/clusters/{clusterName}/assume-role-for-pod-identity",
20        "responseCode":200
21      },
22      "input":{"shape":"AssumeRoleForPodIdentityRequest"},
23      "output":{"shape":"AssumeRoleForPodIdentityResponse"},
24      "errors":[
25        {"shape":"ThrottlingException"},
26        {"shape":"InvalidRequestException"},
27        {"shape":"AccessDeniedException"},
28        {"shape":"InternalServerException"},
29        {"shape":"InvalidTokenException"},
30        {"shape":"InvalidParameterException"},
31        {"shape":"ExpiredTokenException"},
32        {"shape":"ResourceNotFoundException"},
33        {"shape":"ServiceUnavailableException"}
34      ],
35      "documentation":"<p>The Amazon EKS Auth API and the <code>AssumeRoleForPodIdentity</code> action are only used by the EKS Pod Identity Agent.</p> <p>We recommend that applications use the Amazon Web Services SDKs to connect to Amazon Web Services services; if credentials from an EKS Pod Identity association are available in the pod, the latest versions of the SDKs use them automatically.</p>"
36    }
37  },
38  "shapes":{
39    "AccessDeniedException":{
40      "type":"structure",
41      "members":{
42        "message":{"shape":"String"}
43      },
44      "documentation":"<p>You don't have permissions to perform the requested operation. The IAM principal making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html\">Access management</a> in the <i>IAM User Guide</i>. </p>",
45      "error":{
46        "httpStatusCode":400,
47        "senderFault":true
48      },
49      "exception":true
50    },
51    "AssumeRoleForPodIdentityRequest":{
52      "type":"structure",
53      "required":[
54        "clusterName",
55        "token"
56      ],
57      "members":{
58        "clusterName":{
59          "shape":"ClusterName",
60          "documentation":"<p>The name of the cluster for the request.</p>",
61          "location":"uri",
62          "locationName":"clusterName"
63        },
64        "token":{
65          "shape":"JwtToken",
66          "documentation":"<p>The token of the Kubernetes service account for the pod.</p>"
67        }
68      }
69    },
70    "AssumeRoleForPodIdentityResponse":{
71      "type":"structure",
72      "required":[
73        "subject",
74        "audience",
75        "podIdentityAssociation",
76        "assumedRoleUser",
77        "credentials"
78      ],
79      "members":{
80        "subject":{
81          "shape":"Subject",
82          "documentation":"<p>The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.</p>"
83        },
84        "audience":{
85          "shape":"String",
86          "documentation":"<p>The identity that is allowed to use the credentials. This value is always <code>pods.eks.amazonaws.com</code>.</p>"
87        },
88        "podIdentityAssociation":{
89          "shape":"PodIdentityAssociation",
90          "documentation":"<p>The Amazon Resource Name (ARN) and ID of the EKS Pod Identity association.</p>"
91        },
92        "assumedRoleUser":{
93          "shape":"AssumedRoleUser",
94          "documentation":"<p>An object with the permanent IAM role identity and the temporary session name.</p> <p>The ARN of the IAM role that the temporary credentials authenticate to.</p> <p>The session name of the temporary session requested to STS. The value is a unique identifier that contains the role ID, a colon (<code>:</code>), and the role session name of the role that is being assumed. The role ID is generated by IAM when the role is created. The role session name part of the value follows this format: <code>eks-<i>clustername</i>-<i>podname</i>-<i>random UUID</i> </code> </p>"
95        },
96        "credentials":{
97          "shape":"Credentials",
98          "documentation":"<p>The <i>Amazon Web Services Signature Version 4</i> type of temporary credentials.</p>"
99        }
100      }
101    },
102    "AssumedRoleUser":{
103      "type":"structure",
104      "required":[
105        "arn",
106        "assumeRoleId"
107      ],
108      "members":{
109        "arn":{
110          "shape":"String",
111          "documentation":"<p>The ARN of the IAM role that the temporary credentials authenticate to.</p>"
112        },
113        "assumeRoleId":{
114          "shape":"String",
115          "documentation":"<p>The session name of the temporary session requested to STS. The value is a unique identifier that contains the role ID, a colon (<code>:</code>), and the role session name of the role that is being assumed. The role ID is generated by IAM when the role is created. The role session name part of the value follows this format: <code>eks-<i>clustername</i>-<i>podname</i>-<i>random UUID</i> </code> </p>"
116        }
117      },
118      "documentation":"<p>An object with the permanent IAM role identity and the temporary session name.</p>"
119    },
120    "ClusterName":{
121      "type":"string",
122      "max":100,
123      "min":1,
124      "pattern":"[0-9A-Za-z][A-Za-z0-9\\-_]*"
125    },
126    "Credentials":{
127      "type":"structure",
128      "required":[
129        "sessionToken",
130        "secretAccessKey",
131        "accessKeyId",
132        "expiration"
133      ],
134      "members":{
135        "sessionToken":{
136          "shape":"String",
137          "documentation":"<p>The token that applications inside the pods must pass to any service API to use the temporary credentials.</p>"
138        },
139        "secretAccessKey":{
140          "shape":"String",
141          "documentation":"<p>The secret access key that applications inside the pods use to sign requests.</p>"
142        },
143        "accessKeyId":{
144          "shape":"String",
145          "documentation":"<p>The access key ID that identifies the temporary security credentials.</p>"
146        },
147        "expiration":{
148          "shape":"Timestamp",
149          "documentation":"<p>The Unix epoch timestamp in seconds when the current credentials expire.</p>"
150        }
151      },
152      "documentation":"<p>The <i>Amazon Web Services Signature Version 4</i> type of temporary credentials.</p>",
153      "sensitive":true
154    },
155    "ExpiredTokenException":{
156      "type":"structure",
157      "members":{
158        "message":{"shape":"String"}
159      },
160      "documentation":"<p>The specified Kubernetes service account token is expired.</p>",
161      "error":{
162        "httpStatusCode":400,
163        "senderFault":true
164      },
165      "exception":true
166    },
167    "InternalServerException":{
168      "type":"structure",
169      "members":{
170        "message":{"shape":"String"}
171      },
172      "documentation":"<p>These errors are usually caused by a server-side issue.</p>",
173      "error":{"httpStatusCode":500},
174      "exception":true,
175      "fault":true
176    },
177    "InvalidParameterException":{
178      "type":"structure",
179      "members":{
180        "message":{"shape":"String"}
181      },
182      "documentation":"<p>The specified parameter is invalid. Review the available parameters for the API request.</p>",
183      "error":{
184        "httpStatusCode":400,
185        "senderFault":true
186      },
187      "exception":true
188    },
189    "InvalidRequestException":{
190      "type":"structure",
191      "members":{
192        "message":{"shape":"String"}
193      },
194      "documentation":"<p>This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.</p>",
195      "error":{
196        "httpStatusCode":400,
197        "senderFault":true
198      },
199      "exception":true
200    },
201    "InvalidTokenException":{
202      "type":"structure",
203      "members":{
204        "message":{"shape":"String"}
205      },
206      "documentation":"<p>The specified Kubernetes service account token is invalid.</p>",
207      "error":{
208        "httpStatusCode":400,
209        "senderFault":true
210      },
211      "exception":true
212    },
213    "JwtToken":{
214      "type":"string",
215      "min":1,
216      "pattern":"[A-Za-z0-9-_=]+\\.[A-Za-z0-9-_=]+\\.[A-Za-z0-9-_=]+",
217      "sensitive":true
218    },
219    "PodIdentityAssociation":{
220      "type":"structure",
221      "required":[
222        "associationArn",
223        "associationId"
224      ],
225      "members":{
226        "associationArn":{
227          "shape":"String",
228          "documentation":"<p>The Amazon Resource Name (ARN) of the EKS Pod Identity association.</p>"
229        },
230        "associationId":{
231          "shape":"String",
232          "documentation":"<p>The ID of the association.</p>"
233        }
234      },
235      "documentation":"<p>Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.</p>"
236    },
237    "ResourceNotFoundException":{
238      "type":"structure",
239      "members":{
240        "message":{"shape":"String"}
241      },
242      "documentation":"<p>The specified resource could not be found.</p>",
243      "error":{
244        "httpStatusCode":404,
245        "senderFault":true
246      },
247      "exception":true
248    },
249    "ServiceUnavailableException":{
250      "type":"structure",
251      "members":{
252        "message":{"shape":"String"}
253      },
254      "documentation":"<p>The service is unavailable. Back off and retry the operation.</p>",
255      "error":{"httpStatusCode":503},
256      "exception":true,
257      "fault":true
258    },
259    "String":{"type":"string"},
260    "Subject":{
261      "type":"structure",
262      "required":[
263        "namespace",
264        "serviceAccount"
265      ],
266      "members":{
267        "namespace":{
268          "shape":"String",
269          "documentation":"<p>The name of the Kubernetes namespace inside the cluster to create the association in. The service account and the pods that use the service account must be in this namespace.</p>"
270        },
271        "serviceAccount":{
272          "shape":"String",
273          "documentation":"<p>The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.</p>"
274        }
275      },
276      "documentation":"<p>An object containing the name of the Kubernetes service account inside the cluster to associate the IAM credentials with.</p>"
277    },
278    "ThrottlingException":{
279      "type":"structure",
280      "members":{
281        "message":{"shape":"String"}
282      },
283      "documentation":"<p>The request was denied because your request rate is too high. Reduce the frequency of requests.</p>",
284      "error":{
285        "httpStatusCode":429,
286        "senderFault":true
287      },
288      "exception":true
289    },
290    "Timestamp":{"type":"timestamp"}
291  },
292  "documentation":"<p>The Amazon EKS Auth API and the <code>AssumeRoleForPodIdentity</code> action are only used by the EKS Pod Identity Agent.</p>"
293}
294