/*WRITE ONLY BELOW THIS LINE*/ /*WRITE ONLY ABOVE THIS LINE*/ "use strict"; const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; function _createMdxContent(props) { const _components = { code: "code", h1: "h1", p: "p", pre: "pre", ..._provideComponents(), ...props.components }, {SdkMethodsApiReference} = _components; if (!SdkMethodsApiReference) _missingMdxReference("SdkMethodsApiReference", true); return _jsxs(_Fragment, { children: [_jsx(_components.h1, { id: "overview-and-basic-usage", children: "Overview and basic usage" }), "\n", _jsx("br", {}), "\n", _jsx(_components.p, { children: "Lists users in the specified userpool and saves them as CSV to the specified file" }), "\n", _jsx("br", {}), "\n", _jsx("br", {}), "\n", "\n", "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "language-typescript", children: "import { Stacktape } from \"stacktape\";\n\nconst stacktape = new Stacktape();\n\nstacktape.userpoolListUsers({\n region: \"<>\",\n stage: \"<>\",\n userPoolName: \"<>\"\n});\n" }) }), "\n", _jsx(_components.h1, { id: "api-reference", children: "API reference" }), "\n", _jsx(SdkMethodsApiReference, { command: "userpool:list-users", sortedArgs: [{ description: "#### AWS region to use for the current operation.\n---\n", allowedTypes: ["string"], allowedValues: ["af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2"], required: true, name: "region", shortDescription: "

AWS region to use for the current operation.

\n", longDescription: "" }, { description: "#### Stage used for the operation.\n---\n- Example stages are `production`, `staging`, `testing` or `dev-john`.\n- You can configure the default stage used with every Stacktape command using the `defaults:configure` command.\n- Maximum allowed length is 12 characters.", allowedTypes: ["string"], required: true, name: "stage", shortDescription: "

Stage used for the operation.

\n", longDescription: "

Example stages are production, staging, testing or dev-john.
You can configure the default stage used with every Stacktape command using the defaults:configure command.
Maximum allowed length is 12 characters.

\n" }, { description: "#### Name of the user pool (as specified in configuration file).", allowedTypes: ["string"], required: true, name: "userPoolName", shortDescription: "

Name of the user pool (as specified in configuration file).

\n" }, { description: "#### Name of the AWS account used to perform the operation\n---\n- The account must be first connected in the [Stacktape console](https://console.stacktape.com/aws-accounts)", allowedTypes: ["string"], required: false, name: "awsAccount", shortDescription: "

Name of the AWS account used to perform the operation

\n", longDescription: '

The account must be first connected in the Stacktape console

\n' }, { description: "#### Directly supplied stacktape configuration object", allowedTypes: ["object"], required: false, name: "config", shortDescription: "

Directly supplied stacktape configuration object

\n" }, { description: "#### Path to your stacktape configuration file.\n---\n- Relative to CWD (current working directory).", allowedTypes: ["string"], required: false, name: "configPath", shortDescription: "

Path to your stacktape configuration file.

\n", longDescription: "

Relative to CWD (current working directory).

\n" }, { description: "#### Current working directory for the current operation.\n---\n- Every file path in your config will be resolved relatively to specified cwd.\n- By default, directory containing the configuration file is used.", allowedTypes: ["string"], required: false, name: "currentWorkingDirectory", shortDescription: "

Current working directory for the current operation.

\n", longDescription: "

Every file path in your config will be resolved relatively to specified cwd.
By default, directory containing the configuration file is used.

\n" }, { description: "#### AWS profile to use with the command\n---\n- You can manage AWS profiles on your system using `aws-profile:create`, `aws-profile:update` or `aws-profile:delete` command.\n- You can configure the default profile used with every Stacktape command using the `defaults:configure` command.", allowedTypes: ["string"], required: false, name: "profile", shortDescription: "

AWS profile to use with the command

\n", longDescription: "

You can manage AWS profiles on your system using aws-profile:create, aws-profile:update or aws-profile:delete command.
You can configure the default profile used with every Stacktape command using the defaults:configure command.

\n" }, { description: "#### Name of the Stacktape project relevant for this operation", allowedTypes: ["string"], required: false, name: "projectName", shortDescription: "

Name of the Stacktape project relevant for this operation

\n" }, { description: "#### Id of the template to download\n---\n- The list of available templates is available on the [Config builder page](https://console.stacktape.com/templates)", allowedTypes: ["string"], required: false, name: "templateId", shortDescription: "

Id of the template to download

\n", longDescription: '

The list of available templates is available on the Config builder page

\n' }] })] }); } function MDXContent(props = {}) { const {wrapper: MDXLayout} = { ..._provideComponents(), ...props.components }; return MDXLayout ? _jsx(MDXLayout, { ...props, children: _jsx(_createMdxContent, { ...props }) }) : _createMdxContent(props); } return { default: MDXContent }; function _missingMdxReference(id, component) { throw new Error("Expected " + (component ? "component" : "object") + " `" + id + "` to be defined: you likely forgot to import, pass, or provide it."); }

userpoolListUsers()

Overview and basic usage

API reference