openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 176 kB

JSON

{"openapi":"3.0.0","info":{"version":"2016-05-01","x-release":"v4","title":"Amazon WorkDocs","description":"The Amazon WorkDocs API is designed for the following use cases: <ul> <li> File Migration: File migration applications are supported for users who want to migrate their files from an on-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files. </li> <li> Security: Support security applications are supported for users who have additional security needs, such as antivirus or data loss prevention. The API actions, along with CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user. </li> <li> eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with CloudTrail, to replicate data for eDiscovery, backup, or analytical applications. </li> </ul> All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissions and upload any file to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model. <note> The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions: <ul> <li> <code>READ (Get*)</code> </li> <li> <code>WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)</code> </li> <li> <code>LIST (Describe*)</code> </li> <li> <code>DELETE*, CANCEL</code> </li> </ul> For information about Amazon WorkDocs API pricing, see <a href=\"https://aws.amazon.com/workdocs/pricing/\">Amazon WorkDocs Pricing</a>. </note>","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"workdocs","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/workdocs-2016-05-01.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/workdocs/"},"servers":[{"url":"http://workdocs.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon WorkDocs multi-region endpoint"},{"url":"https://workdocs.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon WorkDocs multi-region endpoint"},{"url":"http://workdocs.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon WorkDocs endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://workdocs.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon WorkDocs endpoint for China (Beijing) and China (Ningxia)"}],"paths":{"/api/v1/documents/{DocumentId}/versions/{VersionId}":{"delete":{"operationId":"AbortDocumentVersionUpload","description":"Aborts the upload of the specified document version that was previously initiated by <a>InitiateDocumentVersionUpload</a>. The client should make this call only when it no longer intends to upload the document version, or fails to do so.","responses":{"204":{"description":"Success"},"480":{"description":"EntityNotExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityNotExistsException"}}}},"481":{"description":"ProhibitedStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProhibitedStateException"}}}},"482":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"483":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"484":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"485":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"486":{"description":"ConcurrentModificationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcurrentModificationException"}}}}},"parameters":[{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}},{"name":"DocumentId","in":"path","required":true,"description":"The ID of the document.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}},{"name":"VersionId","in":"path","required":true,"description":"The ID of the version.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetDocumentVersion","description":"Retrieves version metadata for the specified document.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDocumentVersionResponse"}}}},"480":{"description":"EntityNotExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityNotExistsException"}}}},"481":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"482":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"483":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"485":{"description":"ProhibitedStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProhibitedStateException"}}}},"486":{"description":"InvalidPasswordException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPasswordException"}}}}},"parameters":[{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}},{"name":"DocumentId","in":"path","required":true,"description":"The ID of the document.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}},{"name":"VersionId","in":"path","required":true,"description":"The version ID of the document.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of values. Specify \"SOURCE\" to include a URL for the source document.","schema":{"type":"string","pattern":"[\\w,]+","minLength":1,"maxLength":256}},{"name":"includeCustomMetadata","in":"query","required":false,"description":"Set this to TRUE to include custom metadata in the response.","schema":{"type":"boolean"}}]},"patch":{"operationId":"UpdateDocumentVersion","description":"Changes the status of the document version to ACTIVE. Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by <a>InitiateDocumentVersionUpload</a>. ","responses":{"200":{"description":"Success"},"480":{"description":"EntityNotExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityNotExistsException"}}}},"481":{"description":"ProhibitedStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProhibitedStateException"}}}},"482":{"description":"ConcurrentModificationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcurrentModificationException"}}}},"483":{"description":"InvalidOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidOperationException"}}}},"484":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"485":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"486":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"487":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}},{"name":"DocumentId","in":"path","required":true,"description":"The ID of the document.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}},{"name":"VersionId","in":"path","required":true,"description":"The version ID of the document.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"VersionStatus":{"description":"The status of the version.","type":"string","enum":["ACTIVE"]}}}}}}}},"/api/v1/users/{UserId}/activation":{"post":{"operationId":"ActivateUser","description":"Activates the specified user. Only active users can access Amazon WorkDocs.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateUserResponse"}}}},"480":{"description":"EntityNotExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityNotExistsException"}}}},"481":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"482":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"483":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"UserId","in":"path","required":true,"description":"The ID of the user.","schema":{"type":"string","pattern":"[&\\w+-.@]+","minLength":1,"maxLength":256}},{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeactivateUser","description":"Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.","responses":{"204":{"description":"Success"},"480":{"description":"EntityNotExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityNotExistsException"}}}},"481":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"482":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"483":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"UserId","in":"path","required":true,"description":"The ID of the user.","schema":{"type":"string","pattern":"[&\\w+-.@]+","minLength":1,"maxLength":256}},{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}}]}},"/api/v1/resources/{ResourceId}/permissions":{"post":{"operationId":"AddResourcePermissions","description":"Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddResourcePermissionsResponse"}}}},"480":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"481":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"482":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ProhibitedStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProhibitedStateException"}}}}},"parameters":[{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}},{"name":"ResourceId","in":"path","required":true,"description":"The ID of the resource.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Principals"],"properties":{"Principals":{"description":"The users, groups, or organization being granted permission.","type":"array","items":{"$ref":"#/components/schemas/SharePrincipal"}},"NotificationOptions":{"description":"Set of options which defines notification preferences of given action.","type":"object","properties":{"SendEmail":{"allOf":[{"$ref":"#/components/schemas/BooleanType"},{"description":"Boolean value to indicate an email notification should be sent to the recipients."}]},"EmailMessage":{"allOf":[{"$ref":"#/components/schemas/MessageType"},{"description":"Text value to be included in the email body."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"DescribeResourcePermissions","description":"Describes the permissions of a specified resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeResourcePermissionsResponse"}}}},"480":{"description":"InvalidArgumentException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArgumentException"}}}},"481":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"482":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"483":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}},{"name":"ResourceId","in":"path","required":true,"description":"The ID of the resource.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}},{"name":"principalId","in":"query","required":false,"description":"The ID of the principal to filter permissions by.","schema":{"type":"string","pattern":"[&\\w+-.@]+","minLength":1,"maxLength":256}},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return with this call.","schema":{"type":"integer","minimum":1,"maximum":999}},{"name":"marker","in":"query","required":false,"description":"The marker for the next set of results. (You received this marker from a previous call)","schema":{"type":"string","minLength":1,"maxLength":2048}},{"name":"Limit","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"Marker","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]},"delete":{"operationId":"RemoveAllResourcePermissions","description":"Removes all the permissions from the specified resource.","responses":{"204":{"description":"Success"},"480":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"481":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"482":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}},{"name":"ResourceId","in":"path","required":true,"description":"The ID of the resource.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}}]}},"/api/v1/documents/{DocumentId}/versions/{VersionId}/comment":{"post":{"operationId":"CreateComment","description":"Adds a new comment to the specified document version.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommentResponse"}}}},"480":{"description":"EntityNotExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityNotExistsException"}}}},"481":{"description":"ProhibitedStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProhibitedStateException"}}}},"482":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"483":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"484":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"485":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"486":{"description":"DocumentLockedForCommentsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentLockedForCommentsException"}}}},"487":{"description":"InvalidCommentOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidCommentOperationException"}}}}},"parameters":[{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}},{"name":"DocumentId","in":"path","required":true,"description":"The ID of the document.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}},{"name":"VersionId","in":"path","required":true,"description":"The ID of the document version.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Text"],"properties":{"ParentId":{"description":"The ID of the parent comment.","type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128},"ThreadId":{"description":"The ID of the root comment in the thread.","type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128},"Text":{"description":"The text of the comment.","type":"string","minLength":1,"maxLength":2048,"format":"password"},"Visibility":{"description":"The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.","type":"string","enum":["PUBLIC","PRIVATE"]},"NotifyCollaborators":{"description":"Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.","type":"boolean"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/api/v1/resources/{ResourceId}/customMetadata":{"put":{"operationId":"CreateCustomMetadata","description":"Adds one or more custom properties to the specified resource (a folder, document, or version).","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomMetadataResponse"}}}},"480":{"description":"EntityNotExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityNotExistsException"}}}},"481":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"482":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"483":{"description":"ProhibitedStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProhibitedStateException"}}}},"484":{"description":"CustomMetadataLimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomMetadataLimitExceededException"}}}},"485":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"486":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}},{"name":"ResourceId","in":"path","required":true,"description":"The ID of the resource.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}},{"name":"versionid","in":"query","required":false,"description":"The ID of the version, if the custom metadata is being added to a document version.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CustomMetadata"],"properties":{"CustomMetadata":{"description":"Custom metadata in the form of name-value pairs.","type":"object","minProperties":1,"maxProperties":8,"additionalProperties":{"$ref":"#/components/schemas/CustomMetadataValueType"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeleteCustomMetadata","description":"Deletes custom metadata from the specified resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCustomMetadataResponse"}}}},"480":{"description":"EntityNotExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityNotExistsException"}}}},"481":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"482":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"483":{"description":"ProhibitedStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProhibitedStateException"}}}},"484":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"485":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}},{"name":"ResourceId","in":"path","required":true,"description":"The ID of the resource, either a document or folder.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}},{"name":"versionId","in":"query","required":false,"description":"The ID of the version, if the custom metadata is being deleted from a document version.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}},{"name":"keys","in":"query","required":false,"description":"List of properties to remove.","schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomMetadataKeyType"},"maxItems":8}},{"name":"deleteAll","in":"query","required":false,"description":"Flag to indicate removal of all custom metadata properties from the specified resource.","schema":{"type":"boolean"}}]}},"/api/v1/folders":{"post":{"operationId":"CreateFolder","description":"Creates a folder with the specified name and parent folder.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFolderResponse"}}}},"480":{"description":"EntityNotExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityNotExistsException"}}}},"481":{"description":"EntityAlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityAlreadyExistsException"}}}},"482":{"description":"ProhibitedStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProhibitedStateException"}}}},"483":{"description":"ConflictingOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictingOperationException"}}}},"484":{"description":"ConcurrentModificationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcurrentModificationException"}}}},"485":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"486":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"487":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"488":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"489":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ParentFolderId"],"properties":{"Name":{"description":"The name of the new folder.","type":"string","pattern":"[\\u0020-\\u202D\\u202F-\\uFFFF]+","minLength":1,"maxLength":255,"format":"password"},"ParentFolderId":{"description":"The ID of the parent folder.","type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/api/v1/resources/{ResourceId}/labels":{"put":{"operationId":"CreateLabels","description":"Adds the specified list of labels to the given resource (a document or folder)","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLabelsResponse"}}}},"480":{"description":"EntityNotExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityNotExistsException"}}}},"481":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"482":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"483":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"485":{"description":"TooManyLabelsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyLabelsException"}}}}},"parameters":[{"name":"ResourceId","in":"path","required":true,"description":"The ID of the resource.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}},{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Labels"],"properties":{"Labels":{"description":"List of labels to add to the resource.","type":"array","items":{"$ref":"#/components/schemas/SharedLabel"},"maxItems":20}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeleteLabels","description":"Deletes the specified list of labels from a resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLabelsResponse"}}}},"480":{"description":"EntityNotExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityNotExistsException"}}}},"481":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"482":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"483":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"485":{"description":"ProhibitedStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProhibitedStateException"}}}}},"parameters":[{"name":"ResourceId","in":"path","required":true,"description":"The ID of the resource.","schema":{"type":"string","pattern":"[\\w+-.@]+","minLength":1,"maxLength":128}},{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}},{"name":"labels","in":"query","required":false,"description":"List of labels to delete from the resource.","schema":{"type":"array","items":{"$ref":"#/components/schemas/SharedLabel"},"maxItems":20}},{"name":"deleteAll","in":"query","required":false,"description":"Flag to request removal of all labels from the specified resource.","schema":{"type":"boolean"}}]}},"/api/v1/organizations/{OrganizationId}/subscriptions":{"post":{"operationId":"CreateNotificationSubscription","description":"Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription. For more information, see <a href=\"https://docs.aws.amazon.com/workdocs/latest/developerguide/manage-notifications.html\">Setting up notifications for an IAM user or role</a> in the Amazon WorkDocs Developer Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNotificationSubscriptionResponse"}}}},"480":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"481":{"description":"TooManySubscriptionsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManySubscriptionsException"}}}},"482":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"483":{"description":"InvalidArgumentException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArgumentException"}}}}},"parameters":[{"name":"OrganizationId","in":"path","required":true,"description":"The ID of the organization.","schema":{"type":"string","pattern":"[&\\w+-.@]+","minLength":1,"maxLength":256}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","Protocol","SubscriptionType"],"properties":{"Endpoint":{"description":"The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with <code>https</code>.","type":"string","minLength":1,"maxLength":256},"Protocol":{"description":"The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.","type":"string","enum":["HTTPS","SQS"]},"SubscriptionType":{"description":"The notification type.","type":"string","enum":["ALL"]}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"DescribeNotificationSubscriptions","description":"Lists the specified notification subscriptions.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeNotificationSubscriptionsResponse"}}}},"480":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"481":{"description":"EntityNotExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityNotExistsException"}}}},"482":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"OrganizationId","in":"path","required":true,"description":"The ID of the organization.","schema":{"type":"string","pattern":"[&\\w+-.@]+","minLength":1,"maxLength":256}},{"name":"marker","in":"query","required":false,"description":"The marker for the next set of results. (You received this marker from a previous call.)","schema":{"type":"string","minLength":1,"maxLength":2048}},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return with this call.","schema":{"type":"integer","minimum":1,"maximum":999}},{"name":"Limit","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"Marker","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/api/v1/users":{"post":{"operationId":"CreateUser","description":"Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is \"ACTIVE\". New users can access Amazon WorkDocs.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserResponse"}}}},"480":{"description":"EntityAlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityAlreadyExistsException"}}}},"481":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"482":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"483":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Username","GivenName","Surname","Password"],"properties":{"OrganizationId":{"description":"The ID of the organization.","type":"string","pattern":"[&\\w+-.@]+","minLength":1,"maxLength":256},"Username":{"description":"The login name of the user.","type":"string","pattern":"[\\w\\-+.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z]+)?","minLength":1,"maxLength":256,"format":"password"},"EmailAddress":{"description":"The email address of the user.","type":"string","pattern":"[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}","minLength":1,"maxLength":256,"format":"password"},"GivenName":{"description":"The given name of the user.","type":"string","minLength":1,"maxLength":64,"format":"password"},"Surname":{"description":"The surname of the user.","type":"string","minLength":1,"maxLength":64,"format":"password"},"Password":{"description":"The password of the user.","type":"string","pattern":"[\\u0020-\\u00FF]+","minLength":4,"maxLength":32,"format":"password"},"TimeZoneId":{"description":"The time zone ID of the user.","type":"string","minLength":1,"maxLength":256},"StorageRule":{"description":"Describes the storage for a user.","type":"object","properties":{"StorageAllocatedInBytes":{"allOf":[{"$ref":"#/components/schemas/PositiveSizeType"},{"description":"The amount of storage allocated, in bytes."}]},"StorageType":{"allOf":[{"$ref":"#/components/schemas/StorageType"},{"description":"The type of storage."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"DescribeUsers","description":"Describes the specified users. You can describe all users or filter the results (for example, by status or organization). By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeUsersResponse"}}}},"480":{"description":"EntityNotExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityNotExistsException"}}}},"481":{"description":"UnauthorizedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedOperationException"}}}},"482":{"description":"UnauthorizedResourceAccessException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResourceAccessException"}}}},"483":{"description":"FailedDependencyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependencyException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"485":{"description":"InvalidArgumentException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArgumentException"}}}},"486":{"description":"RequestedEntityTooLargeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestedEntityTooLargeException"}}}}},"parameters":[{"name":"Authentication","in":"header","required":false,"description":"Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.","schema":{"type":"string","minLength":1,"maxLength":8199,"format":"password"}},{"name":"organizationId","in":"query","required":false,"description":"The ID of the organization.","schema":{"type":"string","pattern":"[&\\w+-.@]+","minLength":1,"maxLength":256}},{"name":"userIds","in":"query","required":false,"description":"The IDs of the users.","schema":{"type":"string","pattern":"[&\\w+-.@, ]+","minLength":1,"maxLength":2000}},{"name":"query","in":"query","required":false,"description":"A query to filter users by user name. Remember the following about the <code>Userids</code> and <code>Query</code> parameters: <ul> <li> If you don't use either parameter, the API returns a paginated list of all users on the site. </li> <li> If you use both parameters, the API ignores the <code>Query</code> parameter. </li> <li> The <code>Userid</code> parameter only returns user names that match a corresponding user ID. </li> <li> The <code>Query</code> parameter runs a \"prefix\" search for users by the <code>GivenName</code>, <code>SurName</code>, or <code>UserName</code> fields included in a <a href=\"https://docs.aws.amazon.com/workdocs/latest/APIReference/API_CreateUser.html\">CreateUser</a> API call. For example, querying on <code>Ma</code> returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on <code>Ma J</code> only returns Mateo Jackson. </li> </ul>","schema":{"type":"string","pattern":"[\\u0020-\\uFFFF]+","minLength":1,"maxLength":512,"format":"password"}},{"name":"include","in":"query","required":false,"description":"The state of the users. Specify \"ALL\" to include inactive users.","schema":{"type":"string","enum":["ALL","ACTIVE_PENDING"]}},{"name":"order","in":"query","required":false,"description":"The order for the results.","schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"sort","in":"query","required":false,"description":"The sorting criteria.","schema":{"type":"string","enum":["USER_NAME","FULL_NAME","STORAGE_LIMIT","USER_STATUS","STORAGE_USED"]}},{"name":"marker","in":"query","required":false,"description":"The marker for the next set of results. (You received this marker from a previous call.)","schema":{"type":"string","minLength":1,"maxLength":2048}},{"name":"limit","in":"query","required":false,"description":"The maximum number of items to return.","schema":{"type":"integer","minimum":1,"maximum":999}},{"name":"fields","