aws_sdk_transfer/client/
describe_access.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeAccess`](crate::operation::describe_access::builders::DescribeAccessFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`server_id(impl Into<String>)`](crate::operation::describe_access::builders::DescribeAccessFluentBuilder::server_id) / [`set_server_id(Option<String>)`](crate::operation::describe_access::builders::DescribeAccessFluentBuilder::set_server_id):<br>required: **true**<br><p>A system-assigned unique identifier for a server that has this access assigned.</p><br>
    ///   - [`external_id(impl Into<String>)`](crate::operation::describe_access::builders::DescribeAccessFluentBuilder::external_id) / [`set_external_id(Option<String>)`](crate::operation::describe_access::builders::DescribeAccessFluentBuilder::set_external_id):<br>required: **true**<br><p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p> <p><code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code></p> <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p> <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p><br>
    /// - On success, responds with [`DescribeAccessOutput`](crate::operation::describe_access::DescribeAccessOutput) with field(s):
    ///   - [`server_id(String)`](crate::operation::describe_access::DescribeAccessOutput::server_id): <p>A system-assigned unique identifier for a server that has this access assigned.</p>
    ///   - [`access(Option<DescribedAccess>)`](crate::operation::describe_access::DescribeAccessOutput::access): <p>The external identifier of the server that the access is attached to.</p>
    /// - On failure, responds with [`SdkError<DescribeAccessError>`](crate::operation::describe_access::DescribeAccessError)
    pub fn describe_access(&self) -> crate::operation::describe_access::builders::DescribeAccessFluentBuilder {
        crate::operation::describe_access::builders::DescribeAccessFluentBuilder::new(self.handle.clone())
    }
}