ModifySamlProperties - Amazon WorkSpaces Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

Request Syntax

{ "PropertiesToDelete": [ "string" ], "ResourceId": "string", "SamlProperties": { "RelayStateParameterName": "string", "Status": "string", "UserAccessUrl": "string" } }

Request Parameters

The request accepts the following data in JSON format.


The SAML properties to delete as part of your request.

Specify one of the following options:

  • SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.

  • SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name.

Type: Array of strings


Required: No


The directory identifier for which you want to configure SAML properties.

Type: String

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

Pattern: ^d-[0-9a-f]{8,63}$

Required: Yes


The properties for configuring SAML 2.0 authentication.

Type: SamlProperties object

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


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


The user is not authorized to access a resource.

HTTP Status Code: 400


One or more parameter values are not valid.

HTTP Status Code: 400


This operation is not supported.

HTTP Status Code: 400


The resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: