StartStudioSSOConfigurationRepair
Repairs the IAM Identity Center configuration for a given studio.
If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error.
If the studio does not have a valid IAM Identity Center configuration currently
associated with it, then a new IAM Identity Center application is created for the studio
and the studio is changed to the READY
state.
After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
Request Syntax
PUT /2020-08-01/studios/studioId
/sso-configuration HTTP/1.1
X-Amz-Client-Token: clientToken
URI Request Parameters
The request uses the following URI parameters.
- clientToken
-
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.
Length Constraints: Minimum length of 1. Maximum length of 64.
- studioId
-
The studio ID.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"studio": {
"adminRoleArn": "string",
"arn": "string",
"createdAt": "string",
"displayName": "string",
"homeRegion": "string",
"ssoClientId": "string",
"state": "string",
"statusCode": "string",
"statusMessage": "string",
"studioEncryptionConfiguration": {
"keyArn": "string",
"keyType": "string"
},
"studioId": "string",
"studioName": "string",
"studioUrl": "string",
"tags": {
"string" : "string"
},
"updatedAt": "string",
"userRoleArn": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
HTTP Status Code: 403
- ConflictException
-
Another operation is in progress.
HTTP Status Code: 409
- InternalServerErrorException
-
An internal error has occurred. Please retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource could not be found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.
Please use AWS Service Quotas to request an increase.
HTTP Status Code: 402
- ThrottlingException
-
The request throughput limit was exceeded.
HTTP Status Code: 429
- ValidationException
-
One of the parameters in the request is invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: