PUT

/access-policies/{accessPolicyId}

http://iotsitewise.{region}.amazonaws.com/access-policies/{accessPolicyId}

Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.

Access Token Required: API Key

Path Parameters

accessPolicyIdstringrequired

The ID of the access policy.

Body Params

clientTokenstring

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

accessPolicyIdentityobjectrequired

<p>Contains an identity that can access an IoT SiteWise Monitor resource.</p> <note> <p>Currently, you can't use Amazon Web Services APIs to retrieve IAM Identity Center identity IDs. You can find the IAM Identity Center identity IDs in the URL of user and group pages in the <a href="https://console.aws.amazon.com/singlesignon">IAM Identity Center console</a>.</p> </note>

accessPolicyResourceobjectrequired

Contains an IoT SiteWise Monitor resource ID for a portal or project.

accessPolicyPermissionstringrequired

The permission level for this access policy. Note that a project <code>ADMINISTRATOR</code> is also known as a project owner.

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 PUT \
2     --url 'http://iotsitewise.{region}.amazonaws.com/access-policies/{accessPolicyId}' \
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}

PUT