Skip to content

Commit 88ddac3

Browse files
author
AWS
committed
AWS Single Sign-On Update: Documentation updates to reflect service rename - AWS IAM Identity Center (successor to AWS Single Sign-On)
1 parent f3265c6 commit 88ddac3

File tree

2 files changed

+24
-18
lines changed

2 files changed

+24
-18
lines changed

‎.changes/next-release/feature-AWSSingleSignOn-e322840.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Single Sign-On",
4+
"contributor": "",
5+
"description": "Documentation updates to reflect service rename - AWS IAM Identity Center (successor to AWS Single Sign-On)"
6+
}

‎services/sso/src/main/resources/codegen-resources/service-2.json

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
{"shape":"TooManyRequestsException"},
4545
{"shape":"ResourceNotFoundException"}
4646
],
47-
"documentation":"<p>Lists all roles that are assigned to the user for a given AWS account.</p>",
47+
"documentation":"<p>Lists all roles that are assigned to the user for a given Amazon Web Services account.</p>",
4848
"authtype":"none"
4949
},
5050
"ListAccounts":{
@@ -61,7 +61,7 @@
6161
{"shape":"TooManyRequestsException"},
6262
{"shape":"ResourceNotFoundException"}
6363
],
64-
"documentation":"<p>Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the administrator of the account. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/useraccess.html#assignusers\">Assign User Access</a> in the <i>AWS SSO User Guide</i>. This operation returns a paginated response.</p>",
64+
"documentation":"<p>Lists all Amazon Web Services accounts assigned to the user. These Amazon Web Services accounts are assigned by the administrator of the account. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/useraccess.html#assignusers\">Assign User Access</a> in the <i>Amazon Web Services SSO User Guide</i>. This operation returns a paginated response.</p>",
6565
"authtype":"none"
6666
},
6767
"Logout":{
@@ -76,7 +76,7 @@
7676
{"shape":"UnauthorizedException"},
7777
{"shape":"TooManyRequestsException"}
7878
],
79-
"documentation":"<p>Removes the client- and server-side session that is associated with the user.</p>",
79+
"documentation":"<p>Removes the locally stored SSO tokens from the client-side cache and sends an API call to the Amazon Web Services SSO service to invalidate the corresponding server-side Amazon Web Services SSO sign in session.</p> <note> <p>If a user uses Amazon Web Services SSO to access the AWS CLI, the user’s Amazon Web Services SSO sign in session is used to obtain an IAM session, as specified in the corresponding Amazon Web Services SSO permission set. More specifically, Amazon Web Services SSO assumes an IAM role in the target account on behalf of the user, and the corresponding temporary Amazon Web Services credentials are returned to the client.</p> <p>After user logout, any existing IAM role sessions that were created by using Amazon Web Services SSO permission sets continue based on the duration configured in the permission set. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/authconcept.html\">User authentications</a> in the <i>Amazon Web Services SSO User Guide</i>.</p> </note>",
8080
"authtype":"none"
8181
}
8282
},
@@ -92,18 +92,18 @@
9292
"members":{
9393
"accountId":{
9494
"shape":"AccountIdType",
95-
"documentation":"<p>The identifier of the AWS account that is assigned to the user.</p>"
95+
"documentation":"<p>The identifier of the Amazon Web Services account that is assigned to the user.</p>"
9696
},
9797
"accountName":{
9898
"shape":"AccountNameType",
99-
"documentation":"<p>The display name of the AWS account that is assigned to the user.</p>"
99+
"documentation":"<p>The display name of the Amazon Web Services account that is assigned to the user.</p>"
100100
},
101101
"emailAddress":{
102102
"shape":"EmailAddressType",
103-
"documentation":"<p>The email address of the AWS account that is assigned to the user.</p>"
103+
"documentation":"<p>The email address of the Amazon Web Services account that is assigned to the user.</p>"
104104
}
105105
},
106-
"documentation":"<p>Provides information about your AWS account.</p>"
106+
"documentation":"<p>Provides information about your Amazon Web Services account.</p>"
107107
},
108108
"AccountListType":{
109109
"type":"list",
@@ -133,13 +133,13 @@
133133
},
134134
"accountId":{
135135
"shape":"AccountIdType",
136-
"documentation":"<p>The identifier for the AWS account that is assigned to the user.</p>",
136+
"documentation":"<p>The identifier for the Amazon Web Services account that is assigned to the user.</p>",
137137
"location":"querystring",
138138
"locationName":"account_id"
139139
},
140140
"accessToken":{
141141
"shape":"AccessTokenType",
142-
"documentation":"<p>The token issued by the <code>CreateToken</code> API call. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html\">CreateToken</a> in the <i>AWS SSO OIDC API Reference Guide</i>.</p>",
142+
"documentation":"<p>The token issued by the <code>CreateToken</code> API call. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html\">CreateToken</a> in the <i>Amazon Web Services SSO OIDC API Reference Guide</i>.</p>",
143143
"location":"header",
144144
"locationName":"x-amz-sso_bearer_token"
145145
}
@@ -184,13 +184,13 @@
184184
},
185185
"accessToken":{
186186
"shape":"AccessTokenType",
187-
"documentation":"<p>The token issued by the <code>CreateToken</code> API call. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html\">CreateToken</a> in the <i>AWS SSO OIDC API Reference Guide</i>.</p>",
187+
"documentation":"<p>The token issued by the <code>CreateToken</code> API call. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html\">CreateToken</a> in the <i>Amazon Web Services SSO OIDC API Reference Guide</i>.</p>",
188188
"location":"header",
189189
"locationName":"x-amz-sso_bearer_token"
190190
},
191191
"accountId":{
192192
"shape":"AccountIdType",
193-
"documentation":"<p>The identifier for the AWS account that is assigned to the user.</p>",
193+
"documentation":"<p>The identifier for the Amazon Web Services account that is assigned to the user.</p>",
194194
"location":"querystring",
195195
"locationName":"account_id"
196196
}
@@ -227,7 +227,7 @@
227227
},
228228
"accessToken":{
229229
"shape":"AccessTokenType",
230-
"documentation":"<p>The token issued by the <code>CreateToken</code> API call. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html\">CreateToken</a> in the <i>AWS SSO OIDC API Reference Guide</i>.</p>",
230+
"documentation":"<p>The token issued by the <code>CreateToken</code> API call. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html\">CreateToken</a> in the <i>Amazon Web Services SSO OIDC API Reference Guide</i>.</p>",
231231
"location":"header",
232232
"locationName":"x-amz-sso_bearer_token"
233233
}
@@ -252,7 +252,7 @@
252252
"members":{
253253
"accessToken":{
254254
"shape":"AccessTokenType",
255-
"documentation":"<p>The token issued by the <code>CreateToken</code> API call. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html\">CreateToken</a> in the <i>AWS SSO OIDC API Reference Guide</i>.</p>",
255+
"documentation":"<p>The token issued by the <code>CreateToken</code> API call. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html\">CreateToken</a> in the <i>Amazon Web Services SSO OIDC API Reference Guide</i>.</p>",
256256
"location":"header",
257257
"locationName":"x-amz-sso_bearer_token"
258258
}
@@ -279,15 +279,15 @@
279279
"members":{
280280
"accessKeyId":{
281281
"shape":"AccessKeyType",
282-
"documentation":"<p>The identifier used for the temporary security credentials. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html\">Using Temporary Security Credentials to Request Access to AWS Resources</a> in the <i>AWS IAM User Guide</i>.</p>"
282+
"documentation":"<p>The identifier used for the temporary security credentials. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html\">Using Temporary Security Credentials to Request Access to Amazon Web Services Resources</a> in the <i>Amazon Web Services IAM User Guide</i>.</p>"
283283
},
284284
"secretAccessKey":{
285285
"shape":"SecretAccessKeyType",
286-
"documentation":"<p>The key that is used to sign the request. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html\">Using Temporary Security Credentials to Request Access to AWS Resources</a> in the <i>AWS IAM User Guide</i>.</p>"
286+
"documentation":"<p>The key that is used to sign the request. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html\">Using Temporary Security Credentials to Request Access to Amazon Web Services Resources</a> in the <i>Amazon Web Services IAM User Guide</i>.</p>"
287287
},
288288
"sessionToken":{
289289
"shape":"SessionTokenType",
290-
"documentation":"<p>The token used for temporary credentials. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html\">Using Temporary Security Credentials to Request Access to AWS Resources</a> in the <i>AWS IAM User Guide</i>.</p>"
290+
"documentation":"<p>The token used for temporary credentials. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html\">Using Temporary Security Credentials to Request Access to Amazon Web Services Resources</a> in the <i>Amazon Web Services IAM User Guide</i>.</p>"
291291
},
292292
"expiration":{
293293
"shape":"ExpirationTimestampType",
@@ -305,7 +305,7 @@
305305
},
306306
"accountId":{
307307
"shape":"AccountIdType",
308-
"documentation":"<p>The identifier of the AWS account assigned to the user.</p>"
308+
"documentation":"<p>The identifier of the Amazon Web Services account assigned to the user.</p>"
309309
}
310310
},
311311
"documentation":"<p>Provides information about the role that is assigned to the user.</p>"
@@ -342,5 +342,5 @@
342342
"exception":true
343343
}
344344
},
345-
"documentation":"<p>AWS Single Sign-On Portal is a web service that makes it easy for you to assign user access to AWS SSO resources such as the user portal. Users can get AWS account applications and roles assigned to them and get federated into the application.</p> <p>For general information about AWS SSO, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html\">What is AWS Single Sign-On?</a> in the <i>AWS SSO User Guide</i>.</p> <p>This API reference guide describes the AWS SSO Portal operations that you can call programatically and includes detailed information on data types and errors.</p> <note> <p>AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a convenient way to create programmatic access to AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>.</p> </note>"
345+
"documentation":"<p>Amazon Web Services Single Sign On Portal is a web service that makes it easy for you to assign user access to Amazon Web Services SSO resources such as the AWS access portal. Users can get Amazon Web Services account applications and roles assigned to them and get federated into the application.</p> <note> <p>Although Amazon Web Services Single Sign-On was renamed, the <code>sso</code> and <code>identitystore</code> API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed\">Amazon Web Services SSO rename</a>.</p> </note> <p>This API reference guide describes the Amazon Web Services SSO Portal operations that you can call programatically and includes detailed information on data types and errors.</p> <note> <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a convenient way to create programmatic access to Amazon Web Services SSO and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>.</p> </note>"
346346
}

0 commit comments

Comments
 (0)