Skip to content

update_access_policy

update_access_policy(
    access_policy_id: ID,
    access_policy_identity: Identity,
    access_policy_resource: Resource,
    access_policy_permission: Permission,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> UpdateAccessPolicyResponse

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

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

Parameters:

  • access_policy_id (ID) –

    The ID of the access policy.

  • access_policy_identity (Identity) –

    The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.

  • access_policy_resource (Resource) –

    The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

  • access_policy_permission (Permission) –

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

  • client_token (Optional[ClientToken], default: None ) –

    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.

Raises:

  • InternalFailureException –

    IoT SiteWise can't process your request right now. Try again later.

  • InvalidRequestException –

    The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException –

    The requested resource can't be found.

  • ThrottlingException –

    Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

    For more information, see Quotas in the IoT SiteWise User Guide.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_iotsitewise/_services/io_t_site_wise.py
def update_access_policy(
    self,
    access_policy_id: "capo_iotsitewise.types.id.ID",
    access_policy_identity: "capo_iotsitewise.types.identity.Identity",
    access_policy_resource: "capo_iotsitewise.types.resource.Resource",
    access_policy_permission: "capo_iotsitewise.types.permission.Permission",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    client_token: Optional[
        "capo_iotsitewise.types.client_token.ClientToken"
    ] = None,
) -> "capo_iotsitewise.types.update_access_policy_response.UpdateAccessPolicyResponse":
    """<important> <p>The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html">IoT SiteWise Monitor availability change</a>.</p> </important> <p>Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.</p>

    Args:
        access_policy_id: <p>The ID of the access policy.</p>
        access_policy_identity: <p>The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.</p>
        access_policy_resource: <p>The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.</p>
        access_policy_permission: <p>The permission level for this access policy. Note that a project <code>ADMINISTRATOR</code> is also known as a project owner.</p>
        client_token: <p>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.</p>

    Raises:
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.update_access_policy_request.UpdateAccessPolicyRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.update_access_policy_response.UpdateAccessPolicyResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.update_access_policy

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.update_access_policy.update_access_policy(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateAccessPolicy")
    )
    input_: capo_iotsitewise.types.update_access_policy_request.UpdateAccessPolicyRequest = {
        "access_policy_id": access_policy_id,
        "access_policy_identity": access_policy_identity,
        "access_policy_resource": access_policy_resource,
        "access_policy_permission": access_policy_permission,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output