Amazon S3 · Schema

CreateAccessGrantRequest

ArchivesAmazon Web ServicesBackupCloud StorageData StorageObject StorageScalable StorageStorage

Properties

Name Type Description
AccountId string The Amazon Web Services account ID of the S3 Access Grants instance.
AccessGrantsLocationId string The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:
AccessGrantsLocationConfiguration object
Grantee object
Permission string The type of access that you are granting to your S3 data, which can be set to one of the following values: READ – Grant read-only access to the S3 data. WRITE – Grant write-only access to the S3 data.
ApplicationArn string The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an ac
S3PrefixType string The type of S3SubPrefix. The only possible value is Object. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefi
Tags array The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for,
View JSON Schema on GitHub

JSON Schema

amazon-s3-create-access-grant-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-s3/json-schema/amazon-s3-create-access-grant-request-schema.json",
  "title": "CreateAccessGrantRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-s3-accessgrantsinstance-api-openapi.yml#/components/schemas/CreateAccessGrantRequest",
  "type": "object",
  "properties": {
    "AccountId": {
      "type": "string",
      "description": "The Amazon Web Services account ID of the S3 Access Grants instance."
    },
    "AccessGrantsLocationId": {
      "type": "string",
      "description": "The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register. If you are passing the default location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the Subprefix field."
    },
    "AccessGrantsLocationConfiguration": {
      "$ref": "#/$defs/AccessGrantsLocationConfiguration"
    },
    "Grantee": {
      "$ref": "#/$defs/S3ControlGrantee"
    },
    "Permission": {
      "type": "string",
      "enum": [
        "READ",
        "WRITE",
        "READWRITE"
      ],
      "description": "The type of access that you are granting to your S3 data, which can be set to one of the following values: READ – Grant read-only access to the S3 data. WRITE – Grant write-only access to the S3 data. READWRITE – Grant both read and write access to the S3 data."
    },
    "ApplicationArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application."
    },
    "S3PrefixType": {
      "type": "string",
      "enum": [
        "Object"
      ],
      "description": "The type of S3SubPrefix. The only possible value is Object. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix."
    },
    "Tags": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/S3ControlTag"
      },
      "description": "The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources."
    }
  },
  "required": [
    "AccountId",
    "AccessGrantsLocationId",
    "Grantee",
    "Permission"
  ],
  "$defs": {
    "AccessGrantsLocationConfiguration": {
      "type": "object",
      "properties": {
        "S3SubPrefix": {
          "type": "string",
          "description": "The S3SubPrefix is appended to the location scope creating the grant scope. Use this field to narrow the scope of the grant to a subset of the location scope. This field is required if the location scope is the default location s3:// because you cannot create a grant for all of your S3 data in the Region and must narrow the scope. For example, if the location scope is the default location s3://, the S3SubPrefx can be a /*, so the full grant scope path would be s3:///*. Or the S3SubPrefx can be /*, so the full grant scope path would be or s3:///*. If the S3SubPrefix includes a prefix, append th"
        }
      }
    },
    "S3ControlGrantee": {
      "type": "object",
      "properties": {
        "GranteeType": {
          "type": "string",
          "enum": [
            "DIRECTORY_USER",
            "DIRECTORY_GROUP",
            "IAM"
          ],
          "description": "The type of the grantee to which access has been granted. It can be one of the following values: IAM - An IAM user or role. DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance. DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance."
        },
        "GranteeIdentifier": {
          "type": "string",
          "description": "The unique identifier of the Grantee. If the grantee type is IAM, the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. You can obtain this UUID from your Amazon Web Services IAM Identity Center instance."
        }
      }
    },
    "S3ControlTag": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "description": "The key of the key-value pair of a tag added to your Amazon Web Services resource. A tag key can be up to 128 Unicode characters in length and is case-sensitive. System created tags that begin with aws: aren’t supported."
        },
        "Value": {
          "type": "string",
          "description": "The value of the key-value pair of a tag added to your Amazon Web Services resource. A tag value can be up to 256 Unicode characters in length and is case-sensitive."
        }
      },
      "required": [
        "Key",
        "Value"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/amazon-s3-create-access-grant-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.