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

Class: Aws::CognitoIdentityProvider::Types::AdminGetDeviceRequest

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

Overview

Note:

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

{
  device_key: "DeviceKeyType", # required
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
}

Represents the request to get the device, as an administrator.

Instance Attribute Summary collapse

Instance Attribute Details

#device_keyString

The device key.

Returns:

  • (String)


696
697
698
699
700
701
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 696

class AdminGetDeviceRequest < Struct.new(
  :device_key,
  :user_pool_id,
  :username)
  include Aws::Structure
end

#user_pool_idString

The user pool ID.

Returns:

  • (String)


696
697
698
699
700
701
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 696

class AdminGetDeviceRequest < Struct.new(
  :device_key,
  :user_pool_id,
  :username)
  include Aws::Structure
end

#usernameString

The user name.

Returns:

  • (String)


696
697
698
699
700
701
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 696

class AdminGetDeviceRequest < Struct.new(
  :device_key,
  :user_pool_id,
  :username)
  include Aws::Structure
end