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

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::UpdateAccessPolicyRequest

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
    },
    iam_role: {
      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

SENSITIVE =

[]

Instance Attribute Summary

• #access_policy_id ⇒ String

  The ID of the access policy.

• #access_policy_identity ⇒ Types::Identity

  The identity for this access policy.

• #access_policy_permission ⇒ String

  The permission level for this access policy.

• #access_policy_resource ⇒ Types::Resource

  The IoT SiteWise Monitor resource for this access policy.

• #client_token ⇒ String

  A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.

Instance Attribute Details

#access_policy_id ⇒ String

The ID of the access policy.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6555

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_identity ⇒ Types::Identity

The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user.

Returns:

• (Types::Identity)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6555

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_permission ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6555

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_resource ⇒ Types::Resource

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

Returns:

• (Types::Resource)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6555

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

#client_token ⇒ String

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)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6555

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