com.amazonaws.services.connect.model

Class GetFederationTokenRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.GetFederationTokenRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GetFederationTokenRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Retrieves a token for federation.

This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:

Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetFederationTokenRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getInstanceId() The identifier of the Amazon Connect instance.
int	hashCode()
void	setInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetFederationTokenRequest	withInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetFederationTokenRequest

public GetFederationTokenRequest()

Method Detail

getInstanceId

public java.lang.String getInstanceId()

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

Constraints:
Length: 1 - 100

Returns:

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

setInstanceId

public void setInstanceId(java.lang.String instanceId)

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

Constraints:
Length: 1 - 100

Parameters:

instanceId -

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

withInstanceId

public GetFederationTokenRequest withInstanceId(java.lang.String instanceId)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

instanceId -

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object