Own AWS? Customize your docs with AI search, analytics, and more.

POST

/RegisterResource

http://lakeformation.{region}.amazonaws.com/RegisterResource

Registers the resource as managed by the Data Catalog. To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy. The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location. <code>ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true</code> If <code>UseServiceLinkedRole</code> is not set to true, you must provide or set the <code>RoleArn</code>: <code>arn:aws:iam::12345:role/my-data-access-role</code>

Access Token Required: API Key

Body Params

RoleArnstring

The identifier for the role that registers the resource.

ResourceArnstringrequired

The Amazon Resource Name (ARN) of the resource that you want to register.

WithFederationboolean

Whether or not the resource is a federated resource.

UseServiceLinkedRoleboolean

Designates an Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. A service-linked role is a unique type of IAM role that is linked directly to Lake Formation. For more information, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/service-linked-roles.html">Using Service-Linked Roles for Lake Formation</a>.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://lakeformation.{region}.amazonaws.com/RegisterResource' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/RegisterResource

http://lakeformation.{region}.amazonaws.com/RegisterResource

Registers the resource as managed by the Data Catalog. To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy. The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location. <code>ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true</code> If <code>UseServiceLinkedRole</code> is not set to true, you must provide or set the <code>RoleArn</code>: <code>arn:aws:iam::12345:role/my-data-access-role</code>

Access Token Required: API Key

Body Params

RoleArnstring

The identifier for the role that registers the resource.

ResourceArnstringrequired

The Amazon Resource Name (ARN) of the resource that you want to register.

WithFederationboolean

Whether or not the resource is a federated resource.

UseServiceLinkedRoleboolean

Designates an Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. A service-linked role is a unique type of IAM role that is linked directly to Lake Formation. For more information, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/service-linked-roles.html">Using Service-Linked Roles for Lake Formation</a>.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://lakeformation.{region}.amazonaws.com/RegisterResource' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/RegisterResource

http://lakeformation.{region}.amazonaws.com/RegisterResource

Registers the resource as managed by the Data Catalog. To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy. The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location. <code>ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true</code> If <code>UseServiceLinkedRole</code> is not set to true, you must provide or set the <code>RoleArn</code>: <code>arn:aws:iam::12345:role/my-data-access-role</code>

Access Token Required: API Key

Body Params

RoleArnstring

The identifier for the role that registers the resource.

ResourceArnstringrequired

The Amazon Resource Name (ARN) of the resource that you want to register.

WithFederationboolean

Whether or not the resource is a federated resource.

UseServiceLinkedRoleboolean

Designates an Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. A service-linked role is a unique type of IAM role that is linked directly to Lake Formation. For more information, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/service-linked-roles.html">Using Service-Linked Roles for Lake Formation</a>.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://lakeformation.{region}.amazonaws.com/RegisterResource' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/RegisterResource

http://lakeformation.{region}.amazonaws.com/RegisterResource

Registers the resource as managed by the Data Catalog. To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy. The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location. <code>ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true</code> If <code>UseServiceLinkedRole</code> is not set to true, you must provide or set the <code>RoleArn</code>: <code>arn:aws:iam::12345:role/my-data-access-role</code>

Access Token Required: API Key

Body Params

RoleArnstring

The identifier for the role that registers the resource.

ResourceArnstringrequired

The Amazon Resource Name (ARN) of the resource that you want to register.

WithFederationboolean

Whether or not the resource is a federated resource.

UseServiceLinkedRoleboolean

Designates an Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. A service-linked role is a unique type of IAM role that is linked directly to Lake Formation. For more information, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/service-linked-roles.html">Using Service-Linked Roles for Lake Formation</a>.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://lakeformation.{region}.amazonaws.com/RegisterResource' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}