aws_sdk_ssm/client/
modify_document_permission.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ModifyDocumentPermission`](crate::operation::modify_document_permission::builders::ModifyDocumentPermissionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::modify_document_permission::builders::ModifyDocumentPermissionFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::modify_document_permission::builders::ModifyDocumentPermissionFluentBuilder::set_name):<br>required: **true**<br><p>The name of the document that you want to share.</p><br>
7    ///   - [`permission_type(DocumentPermissionType)`](crate::operation::modify_document_permission::builders::ModifyDocumentPermissionFluentBuilder::permission_type) / [`set_permission_type(Option<DocumentPermissionType>)`](crate::operation::modify_document_permission::builders::ModifyDocumentPermissionFluentBuilder::set_permission_type):<br>required: **true**<br><p>The permission type for the document. The permission type can be <i>Share</i>.</p><br>
8    ///   - [`account_ids_to_add(impl Into<String>)`](crate::operation::modify_document_permission::builders::ModifyDocumentPermissionFluentBuilder::account_ids_to_add) / [`set_account_ids_to_add(Option<Vec::<String>>)`](crate::operation::modify_document_permission::builders::ModifyDocumentPermissionFluentBuilder::set_account_ids_to_add):<br>required: **false**<br><p>The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or <i>All</i>. You must specify a value for this parameter or the <code>AccountIdsToRemove</code> parameter.</p><br>
9    ///   - [`account_ids_to_remove(impl Into<String>)`](crate::operation::modify_document_permission::builders::ModifyDocumentPermissionFluentBuilder::account_ids_to_remove) / [`set_account_ids_to_remove(Option<Vec::<String>>)`](crate::operation::modify_document_permission::builders::ModifyDocumentPermissionFluentBuilder::set_account_ids_to_remove):<br>required: **false**<br><p>The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or <i>All</i>. This action has a higher priority than <code>AccountIdsToAdd</code>. If you specify an ID to add and the same ID to remove, the system removes access to the document. You must specify a value for this parameter or the <code>AccountIdsToAdd</code> parameter.</p><br>
10    ///   - [`shared_document_version(impl Into<String>)`](crate::operation::modify_document_permission::builders::ModifyDocumentPermissionFluentBuilder::shared_document_version) / [`set_shared_document_version(Option<String>)`](crate::operation::modify_document_permission::builders::ModifyDocumentPermissionFluentBuilder::set_shared_document_version):<br>required: **false**<br><p>(Optional) The version of the document to share. If it isn't specified, the system choose the <code>Default</code> version to share.</p><br>
11    /// - On success, responds with [`ModifyDocumentPermissionOutput`](crate::operation::modify_document_permission::ModifyDocumentPermissionOutput)
12    /// - On failure, responds with [`SdkError<ModifyDocumentPermissionError>`](crate::operation::modify_document_permission::ModifyDocumentPermissionError)
13    pub fn modify_document_permission(&self) -> crate::operation::modify_document_permission::builders::ModifyDocumentPermissionFluentBuilder {
14        crate::operation::modify_document_permission::builders::ModifyDocumentPermissionFluentBuilder::new(self.handle.clone())
15    }
16}