« blib/lib/Paws/S3Control/GetAccessPointResult.pm
↑ Summary
blib/lib/Paws/S3Control/GetBucketLifecycleConfiguration.pm »
| 1 | |||
| 2 | package Paws::S3Control::GetBucket; | ||
| 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', uri_name => 'name', traits => ['ParamInURI'], required => 1); | ||
| 6 | |||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetBucket'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v20180820/bucket/{name}'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3Control::GetBucketResult'); | ||
| 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::GetBucket - Arguments for method GetBucket on L<Paws::S3Control> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method GetBucket on the | ||
| 28 | L<AWS S3 Control|Paws::S3Control> service. Use the attributes of this class | ||
| 29 | as arguments to method GetBucket. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetBucket. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $s3-control = Paws->service('S3Control'); | ||
| 36 | my $GetBucketResult = $s3 -control->GetBucket( | ||
| 37 | AccountId => 'MyAccountId', | ||
| 38 | Bucket => 'MyBucketName', | ||
| 39 | |||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $Bucket = $GetBucketResult->Bucket; | ||
| 44 | my $CreationDate = $GetBucketResult->CreationDate; | ||
| 45 | my $PublicAccessBlockEnabled = $GetBucketResult->PublicAccessBlockEnabled; | ||
| 46 | |||
| 47 | # Returns a L<Paws::S3Control::GetBucketResult> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3-control/GetBucket> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> AccountId => Str | ||
| 56 | |||
| 57 | The AWS account ID of the Outposts bucket. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> Bucket => Str | ||
| 62 | |||
| 63 | Specifies the bucket. | ||
| 64 | |||
| 65 | For using this parameter with Amazon S3 on Outposts with the REST API, | ||
| 66 | you must specify the name and the x-amz-outpost-id as well. | ||
| 67 | |||
| 68 | For using this parameter with S3 on Outposts with the AWS SDK and CLI, | ||
| 69 | you must specify the ARN of the bucket accessed in the format | ||
| 70 | 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>>. | ||
| 71 | For example, to access the bucket C<reports> through outpost | ||
| 72 | C<my-outpost> owned by account C<123456789012> in Region C<us-west-2>, | ||
| 73 | use the URL encoding of | ||
| 74 | C<arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports>. | ||
| 75 | The value must be URL encoded. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head1 SEE ALSO | ||
| 81 | |||
| 82 | This class forms part of L<Paws>, documenting arguments for method GetBucket in L<Paws::S3Control> | ||
| 83 | |||
| 84 | =head1 BUGS and CONTRIBUTIONS | ||
| 85 | |||
| 86 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 87 | |||
| 88 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 89 | |||
| 90 | =cut | ||
| 91 |