|
46 | 46 | "MigrateWorkspace": "<p>Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.</p> <p>The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original <code>D:\\Users\\%USERNAME%</code> user profile folder is renamed to <code>D:\\Users\\%USERNAME%MMddyyTHHmmss%.NotMigrated</code>. A new <code>D:\\Users\\%USERNAME%\\</code> folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.</p> <p>For available migration scenarios, details about what happens during migration, and best practices, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/migrate-workspaces.html\">Migrate a WorkSpace</a>.</p>", |
47 | 47 | "ModifyAccount": "<p>Modifies the configuration of Bring Your Own License (BYOL) for the specified account.</p>", |
48 | 48 | "ModifyClientProperties": "<p>Modifies the properties of the specified Amazon WorkSpaces clients.</p>", |
| 49 | + "ModifySamlProperties": "<p>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.</p>", |
49 | 50 | "ModifySelfservicePermissions": "<p>Modifies the self-service WorkSpace management capabilities for your users. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html\">Enable Self-Service WorkSpace Management Capabilities for Your Users</a>.</p>", |
50 | 51 | "ModifyWorkspaceAccessProperties": "<p>Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html#control-device-access\"> Control Device Access</a>.</p>", |
51 | 52 | "ModifyWorkspaceCreationProperties": "<p>Modify the default properties used to create WorkSpaces.</p>", |
|
599 | 600 | "WorkspaceDirectory$WorkspaceCreationProperties": "<p>The default creation properties for all WorkSpaces in the directory.</p>" |
600 | 601 | } |
601 | 602 | }, |
| 603 | + "DeletableSamlPropertiesList": { |
| 604 | + "base": null, |
| 605 | + "refs": { |
| 606 | + "ModifySamlPropertiesRequest$PropertiesToDelete": "<p>The SAML properties to delete as part of your request.</p> <p>Specify one of the following options:</p> <ul> <li> <p> <code>SAML_PROPERTIES_USER_ACCESS_URL</code> to delete the user access URL.</p> </li> <li> <p> <code>SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME</code> to delete the relay state parameter name.</p> </li> </ul>" |
| 607 | + } |
| 608 | + }, |
| 609 | + "DeletableSamlProperty": { |
| 610 | + "base": null, |
| 611 | + "refs": { |
| 612 | + "DeletableSamlPropertiesList$member": null |
| 613 | + } |
| 614 | + }, |
602 | 615 | "DeleteClientBrandingRequest": { |
603 | 616 | "base": null, |
604 | 617 | "refs": { |
|
865 | 878 | "DirectoryIdList$member": null, |
866 | 879 | "DisassociateIpGroupsRequest$DirectoryId": "<p>The identifier of the directory.</p>", |
867 | 880 | "ImportClientBrandingRequest$ResourceId": "<p>The directory identifier of the WorkSpace for which you want to import client branding.</p>", |
| 881 | + "ModifySamlPropertiesRequest$ResourceId": "<p>The directory identifier for which you want to configure SAML properties.</p>", |
868 | 882 | "ModifySelfservicePermissionsRequest$ResourceId": "<p>The identifier of the directory.</p>", |
869 | 883 | "ModifyWorkspaceAccessPropertiesRequest$ResourceId": "<p>The identifier of the directory.</p>", |
870 | 884 | "ModifyWorkspaceCreationPropertiesRequest$ResourceId": "<p>The identifier of the directory.</p>", |
|
1262 | 1276 | "refs": { |
1263 | 1277 | } |
1264 | 1278 | }, |
| 1279 | + "ModifySamlPropertiesRequest": { |
| 1280 | + "base": null, |
| 1281 | + "refs": { |
| 1282 | + } |
| 1283 | + }, |
| 1284 | + "ModifySamlPropertiesResult": { |
| 1285 | + "base": null, |
| 1286 | + "refs": { |
| 1287 | + } |
| 1288 | + }, |
1265 | 1289 | "ModifySelfservicePermissionsRequest": { |
1266 | 1290 | "base": null, |
1267 | 1291 | "refs": { |
|
1327 | 1351 | "ResourceNotFoundException$ResourceId": "<p>The ID of the resource that could not be found.</p>", |
1328 | 1352 | "ResourceUnavailableException$ResourceId": "<p>The identifier of the resource that is not available.</p>", |
1329 | 1353 | "RootStorage$Capacity": "<p>The size of the root volume.</p>", |
| 1354 | + "SamlProperties$RelayStateParameterName": "<p>The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.</p> <p>To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.</p>", |
1330 | 1355 | "TagKeyList$member": null, |
1331 | 1356 | "UserStorage$Capacity": "<p>The size of the user volume.</p>", |
1332 | 1357 | "WorkspaceBundle$Name": "<p>The name of the bundle.</p>" |
|
1542 | 1567 | "WorkspaceProperties$RunningModeAutoStopTimeoutInMinutes": "<p>The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.</p>" |
1543 | 1568 | } |
1544 | 1569 | }, |
| 1570 | + "SamlProperties": { |
| 1571 | + "base": "<p>Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.</p>", |
| 1572 | + "refs": { |
| 1573 | + "ModifySamlPropertiesRequest$SamlProperties": "<p>The properties for configuring SAML 2.0 authentication.</p>", |
| 1574 | + "WorkspaceDirectory$SamlProperties": "<p>Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.</p>" |
| 1575 | + } |
| 1576 | + }, |
| 1577 | + "SamlStatusEnum": { |
| 1578 | + "base": null, |
| 1579 | + "refs": { |
| 1580 | + "SamlProperties$Status": "<p>Indicates the status of SAML 2.0 authentication. These statuses include the following.</p> <ul> <li> <p>If the setting is <code>DISABLED</code>, end users will be directed to login with their directory credentials.</p> </li> <li> <p>If the setting is <code>ENABLED</code>, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.</p> </li> <li> <p>If the setting is <code>ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK</code>, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.</p> </li> </ul>" |
| 1581 | + } |
| 1582 | + }, |
| 1583 | + "SamlUserAccessUrl": { |
| 1584 | + "base": null, |
| 1585 | + "refs": { |
| 1586 | + "SamlProperties$UserAccessUrl": "<p>The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.</p>" |
| 1587 | + } |
| 1588 | + }, |
1545 | 1589 | "SecurityGroupId": { |
1546 | 1590 | "base": null, |
1547 | 1591 | "refs": { |
|
0 commit comments