aws_sdk_ssm/client/describe_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 [`DescribeDocumentPermission`](crate::operation::describe_document_permission::builders::DescribeDocumentPermissionFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`name(impl Into<String>)`](crate::operation::describe_document_permission::builders::DescribeDocumentPermissionFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::describe_document_permission::builders::DescribeDocumentPermissionFluentBuilder::set_name):<br>required: **true**<br><p>The name of the document for which you are the owner.</p><br>
7 /// - [`permission_type(DocumentPermissionType)`](crate::operation::describe_document_permission::builders::DescribeDocumentPermissionFluentBuilder::permission_type) / [`set_permission_type(Option<DocumentPermissionType>)`](crate::operation::describe_document_permission::builders::DescribeDocumentPermissionFluentBuilder::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 /// - [`max_results(i32)`](crate::operation::describe_document_permission::builders::DescribeDocumentPermissionFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_document_permission::builders::DescribeDocumentPermissionFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::describe_document_permission::builders::DescribeDocumentPermissionFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_document_permission::builders::DescribeDocumentPermissionFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of items to return. (You received this token from a previous call.)</p><br>
10 /// - On success, responds with [`DescribeDocumentPermissionOutput`](crate::operation::describe_document_permission::DescribeDocumentPermissionOutput) with field(s):
11 /// - [`account_ids(Option<Vec::<String>>)`](crate::operation::describe_document_permission::DescribeDocumentPermissionOutput::account_ids): <p>The account IDs that have permission to use this document. The ID can be either an Amazon Web Services account number or <code>all</code>.</p>
12 /// - [`account_sharing_info_list(Option<Vec::<AccountSharingInfo>>)`](crate::operation::describe_document_permission::DescribeDocumentPermissionOutput::account_sharing_info_list): <p>A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.</p>
13 /// - [`next_token(Option<String>)`](crate::operation::describe_document_permission::DescribeDocumentPermissionOutput::next_token): <p>The token for the next set of items to return. Use this token to get the next set of results.</p>
14 /// - On failure, responds with [`SdkError<DescribeDocumentPermissionError>`](crate::operation::describe_document_permission::DescribeDocumentPermissionError)
15 pub fn describe_document_permission(&self) -> crate::operation::describe_document_permission::builders::DescribeDocumentPermissionFluentBuilder {
16 crate::operation::describe_document_permission::builders::DescribeDocumentPermissionFluentBuilder::new(self.handle.clone())
17 }
18}