AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
aws.cognito.getUserPoolClients
Explore with Pulumi AI
Use this data source to get a list of Cognito user pools clients for a Cognito IdP user pool.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const main = aws.cognito.getUserPoolClients({
    userPoolId: mainAwsCognitoUserPool.id,
});
import pulumi
import pulumi_aws as aws
main = aws.cognito.get_user_pool_clients(user_pool_id=main_aws_cognito_user_pool["id"])
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cognito"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cognito.GetUserPoolClients(ctx, &cognito.GetUserPoolClientsArgs{
			UserPoolId: mainAwsCognitoUserPool.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() => 
{
    var main = Aws.Cognito.GetUserPoolClients.Invoke(new()
    {
        UserPoolId = mainAwsCognitoUserPool.Id,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cognito.CognitoFunctions;
import com.pulumi.aws.cognito.inputs.GetUserPoolClientsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var main = CognitoFunctions.getUserPoolClients(GetUserPoolClientsArgs.builder()
            .userPoolId(mainAwsCognitoUserPool.id())
            .build());
    }
}
variables:
  main:
    fn::invoke:
      function: aws:cognito:getUserPoolClients
      arguments:
        userPoolId: ${mainAwsCognitoUserPool.id}
Using getUserPoolClients
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getUserPoolClients(args: GetUserPoolClientsArgs, opts?: InvokeOptions): Promise<GetUserPoolClientsResult>
function getUserPoolClientsOutput(args: GetUserPoolClientsOutputArgs, opts?: InvokeOptions): Output<GetUserPoolClientsResult>def get_user_pool_clients(user_pool_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetUserPoolClientsResult
def get_user_pool_clients_output(user_pool_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetUserPoolClientsResult]func GetUserPoolClients(ctx *Context, args *GetUserPoolClientsArgs, opts ...InvokeOption) (*GetUserPoolClientsResult, error)
func GetUserPoolClientsOutput(ctx *Context, args *GetUserPoolClientsOutputArgs, opts ...InvokeOption) GetUserPoolClientsResultOutput> Note: This function is named GetUserPoolClients in the Go SDK.
public static class GetUserPoolClients 
{
    public static Task<GetUserPoolClientsResult> InvokeAsync(GetUserPoolClientsArgs args, InvokeOptions? opts = null)
    public static Output<GetUserPoolClientsResult> Invoke(GetUserPoolClientsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetUserPoolClientsResult> getUserPoolClients(GetUserPoolClientsArgs args, InvokeOptions options)
public static Output<GetUserPoolClientsResult> getUserPoolClients(GetUserPoolClientsArgs args, InvokeOptions options)
fn::invoke:
  function: aws:cognito/getUserPoolClients:getUserPoolClients
  arguments:
    # arguments dictionaryThe following arguments are supported:
- UserPool stringId 
- Cognito user pool ID.
- UserPool stringId 
- Cognito user pool ID.
- userPool StringId 
- Cognito user pool ID.
- userPool stringId 
- Cognito user pool ID.
- user_pool_ strid 
- Cognito user pool ID.
- userPool StringId 
- Cognito user pool ID.
getUserPoolClients Result
The following output properties are available:
- ClientIds List<string>
- List of Cognito user pool client IDs.
- ClientNames List<string>
- List of Cognito user pool client names.
- Id string
- The provider-assigned unique ID for this managed resource.
- UserPool stringId 
- ClientIds []string
- List of Cognito user pool client IDs.
- ClientNames []string
- List of Cognito user pool client names.
- Id string
- The provider-assigned unique ID for this managed resource.
- UserPool stringId 
- clientIds List<String>
- List of Cognito user pool client IDs.
- clientNames List<String>
- List of Cognito user pool client names.
- id String
- The provider-assigned unique ID for this managed resource.
- userPool StringId 
- clientIds string[]
- List of Cognito user pool client IDs.
- clientNames string[]
- List of Cognito user pool client names.
- id string
- The provider-assigned unique ID for this managed resource.
- userPool stringId 
- client_ids Sequence[str]
- List of Cognito user pool client IDs.
- client_names Sequence[str]
- List of Cognito user pool client names.
- id str
- The provider-assigned unique ID for this managed resource.
- user_pool_ strid 
- clientIds List<String>
- List of Cognito user pool client IDs.
- clientNames List<String>
- List of Cognito user pool client names.
- id String
- The provider-assigned unique ID for this managed resource.
- userPool StringId 
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the awsTerraform Provider.