Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateIdentityProviderSettings

Updates additional product configuration settings for the registered identity provider.

Request Syntax


POST /identity-provider/UpdateIdentityProviderSettings HTTP/1.1
Content-type: application/json

{
   "IdentityProvider": { ... },
   "IdentityProviderArn": "string",
   "Product": "string",
   "UpdateSettings": { 
      "AddSubnets": [ "string" ],
      "RemoveSubnets": [ "string" ],
      "SecurityGroupId": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

IdentityProvider

Refers to an identity provider.

Type: IdentityProvider object

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

Required: No

IdentityProviderArn

The Amazon Resource Name (ARN) of the identity provider to update.

Type: String

Pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-zA-Z0-9-\.]{1,510}/[a-zA-Z0-9-\.]{1,510}$

Required: No

Product

The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS

Type: String

Required: No

UpdateSettings

Updates the registered identity provider’s product related configuration settings. You can update any combination of settings in a single operation such as the:

Subnets which you want to add to provision VPC endpoints.
Subnets which you want to remove the VPC endpoints from.
Security group ID which permits traffic to the VPC endpoints.

Type: UpdateSettings object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "IdentityProviderSummary": { 
      "FailureMessage": "string",
      "IdentityProvider": { ... },
      "IdentityProviderArn": "string",
      "Product": "string",
      "Settings": { 
         "SecurityGroupId": "string",
         "Subnets": [ "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.

IdentityProviderSummary

Describes an identity provider.

Type: IdentityProviderSummary object

Errors

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

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

An exception occurred with the service.

HTTP Status Code: 500

ThrottlingException

The request was denied because of request throttling. Retry the request.

HTTP Status Code: 400

ValidationException

A parameter is not valid.

HTTP Status Code: 400