openapi: 3.1.0 info: title: Amazon S3 Inventory (bucket-level) description: '3 operations from the Amazon S3 REST API, generated from the authoritative service model. S3 identifies these operations by the `inventory` query subresource, which is declared as a required query parameter on each one because an OpenAPI path cannot carry a query string. 1 further operation(s) share a method, path and subresource with one described here and are recorded in `x-s3-sibling-operations`: S3 separates them by a request header or an id parameter, which OpenAPI cannot express. Generated from boto/botocore `service-2.json` at `aeb03fc4ae530e0b3f47d588b6021581db870c8c` (Apache-2.0). Responses are XML.' version: '2006-03-01' contact: name: AWS Support url: https://aws.amazon.com/premiumsupport/ externalDocs: description: Amazon S3 API Reference url: https://docs.aws.amazon.com/AmazonS3/latest/API/ servers: - url: https://s3.{region}.amazonaws.com variables: region: default: us-east-1 tags: - name: inventory paths: /{Bucket}: delete: operationId: DeleteBucketInventoryConfiguration summary: Deletes an S3 Inventory configuration (identified by the inventory ID) from the bucket. Directory buckets - For director description: Deletes an S3 Inventory configuration (identified by the inventory ID) from the bucket. Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide. Permissions To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. General purpose bucket permissions - The s3:PutInventoryConfiguration permission is required in a policy. For more information about general purpose buck tags: - inventory parameters: - name: inventory in: query required: true description: Selects this operation. S3 identifies it by the `inventory` subresource. schema: type: string - name: Bucket in: path required: true description: The name of the bucket containing the inventory configuration to delete. Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https:/ schema: type: string - name: id in: query required: true description: The ID used to identify the inventory configuration. schema: type: string - name: x-amz-expected-bucket-owner in: header required: false description: The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied) schema: type: string responses: '200': description: Success. S3 answers in XML, not JSON. '403': description: AccessDenied. S3 validates the signature before it routes the operation, so this does not distinguish an unsupported operation from an unauthorised one. get: operationId: GetBucketInventoryConfiguration summary: 'Returns an S3 Inventory configuration (identified by the inventory configuration ID) from the bucket. Directory buckets ' description: Returns an S3 Inventory configuration (identified by the inventory configuration ID) from the bucket. Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide. Permissions To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. General purpose bucket permissions - The s3:GetInventoryConfiguration permission is required in a policy. For more information about genera tags: - inventory parameters: - name: inventory in: query required: true description: Selects this operation. S3 identifies it by the `inventory` subresource. schema: type: string - name: Bucket in: path required: true description: The name of the bucket containing the inventory configuration to retrieve. Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https schema: type: string - name: id in: query required: true description: The ID used to identify the inventory configuration. schema: type: string - name: x-amz-expected-bucket-owner in: header required: false description: The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied) schema: type: string responses: '200': description: Success. S3 answers in XML, not JSON. x-output-shape: GetBucketInventoryConfigurationOutput '403': description: AccessDenied. S3 validates the signature before it routes the operation, so this does not distinguish an unsupported operation from an unauthorised one. put: operationId: PutBucketInventoryConfiguration summary: This implementation of the PUT action adds an S3 Inventory configuration (identified by the inventory ID) to the bucket. description: This implementation of the PUT action adds an S3 Inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket. Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket. When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide. You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analys tags: - inventory parameters: - name: inventory in: query required: true description: Selects this operation. S3 identifies it by the `inventory` subresource. schema: type: string - name: Bucket in: path required: true description: The name of the bucket where the inventory configuration will be stored. Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https:/ schema: type: string - name: id in: query required: true description: The ID used to identify the inventory configuration. schema: type: string - name: x-amz-expected-bucket-owner in: header required: false description: The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied) schema: type: string responses: '200': description: Success. S3 answers in XML, not JSON. '403': description: AccessDenied. S3 validates the signature before it routes the operation, so this does not distinguish an unsupported operation from an unauthorised one. x-s3-sibling-operations: - operation: ListBucketInventoryConfigurations shadows: GetBucketInventoryConfiguration summary: Returns a list of S3 Inventory configurations for the bucket. You can have up to 1,000 inventory configurations per bucket. This action supports list pagination and does not return more than 100 confi why: Same method, path and query subresource as the operation above. S3 separates them by a request header or by the presence of an id parameter, neither of which an OpenAPI path can express.