AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginModifyDocumentPermission and EndModifyDocumentPermission.

Namespace: Amazon.SimpleSystemsManagement
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<ModifyDocumentPermissionResponse> ModifyDocumentPermissionAsync(
         ModifyDocumentPermissionRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.SimpleSystemsManagement.Model.ModifyDocumentPermissionRequest

Container for the necessary parameters to execute the ModifyDocumentPermission service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the ModifyDocumentPermission service method, as returned by SimpleSystemsManagement.

Exceptions

ExceptionCondition
DocumentLimitExceededException You can have at most 500 active SSM documents.
DocumentPermissionLimitException The document can't be shared with more Amazon Web Services accounts. You can specify a maximum of 20 accounts per API operation to share a private document. By default, you can share a private document with a maximum of 1,000 accounts and publicly share up to five documents. If you need to increase the quota for privately or publicly shared Systems Manager documents, contact Amazon Web Services Support.
InternalServerErrorException An error occurred on the server side.
InvalidDocumentException The specified SSM document doesn't exist.
InvalidPermissionTypeException The permission type isn't supported. Share is the only supported permission type.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also