aws_sdk_s3control/client/

get_access_point.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetAccessPoint`](crate::operation::get_access_point::builders::GetAccessPointFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`account_id(impl Into<String>)`](crate::operation::get_access_point::builders::GetAccessPointFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::get_access_point::builders::GetAccessPointFluentBuilder::set_account_id):<br>required: **true**<br><p>The Amazon Web Services account ID for the account that owns the specified access point.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::get_access_point::builders::GetAccessPointFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::get_access_point::builders::GetAccessPointFluentBuilder::set_name):<br>required: **true**<br><p>The name of the access point whose configuration information 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 [`GetAccessPointOutput`](crate::operation::get_access_point::GetAccessPointOutput) with field(s):
    ///   - [`name(Option<String>)`](crate::operation::get_access_point::GetAccessPointOutput::name): <p>The name of the specified access point.</p>
    ///   - [`bucket(Option<String>)`](crate::operation::get_access_point::GetAccessPointOutput::bucket): <p>The name of the bucket associated with the specified access point.</p>
    ///   - [`network_origin(Option<NetworkOrigin>)`](crate::operation::get_access_point::GetAccessPointOutput::network_origin): <p>Indicates whether this access point allows access from the public internet. If <code>VpcConfiguration</code> is specified for this access point, then <code>NetworkOrigin</code> is <code>VPC</code>, and the access point doesn't allow access from the public internet. Otherwise, <code>NetworkOrigin</code> is <code>Internet</code>, and the access point allows access from the public internet, subject to the access point and bucket access policies.</p> <p>This will always be true for an Amazon S3 on Outposts access point</p>
    ///   - [`vpc_configuration(Option<VpcConfiguration>)`](crate::operation::get_access_point::GetAccessPointOutput::vpc_configuration): <p>Contains the virtual private cloud (VPC) configuration for the specified access point.</p><note>  <p>This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other Amazon Web Services services.</p> </note>
    ///   - [`public_access_block_configuration(Option<PublicAccessBlockConfiguration>)`](crate::operation::get_access_point::GetAccessPointOutput::public_access_block_configuration): <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a> in the <i>Amazon S3 User Guide</i>.</p> <p>This data type is not supported for Amazon S3 on Outposts.</p>
    ///   - [`creation_date(Option<DateTime>)`](crate::operation::get_access_point::GetAccessPointOutput::creation_date): <p>The date and time when the specified access point was created.</p>
    ///   - [`alias(Option<String>)`](crate::operation::get_access_point::GetAccessPointOutput::alias): <p>The name or alias of the access point.</p>
    ///   - [`access_point_arn(Option<String>)`](crate::operation::get_access_point::GetAccessPointOutput::access_point_arn): <p>The ARN of the access point.</p>
    ///   - [`endpoints(Option<HashMap::<String, String>>)`](crate::operation::get_access_point::GetAccessPointOutput::endpoints): <p>The VPC endpoint for the access point.</p>
    ///   - [`bucket_account_id(Option<String>)`](crate::operation::get_access_point::GetAccessPointOutput::bucket_account_id): <p>The Amazon Web Services account ID associated with the S3 bucket associated with this access point.</p>
    ///   - [`data_source_id(Option<String>)`](crate::operation::get_access_point::GetAccessPointOutput::data_source_id): <p>The unique identifier for the data source of the access point.</p>
    ///   - [`data_source_type(Option<String>)`](crate::operation::get_access_point::GetAccessPointOutput::data_source_type): <p>The type of the data source that the access point is attached to.</p>
    /// - On failure, responds with [`SdkError<GetAccessPointError>`](crate::operation::get_access_point::GetAccessPointError)
    pub fn get_access_point(&self) -> crate::operation::get_access_point::builders::GetAccessPointFluentBuilder {
        crate::operation::get_access_point::builders::GetAccessPointFluentBuilder::new(self.handle.clone())
    }
}