Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-connect/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) 

5608
5609
5610
5611
5612
5613
5614
5615
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 5608

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) 

5608
5609
5610
5611
5612
5613
5614
5615
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 5608

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) 

5608
5609
5610
5611
5612
5613
5614
5615
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 5608

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) 

5608
5609
5610
5611
5612
5613
5614
5615
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 5608

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