Class: Aws::Connect::Types::UpdateParticipantAuthenticationRequest

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::UpdateParticipantAuthenticationRequest

Includes:

Structure

Defined in:

lib/aws-sdk-connect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:code, :error, :error_description]

Instance Attribute Summary

• #code ⇒ String

  The ‘code` query parameter provided by Cognito in the `redirectUri`.

• #error ⇒ String

  The ‘error` query parameter provided by Cognito in the `redirectUri`.

• #error_description ⇒ String

  The ‘error_description` parameter provided by Cognito in the `redirectUri`.

• #instance_id ⇒ String

  The identifier of the Amazon Connect instance.

• #state ⇒ String

  The ‘state` query parameter that was provided by Cognito in the `redirectUri`.

Instance Attribute Details

#code ⇒ String

The ‘code` query parameter provided by Cognito in the `redirectUri`.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 25013

class UpdateParticipantAuthenticationRequest < Struct.new(
  :state,
  :instance_id,
  :code,
  :error,
  :error_description)
  SENSITIVE = [:code, :error, :error_description]
  include Aws::Structure
end

#error ⇒ String

The ‘error` query parameter provided by Cognito in the `redirectUri`.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 25013

class UpdateParticipantAuthenticationRequest < Struct.new(
  :state,
  :instance_id,
  :code,
  :error,
  :error_description)
  SENSITIVE = [:code, :error, :error_description]
  include Aws::Structure
end

#error_description ⇒ String

The ‘error_description` parameter provided by Cognito in the `redirectUri`.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 25013

class UpdateParticipantAuthenticationRequest < Struct.new(
  :state,
  :instance_id,
  :code,
  :error,
  :error_description)
  SENSITIVE = [:code, :error, :error_description]
  include Aws::Structure
end

#instance_id ⇒ String

The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource Name (ARN) of the instance.

[1]: docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 25013

class UpdateParticipantAuthenticationRequest < Struct.new(
  :state,
  :instance_id,
  :code,
  :error,
  :error_description)
  SENSITIVE = [:code, :error, :error_description]
  include Aws::Structure
end

#state ⇒ String

The ‘state` query parameter that was provided by Cognito in the `redirectUri`. This will also match the `state` parameter provided in the `AuthenticationUrl` from the [GetAuthenticationUrl] response.

[1]: docs.aws.amazon.com/connect/latest/APIReference/API_GetAuthenticationUrl.html

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 25013

class UpdateParticipantAuthenticationRequest < Struct.new(
  :state,
  :instance_id,
  :code,
  :error,
  :error_description)
  SENSITIVE = [:code, :error, :error_description]
  include Aws::Structure
end