blib/lib/Paws/S3/HeadBucket.pm untested

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::S3::HeadBucket;
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 => 'HeadBucket');
11 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}');
12 class_has _api_method => (isa => 'Str', is => 'ro', default => 'HEAD');
13 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
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::HeadBucket - Arguments for method HeadBucket on L<Paws::S3>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method HeadBucket on the
28 L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class
29 as arguments to method HeadBucket.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to HeadBucket.
32  
33 =head1 SYNOPSIS
34  
35 my $s3 = Paws->service('S3');
36 # To determine if bucket exists
37 # This operation checks to see if a bucket exists.
38 $s3->HeadBucket( 'Bucket' => 'acl1' );
39  
40  
41 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.
42 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/HeadBucket>
43  
44 =head1 ATTRIBUTES
45  
46  
47 =head2 B<REQUIRED> Bucket => Str
48  
49 The bucket name.
50  
51 When using this action with an access point, you must direct requests
52 to the access point hostname. The access point hostname takes the form
53 I<AccessPointName>-I<AccountId>.s3-accesspoint.I<Region>.amazonaws.com.
54 When using this action with an access point through the AWS SDKs, you
55 provide the access point ARN in place of the bucket name. For more
56 information about access point ARNs, see Using access points
57 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
58 in the I<Amazon S3 User Guide>.
59  
60 When using this action with Amazon S3 on Outposts, you must direct
61 requests to the S3 on Outposts hostname. The S3 on Outposts hostname
62 takes the form
63 I<AccessPointName>-I<AccountId>.I<outpostID>.s3-outposts.I<Region>.amazonaws.com.
64 When using this action using S3 on Outposts through the AWS SDKs, you
65 provide the Outposts bucket ARN in place of the bucket name. For more
66 information about S3 on Outposts ARNs, see Using S3 on Outposts
67 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html)
68 in the I<Amazon S3 User Guide>.
69  
70  
71  
72 =head2 ExpectedBucketOwner => Str
73  
74 The account ID of the expected bucket owner. If the bucket is owned by
75 a different account, the request will fail with an HTTP C<403 (Access
76 Denied)> error.
77  
78  
79  
80  
81 =head1 SEE ALSO
82  
83 This class forms part of L<Paws>, documenting arguments for method HeadBucket in L<Paws::S3>
84  
85 =head1 BUGS and CONTRIBUTIONS
86  
87 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
88  
89 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
90  
91 =cut
92