Interface SigninAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface SigninAsyncClient extends AwsClient
Service client for accessing AWS Sign-In Service asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

AWS Sign-In manages authentication for AWS services. It implements OAuth 2.0, providing secure token exchange and refresh capabilities.

  • Field Details

  • Method Details

    • createOAuth2Token

      default CompletableFuture<CreateOAuth2TokenResponse> createOAuth2Token(CreateOAuth2TokenRequest createOAuth2TokenRequest)

      Exchanges an authorization code or refresh token for an OAuth 2.0 access token and refresh token.

      Parameters:
      createOAuth2TokenRequest - Input structure for CreateOAuth2Token operation

      Contains flattened token operation inputs for both authorization code and refresh token flows. The operation type is determined by the grant_type parameter in the request body.

      Returns:
      A Java Future containing the result of the CreateOAuth2Token operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createOAuth2Token

      default CompletableFuture<CreateOAuth2TokenResponse> createOAuth2Token(Consumer<CreateOAuth2TokenRequest.Builder> createOAuth2TokenRequest)

      Exchanges an authorization code or refresh token for an OAuth 2.0 access token and refresh token.


      This is a convenience which creates an instance of the CreateOAuth2TokenRequest.Builder avoiding the need to create one manually via CreateOAuth2TokenRequest.builder()

      Parameters:
      createOAuth2TokenRequest - A Consumer that will call methods on CreateOAuth2TokenRequest.Builder to create a request. Input structure for CreateOAuth2Token operation

      Contains flattened token operation inputs for both authorization code and refresh token flows. The operation type is determined by the grant_type parameter in the request body.

      Returns:
      A Java Future containing the result of the CreateOAuth2Token operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createOAuth2TokenWithIAM

      default CompletableFuture<CreateOAuth2TokenWithIamResponse> createOAuth2TokenWithIAM(CreateOAuth2TokenWithIamRequest createOAuth2TokenWithIamRequest)

      Exchanges client credentials for an OAuth 2.0 access token scoped to a resource, which you can use to access AWS services from applications.

      Parameters:
      createOAuth2TokenWithIamRequest - Input structure for CreateOAuth2TokenWithIAM operation
      Returns:
      A Java Future containing the result of the CreateOAuth2TokenWithIAM operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createOAuth2TokenWithIAM

      default CompletableFuture<CreateOAuth2TokenWithIamResponse> createOAuth2TokenWithIAM(Consumer<CreateOAuth2TokenWithIamRequest.Builder> createOAuth2TokenWithIamRequest)

      Exchanges client credentials for an OAuth 2.0 access token scoped to a resource, which you can use to access AWS services from applications.


      This is a convenience which creates an instance of the CreateOAuth2TokenWithIamRequest.Builder avoiding the need to create one manually via CreateOAuth2TokenWithIamRequest.builder()

      Parameters:
      createOAuth2TokenWithIamRequest - A Consumer that will call methods on CreateOAuth2TokenWithIamRequest.Builder to create a request. Input structure for CreateOAuth2TokenWithIAM operation
      Returns:
      A Java Future containing the result of the CreateOAuth2TokenWithIAM operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createOAuth2TokenWithTokenExchange

      default CompletableFuture<CreateOAuth2TokenWithTokenExchangeResponse> createOAuth2TokenWithTokenExchange(CreateOAuth2TokenWithTokenExchangeRequest createOAuth2TokenWithTokenExchangeRequest)

      Exchanges a supported token for an OAuth 2.0 access token scoped to a resource, which you can use to access AWS services from applications.

      Parameters:
      createOAuth2TokenWithTokenExchangeRequest - Input structure for CreateOAuth2TokenWithTokenExchange operation
      Returns:
      A Java Future containing the result of the CreateOAuth2TokenWithTokenExchange operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidGrantException The request failed because the provided grant is invalid or expired.
      • InvalidScopeException The request failed because the requested scope is invalid or exceeds the scope that can be granted.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ServiceUnavailableException The request failed because a dependency is temporarily unavailable. You can retry the request.
      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createOAuth2TokenWithTokenExchange

      default CompletableFuture<CreateOAuth2TokenWithTokenExchangeResponse> createOAuth2TokenWithTokenExchange(Consumer<CreateOAuth2TokenWithTokenExchangeRequest.Builder> createOAuth2TokenWithTokenExchangeRequest)

      Exchanges a supported token for an OAuth 2.0 access token scoped to a resource, which you can use to access AWS services from applications.


      This is a convenience which creates an instance of the CreateOAuth2TokenWithTokenExchangeRequest.Builder avoiding the need to create one manually via CreateOAuth2TokenWithTokenExchangeRequest.builder()

      Parameters:
      createOAuth2TokenWithTokenExchangeRequest - A Consumer that will call methods on CreateOAuth2TokenWithTokenExchangeRequest.Builder to create a request. Input structure for CreateOAuth2TokenWithTokenExchange operation
      Returns:
      A Java Future containing the result of the CreateOAuth2TokenWithTokenExchange operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidGrantException The request failed because the provided grant is invalid or expired.
      • InvalidScopeException The request failed because the requested scope is invalid or exceeds the scope that can be granted.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ServiceUnavailableException The request failed because a dependency is temporarily unavailable. You can retry the request.
      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConsoleAuthorizationConfiguration

      default CompletableFuture<DeleteConsoleAuthorizationConfigurationResponse> deleteConsoleAuthorizationConfiguration(DeleteConsoleAuthorizationConfigurationRequest deleteConsoleAuthorizationConfigurationRequest)

      Delete console authorization configuration with automatic scope detection

      Parameters:
      deleteConsoleAuthorizationConfigurationRequest - Input for DeleteConsoleAuthorizationConfiguration operation
      Returns:
      A Java Future containing the result of the DeleteConsoleAuthorizationConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ResourceNotFoundException Error thrown when requested resource is not found

        HTTP Status Code: 404 Not Found

        Used when the specified resource does not exist

      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConsoleAuthorizationConfiguration

      default CompletableFuture<DeleteConsoleAuthorizationConfigurationResponse> deleteConsoleAuthorizationConfiguration(Consumer<DeleteConsoleAuthorizationConfigurationRequest.Builder> deleteConsoleAuthorizationConfigurationRequest)

      Delete console authorization configuration with automatic scope detection


      This is a convenience which creates an instance of the DeleteConsoleAuthorizationConfigurationRequest.Builder avoiding the need to create one manually via DeleteConsoleAuthorizationConfigurationRequest.builder()

      Parameters:
      deleteConsoleAuthorizationConfigurationRequest - A Consumer that will call methods on DeleteConsoleAuthorizationConfigurationRequest.Builder to create a request. Input for DeleteConsoleAuthorizationConfiguration operation
      Returns:
      A Java Future containing the result of the DeleteConsoleAuthorizationConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ResourceNotFoundException Error thrown when requested resource is not found

        HTTP Status Code: 404 Not Found

        Used when the specified resource does not exist

      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteResourcePermissionStatement

      default CompletableFuture<DeleteResourcePermissionStatementResponse> deleteResourcePermissionStatement(DeleteResourcePermissionStatementRequest deleteResourcePermissionStatementRequest)

      Remove a permission statement from the account's SignIn resource-based policy

      Parameters:
      deleteResourcePermissionStatementRequest - Input for DeleteResourcePermissionStatement operation
      Returns:
      A Java Future containing the result of the DeleteResourcePermissionStatement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ResourceNotFoundException Error thrown when requested resource is not found

        HTTP Status Code: 404 Not Found

        Used when the specified resource does not exist

      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteResourcePermissionStatement

      default CompletableFuture<DeleteResourcePermissionStatementResponse> deleteResourcePermissionStatement(Consumer<DeleteResourcePermissionStatementRequest.Builder> deleteResourcePermissionStatementRequest)

      Remove a permission statement from the account's SignIn resource-based policy


      This is a convenience which creates an instance of the DeleteResourcePermissionStatementRequest.Builder avoiding the need to create one manually via DeleteResourcePermissionStatementRequest.builder()

      Parameters:
      deleteResourcePermissionStatementRequest - A Consumer that will call methods on DeleteResourcePermissionStatementRequest.Builder to create a request. Input for DeleteResourcePermissionStatement operation
      Returns:
      A Java Future containing the result of the DeleteResourcePermissionStatement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ResourceNotFoundException Error thrown when requested resource is not found

        HTTP Status Code: 404 Not Found

        Used when the specified resource does not exist

      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getConsoleAuthorizationConfiguration

      default CompletableFuture<GetConsoleAuthorizationConfigurationResponse> getConsoleAuthorizationConfiguration(GetConsoleAuthorizationConfigurationRequest getConsoleAuthorizationConfigurationRequest)

      Get console authorization configuration with automatic scope detection

      Parameters:
      getConsoleAuthorizationConfigurationRequest - Input for GetConsoleAuthorizationConfiguration operation
      Returns:
      A Java Future containing the result of the GetConsoleAuthorizationConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ResourceNotFoundException Error thrown when requested resource is not found

        HTTP Status Code: 404 Not Found

        Used when the specified resource does not exist

      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getConsoleAuthorizationConfiguration

      default CompletableFuture<GetConsoleAuthorizationConfigurationResponse> getConsoleAuthorizationConfiguration(Consumer<GetConsoleAuthorizationConfigurationRequest.Builder> getConsoleAuthorizationConfigurationRequest)

      Get console authorization configuration with automatic scope detection


      This is a convenience which creates an instance of the GetConsoleAuthorizationConfigurationRequest.Builder avoiding the need to create one manually via GetConsoleAuthorizationConfigurationRequest.builder()

      Parameters:
      getConsoleAuthorizationConfigurationRequest - A Consumer that will call methods on GetConsoleAuthorizationConfigurationRequest.Builder to create a request. Input for GetConsoleAuthorizationConfiguration operation
      Returns:
      A Java Future containing the result of the GetConsoleAuthorizationConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ResourceNotFoundException Error thrown when requested resource is not found

        HTTP Status Code: 404 Not Found

        Used when the specified resource does not exist

      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourcePolicy

      default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)

      Retrieve the account's consolidated SignIn resource-based policy

      Parameters:
      getResourcePolicyRequest - Input for GetResourcePolicy operation
      Returns:
      A Java Future containing the result of the GetResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ResourceNotFoundException Error thrown when requested resource is not found

        HTTP Status Code: 404 Not Found

        Used when the specified resource does not exist

      • InternalServerException The request failed because of an internal server error.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourcePolicy

      default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)

      Retrieve the account's consolidated SignIn resource-based policy


      This is a convenience which creates an instance of the GetResourcePolicyRequest.Builder avoiding the need to create one manually via GetResourcePolicyRequest.builder()

      Parameters:
      getResourcePolicyRequest - A Consumer that will call methods on GetResourcePolicyRequest.Builder to create a request. Input for GetResourcePolicy operation
      Returns:
      A Java Future containing the result of the GetResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ResourceNotFoundException Error thrown when requested resource is not found

        HTTP Status Code: 404 Not Found

        Used when the specified resource does not exist

      • InternalServerException The request failed because of an internal server error.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • introspectOAuth2TokenWithIAM

      default CompletableFuture<IntrospectOAuth2TokenWithIamResponse> introspectOAuth2TokenWithIAM(IntrospectOAuth2TokenWithIamRequest introspectOAuth2TokenWithIamRequest)

      Inspects the metadata and active state of an OAuth 2.0 access token or refresh token.

      Implements RFC 7662 OAuth 2.0 Token Introspection over a SigV4-authenticated endpoint. Returns the claims associated with a token issued by AWS Sign-In.

      Parameters:
      introspectOAuth2TokenWithIamRequest - Input structure for IntrospectOAuth2TokenWithIAM operation

      RFC 7662 §2.1 introspection request. Contains the token to inspect and an optional hint about the token's type.

      Returns:
      A Java Future containing the result of the IntrospectOAuth2TokenWithIAM operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • introspectOAuth2TokenWithIAM

      default CompletableFuture<IntrospectOAuth2TokenWithIamResponse> introspectOAuth2TokenWithIAM(Consumer<IntrospectOAuth2TokenWithIamRequest.Builder> introspectOAuth2TokenWithIamRequest)

      Inspects the metadata and active state of an OAuth 2.0 access token or refresh token.

      Implements RFC 7662 OAuth 2.0 Token Introspection over a SigV4-authenticated endpoint. Returns the claims associated with a token issued by AWS Sign-In.


      This is a convenience which creates an instance of the IntrospectOAuth2TokenWithIamRequest.Builder avoiding the need to create one manually via IntrospectOAuth2TokenWithIamRequest.builder()

      Parameters:
      introspectOAuth2TokenWithIamRequest - A Consumer that will call methods on IntrospectOAuth2TokenWithIamRequest.Builder to create a request. Input structure for IntrospectOAuth2TokenWithIAM operation

      RFC 7662 §2.1 introspection request. Contains the token to inspect and an optional hint about the token's type.

      Returns:
      A Java Future containing the result of the IntrospectOAuth2TokenWithIAM operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourcePermissionStatements

      default CompletableFuture<ListResourcePermissionStatementsResponse> listResourcePermissionStatements(ListResourcePermissionStatementsRequest listResourcePermissionStatementsRequest)

      Retrieve all permission statements in the account's SignIn resource-based policy

      Parameters:
      listResourcePermissionStatementsRequest - Input for ListResourcePermissionStatements operation
      Returns:
      A Java Future containing the result of the ListResourcePermissionStatements operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ResourceNotFoundException Error thrown when requested resource is not found

        HTTP Status Code: 404 Not Found

        Used when the specified resource does not exist

      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourcePermissionStatements

      default CompletableFuture<ListResourcePermissionStatementsResponse> listResourcePermissionStatements(Consumer<ListResourcePermissionStatementsRequest.Builder> listResourcePermissionStatementsRequest)

      Retrieve all permission statements in the account's SignIn resource-based policy


      This is a convenience which creates an instance of the ListResourcePermissionStatementsRequest.Builder avoiding the need to create one manually via ListResourcePermissionStatementsRequest.builder()

      Parameters:
      listResourcePermissionStatementsRequest - A Consumer that will call methods on ListResourcePermissionStatementsRequest.Builder to create a request. Input for ListResourcePermissionStatements operation
      Returns:
      A Java Future containing the result of the ListResourcePermissionStatements operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ResourceNotFoundException Error thrown when requested resource is not found

        HTTP Status Code: 404 Not Found

        Used when the specified resource does not exist

      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourcePermissionStatementsPaginator

      default ListResourcePermissionStatementsPublisher listResourcePermissionStatementsPaginator(ListResourcePermissionStatementsRequest listResourcePermissionStatementsRequest)

      This is a variant of listResourcePermissionStatements(software.amazon.awssdk.services.signin.model.ListResourcePermissionStatementsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.signin.paginators.ListResourcePermissionStatementsPublisher publisher = client.listResourcePermissionStatementsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.signin.paginators.ListResourcePermissionStatementsPublisher publisher = client.listResourcePermissionStatementsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.signin.model.ListResourcePermissionStatementsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.signin.model.ListResourcePermissionStatementsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listResourcePermissionStatements(software.amazon.awssdk.services.signin.model.ListResourcePermissionStatementsRequest) operation.

      Parameters:
      listResourcePermissionStatementsRequest - Input for ListResourcePermissionStatements operation
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ResourceNotFoundException Error thrown when requested resource is not found

        HTTP Status Code: 404 Not Found

        Used when the specified resource does not exist

      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourcePermissionStatementsPaginator

      default ListResourcePermissionStatementsPublisher listResourcePermissionStatementsPaginator(Consumer<ListResourcePermissionStatementsRequest.Builder> listResourcePermissionStatementsRequest)

      This is a variant of listResourcePermissionStatements(software.amazon.awssdk.services.signin.model.ListResourcePermissionStatementsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.signin.paginators.ListResourcePermissionStatementsPublisher publisher = client.listResourcePermissionStatementsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.signin.paginators.ListResourcePermissionStatementsPublisher publisher = client.listResourcePermissionStatementsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.signin.model.ListResourcePermissionStatementsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.signin.model.ListResourcePermissionStatementsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listResourcePermissionStatements(software.amazon.awssdk.services.signin.model.ListResourcePermissionStatementsRequest) operation.


      This is a convenience which creates an instance of the ListResourcePermissionStatementsRequest.Builder avoiding the need to create one manually via ListResourcePermissionStatementsRequest.builder()

      Parameters:
      listResourcePermissionStatementsRequest - A Consumer that will call methods on ListResourcePermissionStatementsRequest.Builder to create a request. Input for ListResourcePermissionStatements operation
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ResourceNotFoundException Error thrown when requested resource is not found

        HTTP Status Code: 404 Not Found

        Used when the specified resource does not exist

      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putConsoleAuthorizationConfiguration

      default CompletableFuture<PutConsoleAuthorizationConfigurationResponse> putConsoleAuthorizationConfiguration(PutConsoleAuthorizationConfigurationRequest putConsoleAuthorizationConfigurationRequest)

      Enable console authorization configuration with automatic scope detection

      Parameters:
      putConsoleAuthorizationConfigurationRequest - Input for PutConsoleAuthorizationConfiguration operation
      Returns:
      A Java Future containing the result of the PutConsoleAuthorizationConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ConflictException Error thrown when request conflicts with current state

        HTTP Status Code: 409 Conflict

        Used when the request conflicts with the current state of the resource

      • ResourceNotFoundException Error thrown when requested resource is not found

        HTTP Status Code: 404 Not Found

        Used when the specified resource does not exist

      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putConsoleAuthorizationConfiguration

      default CompletableFuture<PutConsoleAuthorizationConfigurationResponse> putConsoleAuthorizationConfiguration(Consumer<PutConsoleAuthorizationConfigurationRequest.Builder> putConsoleAuthorizationConfigurationRequest)

      Enable console authorization configuration with automatic scope detection


      This is a convenience which creates an instance of the PutConsoleAuthorizationConfigurationRequest.Builder avoiding the need to create one manually via PutConsoleAuthorizationConfigurationRequest.builder()

      Parameters:
      putConsoleAuthorizationConfigurationRequest - A Consumer that will call methods on PutConsoleAuthorizationConfigurationRequest.Builder to create a request. Input for PutConsoleAuthorizationConfiguration operation
      Returns:
      A Java Future containing the result of the PutConsoleAuthorizationConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ConflictException Error thrown when request conflicts with current state

        HTTP Status Code: 409 Conflict

        Used when the request conflicts with the current state of the resource

      • ResourceNotFoundException Error thrown when requested resource is not found

        HTTP Status Code: 404 Not Found

        Used when the specified resource does not exist

      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putResourcePermissionStatement

      default CompletableFuture<PutResourcePermissionStatementResponse> putResourcePermissionStatement(PutResourcePermissionStatementRequest putResourcePermissionStatementRequest)

      Create a permission statement in the account's SignIn resource-based policy

      Parameters:
      putResourcePermissionStatementRequest - Input for PutResourcePermissionStatement operation
      Returns:
      A Java Future containing the result of the PutResourcePermissionStatement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ConflictException Error thrown when request conflicts with current state

        HTTP Status Code: 409 Conflict

        Used when the request conflicts with the current state of the resource

      • ServiceQuotaExceededException Error thrown when service quota is exceeded

        HTTP Status Code: 402 Payment Required (used as quota exceeded indicator)

        Used when the request would cause a service quota to be exceeded

      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putResourcePermissionStatement

      default CompletableFuture<PutResourcePermissionStatementResponse> putResourcePermissionStatement(Consumer<PutResourcePermissionStatementRequest.Builder> putResourcePermissionStatementRequest)

      Create a permission statement in the account's SignIn resource-based policy


      This is a convenience which creates an instance of the PutResourcePermissionStatementRequest.Builder avoiding the need to create one manually via PutResourcePermissionStatementRequest.builder()

      Parameters:
      putResourcePermissionStatementRequest - A Consumer that will call methods on PutResourcePermissionStatementRequest.Builder to create a request. Input for PutResourcePermissionStatement operation
      Returns:
      A Java Future containing the result of the PutResourcePermissionStatement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • ConflictException Error thrown when request conflicts with current state

        HTTP Status Code: 409 Conflict

        Used when the request conflicts with the current state of the resource

      • ServiceQuotaExceededException Error thrown when service quota is exceeded

        HTTP Status Code: 402 Payment Required (used as quota exceeded indicator)

        Used when the request would cause a service quota to be exceeded

      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • revokeOAuth2TokenWithIAM

      default CompletableFuture<RevokeOAuth2TokenWithIamResponse> revokeOAuth2TokenWithIAM(RevokeOAuth2TokenWithIamRequest revokeOAuth2TokenWithIamRequest)

      Revokes an OAuth 2.0 refresh token and its associated token chain.

      Parameters:
      revokeOAuth2TokenWithIamRequest - Input structure for RevokeOAuth2TokenWithIAM operation

      RFC 7009 §2.1 revocation request. Contains the refresh_token to revoke.

      Returns:
      A Java Future containing the result of the RevokeOAuth2TokenWithIAM operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • revokeOAuth2TokenWithIAM

      default CompletableFuture<RevokeOAuth2TokenWithIamResponse> revokeOAuth2TokenWithIAM(Consumer<RevokeOAuth2TokenWithIamRequest.Builder> revokeOAuth2TokenWithIamRequest)

      Revokes an OAuth 2.0 refresh token and its associated token chain.


      This is a convenience which creates an instance of the RevokeOAuth2TokenWithIamRequest.Builder avoiding the need to create one manually via RevokeOAuth2TokenWithIamRequest.builder()

      Parameters:
      revokeOAuth2TokenWithIamRequest - A Consumer that will call methods on RevokeOAuth2TokenWithIamRequest.Builder to create a request. Input structure for RevokeOAuth2TokenWithIAM operation

      RFC 7009 §2.1 revocation request. Contains the refresh_token to revoke.

      Returns:
      A Java Future containing the result of the RevokeOAuth2TokenWithIAM operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyRequestsErrorException The request failed because you exceeded the request rate limit for this operation.
      • InternalServerException The request failed because of an internal server error.
      • ValidationException The request failed because it contains a malformed, missing, or invalid parameter.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SigninException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default SigninServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static SigninAsyncClient create()
      Create a SigninAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static SigninAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SigninAsyncClient.