1. Packages
  2. Packages
  3. AWS
  4. API Docs
  5. opensearch
  6. getServerlessCollectionGroups
Viewing docs for AWS v7.28.0
published on Thursday, Apr 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.opensearch.getServerlessCollectionGroups

aws logo
Viewing docs for AWS v7.28.0
published on Thursday, Apr 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Data source for listing AWS OpenSearch Serverless Collection Groups.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.opensearch.getServerlessCollectionGroups({});

    import pulumi
import pulumi_aws as aws

example = aws.opensearch.get_serverless_collection_groups()

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/opensearch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := opensearch.GetServerlessCollectionGroups(ctx, &opensearch.GetServerlessCollectionGroupsArgs{}, 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 example = Aws.OpenSearch.GetServerlessCollectionGroups.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.opensearch.OpensearchFunctions;
import com.pulumi.aws.opensearch.inputs.GetServerlessCollectionGroupsArgs;
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 example = OpensearchFunctions.getServerlessCollectionGroups(GetServerlessCollectionGroupsArgs.builder()
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:opensearch:getServerlessCollectionGroups
      arguments: {}

    Using getServerlessCollectionGroups

    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 getServerlessCollectionGroups(args: GetServerlessCollectionGroupsArgs, opts?: InvokeOptions): Promise<GetServerlessCollectionGroupsResult>
function getServerlessCollectionGroupsOutput(args: GetServerlessCollectionGroupsOutputArgs, opts?: InvokeOptions): Output<GetServerlessCollectionGroupsResult>
    def get_serverless_collection_groups(region: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetServerlessCollectionGroupsResult
def get_serverless_collection_groups_output(region: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetServerlessCollectionGroupsResult]
    func GetServerlessCollectionGroups(ctx *Context, args *GetServerlessCollectionGroupsArgs, opts ...InvokeOption) (*GetServerlessCollectionGroupsResult, error)
func GetServerlessCollectionGroupsOutput(ctx *Context, args *GetServerlessCollectionGroupsOutputArgs, opts ...InvokeOption) GetServerlessCollectionGroupsResultOutput

    > Note: This function is named GetServerlessCollectionGroups in the Go SDK.

    public static class GetServerlessCollectionGroups 
{
    public static Task<GetServerlessCollectionGroupsResult> InvokeAsync(GetServerlessCollectionGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetServerlessCollectionGroupsResult> Invoke(GetServerlessCollectionGroupsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServerlessCollectionGroupsResult> getServerlessCollectionGroups(GetServerlessCollectionGroupsArgs args, InvokeOptions options)
public static Output<GetServerlessCollectionGroupsResult> getServerlessCollectionGroups(GetServerlessCollectionGroupsArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:opensearch/getServerlessCollectionGroups:getServerlessCollectionGroups
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    getServerlessCollectionGroups Result

    The following output properties are available:

    CollectionGroupSummaries List<GetServerlessCollectionGroupsCollectionGroupSummary>
    List of collection group summary objects. See collectionGroupSummaries below for details.
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    CollectionGroupSummaries []GetServerlessCollectionGroupsCollectionGroupSummary
    List of collection group summary objects. See collectionGroupSummaries below for details.
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    collectionGroupSummaries List<GetServerlessCollectionGroupsCollectionGroupSummary>
    List of collection group summary objects. See collectionGroupSummaries below for details.
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    collectionGroupSummaries GetServerlessCollectionGroupsCollectionGroupSummary[]
    List of collection group summary objects. See collectionGroupSummaries below for details.
    id string
    The provider-assigned unique ID for this managed resource.
    region string
    collection_group_summaries Sequence[GetServerlessCollectionGroupsCollectionGroupSummary]
    List of collection group summary objects. See collectionGroupSummaries below for details.
    id str
    The provider-assigned unique ID for this managed resource.
    region str
    collectionGroupSummaries List<Property Map>
    List of collection group summary objects. See collectionGroupSummaries below for details.
    id String
    The provider-assigned unique ID for this managed resource.
    region String

    Supporting Types

    GetServerlessCollectionGroupsCollectionGroupSummary

    Arn string
    Amazon Resource Name (ARN) of the collection group.
    CapacityLimits List<GetServerlessCollectionGroupsCollectionGroupSummaryCapacityLimit>
    Capacity limits configured for the collection group. See capacityLimits below for details.
    CreatedDate string
    Epoch time, in milliseconds, when the collection group was created.
    Id string
    Unique identifier for the collection group.
    Name string
    Name of the collection group.
    NumberOfCollections int
    Number of collections currently associated with the collection group.
    StandbyReplicas string
    Indicates whether standby replicas are used for collections in the group.
    Arn string
    Amazon Resource Name (ARN) of the collection group.
    CapacityLimits []GetServerlessCollectionGroupsCollectionGroupSummaryCapacityLimit
    Capacity limits configured for the collection group. See capacityLimits below for details.
    CreatedDate string
    Epoch time, in milliseconds, when the collection group was created.
    Id string
    Unique identifier for the collection group.
    Name string
    Name of the collection group.
    NumberOfCollections int
    Number of collections currently associated with the collection group.
    StandbyReplicas string
    Indicates whether standby replicas are used for collections in the group.
    arn String
    Amazon Resource Name (ARN) of the collection group.
    capacityLimits List<GetServerlessCollectionGroupsCollectionGroupSummaryCapacityLimit>
    Capacity limits configured for the collection group. See capacityLimits below for details.
    createdDate String
    Epoch time, in milliseconds, when the collection group was created.
    id String
    Unique identifier for the collection group.
    name String
    Name of the collection group.
    numberOfCollections Integer
    Number of collections currently associated with the collection group.
    standbyReplicas String
    Indicates whether standby replicas are used for collections in the group.
    arn string
    Amazon Resource Name (ARN) of the collection group.
    capacityLimits GetServerlessCollectionGroupsCollectionGroupSummaryCapacityLimit[]
    Capacity limits configured for the collection group. See capacityLimits below for details.
    createdDate string
    Epoch time, in milliseconds, when the collection group was created.
    id string
    Unique identifier for the collection group.
    name string
    Name of the collection group.
    numberOfCollections number
    Number of collections currently associated with the collection group.
    standbyReplicas string
    Indicates whether standby replicas are used for collections in the group.
    arn str
    Amazon Resource Name (ARN) of the collection group.
    capacity_limits Sequence[GetServerlessCollectionGroupsCollectionGroupSummaryCapacityLimit]
    Capacity limits configured for the collection group. See capacityLimits below for details.
    created_date str
    Epoch time, in milliseconds, when the collection group was created.
    id str
    Unique identifier for the collection group.
    name str
    Name of the collection group.
    number_of_collections int
    Number of collections currently associated with the collection group.
    standby_replicas str
    Indicates whether standby replicas are used for collections in the group.
    arn String
    Amazon Resource Name (ARN) of the collection group.
    capacityLimits List<Property Map>
    Capacity limits configured for the collection group. See capacityLimits below for details.
    createdDate String
    Epoch time, in milliseconds, when the collection group was created.
    id String
    Unique identifier for the collection group.
    name String
    Name of the collection group.
    numberOfCollections Number
    Number of collections currently associated with the collection group.
    standbyReplicas String
    Indicates whether standby replicas are used for collections in the group.

    GetServerlessCollectionGroupsCollectionGroupSummaryCapacityLimit

    MaxIndexingCapacityInOcu double
    Maximum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    MaxSearchCapacityInOcu double
    Maximum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    MinIndexingCapacityInOcu double
    Minimum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    MinSearchCapacityInOcu double
    Minimum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    MaxIndexingCapacityInOcu float64
    Maximum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    MaxSearchCapacityInOcu float64
    Maximum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    MinIndexingCapacityInOcu float64
    Minimum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    MinSearchCapacityInOcu float64
    Minimum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    maxIndexingCapacityInOcu Double
    Maximum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    maxSearchCapacityInOcu Double
    Maximum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    minIndexingCapacityInOcu Double
    Minimum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    minSearchCapacityInOcu Double
    Minimum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    maxIndexingCapacityInOcu number
    Maximum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    maxSearchCapacityInOcu number
    Maximum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    minIndexingCapacityInOcu number
    Minimum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    minSearchCapacityInOcu number
    Minimum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    max_indexing_capacity_in_ocu float
    Maximum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    max_search_capacity_in_ocu float
    Maximum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    min_indexing_capacity_in_ocu float
    Minimum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    min_search_capacity_in_ocu float
    Minimum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    maxIndexingCapacityInOcu Number
    Maximum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    maxSearchCapacityInOcu Number
    Maximum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    minIndexingCapacityInOcu Number
    Minimum indexing capacity, in OpenSearch Compute Units (OCUs), for the collection group.
    minSearchCapacityInOcu Number
    Minimum search capacity, in OpenSearch Compute Units (OCUs), for the collection group.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v7.28.0
    published on Thursday, Apr 30, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws
      Try Pulumi Cloud free. Your team will thank you.