aws_sdk_ram/client/
get_permission.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetPermission`](crate::operation::get_permission::builders::GetPermissionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`permission_arn(impl Into<String>)`](crate::operation::get_permission::builders::GetPermissionFluentBuilder::permission_arn) / [`set_permission_arn(Option<String>)`](crate::operation::get_permission::builders::GetPermissionFluentBuilder::set_permission_arn):<br>required: **true**<br><p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the permission whose contents you want to retrieve. To find the ARN for a permission, use either the <code>ListPermissions</code> operation or go to the <a href="https://console.aws.amazon.com/ram/home#Permissions:">Permissions library</a> page in the RAM console and then choose the name of the permission. The ARN is displayed on the detail page.</p><br>
    ///   - [`permission_version(i32)`](crate::operation::get_permission::builders::GetPermissionFluentBuilder::permission_version) / [`set_permission_version(Option<i32>)`](crate::operation::get_permission::builders::GetPermissionFluentBuilder::set_permission_version):<br>required: **false**<br><p>Specifies the version number of the RAM permission to retrieve. If you don't specify this parameter, the operation retrieves the default version.</p> <p>To see the list of available versions, use <code>ListPermissionVersions</code>.</p><br>
    /// - On success, responds with [`GetPermissionOutput`](crate::operation::get_permission::GetPermissionOutput) with field(s):
    ///   - [`permission(Option<ResourceSharePermissionDetail>)`](crate::operation::get_permission::GetPermissionOutput::permission): <p>An object with details about the permission.</p>
    /// - On failure, responds with [`SdkError<GetPermissionError>`](crate::operation::get_permission::GetPermissionError)
    pub fn get_permission(&self) -> crate::operation::get_permission::builders::GetPermissionFluentBuilder {
        crate::operation::get_permission::builders::GetPermissionFluentBuilder::new(self.handle.clone())
    }
}