Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. apigateway
  5. getApiKeys
AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-aws

aws.apigateway.getApiKeys

Explore with Pulumi AI

aws logo
AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-aws

    Data source for managing AWS API Gateway API Keys.

    Example Usage

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

const example = aws.apigateway.getApiKeys({});

    import pulumi
import pulumi_aws as aws

example = aws.apigateway.get_api_keys()

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.GetApiKeys(ctx, &apigateway.GetApiKeysArgs{}, 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.ApiGateway.GetApiKeys.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.ApigatewayFunctions;
import com.pulumi.aws.apigateway.inputs.GetApiKeysArgs;
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 = ApigatewayFunctions.getApiKeys();

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:apigateway:getApiKeys
      arguments: {}

    Using getApiKeys

    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 getApiKeys(args: GetApiKeysArgs, opts?: InvokeOptions): Promise<GetApiKeysResult>
function getApiKeysOutput(args: GetApiKeysOutputArgs, opts?: InvokeOptions): Output<GetApiKeysResult>
    def get_api_keys(customer_id: Optional[str] = None,
                 include_values: Optional[bool] = None,
                 opts: Optional[InvokeOptions] = None) -> GetApiKeysResult
def get_api_keys_output(customer_id: Optional[pulumi.Input[str]] = None,
                 include_values: Optional[pulumi.Input[bool]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetApiKeysResult]
    func GetApiKeys(ctx *Context, args *GetApiKeysArgs, opts ...InvokeOption) (*GetApiKeysResult, error)
func GetApiKeysOutput(ctx *Context, args *GetApiKeysOutputArgs, opts ...InvokeOption) GetApiKeysResultOutput

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

    public static class GetApiKeys 
{
    public static Task<GetApiKeysResult> InvokeAsync(GetApiKeysArgs args, InvokeOptions? opts = null)
    public static Output<GetApiKeysResult> Invoke(GetApiKeysInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiKeysResult> getApiKeys(GetApiKeysArgs args, InvokeOptions options)
public static Output<GetApiKeysResult> getApiKeys(GetApiKeysArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:apigateway/getApiKeys:getApiKeys
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CustomerId string
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    IncludeValues bool
    Set this value to true if you wish the result contains the key value. Defaults to false.
    CustomerId string
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    IncludeValues bool
    Set this value to true if you wish the result contains the key value. Defaults to false.
    customerId String
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    includeValues Boolean
    Set this value to true if you wish the result contains the key value. Defaults to false.
    customerId string
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    includeValues boolean
    Set this value to true if you wish the result contains the key value. Defaults to false.
    customer_id str
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    include_values bool
    Set this value to true if you wish the result contains the key value. Defaults to false.
    customerId String
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    includeValues Boolean
    Set this value to true if you wish the result contains the key value. Defaults to false.

    getApiKeys Result

    The following output properties are available:

    Id string
    ID of the API Key.
    Items List<GetApiKeysItem>
    List of objects containing API Key information. See below.
    CustomerId string
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    IncludeValues bool
    Id string
    ID of the API Key.
    Items []GetApiKeysItem
    List of objects containing API Key information. See below.
    CustomerId string
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    IncludeValues bool
    id String
    ID of the API Key.
    items List<GetApiKeysItem>
    List of objects containing API Key information. See below.
    customerId String
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    includeValues Boolean
    id string
    ID of the API Key.
    items GetApiKeysItem[]
    List of objects containing API Key information. See below.
    customerId string
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    includeValues boolean
    id str
    ID of the API Key.
    items Sequence[GetApiKeysItem]
    List of objects containing API Key information. See below.
    customer_id str
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    include_values bool
    id String
    ID of the API Key.
    items List<Property Map>
    List of objects containing API Key information. See below.
    customerId String
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    includeValues Boolean

    Supporting Types

    GetApiKeysItem

    CreatedDate string
    Date and time when the API Key was created.
    CustomerId string
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    Description string
    Description of the API Key.
    Enabled bool
    Whether the API Key is enabled.
    Id string
    ID of the API Key.
    LastUpdatedDate string
    Date and time when the API Key was last updated.
    Name string
    Name of the API Key.
    StageKeys List<string>
    Tags Dictionary<string, string>
    Map of tags for the resource.
    Value string
    Value of the API Key.
    CreatedDate string
    Date and time when the API Key was created.
    CustomerId string
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    Description string
    Description of the API Key.
    Enabled bool
    Whether the API Key is enabled.
    Id string
    ID of the API Key.
    LastUpdatedDate string
    Date and time when the API Key was last updated.
    Name string
    Name of the API Key.
    StageKeys []string
    Tags map[string]string
    Map of tags for the resource.
    Value string
    Value of the API Key.
    createdDate String
    Date and time when the API Key was created.
    customerId String
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    description String
    Description of the API Key.
    enabled Boolean
    Whether the API Key is enabled.
    id String
    ID of the API Key.
    lastUpdatedDate String
    Date and time when the API Key was last updated.
    name String
    Name of the API Key.
    stageKeys List<String>
    tags Map<String,String>
    Map of tags for the resource.
    value String
    Value of the API Key.
    createdDate string
    Date and time when the API Key was created.
    customerId string
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    description string
    Description of the API Key.
    enabled boolean
    Whether the API Key is enabled.
    id string
    ID of the API Key.
    lastUpdatedDate string
    Date and time when the API Key was last updated.
    name string
    Name of the API Key.
    stageKeys string[]
    tags {[key: string]: string}
    Map of tags for the resource.
    value string
    Value of the API Key.
    created_date str
    Date and time when the API Key was created.
    customer_id str
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    description str
    Description of the API Key.
    enabled bool
    Whether the API Key is enabled.
    id str
    ID of the API Key.
    last_updated_date str
    Date and time when the API Key was last updated.
    name str
    Name of the API Key.
    stage_keys Sequence[str]
    tags Mapping[str, str]
    Map of tags for the resource.
    value str
    Value of the API Key.
    createdDate String
    Date and time when the API Key was created.
    customerId String
    Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    description String
    Description of the API Key.
    enabled Boolean
    Whether the API Key is enabled.
    id String
    ID of the API Key.
    lastUpdatedDate String
    Date and time when the API Key was last updated.
    name String
    Name of the API Key.
    stageKeys List<String>
    tags Map<String>
    Map of tags for the resource.
    value String
    Value of the API Key.

    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
    AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi
    pulumi/pulumi-aws