Request Syntax Request Parameters Response Elements Errors See Also

UpdateInstance

Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.

In a single UpdateInstance request, you can perform only one of the following operations:

Update the encryption configuration of the instance by specifying EncryptionConfiguration.
Enable permission sets for the instance by specifying PermissionSetsEnabled.
Update the network configuration of the instance by specifying NetworkConfiguration.

A request that specifies more than one of EncryptionConfiguration, PermissionSetsEnabled, and NetworkConfiguration returns a ValidationException. To perform more than one of these operations, call UpdateInstance separately for each. The calls can be made in parallel.

Request Syntax


{
   "EncryptionConfiguration": { 
      "KeyType": "string",
      "KmsKeyArn": "string"
   },
   "InstanceArn": "string",
   "Name": "string",
   "NetworkConfiguration": { 
      "AllowSourceIps": [ "string" ],
      "ExcludeApplicationArns": [ "string" ],
      "RestrictSourceVpcs": [ "string" ],
      "VpceAccessRequired": boolean
   },
   "PermissionSetsEnabled": boolean
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EncryptionConfiguration

Specifies the encryption configuration for your IAM Identity Center instance. You can use this to configure customer managed KMS keys or Amazon owned KMS keys for encrypting your instance data.

Note

You can't set more than one of EncryptionConfiguration, PermissionSetsEnabled, and NetworkConfiguration in the same request. To configure more than one of them, make a separate UpdateInstance call for each. These calls can be made in parallel.

Type: EncryptionConfiguration object

Required: No

InstanceArn

The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces in the Amazon General Reference.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 1224.

Pattern: arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}

Required: Yes

Name

Updates the instance name.

Type: String

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

Pattern: [\w+=,.@-]+

Required: No

NetworkConfiguration

Specifies the network access controls for your Identity Center instance. Use this to require that access to your instance and to applications originates from VPC endpoints, and to optionally restrict which VPCs are permitted, allow specific IP address ranges that bypass the VPC endpoint requirement, or exempt specific applications from the controls.

If you omit NetworkConfiguration, the stored network configuration is preserved. If you specify NetworkConfiguration, it replaces the stored network configuration in its entirety. Any list that you omit from the object, or include as an empty list, is cleared.

Type: NetworkConfigurationInfo object

Required: No

PermissionSetsEnabled

Enables permission sets for this Identity Center instance. The only accepted value is true. After permission sets are enabled, they cannot be disabled.

Type: Boolean

Required: No

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 Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

Reason: The reason for the access denied exception.

HTTP Status Code: 400

ConflictException

Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception, or failure with an internal server.

HTTP Status Code: 500

ResourceNotFoundException

Indicates that a requested resource is not found.

Reason: The reason for the resource not found exception.

HTTP Status Code: 400

ThrottlingException

Indicates that the principal has crossed the throttling limits of the API operations.

Reason: The reason for the throttling exception.

HTTP Status Code: 400

ValidationException

The request failed because it contains a syntax error.

Reason: The reason for the validation exception.

HTTP Status Code: 400