You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::WorkDocs::Types::DescribeResourcePermissionsRequest

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

Overview

Note:

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

{
  authentication_token: "AuthenticationHeaderType",
  resource_id: "ResourceIdType", # required
  principal_id: "IdType",
  limit: 1,
  marker: "PageMarkerType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

Returns:

  • (String)


1340
1341
1342
1343
1344
1345
1346
1347
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1340

class DescribeResourcePermissionsRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :principal_id,
  :limit,
  :marker)
  include Aws::Structure
end

#limitInteger

The maximum number of items to return with this call.

Returns:

  • (Integer)


1340
1341
1342
1343
1344
1345
1346
1347
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1340

class DescribeResourcePermissionsRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :principal_id,
  :limit,
  :marker)
  include Aws::Structure
end

#markerString

The marker for the next set of results. (You received this marker from a previous call)

Returns:

  • (String)


1340
1341
1342
1343
1344
1345
1346
1347
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1340

class DescribeResourcePermissionsRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :principal_id,
  :limit,
  :marker)
  include Aws::Structure
end

#principal_idString

The ID of the principal to filter permissions by.

Returns:

  • (String)


1340
1341
1342
1343
1344
1345
1346
1347
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1340

class DescribeResourcePermissionsRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :principal_id,
  :limit,
  :marker)
  include Aws::Structure
end

#resource_idString

The ID of the resource.

Returns:

  • (String)


1340
1341
1342
1343
1344
1345
1346
1347
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1340

class DescribeResourcePermissionsRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :principal_id,
  :limit,
  :marker)
  include Aws::Structure
end