Class: Aws::IoTSiteWise::Types::ListAccessPoliciesRequest

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 ListAccessPoliciesRequest data as a hash:

{
  identity_type: "USER", # accepts USER, GROUP, IAM
  identity_id: "IdentityId",
  resource_type: "PORTAL", # accepts PORTAL, PROJECT
  resource_id: "ID",
  iam_arn: "ARN",
  next_token: "NextToken",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#iam_arnString

The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. This parameter is required if you specify IAM for identityType.

Returns:

  • (String)


3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3426

class ListAccessPoliciesRequest < Struct.new(
  :identity_type,
  :identity_id,
  :resource_type,
  :resource_id,
  :iam_arn,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#identity_idString

The ID of the identity. This parameter is required if you specify USER or GROUP for identityType.

Returns:

  • (String)


3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3426

class ListAccessPoliciesRequest < Struct.new(
  :identity_type,
  :identity_id,
  :resource_type,
  :resource_id,
  :iam_arn,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#identity_typeString

The type of identity (AWS SSO user, AWS SSO group, or IAM user). This parameter is required if you specify identityId.

Returns:

  • (String)


3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3426

class ListAccessPoliciesRequest < Struct.new(
  :identity_type,
  :identity_id,
  :resource_type,
  :resource_id,
  :iam_arn,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to be returned per paginated request.

Default: 50

Returns:

  • (Integer)


3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3426

class ListAccessPoliciesRequest < Struct.new(
  :identity_type,
  :identity_id,
  :resource_type,
  :resource_id,
  :iam_arn,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token to be used for the next set of paginated results.

Returns:

  • (String)


3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3426

class ListAccessPoliciesRequest < Struct.new(
  :identity_type,
  :identity_id,
  :resource_type,
  :resource_id,
  :iam_arn,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#resource_idString

The ID of the resource. This parameter is required if you specify resourceType.

Returns:

  • (String)


3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3426

class ListAccessPoliciesRequest < Struct.new(
  :identity_type,
  :identity_id,
  :resource_type,
  :resource_id,
  :iam_arn,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#resource_typeString

The type of resource (portal or project). This parameter is required if you specify resourceId.

Returns:

  • (String)


3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3426

class ListAccessPoliciesRequest < Struct.new(
  :identity_type,
  :identity_id,
  :resource_type,
  :resource_id,
  :iam_arn,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end