« blib/lib/Paws/Macie2/BucketLevelPermissions.pm
↑ Summary
blib/lib/Paws/Macie2/BucketPermissionConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Macie2::BucketMetadata; | ||
| 3 | use Moose; | ||
| 4 | has AccountId => (is => 'ro', isa => 'Str', request_name => 'accountId', traits => ['NameInRequest']); | ||
| 5 | has AllowsUnencryptedObjectUploads => (is => 'ro', isa => 'Str', request_name => 'allowsUnencryptedObjectUploads', traits => ['NameInRequest']); | ||
| 6 | has BucketArn => (is => 'ro', isa => 'Str', request_name => 'bucketArn', traits => ['NameInRequest']); | ||
| 7 | has BucketCreatedAt => (is => 'ro', isa => 'Str', request_name => 'bucketCreatedAt', traits => ['NameInRequest']); | ||
| 8 | has BucketName => (is => 'ro', isa => 'Str', request_name => 'bucketName', traits => ['NameInRequest']); | ||
| 9 | has ClassifiableObjectCount => (is => 'ro', isa => 'Int', request_name => 'classifiableObjectCount', traits => ['NameInRequest']); | ||
| 10 | has ClassifiableSizeInBytes => (is => 'ro', isa => 'Int', request_name => 'classifiableSizeInBytes', traits => ['NameInRequest']); | ||
| 11 | has JobDetails => (is => 'ro', isa => 'Paws::Macie2::JobDetails', request_name => 'jobDetails', traits => ['NameInRequest']); | ||
| 12 | has LastUpdated => (is => 'ro', isa => 'Str', request_name => 'lastUpdated', traits => ['NameInRequest']); | ||
| 13 | has ObjectCount => (is => 'ro', isa => 'Int', request_name => 'objectCount', traits => ['NameInRequest']); | ||
| 14 | has ObjectCountByEncryptionType => (is => 'ro', isa => 'Paws::Macie2::ObjectCountByEncryptionType', request_name => 'objectCountByEncryptionType', traits => ['NameInRequest']); | ||
| 15 | has PublicAccess => (is => 'ro', isa => 'Paws::Macie2::BucketPublicAccess', request_name => 'publicAccess', traits => ['NameInRequest']); | ||
| 16 | has Region => (is => 'ro', isa => 'Str', request_name => 'region', traits => ['NameInRequest']); | ||
| 17 | has ReplicationDetails => (is => 'ro', isa => 'Paws::Macie2::ReplicationDetails', request_name => 'replicationDetails', traits => ['NameInRequest']); | ||
| 18 | has ServerSideEncryption => (is => 'ro', isa => 'Paws::Macie2::BucketServerSideEncryption', request_name => 'serverSideEncryption', traits => ['NameInRequest']); | ||
| 19 | has SharedAccess => (is => 'ro', isa => 'Str', request_name => 'sharedAccess', traits => ['NameInRequest']); | ||
| 20 | has SizeInBytes => (is => 'ro', isa => 'Int', request_name => 'sizeInBytes', traits => ['NameInRequest']); | ||
| 21 | has SizeInBytesCompressed => (is => 'ro', isa => 'Int', request_name => 'sizeInBytesCompressed', traits => ['NameInRequest']); | ||
| 22 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Macie2::KeyValuePair]', request_name => 'tags', traits => ['NameInRequest']); | ||
| 23 | has UnclassifiableObjectCount => (is => 'ro', isa => 'Paws::Macie2::ObjectLevelStatistics', request_name => 'unclassifiableObjectCount', traits => ['NameInRequest']); | ||
| 24 | has UnclassifiableObjectSizeInBytes => (is => 'ro', isa => 'Paws::Macie2::ObjectLevelStatistics', request_name => 'unclassifiableObjectSizeInBytes', traits => ['NameInRequest']); | ||
| 25 | has Versioning => (is => 'ro', isa => 'Bool', request_name => 'versioning', traits => ['NameInRequest']); | ||
| 26 | |||
| 27 | 1; | ||
| 28 | |||
| 29 | ### main pod documentation begin ### | ||
| 30 | |||
| 31 | =head1 NAME | ||
| 32 | |||
| 33 | Paws::Macie2::BucketMetadata | ||
| 34 | |||
| 35 | =head1 USAGE | ||
| 36 | |||
| 37 | This class represents one of two things: | ||
| 38 | |||
| 39 | =head3 Arguments in a call to a service | ||
| 40 | |||
| 41 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 42 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 43 | |||
| 44 | As an example, if Att1 is expected to be a Paws::Macie2::BucketMetadata object: | ||
| 45 | |||
| 46 | $service_obj->Method(Att1 => { AccountId => $value, ..., Versioning => $value }); | ||
| 47 | |||
| 48 | =head3 Results returned from an API call | ||
| 49 | |||
| 50 | Use accessors for each attribute. If Att1 is expected to be an Paws::Macie2::BucketMetadata object: | ||
| 51 | |||
| 52 | $result = $service_obj->Method(...); | ||
| 53 | $result->Att1->AccountId | ||
| 54 | |||
| 55 | =head1 DESCRIPTION | ||
| 56 | |||
| 57 | Provides information about an S3 bucket that Amazon Macie monitors and | ||
| 58 | analyzes. | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 AccountId => Str | ||
| 64 | |||
| 65 | The unique identifier for the Amazon Web Services account that owns the | ||
| 66 | bucket. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 AllowsUnencryptedObjectUploads => Str | ||
| 70 | |||
| 71 | Specifies whether the bucket policy for the bucket requires server-side | ||
| 72 | encryption of objects when objects are uploaded to the bucket. Possible | ||
| 73 | values are: | ||
| 74 | |||
| 75 | =over | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | FALSE - The bucket policy requires server-side encryption of new | ||
| 80 | objects. PutObject requests must include the | ||
| 81 | x-amz-server-side-encryption header and the value for that header must | ||
| 82 | be AES256 or aws:kms. | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | TRUE - The bucket doesn't have a bucket policy or it has a bucket | ||
| 87 | policy that doesn't require server-side encryption of new objects. If a | ||
| 88 | bucket policy exists, it doesn't require PutObject requests to include | ||
| 89 | the x-amz-server-side-encryption header and it doesn't require the | ||
| 90 | value for that header to be AES256 or aws:kms. | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | UNKNOWN - Amazon Macie can't determine whether the bucket policy | ||
| 95 | requires server-side encryption of new objects. | ||
| 96 | |||
| 97 | =back | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 BucketArn => Str | ||
| 102 | |||
| 103 | The Amazon Resource Name (ARN) of the bucket. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 BucketCreatedAt => Str | ||
| 107 | |||
| 108 | The date and time, in UTC and extended ISO 8601 format, when the bucket | ||
| 109 | was created. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 BucketName => Str | ||
| 113 | |||
| 114 | The name of the bucket. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 ClassifiableObjectCount => Int | ||
| 118 | |||
| 119 | The total number of objects that Amazon Macie can analyze in the | ||
| 120 | bucket. These objects use a supported storage class and have a file | ||
| 121 | name extension for a supported file or storage format. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 ClassifiableSizeInBytes => Int | ||
| 125 | |||
| 126 | The total storage size, in bytes, of the objects that Amazon Macie can | ||
| 127 | analyze in the bucket. These objects use a supported storage class and | ||
| 128 | have a file name extension for a supported file or storage format. | ||
| 129 | |||
| 130 | If versioning is enabled for the bucket, Macie calculates this value | ||
| 131 | based on the size of the latest version of each applicable object in | ||
| 132 | the bucket. This value doesn't reflect the storage size of all versions | ||
| 133 | of each applicable object in the bucket. | ||
| 134 | |||
| 135 | |||
| 136 | =head2 JobDetails => L<Paws::Macie2::JobDetails> | ||
| 137 | |||
| 138 | Specifies whether any one-time or recurring classification jobs are | ||
| 139 | configured to analyze data in the bucket, and, if so, the details of | ||
| 140 | the job that ran most recently. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 LastUpdated => Str | ||
| 144 | |||
| 145 | The date and time, in UTC and extended ISO 8601 format, when Amazon | ||
| 146 | Macie most recently retrieved both bucket and object metadata from | ||
| 147 | Amazon S3 for the bucket. | ||
| 148 | |||
| 149 | |||
| 150 | =head2 ObjectCount => Int | ||
| 151 | |||
| 152 | The total number of objects in the bucket. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 ObjectCountByEncryptionType => L<Paws::Macie2::ObjectCountByEncryptionType> | ||
| 156 | |||
| 157 | The total number of objects that are in the bucket, grouped by | ||
| 158 | server-side encryption type. This includes a grouping that reports the | ||
| 159 | total number of objects that aren't encrypted or use client-side | ||
| 160 | encryption. | ||
| 161 | |||
| 162 | |||
| 163 | =head2 PublicAccess => L<Paws::Macie2::BucketPublicAccess> | ||
| 164 | |||
| 165 | Specifies whether the bucket is publicly accessible due to the | ||
| 166 | combination of permissions settings that apply to the bucket, and | ||
| 167 | provides information about those settings. | ||
| 168 | |||
| 169 | |||
| 170 | =head2 Region => Str | ||
| 171 | |||
| 172 | The Amazon Web Services Region that hosts the bucket. | ||
| 173 | |||
| 174 | |||
| 175 | =head2 ReplicationDetails => L<Paws::Macie2::ReplicationDetails> | ||
| 176 | |||
| 177 | Specifies whether the bucket is configured to replicate one or more | ||
| 178 | objects to buckets for other Amazon Web Services accounts and, if so, | ||
| 179 | which accounts. | ||
| 180 | |||
| 181 | |||
| 182 | =head2 ServerSideEncryption => L<Paws::Macie2::BucketServerSideEncryption> | ||
| 183 | |||
| 184 | Specifies whether the bucket encrypts new objects by default and, if | ||
| 185 | so, the type of server-side encryption that's used. | ||
| 186 | |||
| 187 | |||
| 188 | =head2 SharedAccess => Str | ||
| 189 | |||
| 190 | Specifies whether the bucket is shared with another Amazon Web Services | ||
| 191 | account. Possible values are: | ||
| 192 | |||
| 193 | =over | ||
| 194 | |||
| 195 | =item * | ||
| 196 | |||
| 197 | EXTERNAL - The bucket is shared with an Amazon Web Services account | ||
| 198 | that isn't part of the same Amazon Macie organization. | ||
| 199 | |||
| 200 | =item * | ||
| 201 | |||
| 202 | INTERNAL - The bucket is shared with an Amazon Web Services account | ||
| 203 | that's part of the same Amazon Macie organization. | ||
| 204 | |||
| 205 | =item * | ||
| 206 | |||
| 207 | NOT_SHARED - The bucket isn't shared with other Amazon Web Services | ||
| 208 | accounts. | ||
| 209 | |||
| 210 | =item * | ||
| 211 | |||
| 212 | UNKNOWN - Amazon Macie wasn't able to evaluate the shared access | ||
| 213 | settings for the bucket. | ||
| 214 | |||
| 215 | =back | ||
| 216 | |||
| 217 | |||
| 218 | |||
| 219 | =head2 SizeInBytes => Int | ||
| 220 | |||
| 221 | The total storage size, in bytes, of the bucket. | ||
| 222 | |||
| 223 | If versioning is enabled for the bucket, Amazon Macie calculates this | ||
| 224 | value based on the size of the latest version of each object in the | ||
| 225 | bucket. This value doesn't reflect the storage size of all versions of | ||
| 226 | each object in the bucket. | ||
| 227 | |||
| 228 | |||
| 229 | =head2 SizeInBytesCompressed => Int | ||
| 230 | |||
| 231 | The total storage size, in bytes, of the objects that are compressed | ||
| 232 | (.gz, .gzip, .zip) files in the bucket. | ||
| 233 | |||
| 234 | If versioning is enabled for the bucket, Macie calculates this value | ||
| 235 | based on the size of the latest version of each applicable object in | ||
| 236 | the bucket. This value doesn't reflect the storage size of all versions | ||
| 237 | of each applicable object in the bucket. | ||
| 238 | |||
| 239 | |||
| 240 | =head2 Tags => ArrayRef[L<Paws::Macie2::KeyValuePair>] | ||
| 241 | |||
| 242 | An array that specifies the tags (keys and values) that are associated | ||
| 243 | with the bucket. | ||
| 244 | |||
| 245 | |||
| 246 | =head2 UnclassifiableObjectCount => L<Paws::Macie2::ObjectLevelStatistics> | ||
| 247 | |||
| 248 | The total number of objects that Amazon Macie can't analyze in the | ||
| 249 | bucket. These objects don't use a supported storage class or don't have | ||
| 250 | a file name extension for a supported file or storage format. | ||
| 251 | |||
| 252 | |||
| 253 | =head2 UnclassifiableObjectSizeInBytes => L<Paws::Macie2::ObjectLevelStatistics> | ||
| 254 | |||
| 255 | The total storage size, in bytes, of the objects that Amazon Macie | ||
| 256 | can't analyze in the bucket. These objects don't use a supported | ||
| 257 | storage class or don't have a file name extension for a supported file | ||
| 258 | or storage format. | ||
| 259 | |||
| 260 | |||
| 261 | =head2 Versioning => Bool | ||
| 262 | |||
| 263 | Specifies whether versioning is enabled for the bucket. | ||
| 264 | |||
| 265 | |||
| 266 | |||
| 267 | =head1 SEE ALSO | ||
| 268 | |||
| 269 | This class forms part of L<Paws>, describing an object used in L<Paws::Macie2> | ||
| 270 | |||
| 271 | =head1 BUGS and CONTRIBUTIONS | ||
| 272 | |||
| 273 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 274 | |||
| 275 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 276 | |||
| 277 | =cut | ||
| 278 |