« blib/lib/Paws/S3Control/LifecycleRuleFilter.pm
↑ Summary
blib/lib/Paws/S3Control/ListAccessPointsForObjectLambda.pm »
| 1 | |||
| 2 | package Paws::S3Control::ListAccessPoints; | ||
| 3 | use Moose; | ||
| 4 | has AccountId => (is => 'ro', isa => 'Str', header_name => 'x-amz-account-id', traits => ['ParamInHeader'], required => 1); | ||
| 5 | has Bucket => (is => 'ro', isa => 'Str', query_name => 'bucket', traits => ['ParamInQuery']); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', query_name => 'maxResults', traits => ['ParamInQuery']); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', query_name => 'nextToken', traits => ['ParamInQuery']); | ||
| 8 | |||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListAccessPoints'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v20180820/accesspoint'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3Control::ListAccessPointsResult'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | |||
| 18 | |||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::S3Control::ListAccessPoints - Arguments for method ListAccessPoints on L<Paws::S3Control> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method ListAccessPoints on the | ||
| 30 | L<AWS S3 Control|Paws::S3Control> service. Use the attributes of this class | ||
| 31 | as arguments to method ListAccessPoints. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListAccessPoints. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $s3-control = Paws->service('S3Control'); | ||
| 38 | my $ListAccessPointsResult = $s3 -control->ListAccessPoints( | ||
| 39 | AccountId => 'MyAccountId', | ||
| 40 | Bucket => 'MyBucketName', # OPTIONAL | ||
| 41 | MaxResults => 1, # OPTIONAL | ||
| 42 | NextToken => 'MyNonEmptyMaxLength1024String', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $AccessPointList = $ListAccessPointsResult->AccessPointList; | ||
| 47 | my $NextToken = $ListAccessPointsResult->NextToken; | ||
| 48 | |||
| 49 | # Returns a L<Paws::S3Control::ListAccessPointsResult> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3-control/ListAccessPoints> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> AccountId => Str | ||
| 58 | |||
| 59 | The AWS account ID for owner of the bucket whose access points you want | ||
| 60 | to list. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 Bucket => Str | ||
| 65 | |||
| 66 | The name of the bucket whose associated access points you want to list. | ||
| 67 | |||
| 68 | For using this parameter with Amazon S3 on Outposts with the REST API, | ||
| 69 | you must specify the name and the x-amz-outpost-id as well. | ||
| 70 | |||
| 71 | For using this parameter with S3 on Outposts with the AWS SDK and CLI, | ||
| 72 | you must specify the ARN of the bucket accessed in the format | ||
| 73 | C<arn:aws:s3-outposts:E<lt>RegionE<gt>:E<lt>account-idE<gt>:outpost/E<lt>outpost-idE<gt>/bucket/E<lt>my-bucket-nameE<gt>>. | ||
| 74 | For example, to access the bucket C<reports> through outpost | ||
| 75 | C<my-outpost> owned by account C<123456789012> in Region C<us-west-2>, | ||
| 76 | use the URL encoding of | ||
| 77 | C<arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports>. | ||
| 78 | The value must be URL encoded. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 MaxResults => Int | ||
| 83 | |||
| 84 | The maximum number of access points that you want to include in the | ||
| 85 | list. If the specified bucket has more than this number of access | ||
| 86 | points, then the response will include a continuation token in the | ||
| 87 | C<NextToken> field that you can use to retrieve the next page of access | ||
| 88 | points. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 NextToken => Str | ||
| 93 | |||
| 94 | A continuation token. If a previous call to C<ListAccessPoints> | ||
| 95 | returned a continuation token in the C<NextToken> field, then providing | ||
| 96 | that value here causes Amazon S3 to retrieve the next page of results. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, documenting arguments for method ListAccessPoints in L<Paws::S3Control> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |