Class: Aws::Connect::Types::Credentials

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

Overview

Contains credentials to use for federation.

See Also:

Constant Summary collapse

SENSITIVE = 
[:access_token, :refresh_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

An access token generated for a federated user to access Amazon Connect.

Returns:

  • (String) 


5455
5456
5457
5458
5459
5460
5461
5462
 
# File 'lib/aws-sdk-connect/types.rb', line 5455

class Credentials < Struct.new(
  :access_token,
  :access_token_expiration,
  :refresh_token,
  :refresh_token_expiration)
  SENSITIVE = [:access_token, :refresh_token]
  include Aws::Structure
end

#access_token_expiration ⇒ Time

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

Returns:

  • (Time) 


5455
5456
5457
5458
5459
5460
5461
5462
 
# File 'lib/aws-sdk-connect/types.rb', line 5455

class Credentials < Struct.new(
  :access_token,
  :access_token_expiration,
  :refresh_token,
  :refresh_token_expiration)
  SENSITIVE = [:access_token, :refresh_token]
  include Aws::Structure
end

#refresh_token ⇒ String

Renews a token generated for a user to access the Amazon Connect instance.

Returns:

  • (String) 


5455
5456
5457
5458
5459
5460
5461
5462
 
# File 'lib/aws-sdk-connect/types.rb', line 5455

class Credentials < Struct.new(
  :access_token,
  :access_token_expiration,
  :refresh_token,
  :refresh_token_expiration)
  SENSITIVE = [:access_token, :refresh_token]
  include Aws::Structure
end

#refresh_token_expiration ⇒ Time

Renews the expiration timer for a generated token.

Returns:

  • (Time) 


5455
5456
5457
5458
5459
5460
5461
5462
 
# File 'lib/aws-sdk-connect/types.rb', line 5455

class Credentials < Struct.new(
  :access_token,
  :access_token_expiration,
  :refresh_token,
  :refresh_token_expiration)
  SENSITIVE = [:access_token, :refresh_token]
  include Aws::Structure
end