« blib/lib/Paws/S3/GetObjectLegalHoldOutput.pm
↑ Summary
blib/lib/Paws/S3/GetObjectLockConfigurationOutput.pm »
| 1 | |||
| 2 | package Paws::S3::GetObjectLockConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has Bucket => (is => 'ro', isa => 'Str', uri_name => 'Bucket', traits => ['ParamInURI'], required => 1); | ||
| 5 | has ExpectedBucketOwner => (is => 'ro', isa => 'Str', header_name => 'x-amz-expected-bucket-owner', traits => ['ParamInHeader']); | ||
| 6 | |||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetObjectLockConfiguration'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}?object-lock'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::GetObjectLockConfigurationOutput'); | ||
| 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::S3::GetObjectLockConfiguration - Arguments for method GetObjectLockConfiguration on L<Paws::S3> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method GetObjectLockConfiguration on the | ||
| 28 | L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class | ||
| 29 | as arguments to method GetObjectLockConfiguration. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetObjectLockConfiguration. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $s3 = Paws->service('S3'); | ||
| 36 | my $GetObjectLockConfigurationOutput = $s3->GetObjectLockConfiguration( | ||
| 37 | Bucket => 'MyBucketName', | ||
| 38 | ExpectedBucketOwner => 'MyAccountId', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $ObjectLockConfiguration = | ||
| 43 | $GetObjectLockConfigurationOutput->ObjectLockConfiguration; | ||
| 44 | |||
| 45 | # Returns a L<Paws::S3::GetObjectLockConfigurationOutput> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/GetObjectLockConfiguration> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> Bucket => Str | ||
| 54 | |||
| 55 | The bucket whose Object Lock configuration you want to retrieve. | ||
| 56 | |||
| 57 | When using this action with an access point, you must direct requests | ||
| 58 | to the access point hostname. The access point hostname takes the form | ||
| 59 | I<AccessPointName>-I<AccountId>.s3-accesspoint.I<Region>.amazonaws.com. | ||
| 60 | When using this action with an access point through the AWS SDKs, you | ||
| 61 | provide the access point ARN in place of the bucket name. For more | ||
| 62 | information about access point ARNs, see Using access points | ||
| 63 | (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) | ||
| 64 | in the I<Amazon S3 User Guide>. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 ExpectedBucketOwner => Str | ||
| 69 | |||
| 70 | The account ID of the expected bucket owner. If the bucket is owned by | ||
| 71 | a different account, the request will fail with an HTTP C<403 (Access | ||
| 72 | Denied)> error. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head1 SEE ALSO | ||
| 78 | |||
| 79 | This class forms part of L<Paws>, documenting arguments for method GetObjectLockConfiguration in L<Paws::S3> | ||
| 80 | |||
| 81 | =head1 BUGS and CONTRIBUTIONS | ||
| 82 | |||
| 83 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 84 | |||
| 85 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 86 | |||
| 87 | =cut | ||
| 88 |