aws_sdk_s3control/client/

get_access_point_policy.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetAccessPointPolicy`](crate::operation::get_access_point_policy::builders::GetAccessPointPolicyFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`account_id(impl Into<String>)`](crate::operation::get_access_point_policy::builders::GetAccessPointPolicyFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::get_access_point_policy::builders::GetAccessPointPolicyFluentBuilder::set_account_id):<br>required: **true**<br><p>The account ID for the account that owns the specified access point.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::get_access_point_policy::builders::GetAccessPointPolicyFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::get_access_point_policy::builders::GetAccessPointPolicyFluentBuilder::set_name):<br>required: **true**<br><p>The name of the access point whose policy you want to retrieve.</p> <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p> <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format <code>arn:aws:s3-outposts:<region>    :    <account-id>     :outpost/     <outpost-id>      /accesspoint/      <my-accesspoint-name></my-accesspoint-name>     </outpost-id>    </account-id>   </region></code>. For example, to access the access point <code>reports-ap</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap</code>. The value must be URL encoded.</p><br>
    /// - On success, responds with [`GetAccessPointPolicyOutput`](crate::operation::get_access_point_policy::GetAccessPointPolicyOutput) with field(s):
    ///   - [`policy(Option<String>)`](crate::operation::get_access_point_policy::GetAccessPointPolicyOutput::policy): <p>The access point policy associated with the specified access point.</p>
    /// - On failure, responds with [`SdkError<GetAccessPointPolicyError>`](crate::operation::get_access_point_policy::GetAccessPointPolicyError)
    pub fn get_access_point_policy(&self) -> crate::operation::get_access_point_policy::builders::GetAccessPointPolicyFluentBuilder {
        crate::operation::get_access_point_policy::builders::GetAccessPointPolicyFluentBuilder::new(self.handle.clone())
    }
}