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

Class: Aws::IoT::Types::TestAuthorizationRequest

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

Overview

Note:

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

{
  principal: "Principal",
  cognito_identity_pool_id: "CognitoIdentityPoolId",
  auth_infos: [ # required
    {
      action_type: "PUBLISH", # accepts PUBLISH, SUBSCRIBE, RECEIVE, CONNECT
      resources: ["Resource"],
    },
  ],
  client_id: "ClientId",
  policy_names_to_add: ["PolicyName"],
  policy_names_to_skip: ["PolicyName"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#auth_infosArray<Types::AuthInfo>

A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.

Returns:



7080
7081
7082
7083
7084
7085
7086
7087
7088
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7080

class TestAuthorizationRequest < Struct.new(
  :principal,
  :cognito_identity_pool_id,
  :auth_infos,
  :client_id,
  :policy_names_to_add,
  :policy_names_to_skip)
  include Aws::Structure
end

#client_idString

The MQTT client ID.

Returns:

  • (String)


7080
7081
7082
7083
7084
7085
7086
7087
7088
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7080

class TestAuthorizationRequest < Struct.new(
  :principal,
  :cognito_identity_pool_id,
  :auth_infos,
  :client_id,
  :policy_names_to_add,
  :policy_names_to_skip)
  include Aws::Structure
end

#cognito_identity_pool_idString

The Cognito identity pool ID.

Returns:

  • (String)


7080
7081
7082
7083
7084
7085
7086
7087
7088
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7080

class TestAuthorizationRequest < Struct.new(
  :principal,
  :cognito_identity_pool_id,
  :auth_infos,
  :client_id,
  :policy_names_to_add,
  :policy_names_to_skip)
  include Aws::Structure
end

#policy_names_to_addArray<String>

When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

Returns:

  • (Array<String>)


7080
7081
7082
7083
7084
7085
7086
7087
7088
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7080

class TestAuthorizationRequest < Struct.new(
  :principal,
  :cognito_identity_pool_id,
  :auth_infos,
  :client_id,
  :policy_names_to_add,
  :policy_names_to_skip)
  include Aws::Structure
end

#policy_names_to_skipArray<String>

When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

Returns:

  • (Array<String>)


7080
7081
7082
7083
7084
7085
7086
7087
7088
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7080

class TestAuthorizationRequest < Struct.new(
  :principal,
  :cognito_identity_pool_id,
  :auth_infos,
  :client_id,
  :policy_names_to_add,
  :policy_names_to_skip)
  include Aws::Structure
end

#principalString

The principal.

Returns:

  • (String)


7080
7081
7082
7083
7084
7085
7086
7087
7088
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7080

class TestAuthorizationRequest < Struct.new(
  :principal,
  :cognito_identity_pool_id,
  :auth_infos,
  :client_id,
  :policy_names_to_add,
  :policy_names_to_skip)
  include Aws::Structure
end