Class: Aws::IoTSiteWise::Types::UpdateAccessPolicyRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

Note:

When making an API call, you may pass UpdateAccessPolicyRequest data as a hash:

{
  access_policy_id: "ID", # required
  access_policy_identity: { # required
    user: {
      id: "IdentityId", # required
    },
    group: {
      id: "IdentityId", # required
    },
    iam_user: {
      arn: "ARN", # required
    },
  },
  access_policy_resource: { # required
    portal: {
      id: "ID", # required
    },
    project: {
      id: "ID", # required
    },
  },
  access_policy_permission: "ADMINISTRATOR", # required, accepts ADMINISTRATOR, VIEWER
  client_token: "ClientToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_policy_idString

The ID of the access policy.

Returns:

  • (String)


4743
4744
4745
4746
4747
4748
4749
4750
4751
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4743

class UpdateAccessPolicyRequest < Struct.new(
  :access_policy_id,
  :access_policy_identity,
  :access_policy_resource,
  :access_policy_permission,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#access_policy_identityTypes::Identity

The identity for this access policy. Choose an AWS SSO user, an AWS SSO group, or an IAM user.

Returns:



4743
4744
4745
4746
4747
4748
4749
4750
4751
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4743

class UpdateAccessPolicyRequest < Struct.new(
  :access_policy_id,
  :access_policy_identity,
  :access_policy_resource,
  :access_policy_permission,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#access_policy_permissionString

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

Returns:

  • (String)


4743
4744
4745
4746
4747
4748
4749
4750
4751
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4743

class UpdateAccessPolicyRequest < Struct.new(
  :access_policy_id,
  :access_policy_identity,
  :access_policy_resource,
  :access_policy_permission,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#access_policy_resourceTypes::Resource

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

Returns:



4743
4744
4745
4746
4747
4748
4749
4750
4751
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4743

class UpdateAccessPolicyRequest < Struct.new(
  :access_policy_id,
  :access_policy_identity,
  :access_policy_resource,
  :access_policy_permission,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


4743
4744
4745
4746
4747
4748
4749
4750
4751
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4743

class UpdateAccessPolicyRequest < Struct.new(
  :access_policy_id,
  :access_policy_identity,
  :access_policy_resource,
  :access_policy_permission,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end