n8n-nodes-base
Version:
Base nodes of n8n
90 lines (86 loc) • 2.58 kB
text/typescript
/**
* AWS Cognito Node - Version 1
* Discriminator: resource=user, operation=getAll
*/
interface Credentials {
aws: CredentialReference;
}
/** Retrieve a list of groups */
export type AwsCognitoV1UserGetAllParams = {
resource: 'user';
operation: 'getAll';
/**
* Select the user pool to use
* @default {"mode":"list","value":""}
*/
userPool?: { __rl: true; mode: 'list' | 'id'; value: string; cachedResultName?: string };
/**
* Whether to return all results or only up to a given limit
* @default false
*/
returnAll?: boolean | Expression<boolean>;
/**
* Max number of results to return
* @displayOptions.show { returnAll: [false] }
* @default 50
*/
limit?: number | Expression<number>;
/**
* Whether to return a simplified version of the response instead of the raw data
* @default true
*/
simple?: boolean | Expression<boolean>;
/**
* Filters
* @default {}
*/
filters?: {
/** Filter
*/
filter?: {
/** The attribute to search for
* @default email
*/
attribute?: 'cognito:user_status' | 'email' | 'family_name' | 'given_name' | 'name' | 'phone_number' | 'preferred_username' | 'status' | 'sub' | 'username' | Expression<string>;
/** The value of the attribute to search for
*/
value?: string | Expression<string> | PlaceholderValue;
};
};
requestOptions?: {
/** Batching
* @default {"batch":{}}
*/
batching?: {
/** Batching
*/
batch?: {
/** Input will be split in batches to throttle requests. -1 for disabled. 0 will be treated as 1.
* @default 50
*/
batchSize?: number | Expression<number>;
/** Time (in milliseconds) between each batch of requests. 0 for disabled.
* @default 1000
*/
batchInterval?: number | Expression<number>;
};
};
/** Whether to accept the response even if SSL certificate validation is not possible
* @default false
*/
allowUnauthorizedCerts?: boolean;
/** HTTP proxy to use. If authentication is required it can be defined as follow: http://username:password@myproxy:3128
*/
proxy?: string | Expression<string> | PlaceholderValue;
/** Time in ms to wait for the server to send response headers (and start the response body) before aborting the request
* @default 10000
*/
timeout?: number | Expression<number>;
};
};
export type AwsCognitoV1UserGetAllNode = {
type: 'n8n-nodes-base.awsCognito';
version: 1;
credentials?: Credentials;
config: NodeConfig<AwsCognitoV1UserGetAllParams>;
};