« blib/lib/Paws/S3Control/Exclude.pm
↑ Summary
blib/lib/Paws/S3Control/GetAccessPointConfigurationForObjectLambda.pm »
| 1 | |||
| 2 | package Paws::S3Control::GetAccessPoint; | ||
| 3 | use Moose; | ||
| 4 | has AccountId => (is => 'ro', isa => 'Str', header_name => 'x-amz-account-id', traits => ['ParamInHeader'], required => 1); | ||
| 5 | has Name => (is => 'ro', isa => 'Str', uri_name => 'name', traits => ['ParamInURI'], required => 1); | ||
| 6 | |||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetAccessPoint'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v20180820/accesspoint/{name}'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3Control::GetAccessPointResult'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | |||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::S3Control::GetAccessPoint - Arguments for method GetAccessPoint on L<Paws::S3Control> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method GetAccessPoint on the | ||
| 28 | L<AWS S3 Control|Paws::S3Control> service. Use the attributes of this class | ||
| 29 | as arguments to method GetAccessPoint. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetAccessPoint. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $s3-control = Paws->service('S3Control'); | ||
| 36 | my $GetAccessPointResult = $s3 -control->GetAccessPoint( | ||
| 37 | AccountId => 'MyAccountId', | ||
| 38 | Name => 'MyAccessPointName', | ||
| 39 | |||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $Bucket = $GetAccessPointResult->Bucket; | ||
| 44 | my $CreationDate = $GetAccessPointResult->CreationDate; | ||
| 45 | my $Name = $GetAccessPointResult->Name; | ||
| 46 | my $NetworkOrigin = $GetAccessPointResult->NetworkOrigin; | ||
| 47 | my $PublicAccessBlockConfiguration = | ||
| 48 | $GetAccessPointResult->PublicAccessBlockConfiguration; | ||
| 49 | my $VpcConfiguration = $GetAccessPointResult->VpcConfiguration; | ||
| 50 | |||
| 51 | # Returns a L<Paws::S3Control::GetAccessPointResult> object. | ||
| 52 | |||
| 53 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3-control/GetAccessPoint> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> AccountId => Str | ||
| 60 | |||
| 61 | The account ID for the account that owns the specified access point. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> Name => Str | ||
| 66 | |||
| 67 | The name of the access point whose configuration information you want | ||
| 68 | to retrieve. | ||
| 69 | |||
| 70 | For using this parameter with Amazon S3 on Outposts with the REST API, | ||
| 71 | you must specify the name and the x-amz-outpost-id as well. | ||
| 72 | |||
| 73 | For using this parameter with S3 on Outposts with the AWS SDK and CLI, | ||
| 74 | you must specify the ARN of the access point accessed in the format | ||
| 75 | C<arn:aws:s3-outposts:E<lt>RegionE<gt>:E<lt>account-idE<gt>:outpost/E<lt>outpost-idE<gt>/accesspoint/E<lt>my-accesspoint-nameE<gt>>. | ||
| 76 | For example, to access the access point C<reports-ap> through outpost | ||
| 77 | C<my-outpost> owned by account C<123456789012> in Region C<us-west-2>, | ||
| 78 | use the URL encoding of | ||
| 79 | C<arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap>. | ||
| 80 | The value must be URL encoded. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head1 SEE ALSO | ||
| 86 | |||
| 87 | This class forms part of L<Paws>, documenting arguments for method GetAccessPoint in L<Paws::S3Control> | ||
| 88 | |||
| 89 | =head1 BUGS and CONTRIBUTIONS | ||
| 90 | |||
| 91 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 92 | |||
| 93 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 94 | |||
| 95 | =cut | ||
| 96 |