Class: Aws::VerifiedPermissions::Types::ContextDefinition

Inherits:
Struct
  • Object
show all
Includes:
Structure, Structure::Union
Defined in:
lib/aws-sdk-verifiedpermissions/types.rb

Overview

Note:

ContextDefinition is a union - when making an API calls you must set exactly one of the members.

Note:

ContextDefinition is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ContextDefinition corresponding to the set member.

Contains additional details about the context of the request. Verified Permissions evaluates this information in an authorization request as part of the ‘when` and `unless` clauses in a policy.

This data type is used as a request parameter for the [IsAuthorized], [BatchIsAuthorized], and

IsAuthorizedWithToken][3

operations.

Example: ‘“context”:“contextMap”:{“<KeyName1>”:{“boolean”:true,“<KeyName2>”:“long”:1234}}`

[1]: docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html [2]: docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html [3]: docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html

See Also:

Direct Known Subclasses

ContextMap, Unknown

Defined Under Namespace

Classes: ContextMap, Unknown

Constant Summary collapse

SENSITIVE = 
[:context_map]

Instance Attribute Summary collapse

Instance Attribute Details

#context_map ⇒ Hash<String,Types::AttributeValue>

An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

Example: ‘“contextMap”:“<KeyName1>”:{“boolean”:true,“<KeyName2>”:“long”:1234}`

Returns:



1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 1034

class ContextDefinition < Struct.new(
  :context_map,
  :unknown)
  SENSITIVE = [:context_map]
  include Aws::Structure
  include Aws::Structure::Union

  class ContextMap < ContextDefinition; end
  class Unknown < ContextDefinition; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



1034
1035
1036
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 1034

def unknown
  @unknown
end