Skip to main content

Retrieve an S3 bucket​

Returns a representation of the specified S3 bucket.

Path Parameters
  • bucket_id string required

    Performs the operation on the Bucket with the specified ID.

Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • _etag string

    The ETag value.

  • _links object

    URLs to pages related to the resource.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • account_native_id string

    The AWS-assigned ID of the account associated with the S3 bucket.

  • aws_region string

    The AWS region associated with the S3 bucket.

  • bucket_size_bytes_breakdown object

    The total size breakdown of S3 buckets in bytes per storage class. This parameter aggregates relevant fields from cloudwatch_metrics > size_bytes_per_storage_class

  • glacier_deep_archive_storage_bytes int64

    Size of Glacier Deep Archive Storage in bytes.

  • glacier_flexible_retrieval_storage_bytes int64

    Size of Glacier Flexible Retrieval Storage in bytes.

  • glacier_instant_retrieval_storage_bytes int64

    Size of Glacier Instant Retrieval Storage in bytes.

  • intelligent_tiering_storage_bytes int64

    Size of Intelligent-Tiering Storage objects in bytes.

  • one_zone_ia_storage_bytes int64

    Size of OneZone-IA Storage in bytes.

  • reduced_redundancy_storage_bytes int64

    Size of Reduced Redundancy Storage in bytes.

  • standard_ia_storage_bytes int64

    Size of Standard-IA Storage in bytes.

  • standard_storage_bytes int64

    Size of Standard Storage in bytes.

  • cloudwatch_metrics object

    The Cloudwatch metrics of the bucket.

  • average_object_size_bytes double

    The average size of object in bucket.

  • average_object_size_bytes_time date-time

    Timestamp when average size of the bucket is calculated.

  • object_count int64

    Number of objects in bucket.

  • object_count_retrieved_time date-time

    Timestamp when CloudWatch reported the bucket object count.

  • size_bytes int64

    Size of bucket in bytes.

  • size_bytes_per_storage_class object

    The size breakdown in bytes with timestamps of a bucket per storage class.

  • deep_archive_object_overhead int64

    Size of Deep Archive Object Overhead in bytes.

  • deep_archive_object_overhead_retrieved_time date-time

    Timestamp when CloudWatch reported the Deep Archive Object Overhead size.

  • deep_archive_s3_object_overhead int64

    Size of Deep Archive S3 Object Overhead in bytes.

  • deep_archive_s3_object_overhead_retrieved_time date-time

    Timestamp when CloudWatch reported the Deep Archive S3 Object Overhead size.

  • deep_archive_staging_storage int64

    Size of Deep Archive Staging Storage objects in bytes.

  • deep_archive_staging_storage_retrieved_time date-time

    Timestamp when CloudWatch reported the Deep Archive Staging Storage objects size.

  • deep_archive_storage int64

    Size of Deep Archive Storage objects in bytes.

  • deep_archive_storage_retrieved_time date-time

    Timestamp when CloudWatch reported the Deep Archive Storage objects size.

  • glacier_instant_retrieval_storage int64

    Size of Glacier Instant Retrieval Storage objects in bytes.

  • glacier_instant_retrieval_storage_retrieved_time date-time

    Timestamp when CloudWatch reported the Glacier Instant Retrieval Storage objects size.

  • glacier_object_overhead int64

    Size of Glacier Object Overhead in bytes.

  • glacier_object_overhead_retrieved_time date-time

    Timestamp when CloudWatch reported the Glacier Object Overhead size.

  • glacier_s3_object_overhead int64

    Size of Glacier S3 Object Overhead in bytes.

  • glacier_s3_object_overhead_retrieved_time date-time

    Timestamp when CloudWatch reported the Glacier S3 Object Overhead size.

  • glacier_staging_storage int64

    Size of Glacier Staging Storage objects in bytes.

  • glacier_staging_storage_retrieved_time date-time

    Timestamp when CloudWatch reported the Glacier Staging Storage objects size.

  • glacier_storage int64

    Size of Glacier Storage objects in bytes.

  • glacier_storage_retrieved_time date-time

    Timestamp when CloudWatch reported the Glacier Storage objects size.

  • intelligent_tiering_aa_storage int64

    Size of Intelligent-Tiering AA Storage objects in bytes.

  • intelligent_tiering_aa_storage_retrieved_time date-time

    Timestamp when CloudWatch reported the Intelligent-Tiering AA Storage objects size.

  • intelligent_tiering_aia_storage int64

    Size of Intelligent-Tiering AIA Storage objects in bytes.

  • intelligent_tiering_aia_storage_retrieved_time date-time

    Timestamp when CloudWatch reported the Intelligent-Tiering AIA Storage objects size.

  • intelligent_tiering_daa_storage int64

    Size of Intelligent-Tiering DAA Storage objects in bytes.

  • intelligent_tiering_daa_storage_retrieved_time date-time

    Timestamp when CloudWatch reported the Intelligent-Tiering DAA Storage objects size.

  • intelligent_tiering_fa_storage int64

    Size of Intelligent-Tiering FA Storage objects in bytes.

  • intelligent_tiering_fa_storage_retrieved_time date-time

    Timestamp when CloudWatch reported the Intelligent-Tiering FA Storage objects size.

  • intelligent_tiering_ia_storage int64

    Size of Intelligent-Tiering IA Storage objects in bytes.

  • intelligent_tiering_ia_storage_retrieved_time date-time

    Timestamp when CloudWatch reported the Intelligent-Tiering IA Storage objects size.

  • one_zone_ia_size_overhead int64

    Size of OneZone IA Overhead in bytes.

  • one_zone_ia_size_overhead_retrieved_time date-time

    Timestamp when CloudWatch reported the OneZone IA Overhead size.

  • one_zone_ia_storage int64

    Size of OneZone IA Storage objects in bytes.

  • one_zone_ia_storage_retrieved_time date-time

    Timestamp when CloudWatch reported the OneZone IA Storage objects size.

  • reduced_redundancy_storage int64

    Size of Reduced Redundancy Storage objects in bytes.

  • reduced_redundancy_storage_retrieved_time date-time

    Timestamp when CloudWatch reported the Reduced Redundancy Storage objects size.

  • standard_ia_object_overhead int64

    Size of Standard IA Object Overhead in bytes.

  • standard_ia_object_overhead_retrieved_time date-time

    Timestamp when CloudWatch reported the Standard IA Object Overhead size.

  • standard_ia_size_overhead int64

    Size of Standard IA Overhead in bytes.

  • standard_ia_size_overhead_retrieved_time date-time

    Timestamp when CloudWatch reported the Standard IA Overhead size.

  • standard_ia_storage int64

    Size of Standard IA Storage objects in bytes.

  • standard_ia_storage_retrieved_time date-time

    Timestamp when CloudWatch reported the Standard IA Storage objects size.

  • standard_storage int64

    Size of Standard Storage objects in bytes.

  • standard_storage_retrieved_time date-time

    Timestamp when CloudWatch reported the Standard Storage objects size.

  • size_bytes_retrieved_time date-time

    Timestamp when CloudWatch reported the bucket size.

  • creation_timestamp string

    The timestamp of when the bucket was created. Represented in RFC-3339 format.

  • encryption_setting object

    The AWS encryption output of the bucket.

  • server_side_encryption_configuration object

    Specifies the default server-side-encryption configuration.

  • rules object[]

    Container for information about a particular server-side encryption configuration rule.

  • apply_server_side_encryption_by_default object

    Describes the default server-side encryption to apply to new objects in the bucket.

  • kms_master_key_id string

    AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default encryption.

  • sse_algorithm string

    Server-side encryption algorithm to use for the default encryption.

  • bucket_key_enabled boolean

    Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket.

  • environment_id string

    The Clumio-assigned ID of the AWS environment associated with the S3 bucket.

  • event_bridge_enabled boolean

    The EventBridge enablement state for the S3 bucket.

  • id string

    The Clumio-assigned ID of the bucket.

  • is_encryption_enabled boolean

    The Encryption enablement state for the S3 bucket.

  • is_replication_enabled boolean

    The Replication enablement state for the S3 bucket.

  • is_versioning_enabled boolean

    The Versioning enablement state for the S3 bucket.

  • last_backtrack_sync_timestamp string

    Time of the last S3 Backtrack sync in RFC-3339 format.

  • last_backup_timestamp string

    Time of the last backup in RFC-3339 format.

  • last_continuous_backup_timestamp string

    Time of the last continuous backup in RFC-3339 format.

  • name string

    The AWS-assigned name of the bucket.

  • object_count int64

    Number of objects in bucket.

  • organizational_unit_id string

    The Clumio-assigned ID of the organizational unit associated with the S3 bucket.

  • protection_group_count int64

    Protection group count reflects how many protection groups are linked to this bucket.

  • replication_setting object

    The AWS replication output of the bucket.

  • replication_configuration object

    A container for replication rules with a maximum size of 2MB and a maximum of 1,000 rules.

  • role string

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects.

  • rules object[]

    Specifies which Amazon S3 objects to replicate and where to store the replicas.

  • delete_marker_replication object

    Specifies whether Amazon S3 replicates delete markers.

  • status string

    Indicates whether to replicate delete markers.

  • destination object

    Specifies information about where to publish analysis or configuration results.

  • access_control_translation object

    A container for information about access control for replicas.

  • owner string

    Specifies the replica ownership.

  • account string

    Destination bucket owner account ID.

  • bucket string

    The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.

  • encryption_configuration object

    Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.

  • replica_kms_key_id string

    Specifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key stored in AWS Key Management Service (KMS) for the destination bucket.

  • metrics object

    A container specifying replication metrics-related settings enabling replication metrics and events.

  • event_threshold object

    A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics EventThreshold.

  • minutes int64

    Contains an integer specifying time in minutes.

  • status string

    Specifies whether the replication metrics are enabled.

  • replication_time object

    A container specifying S3 Replication Time Control (S3 RTC) related information.

  • status string

    Specifies whether the replication time is enabled.

  • time object

    A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics EventThreshold.

  • minutes int64

    Contains an integer specifying time in minutes.

  • storage_class string

    The storage class to use when replicating objects.

  • existing_object_replication object

    Configuration to replicate existing source bucket objects.

  • status string

    Specifies whether the existing object replication is enabled.

  • filter object

    A filter that identifies the subset of objects to which the replication rule applies.

  • and object

    A container for specifying rule filters. The filters determine the subset of objects to which the rule applies.

  • prefix string

    An object key name prefix that identifies the subset of objects to which the rule applies.

  • tags object[]

    An array of tags containing key and value pairs.

  • key string

    Name of the object key.

  • value string

    Value of the tag.

  • prefix string

    An object key name prefix that identifies the subset of objects to which the rule applies.

  • tag object

    A container of a key value name pair.

  • key string

    Name of the object key.

  • value string

    Value of the tag.

  • id string

    A unique identifier for the rule (max 255 characters).

  • priority int64

    The priority indicates which rule has precedence whenever two or more replication rules conflict.

  • source_selection_criteria object

    A container that describes additional filters for identifying the source objects that you want to replicate.

  • replica_modifications object

    A filter that you can specify for selection for modifications on replicas.

  • status string

    Specifies whether Amazon S3 replicates modifications on replicas.

  • sse_kms_encrypted_objects object

    A container for filter information for the selection of S3 objects encrypted with AWS KMS.

  • status string

    Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key stored in AWS Key Management Service.

  • status string

    Specifies whether the rule is enabled.

  • size_bytes int64

    Size of bucket in bytes.

  • tags object[]

    The AWS tags applied to the S3 bucket.

  • id string

    The Clumio-assigned ID of the AWS tag.

  • key string

    The AWS-assigned tag key.

  • key_id string

    The Clumio-assigned ID of the AWS key.

  • value string

    The AWS-assigned tag value.

  • versioning_setting object

    The AWS versioning output of the bucket.

  • mfa_delete string

    Specifies whether MFA delete is enabled in the bucket versioning configuration.

  • status string

    The versioning state of the bucket.

Loading...