diff --git a/src/directory/apiReferences/amplify-js.json b/src/directory/apiReferences/amplify-js.json index 20ab9c53f8c..79bd59fe562 100644 --- a/src/directory/apiReferences/amplify-js.json +++ b/src/directory/apiReferences/amplify-js.json @@ -1,6 +1,6 @@ { - "3110": { - "id": 3110, + "3396": { + "id": 3396, "name": "analytics", "variant": "declaration", "kind": 2, @@ -10,39 +10,106 @@ { "title": "Type Aliases", "children": [ - 3111, - 3112, - 3113 + 3397, + 3398, + 3399 ] }, { "title": "Variables", "children": [ - 3114, - 3118, - 3121, - 3124, - 3127, - 3131 + 3400, + 3401, + 3404, + 3407, + 3408, + 3409 ] } ] }, - "3210": { - "id": 3210, + "3505": { + "id": 3505, "name": "api", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { - "id": 3325, + "id": 3605, + "name": "del", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3606, + 3609 + ] + }, + { + "id": 3611, "name": "generateClient", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3326 + 3612, + 3617 + ] + }, + { + "id": 3621, + "name": "get", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3622, + 3625 + ] + }, + { + "id": 3627, + "name": "head", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3628, + 3631 + ] + }, + { + "id": 3633, + "name": "patch", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3634, + 3637 + ] + }, + { + "id": 3639, + "name": "post", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3640, + 3643 + ] + }, + { + "id": 3645, + "name": "put", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3646, + 3649 ] } ], @@ -50,73 +117,227 @@ { "title": "Namespaces", "children": [ - 3211 + 3506 ] }, { "title": "Enumerations", "children": [ - 3223, - 3232 + 3527, + 3536 ] }, { "title": "Classes", "children": [ - 3238 + 3542 ] }, { "title": "Interfaces", "children": [ - 3260, - 3271, - 3275 + 3564, + 3575, + 3579 ] }, { "title": "Type Aliases", "children": [ - 3280, - 3282, - 3286, - 3288, - 3292 + 3584, + 3586, + 3590, + 3592, + 3596 ] }, { "title": "Variables", "children": [ - 3296, - 3297, - 3301, - 3305, - 3309, - 3313, - 3317, - 3321 + 3600, + 3601 ] }, { "title": "Functions", "children": [ - 3325 + 3605, + 3611, + 3621, + 3627, + 3633, + 3639, + 3645 ] } ] }, - "3325": { - "id": 3325, + "3605": { + "id": 3605, + "name": "del", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3606, + 3609 + ] + }, + "3606": { + "id": 3606, + "name": "del", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3607, + 3608 + ], + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "DeleteOperation" + }, + "name": "DeleteOperation", + "package": "@aws-amplify/api-rest" + } + }, + "3607": { + "id": 3607, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3608": { + "id": 3608, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "DeleteInput" + }, + "name": "DeleteInput", + "package": "@aws-amplify/api-rest" + } + }, + "3609": { + "id": 3609, + "name": "del", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "DELETE HTTP request" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Operation for DELETE request" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "RestApiError" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Send a DELETE request\n" + }, + { + "kind": "code", + "text": "```js\nimport { del } from '@aws-amplify/api';\n\nconst { statusCode } = await del({\n apiName,\n path,\n options: {\n headers, // Optional, A map of custom header key/values\n queryParams, // Optional, A map of query strings\n }\n}).response;\n```" + } + ] + } + ] + }, + "parameters": [ + 3610 + ], + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "DeleteOperation" + }, + "name": "DeleteOperation", + "package": "@aws-amplify/api-rest" + } + }, + "3610": { + "id": 3610, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input for DELETE operation" + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "DeleteInput" + }, + "name": "DeleteInput", + "package": "@aws-amplify/api-rest" + } + }, + "3611": { + "id": 3611, "name": "generateClient", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3326 + 3612, + 3617 ] }, - "3326": { - "id": 3326, + "3612": { + "id": 3612, "name": "generateClient", "variant": "signature", "kind": 4096, @@ -125,7 +346,25 @@ "summary": [ { "kind": "text", - "text": "Generates an API client that can work with models or raw GraphQL" + "text": "Generates an API client bound to a specific " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AmplifyContext", + "target": 5131 + }, + { + "kind": "text", + "text": " instead of\nthe global " + }, + { + "kind": "code", + "text": "`Amplify`" + }, + { + "kind": "text", + "text": " singleton. Use this overload when you need to scope a\nclient to an explicit context (e.g. multi-tenant or server-side rendering\nscenarios) rather than the shared singleton configuration." } ], "blockTags": [ @@ -152,15 +391,25 @@ "text": " - Throws error when client cannot be generated due to configuration issues." } ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport { generateClient } from 'aws-amplify/api';\n// `listTodos` is a generated GraphQL query document (from your API's codegen output).\n\nconst client = generateClient(ctx);\nconst result = await client.graphql({ query: listTodos });\n```" + } + ] } ] }, "typeParameters": [ - 3327, - 3328 + 3613, + 3614 ], "parameters": [ - 3329 + 3615, + 3616 ], "type": { "type": "reference", @@ -172,14 +421,14 @@ "typeArguments": [ { "type": "reference", - "target": 3327, + "target": 3613, "name": "T", "package": "@aws-amplify/api", "refersToTypeParameter": true }, { "type": "reference", - "target": 3328, + "target": 3614, "name": "Options", "package": "@aws-amplify/api", "refersToTypeParameter": true @@ -189,8 +438,8 @@ "package": "@aws-amplify/api-graphql" } }, - "3327": { - "id": 3327, + "3613": { + "id": 3613, "name": "T", "variant": "typeParam", "kind": 131072, @@ -220,8 +469,8 @@ "name": "never" } }, - "3328": { - "id": 3328, + "3614": { + "id": 3614, "name": "Options", "variant": "typeParam", "kind": 131072, @@ -247,1540 +496,6336 @@ "package": "@aws-amplify/api-graphql" } }, - "3329": { - "id": 3329, + "3615": { + "id": 3615, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AmplifyContext", + "target": 5131 + }, + { + "kind": "text", + "text": " the client should resolve its\nconfiguration and auth from." + } + ] + }, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3616": { + "id": 3616, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional client options." + } + ] + }, "type": { "type": "reference", - "target": 3328, + "target": 3614, "name": "Options", "package": "@aws-amplify/api", "refersToTypeParameter": true } }, - "3369": { - "id": 3369, - "name": "auth", - "variant": "declaration", - "kind": 2, + "3617": { + "id": 3617, + "name": "generateClient", + "variant": "signature", + "kind": 4096, "flags": {}, - "children": [ - { - "id": 3505, - "name": "associateWebAuthnCredential", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3506 - ] - }, - { - "id": 3507, - "name": "confirmResetPassword", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3508 - ] - }, - { - "id": 3510, - "name": "confirmSignIn", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3511 - ] - }, - { - "id": 3513, - "name": "confirmSignUp", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3514 - ] - }, - { - "id": 3516, - "name": "confirmUserAttribute", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3517 - ] - }, - { - "id": 3519, - "name": "decodeJWT", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3520 - ] - }, - { - "id": 3522, - "name": "deleteUser", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3523 - ] - }, - { - "id": 3524, - "name": "deleteUserAttributes", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3525 - ] - }, - { - "id": 3527, - "name": "deleteWebAuthnCredential", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3528 - ] - }, - { - "id": 3530, - "name": "fetchDevices", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3531 - ] - }, - { - "id": 3532, - "name": "fetchMFAPreference", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3533 - ] - }, - { - "id": 3534, - "name": "forgetDevice", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3535 - ] + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generates an API client that can work with models or raw GraphQL" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "V6Client" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "Error" + }, + { + "kind": "text", + "text": " - Throws error when client cannot be generated due to configuration issues." + } + ] + } + ] + }, + "typeParameters": [ + 3618, + 3619 + ], + "parameters": [ + 3620 + ], + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-graphql", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "V6Client" }, - { - "id": 3537, - "name": "listWebAuthnCredentials", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3538 - ] + "typeArguments": [ + { + "type": "reference", + "target": 3618, + "name": "T", + "package": "@aws-amplify/api", + "refersToTypeParameter": true + }, + { + "type": "reference", + "target": 3619, + "name": "Options", + "package": "@aws-amplify/api", + "refersToTypeParameter": true + } + ], + "name": "V6Client", + "package": "@aws-amplify/api-graphql" + } + }, + "3618": { + "id": 3618, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Record" }, - { - "id": 3540, - "name": "rememberDevice", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3541 - ] + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" + }, + "default": { + "type": "intrinsic", + "name": "never" + } + }, + "3619": { + "id": 3619, + "name": "Options", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-graphql", + "packagePath": "dist/esm/internals/types.d.ts", + "qualifiedName": "CommonPublicClientOptions" }, - { - "id": 3542, - "name": "resendSignUpCode", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3543 - ] + "name": "CommonPublicClientOptions", + "package": "@aws-amplify/api-graphql" + }, + "default": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-graphql", + "packagePath": "dist/esm/internals/types.d.ts", + "qualifiedName": "DefaultCommonClientOptions" }, - { - "id": 3545, - "name": "resetPassword", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3546 - ] + "name": "DefaultCommonClientOptions", + "package": "@aws-amplify/api-graphql" + } + }, + "3620": { + "id": 3620, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 3619, + "name": "Options", + "package": "@aws-amplify/api", + "refersToTypeParameter": true + } + }, + "3621": { + "id": 3621, + "name": "get", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3622, + 3625 + ] + }, + "3622": { + "id": 3622, + "name": "get", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3623, + 3624 + ], + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "GetOperation" }, - { - "id": 3548, - "name": "setUpTOTP", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3549 - ] + "name": "GetOperation", + "package": "@aws-amplify/api-rest" + } + }, + "3623": { + "id": 3623, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3624": { + "id": 3624, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "GetInput" }, - { - "id": 3550, - "name": "signIn", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3551 - ] - }, - { - "id": 3553, - "name": "signInWithRedirect", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3554 - ] - }, - { - "id": 3556, - "name": "signOut", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3557 - ] - }, - { - "id": 3559, - "name": "signUp", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3560 - ] - }, - { - "id": 3562, - "name": "updateMFAPreference", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3563 - ] + "name": "GetInput", + "package": "@aws-amplify/api-rest" + } + }, + "3625": { + "id": 3625, + "name": "get", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "GET HTTP request" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Operation for GET request" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "RestApiError" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Send a GET request\n" + }, + { + "kind": "code", + "text": "```js\nimport { get, isCancelError } from '@aws-amplify/api';\n\nconst { body } = await get({\n apiName,\n path,\n options: {\n headers, // Optional, A map of custom header key/values\n body, // Optional, JSON object or FormData\n queryParams, // Optional, A map of query strings\n }\n}).response;\nconst data = await body.json();\n```" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Cancel a GET request\n\n" + }, + { + "kind": "code", + "text": "```js\nimport { get, isCancelError } from '@aws-amplify/api';\n\nconst { response, cancel } = get({apiName, path, options});\ncancel(message);\ntry {\n await response;\n} catch (e) {\n if (isCancelError(e)) {\n // handle request cancellation\n }\n //...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + 3626 + ], + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "GetOperation" }, - { - "id": 3565, - "name": "updatePassword", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3566 - ] + "name": "GetOperation", + "package": "@aws-amplify/api-rest" + } + }, + "3626": { + "id": 3626, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input for GET operation" + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "GetInput" }, - { - "id": 3568, - "name": "verifyTOTPSetup", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3569 - ] - } + "name": "GetInput", + "package": "@aws-amplify/api-rest" + } + }, + "3627": { + "id": 3627, + "name": "head", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3628, + 3631 + ] + }, + "3628": { + "id": 3628, + "name": "head", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3629, + 3630 ], - "groups": [ - { - "title": "Classes", - "children": [ - 3370 - ] - }, - { - "title": "Interfaces", - "children": [ - 3390, - 3395, - 3399, - 3403, - 3410, - 3413, - 3419, - 3421, - 3424, - 3427, - 3431, - 3434, - 3437, - 3443 - ] + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "HeadOperation" }, - { - "title": "Type Aliases", - "children": [ - 3447, - 3449, - 3450, - 3451, - 3452, - 3453, - 3454, - 3455, - 3456, - 3457, - 3458, - 3459, - 3460, - 3461, - 3462, - 3463, - 3464, - 3465, - 3466, - 3467, - 3468, - 3469, - 3470, - 3471, - 3472, - 3473, - 3474, - 3475, - 3476, - 3477, - 3478, - 3479, - 3480, - 3481 - ] + "name": "HeadOperation", + "package": "@aws-amplify/api-rest" + } + }, + "3629": { + "id": 3629, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3630": { + "id": 3630, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "HeadInput" }, - { - "title": "Variables", - "children": [ - 3482, - 3483, - 3487, - 3490, - 3493, - 3497, - 3501 - ] + "name": "HeadInput", + "package": "@aws-amplify/api-rest" + } + }, + "3631": { + "id": 3631, + "name": "head", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HEAD HTTP request" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Operation for HEAD request" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "RestApiError" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Send a HEAD request\n" + }, + { + "kind": "code", + "text": "```js\nimport { head, isCancelError } from '@aws-amplify/api';\n\nconst { headers, statusCode } = await head({\n apiName,\n path,\n options: {\n headers, // Optional, A map of custom header key/values\n queryParams, // Optional, A map of query strings\n }\n}),response;\n```" + } + ] + } + ] + }, + "parameters": [ + 3632 + ], + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "HeadOperation" }, - { - "title": "Functions", - "children": [ - 3505, - 3507, - 3510, - 3513, - 3516, - 3519, - 3522, - 3524, - 3527, - 3530, - 3532, - 3534, - 3537, - 3540, - 3542, - 3545, - 3548, - 3550, - 3553, - 3556, - 3559, - 3562, - 3565, - 3568 - ] - } - ] + "name": "HeadOperation", + "package": "@aws-amplify/api-rest" + } }, - "3403": { - "id": 3403, - "name": "AuthWebAuthnCredential", - "variant": "declaration", - "kind": 256, + "3632": { + "id": 3632, + "name": "input", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Shape of a WebAuthn credential" + "text": "Input for HEAD operation" + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "HeadInput" + }, + "name": "HeadInput", + "package": "@aws-amplify/api-rest" + } + }, + "3633": { + "id": 3633, + "name": "patch", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3634, + 3637 + ] + }, + "3634": { + "id": 3634, + "name": "patch", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3635, + 3636 + ], + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "PatchOperation" + }, + "name": "PatchOperation", + "package": "@aws-amplify/api-rest" + } + }, + "3635": { + "id": 3635, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3636": { + "id": 3636, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "PatchInput" + }, + "name": "PatchInput", + "package": "@aws-amplify/api-rest" + } + }, + "3637": { + "id": 3637, + "name": "patch", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "PATCH HTTP request" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Operation for PATCH request" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "RestApiError" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Send a PATCH request\n" + }, + { + "kind": "code", + "text": "```js\nimport { patch } from '@aws-amplify/api';\n\nconst { body } = await patch({\n apiName,\n path,\n options: {\n headers, // Optional, A map of custom header key/values\n body, // Optional, JSON object or FormData\n queryParams, // Optional, A map of query strings\n }\n}).response;\nconst data = await body.json();\n```" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Cancel a PATCH request\n" + }, + { + "kind": "code", + "text": "```js\nimport { patch, isCancelError } from '@aws-amplify/api';\n\nconst { response, cancel } = patch({apiName, path, options});\ncancel(message);\ntry {\n await response;\n} catch (e) {\n if (isCancelError(e)) {\n // handle request cancellation\n }\n//...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + 3638 + ], + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "PatchOperation" + }, + "name": "PatchOperation", + "package": "@aws-amplify/api-rest" + } + }, + "3638": { + "id": 3638, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input for PATCH operation" + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "PatchInput" + }, + "name": "PatchInput", + "package": "@aws-amplify/api-rest" + } + }, + "3639": { + "id": 3639, + "name": "post", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3640, + 3643 + ] + }, + "3640": { + "id": 3640, + "name": "post", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3641, + 3642 + ], + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "PostOperation" + }, + "name": "PostOperation", + "package": "@aws-amplify/api-rest" + } + }, + "3641": { + "id": 3641, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3642": { + "id": 3642, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "PostInput" + }, + "name": "PostInput", + "package": "@aws-amplify/api-rest" + } + }, + "3643": { + "id": 3643, + "name": "post", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "POST HTTP request" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Operation for POST request" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "RestApiError" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Send a POST request\n" + }, + { + "kind": "code", + "text": "```js\nimport { post, isCancelError } from '@aws-amplify/api';\n\nconst { body } = await post({\n apiName,\n path,\n options: {\n headers, // Optional, A map of custom header key/values\n body, // Optional, JSON object or FormData\n queryParams, // Optional, A map of query strings\n }\n}).response;\nconst data = await body.json();\n```" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Cancel a POST request\n\n" + }, + { + "kind": "code", + "text": "```js\nimport { post, isCancelError } from '@aws-amplify/api';\n\nconst { response, cancel } = post({apiName, path, options});\ncancel(message);\ntry {\n await response;\n} catch (e) {\n if (isCancelError(e)) {\n // handle request cancellation\n }\n //...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + 3644 + ], + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "PostOperation" + }, + "name": "PostOperation", + "package": "@aws-amplify/api-rest" + } + }, + "3644": { + "id": 3644, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input for POST operation" + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "PostInput" + }, + "name": "PostInput", + "package": "@aws-amplify/api-rest" + } + }, + "3645": { + "id": 3645, + "name": "put", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3646, + 3649 + ] + }, + "3646": { + "id": 3646, + "name": "put", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3647, + 3648 + ], + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "PutOperation" + }, + "name": "PutOperation", + "package": "@aws-amplify/api-rest" + } + }, + "3647": { + "id": 3647, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3648": { + "id": 3648, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "PutInput" + }, + "name": "PutInput", + "package": "@aws-amplify/api-rest" + } + }, + "3649": { + "id": 3649, + "name": "put", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "PUT HTTP request" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Operation for PUT request" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "RestApiError" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Send a PUT request\n" + }, + { + "kind": "code", + "text": "```js\nimport { put, isCancelError } from '@aws-amplify/api';\n\nconst { body } = await put({\n apiName,\n path,\n options: {\n headers, // Optional, A map of custom header key/values\n body, // Optional, JSON object or FormData\n queryParams, // Optional, A map of query strings\n }\n}).response;\nconst data = await body.json();\n```" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Cancel a PUT request\n" + }, + { + "kind": "code", + "text": "```js\nimport { put, isCancelError } from '@aws-amplify/api';\n\nconst { response, cancel } = put({apiName, path, options});\ncancel(message);\ntry {\n await response;\n} catch (e) {\n if (isCancelError(e)) {\n // handle request cancellation\n }\n//...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + 3650 + ], + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "PutOperation" + }, + "name": "PutOperation", + "package": "@aws-amplify/api-rest" + } + }, + "3650": { + "id": 3650, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input for PUT operation" + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/api-rest", + "packagePath": "dist/esm/types/index.d.ts", + "qualifiedName": "PutInput" + }, + "name": "PutInput", + "package": "@aws-amplify/api-rest" + } + }, + "3666": { + "id": 3666, + "name": "auth", + "variant": "declaration", + "kind": 2, + "flags": {}, + "children": [ + { + "id": 3784, + "name": "associateWebAuthnCredential", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3785 + ] + }, + { + "id": 3786, + "name": "confirmResetPassword", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3787, + 3790 + ] + }, + { + "id": 3792, + "name": "confirmSignIn", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3793, + 3796 + ] + }, + { + "id": 3798, + "name": "confirmSignUp", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3799, + 3802 + ] + }, + { + "id": 3804, + "name": "confirmUserAttribute", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3805, + 3808 + ] + }, + { + "id": 3810, + "name": "decodeJWT", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3811 + ] + }, + { + "id": 3813, + "name": "deleteUser", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3814, + 3816 + ] + }, + { + "id": 3817, + "name": "deleteUserAttributes", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3818, + 3821 + ] + }, + { + "id": 3823, + "name": "deleteWebAuthnCredential", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3824 + ] + }, + { + "id": 3826, + "name": "fetchAuthSession", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3827, + 3830 + ] + }, + { + "id": 3832, + "name": "fetchDevices", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3833, + 3835 + ] + }, + { + "id": 3836, + "name": "fetchMFAPreference", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3837, + 3839 + ] + }, + { + "id": 3840, + "name": "fetchUserAttributes", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3841, + 3843 + ] + }, + { + "id": 3844, + "name": "forgetDevice", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3845, + 3848 + ] + }, + { + "id": 3850, + "name": "getCurrentUser", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3851, + 3853 + ] + }, + { + "id": 3854, + "name": "listWebAuthnCredentials", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3855 + ] + }, + { + "id": 3857, + "name": "rememberDevice", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3858, + 3860 + ] + }, + { + "id": 3861, + "name": "resendSignUpCode", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3862, + 3865 + ] + }, + { + "id": 3867, + "name": "resetPassword", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3868, + 3871 + ] + }, + { + "id": 3873, + "name": "sendUserAttributeVerificationCode", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3874, + 3877 + ] + }, + { + "id": 3879, + "name": "setUpTOTP", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3880, + 3882 + ] + }, + { + "id": 3883, + "name": "signIn", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3884, + 3887 + ] + }, + { + "id": 3889, + "name": "signInWithRedirect", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3890, + 3893 + ] + }, + { + "id": 3895, + "name": "signOut", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3896, + 3899 + ] + }, + { + "id": 3901, + "name": "signUp", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3902, + 3905 + ] + }, + { + "id": 3907, + "name": "updateMFAPreference", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3908, + 3911 + ] + }, + { + "id": 3913, + "name": "updatePassword", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3914, + 3917 + ] + }, + { + "id": 3919, + "name": "updateUserAttributes", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3920, + 3923 + ] + }, + { + "id": 3925, + "name": "verifyTOTPSetup", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3926, + 3929 + ] + } + ], + "groups": [ + { + "title": "Classes", + "children": [ + 3667 + ] + }, + { + "title": "Interfaces", + "children": [ + 3687, + 3692, + 3696, + 3700, + 3707, + 3710, + 3716, + 3718, + 3721, + 3724, + 3728, + 3731, + 3734, + 3740 + ] + }, + { + "title": "Type Aliases", + "children": [ + 3744, + 3746, + 3747, + 3748, + 3749, + 3750, + 3751, + 3752, + 3753, + 3754, + 3755, + 3756, + 3757, + 3758, + 3759, + 3760, + 3761, + 3762, + 3763, + 3764, + 3765, + 3766, + 3767, + 3768, + 3769, + 3770, + 3771, + 3772, + 3773, + 3774, + 3775, + 3776, + 3777, + 3778 + ] + }, + { + "title": "Variables", + "children": [ + 3779, + 3780 + ] + }, + { + "title": "Functions", + "children": [ + 3784, + 3786, + 3792, + 3798, + 3804, + 3810, + 3813, + 3817, + 3823, + 3826, + 3832, + 3836, + 3840, + 3844, + 3850, + 3854, + 3857, + 3861, + 3867, + 3873, + 3879, + 3883, + 3889, + 3895, + 3901, + 3907, + 3913, + 3919, + 3925 + ] + } + ] + }, + "3687": { + "id": 3687, + "name": "AuthSession", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + 3688, + 3689, + 3690, + 3691 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3688, + 3689, + 3690, + 3691 + ] + } + ] + }, + "3688": { + "id": 3688, + "name": "credentials", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Auth/types.d.ts", + "qualifiedName": "AWSCredentials" + }, + "name": "AWSCredentials", + "package": "@aws-amplify/core" + } + }, + "3689": { + "id": 3689, + "name": "identityId", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + "3690": { + "id": 3690, + "name": "tokens", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 3692, + "name": "AuthTokens", + "package": "@aws-amplify/core" + } + }, + "3691": { + "id": 3691, + "name": "userSub", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + "3692": { + "id": 3692, + "name": "AuthTokens", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + 3693, + 3694, + 3695 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3693, + 3694, + 3695 + ] + } + ] + }, + "3693": { + "id": 3693, + "name": "accessToken", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 3724, + "name": "JWT", + "package": "@aws-amplify/core" + } + }, + "3694": { + "id": 3694, + "name": "idToken", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 3724, + "name": "JWT", + "package": "@aws-amplify/core" + } + }, + "3695": { + "id": 3695, + "name": "signInDetails", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use getCurrentUser to access signInDetails" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Auth/types.d.ts", + "qualifiedName": "AWSAuthSignInDetails" + }, + "name": "AWSAuthSignInDetails", + "package": "@aws-amplify/core" + } + }, + "3696": { + "id": 3696, + "name": "AuthUser", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Holds the user information along with the sign in details." + } + ] + }, + "children": [ + 3697, + 3698, + 3699 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3697, + 3698, + 3699 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/models.d.ts", + "qualifiedName": "AWSAuthUser" + }, + "name": "AWSAuthUser", + "package": "@aws-amplify/auth" + } + ] + }, + "3697": { + "id": 3697, + "name": "signInDetails", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/models.d.ts", + "qualifiedName": "CognitoAuthSignInDetails" + }, + "name": "CognitoAuthSignInDetails", + "package": "@aws-amplify/auth" + } + }, + "3698": { + "id": 3698, + "name": "userId", + "variant": "declaration", + "kind": 1024, + "flags": { + "isInherited": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "AWSAuthUser.userId" + } + }, + "3699": { + "id": 3699, + "name": "username", + "variant": "declaration", + "kind": 1024, + "flags": { + "isInherited": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "AWSAuthUser.username" + } + }, + "3700": { + "id": 3700, + "name": "AuthWebAuthnCredential", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Shape of a WebAuthn credential" + } + ] + }, + "children": [ + 3701, + 3702, + 3703, + 3704, + 3705, + 3706 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3701, + 3702, + 3703, + 3704, + 3705, + 3706 + ] + } + ] + }, + "3701": { + "id": 3701, + "name": "authenticatorAttachment", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + "3702": { + "id": 3702, + "name": "authenticatorTransports", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "intrinsic", + "name": "undefined" + } + ] + } + }, + "3703": { + "id": 3703, + "name": "createdAt", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "undefined" + } + ] + } + }, + "3704": { + "id": 3704, + "name": "credentialId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "undefined" + } + ] + } + }, + "3705": { + "id": 3705, + "name": "friendlyCredentialName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "undefined" + } + ] + } + }, + "3706": { + "id": 3706, + "name": "relyingPartyId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "undefined" + } + ] + } + }, + "3716": { + "id": 3716, + "name": "DeleteWebAuthnCredentialInput", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + 3717 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3717 + ] + } + ] + }, + "3717": { + "id": 3717, + "name": "credentialId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + "3718": { + "id": 3718, + "name": "FetchAuthSessionOptions", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + 3719, + 3720 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3719, + 3720 + ] + } + ] + }, + "3719": { + "id": 3719, + "name": "clientMetadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Auth/types.d.ts", + "qualifiedName": "ClientMetadata" + }, + "name": "ClientMetadata", + "package": "@aws-amplify/core" + } + }, + "3720": { + "id": 3720, + "name": "forceRefresh", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + "3721": { + "id": 3721, + "name": "FetchMFAPreferenceOutput", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + 3722, + 3723 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3722, + 3723 + ] + } + ] + }, + "3722": { + "id": 3722, + "name": "enabled", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/models.d.ts", + "qualifiedName": "AuthMFAType" + }, + "name": "AuthMFAType", + "package": "@aws-amplify/auth" + } + } + }, + "3723": { + "id": 3723, + "name": "preferred", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/models.d.ts", + "qualifiedName": "AuthMFAType" + }, + "name": "AuthMFAType", + "package": "@aws-amplify/auth" + } + }, + "3724": { + "id": 3724, + "name": "JWT", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + 3725, + 3726 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3725 + ] + }, + { + "title": "Methods", + "children": [ + 3726 + ] + } + ] + }, + "3725": { + "id": 3725, + "name": "payload", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Auth/types.d.ts", + "qualifiedName": "JwtPayload" + }, + "name": "JwtPayload", + "package": "@aws-amplify/core" + } + }, + "3726": { + "id": 3726, + "name": "toString", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + 3727 + ] + }, + "3727": { + "id": 3727, + "name": "toString", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + "3728": { + "id": 3728, + "name": "ListWebAuthnCredentialsInput", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type for Cognito listWebAuthnCredentials API." + } + ] + }, + "children": [ + 3729, + 3730 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3729, + 3730 + ] + } + ] + }, + "3729": { + "id": 3729, + "name": "nextToken", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + "3730": { + "id": 3730, + "name": "pageSize", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + "3731": { + "id": 3731, + "name": "ListWebAuthnCredentialsOutput", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Output type for Cognito listWebAuthnCredentials API." + } + ] + }, + "children": [ + 3732, + 3733 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3732, + 3733 + ] + } + ] + }, + "3732": { + "id": 3732, + "name": "credentials", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 3700, + "name": "AuthWebAuthnCredential", + "package": "@aws-amplify/auth" + } + } + }, + "3733": { + "id": 3733, + "name": "nextToken", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + "3740": { + "id": 3740, + "name": "UpdateMFAPreferenceInput", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type for Cognito updateMFAPreference API." + } + ] + }, + "children": [ + 3741, + 3742, + 3743 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3741, + 3742, + 3743 + ] + } + ] + }, + "3741": { + "id": 3741, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/models.d.ts", + "qualifiedName": "MFAPreference" + }, + "name": "MFAPreference", + "package": "@aws-amplify/auth" + } + }, + "3742": { + "id": 3742, + "name": "sms", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/models.d.ts", + "qualifiedName": "MFAPreference" + }, + "name": "MFAPreference", + "package": "@aws-amplify/auth" + } + }, + "3743": { + "id": 3743, + "name": "totp", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/models.d.ts", + "qualifiedName": "MFAPreference" + }, + "name": "MFAPreference", + "package": "@aws-amplify/auth" + } + }, + "3746": { + "id": 3746, + "name": "ConfirmResetPasswordInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type for Cognito confirmResetPassword API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthConfirmResetPasswordInput" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/options.d.ts", + "qualifiedName": "ConfirmResetPasswordOptions" + }, + "name": "ConfirmResetPasswordOptions", + "package": "@aws-amplify/auth" + } + ], + "name": "AuthConfirmResetPasswordInput", + "package": "@aws-amplify/auth" + } + }, + "3747": { + "id": 3747, + "name": "ConfirmSignInInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type for Cognito confirmSignIn API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthConfirmSignInInput" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/options.d.ts", + "qualifiedName": "ConfirmSignInOptions" + }, + "name": "ConfirmSignInOptions", + "package": "@aws-amplify/auth" + } + ], + "name": "AuthConfirmSignInInput", + "package": "@aws-amplify/auth" + } + }, + "3748": { + "id": 3748, + "name": "ConfirmSignInOutput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Output type for Cognito confirmSignIn API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "AuthSignInOutput" + }, + "name": "AuthSignInOutput", + "package": "@aws-amplify/auth" + } + }, + "3749": { + "id": 3749, + "name": "ConfirmSignUpInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type for Cognito confirmSignUp API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthConfirmSignUpInput" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/options.d.ts", + "qualifiedName": "ConfirmSignUpOptions" + }, + "name": "ConfirmSignUpOptions", + "package": "@aws-amplify/auth" + } + ], + "name": "AuthConfirmSignUpInput", + "package": "@aws-amplify/auth" + } + }, + "3750": { + "id": 3750, + "name": "ConfirmSignUpOutput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Output type for Cognito confirmSignUp API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "AuthSignUpOutput" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Auth/types.d.ts", + "qualifiedName": "AuthVerifiableAttributeKey" + }, + "name": "AuthVerifiableAttributeKey", + "package": "@aws-amplify/core" + } + ], + "name": "AuthSignUpOutput", + "package": "@aws-amplify/auth" + } + }, + "3751": { + "id": 3751, + "name": "ConfirmUserAttributeInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type for Cognito confirmUserAttribute API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthConfirmUserAttributeInput" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Auth/types.d.ts", + "qualifiedName": "AuthVerifiableAttributeKey" + }, + "name": "AuthVerifiableAttributeKey", + "package": "@aws-amplify/core" + } + ], + "name": "AuthConfirmUserAttributeInput", + "package": "@aws-amplify/auth" + } + }, + "3752": { + "id": 3752, + "name": "DeleteUserAttributesInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type for Cognito deleteUserAttributes API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthDeleteUserAttributesInput" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3776, + "name": "UserAttributeKey", + "package": "@aws-amplify/auth" + } + ], + "name": "AuthDeleteUserAttributesInput", + "package": "@aws-amplify/auth" + } + }, + "3753": { + "id": 3753, + "name": "FetchDevicesOutput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Output type for Cognito fetchDevices API." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/models.d.ts", + "qualifiedName": "AWSAuthDevice" + }, + "name": "AWSAuthDevice", + "package": "@aws-amplify/auth" + } + } + }, + "3758": { + "id": 3758, + "name": "ResendSignUpCodeInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type for Cognito resendSignUpCode API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthResendSignUpCodeInput" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/options.d.ts", + "qualifiedName": "ResendSignUpCodeOptions" + }, + "name": "ResendSignUpCodeOptions", + "package": "@aws-amplify/auth" + } + ], + "name": "AuthResendSignUpCodeInput", + "package": "@aws-amplify/auth" + } + }, + "3759": { + "id": 3759, + "name": "ResendSignUpCodeOutput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Output type for Cognito resendSignUpCode API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/models.d.ts", + "qualifiedName": "AuthCodeDeliveryDetails" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Auth/types.d.ts", + "qualifiedName": "AuthVerifiableAttributeKey" + }, + "name": "AuthVerifiableAttributeKey", + "package": "@aws-amplify/core" + } + ], + "name": "AuthCodeDeliveryDetails", + "package": "@aws-amplify/auth" + } + }, + "3760": { + "id": 3760, + "name": "ResetPasswordInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type for Cognito resetPassword API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthResetPasswordInput" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/options.d.ts", + "qualifiedName": "ResetPasswordOptions" + }, + "name": "ResetPasswordOptions", + "package": "@aws-amplify/auth" + } + ], + "name": "AuthResetPasswordInput", + "package": "@aws-amplify/auth" + } + }, + "3761": { + "id": 3761, + "name": "ResetPasswordOutput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Output type for Cognito resetPassword API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "AuthResetPasswordOutput" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Auth/types.d.ts", + "qualifiedName": "AuthVerifiableAttributeKey" + }, + "name": "AuthVerifiableAttributeKey", + "package": "@aws-amplify/core" + } + ], + "name": "AuthResetPasswordOutput", + "package": "@aws-amplify/auth" + } + }, + "3762": { + "id": 3762, + "name": "SendUserAttributeVerificationCodeInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type for Cognito sendUserAttributeVerificationCode API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthSendUserAttributeVerificationCodeInput" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3777, + "name": "VerifiableUserAttributeKey", + "package": "@aws-amplify/auth" + }, + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/options.d.ts", + "qualifiedName": "SendUserAttributeVerificationCodeOptions" + }, + "name": "SendUserAttributeVerificationCodeOptions", + "package": "@aws-amplify/auth" + } + ], + "name": "AuthSendUserAttributeVerificationCodeInput", + "package": "@aws-amplify/auth" + } + }, + "3763": { + "id": 3763, + "name": "SendUserAttributeVerificationCodeOutput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Output type for Cognito sendUserAttributeVerificationCode API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/models.d.ts", + "qualifiedName": "AuthCodeDeliveryDetails" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Auth/types.d.ts", + "qualifiedName": "AuthVerifiableAttributeKey" + }, + "name": "AuthVerifiableAttributeKey", + "package": "@aws-amplify/core" + } + ], + "name": "AuthCodeDeliveryDetails", + "package": "@aws-amplify/auth" + } + }, + "3765": { + "id": 3765, + "name": "SignInInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type for Cognito signIn API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthSignInInput" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/options.d.ts", + "qualifiedName": "SignInOptions" + }, + "name": "SignInOptions", + "package": "@aws-amplify/auth" + } + ], + "name": "AuthSignInInput", + "package": "@aws-amplify/auth" + } + }, + "3766": { + "id": 3766, + "name": "SignInOutput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Output type for Cognito signIn API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "AuthSignInOutput" + }, + "name": "AuthSignInOutput", + "package": "@aws-amplify/auth" + } + }, + "3769": { + "id": 3769, + "name": "SignUpInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type for Cognito signUp API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthSignUpInput" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/options.d.ts", + "qualifiedName": "SignUpOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3776, + "name": "UserAttributeKey", + "package": "@aws-amplify/auth" + } + ], + "name": "SignUpOptions", + "package": "@aws-amplify/auth" + } + ], + "name": "AuthSignUpInput", + "package": "@aws-amplify/auth" + } + }, + "3770": { + "id": 3770, + "name": "SignUpOutput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Output type for Cognito signUp API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "AuthSignUpOutput" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Auth/types.d.ts", + "qualifiedName": "AuthVerifiableAttributeKey" + }, + "name": "AuthVerifiableAttributeKey", + "package": "@aws-amplify/core" + } + ], + "name": "AuthSignUpOutput", + "package": "@aws-amplify/auth" + } + }, + "3774": { + "id": 3774, + "name": "UpdateUserAttributesInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type for Cognito updateUserAttributes API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthUpdateUserAttributesInput" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3776, + "name": "UserAttributeKey", + "package": "@aws-amplify/auth" + }, + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/options.d.ts", + "qualifiedName": "UpdateUserAttributesOptions" + }, + "name": "UpdateUserAttributesOptions", + "package": "@aws-amplify/auth" + } + ], + "name": "AuthUpdateUserAttributesInput", + "package": "@aws-amplify/auth" + } + }, + "3775": { + "id": 3775, + "name": "UpdateUserAttributesOutput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Output type for Cognito updateUserAttributes API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "AuthUpdateUserAttributesOutput" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3776, + "name": "UserAttributeKey", + "package": "@aws-amplify/auth" + } + ], + "name": "AuthUpdateUserAttributesOutput", + "package": "@aws-amplify/auth" + } + }, + "3776": { + "id": 3776, + "name": "UserAttributeKey", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user attribute types available for Cognito." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Auth/types.d.ts", + "qualifiedName": "AuthStandardAttributeKey" + }, + "name": "AuthStandardAttributeKey", + "package": "@aws-amplify/core" + }, + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/models.d.ts", + "qualifiedName": "CustomAttribute" + }, + "name": "CustomAttribute", + "package": "@aws-amplify/auth" + } + ] + } + }, + "3777": { + "id": 3777, + "name": "VerifiableUserAttributeKey", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Verifiable user attribute types available for Cognito." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Auth/types.d.ts", + "qualifiedName": "AuthVerifiableAttributeKey" + }, + "name": "AuthVerifiableAttributeKey", + "package": "@aws-amplify/core" + } + }, + "3778": { + "id": 3778, + "name": "VerifyTOTPSetupInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type for Cognito verifyTOTPSetup API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthVerifyTOTPSetupInput" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/providers/cognito/types/options.d.ts", + "qualifiedName": "VerifyTOTPSetupOptions" + }, + "name": "VerifyTOTPSetupOptions", + "package": "@aws-amplify/auth" + } + ], + "name": "AuthVerifyTOTPSetupInput", + "package": "@aws-amplify/auth" + } + }, + "3784": { + "id": 3784, + "name": "associateWebAuthnCredential", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3785 + ] + }, + "3785": { + "id": 3785, + "name": "associateWebAuthnCredential", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Registers a new passkey for an authenticated user" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Promise" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "PasskeyError" + }, + { + "kind": "text", + "text": ":\n- Thrown when intermediate state is invalid" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AuthError", + "target": 3667 + }, + { + "kind": "text", + "text": ":\n- Thrown when user is unauthenticated" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "StartWebAuthnRegistrationException" + }, + { + "kind": "text", + "text": "\n- Thrown due to a service error retrieving WebAuthn registration options" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "CompleteWebAuthnRegistrationException" + }, + { + "kind": "text", + "text": "\n- Thrown due to a service error when verifying WebAuthn registration result" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3786": { + "id": 3786, + "name": "confirmResetPassword", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3787, + 3790 + ] + }, + "3787": { + "id": 3787, + "name": "confirmResetPassword", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3788, + 3789 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3788": { + "id": 3788, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3789": { + "id": 3789, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3746, + "name": "ConfirmResetPasswordInput", + "package": "@aws-amplify/auth" + } + }, + "3790": { + "id": 3790, + "name": "confirmResetPassword", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Confirms the new password and verification code to reset the password." + } + ], + "blockTags": [ + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "ConfirmForgotPasswordException" + }, + { + "kind": "text", + "text": "\nThrown due to an invalid confirmation code or password." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AuthValidationErrorCode" + }, + { + "kind": "text", + "text": "\nThrown due to an empty confirmation code, password or username." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] + } + ] + }, + "parameters": [ + 3791 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3791": { + "id": 3791, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ConfirmResetPasswordInput object." + } + ] + }, + "type": { + "type": "reference", + "target": 3746, + "name": "ConfirmResetPasswordInput", + "package": "@aws-amplify/auth" + } + }, + "3792": { + "id": 3792, + "name": "confirmSignIn", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3793, + 3796 + ] + }, + "3793": { + "id": 3793, + "name": "confirmSignIn", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3794, + 3795 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3748, + "name": "ConfirmSignInOutput", + "package": "@aws-amplify/auth" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3794": { + "id": 3794, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3795": { + "id": 3795, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3747, + "name": "ConfirmSignInInput", + "package": "@aws-amplify/auth" + } + }, + "3796": { + "id": 3796, + "name": "confirmSignIn", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Continues or completes the sign in process when required by the initial call to " + }, + { + "kind": "code", + "text": "`signIn`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "ConfirmSignInOutput" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "VerifySoftwareTokenException" + }, + { + "kind": "text", + "text": ":\nThrown due to an invalid MFA token." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "RespondToAuthChallengeException" + }, + { + "kind": "text", + "text": ":\nThrown due to an invalid auth challenge response." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AssociateSoftwareTokenException" + }, + { + "kind": "text", + "text": ":\nThrown due to a service error during the MFA setup process." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AuthValidationErrorCode" + }, + { + "kind": "text", + "text": ":\nThrown when " + }, + { + "kind": "code", + "text": "`challengeResponse`" + }, + { + "kind": "text", + "text": " is not defined." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] + } + ] + }, + "parameters": [ + 3797 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3748, + "name": "ConfirmSignInOutput", + "package": "@aws-amplify/auth" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3797": { + "id": 3797, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ConfirmSignInInput object" + } + ] + }, + "type": { + "type": "reference", + "target": 3747, + "name": "ConfirmSignInInput", + "package": "@aws-amplify/auth" + } + }, + "3798": { + "id": 3798, + "name": "confirmSignUp", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3799, + 3802 + ] + }, + "3799": { + "id": 3799, + "name": "confirmSignUp", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3800, + 3801 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3750, + "name": "ConfirmSignUpOutput", + "package": "@aws-amplify/auth" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3800": { + "id": 3800, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3801": { + "id": 3801, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3749, + "name": "ConfirmSignUpInput", + "package": "@aws-amplify/auth" + } + }, + "3802": { + "id": 3802, + "name": "confirmSignUp", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Confirms a new user account." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "ConfirmSignUpOutput" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "ConfirmSignUpException" + }, + { + "kind": "text", + "text": "\nThrown due to an invalid confirmation code." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AuthValidationErrorCode" + }, + { + "kind": "text", + "text": "\nThrown due to an empty confirmation code" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] + } + ] + }, + "parameters": [ + 3803 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3750, + "name": "ConfirmSignUpOutput", + "package": "@aws-amplify/auth" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3803": { + "id": 3803, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ConfirmSignUpInput object." + } + ] + }, + "type": { + "type": "reference", + "target": 3749, + "name": "ConfirmSignUpInput", + "package": "@aws-amplify/auth" + } + }, + "3804": { + "id": 3804, + "name": "confirmUserAttribute", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3805, + 3808 + ] + }, + "3805": { + "id": 3805, + "name": "confirmUserAttribute", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3806, + 3807 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3806": { + "id": 3806, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3807": { + "id": 3807, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3751, + "name": "ConfirmUserAttributeInput", + "package": "@aws-amplify/auth" + } + }, + "3808": { + "id": 3808, + "name": "confirmUserAttribute", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Confirms a user attribute with the confirmation code." + } + ], + "blockTags": [ + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AuthValidationErrorCode" + }, + { + "kind": "text", + "text": " -\nThrown when " + }, + { + "kind": "code", + "text": "`confirmationCode`" + }, + { + "kind": "text", + "text": " is not defined." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "VerifyUserAttributeException" + }, + { + "kind": "text", + "text": " - Thrown due to an invalid confirmation code or attribute." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] + } + ] + }, + "parameters": [ + 3809 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3809": { + "id": 3809, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ConfirmUserAttributeInput object" + } + ] + }, + "type": { + "type": "reference", + "target": 3751, + "name": "ConfirmUserAttributeInput", + "package": "@aws-amplify/auth" + } + }, + "3810": { + "id": 3810, + "name": "decodeJWT", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3811 + ] + }, + "3811": { + "id": 3811, + "name": "decodeJWT", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Decodes payload of JWT token" + } + ], + "blockTags": [ + { + "tag": "@throws", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "Error" + }, + { + "kind": "text", + "text": " - Throws error when token is invalid or payload malformed." + } + ] + } + ] + }, + "parameters": [ + 3812 + ], + "type": { + "type": "reference", + "target": 3724, + "name": "JWT", + "package": "@aws-amplify/core" + } + }, + "3812": { + "id": 3812, + "name": "token", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A string representing a token to be decoded" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + "3813": { + "id": 3813, + "name": "deleteUser", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3814, + 3816 + ] + }, + "3814": { + "id": 3814, + "name": "deleteUser", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3815 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3815": { + "id": 3815, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3816": { + "id": 3816, + "name": "deleteUser", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Deletes a user from the user pool while authenticated." + } + ], + "blockTags": [ + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "DeleteUserException" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3817": { + "id": 3817, + "name": "deleteUserAttributes", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3818, + 3821 + ] + }, + "3818": { + "id": 3818, + "name": "deleteUserAttributes", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3819, + 3820 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3819": { + "id": 3819, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3820": { + "id": 3820, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3752, + "name": "DeleteUserAttributesInput", + "package": "@aws-amplify/auth" + } + }, + "3821": { + "id": 3821, + "name": "deleteUserAttributes", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Deletes user attributes." + } + ], + "blockTags": [ + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "DeleteUserAttributesException" + }, + { + "kind": "text", + "text": " - Thrown due to invalid attribute." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] + } + ] + }, + "parameters": [ + 3822 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3822": { + "id": 3822, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The DeleteUserAttributesInput object" + } + ] + }, + "type": { + "type": "reference", + "target": 3752, + "name": "DeleteUserAttributesInput", + "package": "@aws-amplify/auth" + } + }, + "3823": { + "id": 3823, + "name": "deleteWebAuthnCredential", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3824 + ] + }, + "3824": { + "id": 3824, + "name": "deleteWebAuthnCredential", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete a registered credential for an authenticated user by credentialId" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Promise" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AuthError", + "target": 3667 + }, + { + "kind": "text", + "text": ":\n- Thrown when user is unauthenticated" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "DeleteWebAuthnCredentialException" + }, + { + "kind": "text", + "text": "\n- Thrown due to a service error when deleting a WebAuthn credential" + } + ] + } + ] + }, + "parameters": [ + 3825 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3825": { + "id": 3825, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The delete input parameters including the credentialId" + } + ] + }, + "type": { + "type": "reference", + "target": 3716, + "name": "DeleteWebAuthnCredentialInput", + "package": "@aws-amplify/auth" + } + }, + "3826": { + "id": 3826, + "name": "fetchAuthSession", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3827, + 3830 + ] + }, + "3827": { + "id": 3827, + "name": "fetchAuthSession", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Fetch the auth session of the given " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AmplifyContext", + "target": 5131 + }, + { + "kind": "text", + "text": " — e.g. the\nper-request context handed to an SSR " + }, + { + "kind": "code", + "text": "`runWithAmplifyServerContext`" + }, + { + "kind": "text", + "text": "\noperation — instead of the global context. This restores the pre-context\nv6 SSR calling pattern " + }, + { + "kind": "code", + "text": "`fetchAuthSession(contextSpec)`" + }, + { + "kind": "text", + "text": " (the deprecated\n" + }, + { + "kind": "code", + "text": "`ContextSpec`" + }, + { + "kind": "text", + "text": " type is an alias of " + }, + { + "kind": "code", + "text": "`AmplifyContext`" + }, + { + "kind": "text", + "text": ", so existing SSR code\ncompiles unchanged)." + } + ], + "blockTags": [ + { + "tag": "@throws", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "AuthError", + "target": 3667 + }, + { + "kind": "text", + "text": " - Throws error when session information cannot be refreshed." + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Promise" + } + ] + } + ] + }, + "parameters": [ + 3828, + 3829 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3687, + "name": "AuthSession", + "package": "@aws-amplify/core" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3828": { + "id": 3828, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The explicit " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AmplifyContext", + "target": 5131 + }, + { + "kind": "text", + "text": " whose auth providers are used." + } + ] + }, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3829": { + "id": 3829, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options configuring the fetch behavior." + } + ] + }, + "type": { + "type": "reference", + "target": 3718, + "name": "FetchAuthSessionOptions", + "package": "@aws-amplify/core" + } + }, + "3830": { + "id": 3830, + "name": "fetchAuthSession", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Fetch the auth session including the tokens and credentials if they are available. By default it\nwill automatically refresh expired auth tokens if a valid refresh token is present. You can force a refresh\nof non-expired tokens with " + }, + { + "kind": "code", + "text": "`{ forceRefresh: true }`" + }, + { + "kind": "text", + "text": " input." + } + ], + "blockTags": [ + { + "tag": "@throws", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "AuthError", + "target": 3667 + }, + { + "kind": "text", + "text": " - Throws error when session information cannot be refreshed." + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Promise — before " + }, + { + "kind": "code", + "text": "`Amplify.configure()`" + }, + { + "kind": "text", + "text": " has run this\nresolves with an empty session (all fields " + }, + { + "kind": "code", + "text": "`undefined`" + }, + { + "kind": "text", + "text": "), matching the\npre-context behavior." + } + ] + } + ] + }, + "parameters": [ + 3831 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3687, + "name": "AuthSession", + "package": "@aws-amplify/core" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3831": { + "id": 3831, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options configuring the fetch behavior." } ] }, - "children": [ - 3404, - 3405, - 3406, - 3407, - 3408, - 3409 - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3404, - 3405, - 3406, - 3407, - 3408, - 3409 - ] - } - ] - }, - "3404": { - "id": 3404, - "name": "authenticatorAttachment", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": 3718, + "name": "FetchAuthSessionOptions", + "package": "@aws-amplify/core" } }, - "3405": { - "id": 3405, - "name": "authenticatorTransports", + "3832": { + "id": 3832, + "name": "fetchDevices", "variant": "declaration", - "kind": 1024, + "kind": 64, "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "intrinsic", - "name": "undefined" - } - ] - } + "signatures": [ + 3833, + 3835 + ] }, - "3406": { - "id": 3406, - "name": "createdAt", - "variant": "declaration", - "kind": 1024, + "3833": { + "id": 3833, + "name": "fetchDevices", + "variant": "signature", + "kind": 4096, "flags": {}, + "parameters": [ + 3834 + ], "type": { - "type": "union", - "types": [ + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ { "type": "reference", - "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "undefined" + "target": 3753, + "name": "FetchDevicesOutput", + "package": "@aws-amplify/auth" } - ] + ], + "name": "Promise", + "package": "typescript" } }, - "3407": { - "id": 3407, - "name": "credentialId", - "variant": "declaration", - "kind": 1024, + "3834": { + "id": 3834, + "name": "ctx", + "variant": "param", + "kind": 32768, "flags": {}, "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "undefined" - } - ] + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" } }, - "3408": { - "id": 3408, - "name": "friendlyCredentialName", - "variant": "declaration", - "kind": 1024, + "3835": { + "id": 3835, + "name": "fetchDevices", + "variant": "signature", + "kind": 4096, "flags": {}, - "type": { - "type": "union", - "types": [ + "comment": { + "summary": [ { - "type": "intrinsic", - "name": "string" + "kind": "text", + "text": "Fetches devices that have been remembered using " }, { - "type": "intrinsic", - "name": "undefined" + "kind": "inline-tag", + "tag": "@link", + "text": "rememberDevice", + "target": 3857 + }, + { + "kind": "text", + "text": "\nfor the currently authenticated user." } - ] - } - }, - "3409": { - "id": 3409, - "name": "relyingPartyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ + ], + "blockTags": [ { - "type": "intrinsic", - "name": "string" + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "FetchDevicesOutput" + } + ] }, { - "type": "intrinsic", - "name": "undefined" + "tag": "@throws", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "ListDevicesException" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] } ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3753, + "name": "FetchDevicesOutput", + "package": "@aws-amplify/auth" + } + ], + "name": "Promise", + "package": "typescript" } }, - "3419": { - "id": 3419, - "name": "DeleteWebAuthnCredentialInput", + "3836": { + "id": 3836, + "name": "fetchMFAPreference", "variant": "declaration", - "kind": 256, + "kind": 64, "flags": {}, - "children": [ - 3420 - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3420 - ] - } + "signatures": [ + 3837, + 3839 ] }, - "3420": { - "id": 3420, - "name": "credentialId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - "3424": { - "id": 3424, - "name": "FetchMFAPreferenceOutput", - "variant": "declaration", - "kind": 256, + "3837": { + "id": 3837, + "name": "fetchMFAPreference", + "variant": "signature", + "kind": 4096, "flags": {}, - "children": [ - 3425, - 3426 + "parameters": [ + 3838 ], - "groups": [ - { - "title": "Properties", - "children": [ - 3425, - 3426 - ] - } - ] - }, - "3425": { - "id": 3425, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/models.d.ts", - "qualifiedName": "AuthMFAType" - }, - "name": "AuthMFAType", - "package": "@aws-amplify/auth" - } + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3721, + "name": "FetchMFAPreferenceOutput", + "package": "@aws-amplify/auth" + } + ], + "name": "Promise", + "package": "typescript" } }, - "3426": { - "id": 3426, - "name": "preferred", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, + "3838": { + "id": 3838, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, "type": { "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/models.d.ts", - "qualifiedName": "AuthMFAType" - }, - "name": "AuthMFAType", - "package": "@aws-amplify/auth" + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" } }, - "3427": { - "id": 3427, - "name": "JWT", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - 3428, - 3429 - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3428 - ] - }, - { - "title": "Methods", - "children": [ - 3429 - ] - } - ] - }, - "3428": { - "id": 3428, - "name": "payload", - "variant": "declaration", - "kind": 1024, + "3839": { + "id": 3839, + "name": "fetchMFAPreference", + "variant": "signature", + "kind": 4096, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Fetches the preferred MFA setting and enabled MFA settings for the user." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "FetchMFAPreferenceOutput" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "GetUserException" + }, + { + "kind": "text", + "text": " : error thrown when the service fails to fetch MFA preference\nand settings." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] + } + ] + }, "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/core", - "packagePath": "dist/esm/singleton/Auth/types.d.ts", - "qualifiedName": "JwtPayload" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, - "name": "JwtPayload", - "package": "@aws-amplify/core" + "typeArguments": [ + { + "type": "reference", + "target": 3721, + "name": "FetchMFAPreferenceOutput", + "package": "@aws-amplify/auth" + } + ], + "name": "Promise", + "package": "typescript" } }, - "3429": { - "id": 3429, - "name": "toString", + "3840": { + "id": 3840, + "name": "fetchUserAttributes", "variant": "declaration", - "kind": 2048, + "kind": 64, "flags": {}, "signatures": [ - 3430 + 3841, + 3843 ] }, - "3430": { - "id": 3430, - "name": "toString", + "3841": { + "id": 3841, + "name": "fetchUserAttributes", "variant": "signature", "kind": 4096, "flags": {}, + "parameters": [ + 3842 + ], "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3776, + "name": "UserAttributeKey", + "package": "@aws-amplify/auth" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Record", + "package": "typescript" + } + ], + "name": "Partial", + "package": "typescript" + } + ], + "name": "Promise", + "package": "typescript" } }, - "3431": { - "id": 3431, - "name": "ListWebAuthnCredentialsInput", - "variant": "declaration", - "kind": 256, + "3842": { + "id": 3842, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3843": { + "id": 3843, + "name": "fetchUserAttributes", + "variant": "signature", + "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Input type for Cognito listWebAuthnCredentials API." + "text": "Fetches the current user attributes while authenticated." + } + ], + "blockTags": [ + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "GetUserException" + }, + { + "kind": "text", + "text": " - Cognito service errors thrown when the service is not able to get the user." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] } ] }, - "children": [ - 3432, - 3433 - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3432, - 3433 - ] - } - ] - }, - "3432": { - "id": 3432, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, "type": { - "type": "intrinsic", - "name": "string" - } - }, - "3433": { - "id": 3433, - "name": "pageSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3776, + "name": "UserAttributeKey", + "package": "@aws-amplify/auth" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Record", + "package": "typescript" + } + ], + "name": "Partial", + "package": "typescript" + } + ], + "name": "Promise", + "package": "typescript" } }, - "3434": { - "id": 3434, - "name": "ListWebAuthnCredentialsOutput", + "3844": { + "id": 3844, + "name": "forgetDevice", "variant": "declaration", - "kind": 256, + "kind": 64, "flags": {}, - "comment": { - "summary": [ + "signatures": [ + 3845, + 3848 + ] + }, + "3845": { + "id": 3845, + "name": "forgetDevice", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3846, + 3847 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ { - "kind": "text", - "text": "Output type for Cognito listWebAuthnCredentials API." + "type": "intrinsic", + "name": "void" } - ] - }, - "children": [ - 3435, - 3436 - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3435, - 3436 - ] - } - ] + ], + "name": "Promise", + "package": "typescript" + } }, - "3435": { - "id": 3435, - "name": "credentials", - "variant": "declaration", - "kind": 1024, + "3846": { + "id": 3846, + "name": "ctx", + "variant": "param", + "kind": 32768, "flags": {}, "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 3403, - "name": "AuthWebAuthnCredential", - "package": "@aws-amplify/auth" - } + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" } }, - "3436": { - "id": 3436, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, + "3847": { + "id": 3847, + "name": "input", + "variant": "param", + "kind": 32768, "flags": { "isOptional": true }, "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthForgetDeviceInput" + }, + "name": "AuthForgetDeviceInput", + "package": "@aws-amplify/auth" } }, - "3443": { - "id": 3443, - "name": "UpdateMFAPreferenceInput", - "variant": "declaration", - "kind": 256, + "3848": { + "id": 3848, + "name": "forgetDevice", + "variant": "signature", + "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Input type for Cognito updateMFAPreference API." + "text": "Forget a remembered device while authenticated." + } + ], + "blockTags": [ + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "ForgetDeviceException" + }, + { + "kind": "text", + "text": " - Cognito service errors thrown when\nforgetting device with invalid device key" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] } ] }, - "children": [ - 3444, - 3445, - 3446 + "parameters": [ + 3849 ], - "groups": [ - { - "title": "Properties", - "children": [ - 3444, - 3445, - 3446 - ] - } - ] - }, - "3444": { - "id": 3444, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/providers/cognito/types/models.d.ts", - "qualifiedName": "MFAPreference" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, - "name": "MFAPreference", - "package": "@aws-amplify/auth" + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" } }, - "3445": { - "id": 3445, - "name": "sms", - "variant": "declaration", - "kind": 1024, + "3849": { + "id": 3849, + "name": "input", + "variant": "param", + "kind": 32768, "flags": { "isOptional": true }, - "type": { - "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/providers/cognito/types/models.d.ts", - "qualifiedName": "MFAPreference" - }, - "name": "MFAPreference", - "package": "@aws-amplify/auth" - } - }, - "3446": { - "id": 3446, - "name": "totp", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ForgetDeviceInput object." + } + ] }, "type": { "type": "reference", "target": { "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/providers/cognito/types/models.d.ts", - "qualifiedName": "MFAPreference" + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthForgetDeviceInput" }, - "name": "MFAPreference", + "name": "AuthForgetDeviceInput", "package": "@aws-amplify/auth" } }, - "3449": { - "id": 3449, - "name": "ConfirmResetPasswordInput", + "3850": { + "id": 3850, + "name": "getCurrentUser", "variant": "declaration", - "kind": 2097152, + "kind": 64, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input type for Cognito confirmResetPassword API." - } - ] - }, + "signatures": [ + 3851, + 3853 + ] + }, + "3851": { + "id": 3851, + "name": "getCurrentUser", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3852 + ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "AuthConfirmResetPasswordInput" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/providers/cognito/types/options.d.ts", - "qualifiedName": "ConfirmResetPasswordOptions" - }, - "name": "ConfirmResetPasswordOptions", + "target": 3696, + "name": "AuthUser", "package": "@aws-amplify/auth" } ], - "name": "AuthConfirmResetPasswordInput", - "package": "@aws-amplify/auth" + "name": "Promise", + "package": "typescript" } }, - "3450": { - "id": 3450, - "name": "ConfirmSignInInput", - "variant": "declaration", - "kind": 2097152, + "3852": { + "id": 3852, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3853": { + "id": 3853, + "name": "getCurrentUser", + "variant": "signature", + "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Input type for Cognito confirmSignIn API." + "text": "Gets the current user from the idToken." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "GetCurrentUserOutput" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "InitiateAuthException" + }, + { + "kind": "text", + "text": " - Thrown when the service fails to refresh the tokens." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] } ] }, "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "AuthConfirmSignInInput" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/providers/cognito/types/options.d.ts", - "qualifiedName": "ConfirmSignInOptions" - }, - "name": "ConfirmSignInOptions", + "target": 3696, + "name": "AuthUser", "package": "@aws-amplify/auth" } ], - "name": "AuthConfirmSignInInput", - "package": "@aws-amplify/auth" + "name": "Promise", + "package": "typescript" } }, - "3451": { - "id": 3451, - "name": "ConfirmSignInOutput", + "3854": { + "id": 3854, + "name": "listWebAuthnCredentials", "variant": "declaration", - "kind": 2097152, + "kind": 64, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Output type for Cognito confirmSignIn API." - } - ] - }, - "type": { - "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/outputs.d.ts", - "qualifiedName": "AuthSignInOutput" - }, - "name": "AuthSignInOutput", - "package": "@aws-amplify/auth" - } + "signatures": [ + 3855 + ] }, - "3452": { - "id": 3452, - "name": "ConfirmSignUpInput", - "variant": "declaration", - "kind": 2097152, + "3855": { + "id": 3855, + "name": "listWebAuthnCredentials", + "variant": "signature", + "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Input type for Cognito confirmSignUp API." + "text": "Lists registered credentials for an authenticated user" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Promise" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AuthError", + "target": 3667 + }, + { + "kind": "text", + "text": ":\n- Thrown when user is unauthenticated" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "ListWebAuthnCredentialsException" + }, + { + "kind": "text", + "text": "\n- Thrown due to a service error when listing WebAuthn credentials" + } + ] } ] }, + "parameters": [ + 3856 + ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "AuthConfirmSignUpInput" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/providers/cognito/types/options.d.ts", - "qualifiedName": "ConfirmSignUpOptions" - }, - "name": "ConfirmSignUpOptions", + "target": 3731, + "name": "ListWebAuthnCredentialsOutput", "package": "@aws-amplify/auth" } ], - "name": "AuthConfirmSignUpInput", - "package": "@aws-amplify/auth" + "name": "Promise", + "package": "typescript" } }, - "3453": { - "id": 3453, - "name": "ConfirmSignUpOutput", - "variant": "declaration", - "kind": 2097152, - "flags": {}, + "3856": { + "id": 3856, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { "kind": "text", - "text": "Output type for Cognito confirmSignUp API." + "text": "The list input parameters including page size and next token." } ] }, + "type": { + "type": "reference", + "target": 3728, + "name": "ListWebAuthnCredentialsInput", + "package": "@aws-amplify/auth" + } + }, + "3857": { + "id": 3857, + "name": "rememberDevice", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3858, + 3860 + ] + }, + "3858": { + "id": 3858, + "name": "rememberDevice", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3859 + ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/outputs.d.ts", - "qualifiedName": "AuthSignUpOutput" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { - "type": "reference", - "target": { - "packageName": "@aws-amplify/core", - "packagePath": "dist/esm/singleton/Auth/types.d.ts", - "qualifiedName": "AuthVerifiableAttributeKey" - }, - "name": "AuthVerifiableAttributeKey", - "package": "@aws-amplify/core" + "type": "intrinsic", + "name": "void" } ], - "name": "AuthSignUpOutput", - "package": "@aws-amplify/auth" + "name": "Promise", + "package": "typescript" } }, - "3454": { - "id": 3454, - "name": "ConfirmUserAttributeInput", - "variant": "declaration", - "kind": 2097152, + "3859": { + "id": 3859, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3860": { + "id": 3860, + "name": "rememberDevice", + "variant": "signature", + "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Input type for Cognito confirmUserAttribute API." + "text": "Marks device as remembered while authenticated." + } + ], + "blockTags": [ + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "UpdateDeviceStatusException" + }, + { + "kind": "text", + "text": " - Cognito service errors thrown when\nsetting device status to remembered using an invalid device key." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] } ] }, "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "AuthConfirmUserAttributeInput" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { - "type": "reference", - "target": { - "packageName": "@aws-amplify/core", - "packagePath": "dist/esm/singleton/Auth/types.d.ts", - "qualifiedName": "AuthVerifiableAttributeKey" - }, - "name": "AuthVerifiableAttributeKey", - "package": "@aws-amplify/core" + "type": "intrinsic", + "name": "void" } ], - "name": "AuthConfirmUserAttributeInput", - "package": "@aws-amplify/auth" + "name": "Promise", + "package": "typescript" } }, - "3455": { - "id": 3455, - "name": "DeleteUserAttributesInput", + "3861": { + "id": 3861, + "name": "resendSignUpCode", "variant": "declaration", - "kind": 2097152, + "kind": 64, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input type for Cognito deleteUserAttributes API." - } - ] - }, + "signatures": [ + 3862, + 3865 + ] + }, + "3862": { + "id": 3862, + "name": "resendSignUpCode", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3863, + 3864 + ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "AuthDeleteUserAttributesInput" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": 3479, - "name": "UserAttributeKey", + "target": 3759, + "name": "ResendSignUpCodeOutput", "package": "@aws-amplify/auth" } ], - "name": "AuthDeleteUserAttributesInput", - "package": "@aws-amplify/auth" + "name": "Promise", + "package": "typescript" } }, - "3456": { - "id": 3456, - "name": "FetchDevicesOutput", - "variant": "declaration", - "kind": 2097152, + "3863": { + "id": 3863, + "name": "ctx", + "variant": "param", + "kind": 32768, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Output type for Cognito fetchDevices API." - } - ] - }, "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/providers/cognito/types/models.d.ts", - "qualifiedName": "AWSAuthDevice" - }, - "name": "AWSAuthDevice", - "package": "@aws-amplify/auth" - } + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" } }, - "3461": { - "id": 3461, - "name": "ResendSignUpCodeInput", - "variant": "declaration", - "kind": 2097152, + "3864": { + "id": 3864, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3758, + "name": "ResendSignUpCodeInput", + "package": "@aws-amplify/auth" + } + }, + "3865": { + "id": 3865, + "name": "resendSignUpCode", + "variant": "signature", + "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Input type for Cognito resendSignUpCode API." + "text": "Resend the confirmation code while signing up" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "ResendSignUpCodeOutput" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "service: " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "ResendConfirmationException" + }, + { + "kind": "text", + "text": " - Cognito service errors thrown when resending the code." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "validation: " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AuthValidationErrorCode" + }, + { + "kind": "text", + "text": " - Validation errors thrown either username are not defined." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] } ] }, + "parameters": [ + 3866 + ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "AuthResendSignUpCodeInput" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/providers/cognito/types/options.d.ts", - "qualifiedName": "ResendSignUpCodeOptions" - }, - "name": "ResendSignUpCodeOptions", + "target": 3759, + "name": "ResendSignUpCodeOutput", "package": "@aws-amplify/auth" } ], - "name": "AuthResendSignUpCodeInput", - "package": "@aws-amplify/auth" + "name": "Promise", + "package": "typescript" } }, - "3462": { - "id": 3462, - "name": "ResendSignUpCodeOutput", - "variant": "declaration", - "kind": 2097152, + "3866": { + "id": 3866, + "name": "input", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Output type for Cognito resendSignUpCode API." + "text": "The ResendSignUpCodeInput object" } ] }, + "type": { + "type": "reference", + "target": 3758, + "name": "ResendSignUpCodeInput", + "package": "@aws-amplify/auth" + } + }, + "3867": { + "id": 3867, + "name": "resetPassword", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3868, + 3871 + ] + }, + "3868": { + "id": 3868, + "name": "resetPassword", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3869, + 3870 + ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/models.d.ts", - "qualifiedName": "AuthCodeDeliveryDetails" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/core", - "packagePath": "dist/esm/singleton/Auth/types.d.ts", - "qualifiedName": "AuthVerifiableAttributeKey" - }, - "name": "AuthVerifiableAttributeKey", - "package": "@aws-amplify/core" + "target": 3761, + "name": "ResetPasswordOutput", + "package": "@aws-amplify/auth" } ], - "name": "AuthCodeDeliveryDetails", + "name": "Promise", + "package": "typescript" + } + }, + "3869": { + "id": 3869, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3870": { + "id": 3870, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3760, + "name": "ResetPasswordInput", "package": "@aws-amplify/auth" } }, - "3463": { - "id": 3463, - "name": "ResetPasswordInput", - "variant": "declaration", - "kind": 2097152, + "3871": { + "id": 3871, + "name": "resetPassword", + "variant": "signature", + "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Input type for Cognito resetPassword API." + "text": "Resets a user's password." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "ResetPasswordOutput" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "ForgotPasswordException" + }, + { + "kind": "text", + "text": "\nThrown due to an invalid confirmation code or password." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AuthValidationErrorCode" + }, + { + "kind": "text", + "text": "\nThrown due to an empty username." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] } ] }, + "parameters": [ + 3872 + ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "AuthResetPasswordInput" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/providers/cognito/types/options.d.ts", - "qualifiedName": "ResetPasswordOptions" - }, - "name": "ResetPasswordOptions", + "target": 3761, + "name": "ResetPasswordOutput", "package": "@aws-amplify/auth" } ], - "name": "AuthResetPasswordInput", - "package": "@aws-amplify/auth" + "name": "Promise", + "package": "typescript" } }, - "3464": { - "id": 3464, - "name": "ResetPasswordOutput", - "variant": "declaration", - "kind": 2097152, + "3872": { + "id": 3872, + "name": "input", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Output type for Cognito resetPassword API." + "text": "The ResetPasswordInput object." } ] }, + "type": { + "type": "reference", + "target": 3760, + "name": "ResetPasswordInput", + "package": "@aws-amplify/auth" + } + }, + "3873": { + "id": 3873, + "name": "sendUserAttributeVerificationCode", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3874, + 3877 + ] + }, + "3874": { + "id": 3874, + "name": "sendUserAttributeVerificationCode", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3875, + 3876 + ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/outputs.d.ts", - "qualifiedName": "AuthResetPasswordOutput" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/core", - "packagePath": "dist/esm/singleton/Auth/types.d.ts", - "qualifiedName": "AuthVerifiableAttributeKey" - }, - "name": "AuthVerifiableAttributeKey", - "package": "@aws-amplify/core" + "target": 3763, + "name": "SendUserAttributeVerificationCodeOutput", + "package": "@aws-amplify/auth" } ], - "name": "AuthResetPasswordOutput", + "name": "Promise", + "package": "typescript" + } + }, + "3875": { + "id": 3875, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3876": { + "id": 3876, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3762, + "name": "SendUserAttributeVerificationCodeInput", "package": "@aws-amplify/auth" } }, - "3468": { - "id": 3468, - "name": "SignInInput", - "variant": "declaration", - "kind": 2097152, + "3877": { + "id": 3877, + "name": "sendUserAttributeVerificationCode", + "variant": "signature", + "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Input type for Cognito signIn API." + "text": "Resends user's confirmation code when updating attributes while authenticated." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "SendUserAttributeVerificationCodeOutput" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "GetUserAttributeVerificationException" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] } ] }, + "parameters": [ + 3878 + ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "AuthSignInInput" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/providers/cognito/types/options.d.ts", - "qualifiedName": "SignInOptions" - }, - "name": "SignInOptions", + "target": 3763, + "name": "SendUserAttributeVerificationCodeOutput", "package": "@aws-amplify/auth" } ], - "name": "AuthSignInInput", - "package": "@aws-amplify/auth" + "name": "Promise", + "package": "typescript" } }, - "3469": { - "id": 3469, - "name": "SignInOutput", - "variant": "declaration", - "kind": 2097152, + "3878": { + "id": 3878, + "name": "input", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Output type for Cognito signIn API." + "text": "The SendUserAttributeVerificationCodeInput object" } ] }, "type": { "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/outputs.d.ts", - "qualifiedName": "AuthSignInOutput" - }, - "name": "AuthSignInOutput", + "target": 3762, + "name": "SendUserAttributeVerificationCodeInput", "package": "@aws-amplify/auth" } }, - "3472": { - "id": 3472, - "name": "SignUpInput", + "3879": { + "id": 3879, + "name": "setUpTOTP", "variant": "declaration", - "kind": 2097152, + "kind": 64, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input type for Cognito signUp API." - } - ] - }, + "signatures": [ + 3880, + 3882 + ] + }, + "3880": { + "id": 3880, + "name": "setUpTOTP", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3881 + ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "AuthSignUpInput" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/providers/cognito/types/options.d.ts", - "qualifiedName": "SignUpOptions" + "packagePath": "dist/esm/types/models.d.ts", + "qualifiedName": "AuthTOTPSetupDetails" }, - "typeArguments": [ - { - "type": "reference", - "target": 3479, - "name": "UserAttributeKey", - "package": "@aws-amplify/auth" - } - ], - "name": "SignUpOptions", + "name": "AuthTOTPSetupDetails", "package": "@aws-amplify/auth" } ], - "name": "AuthSignUpInput", - "package": "@aws-amplify/auth" + "name": "Promise", + "package": "typescript" } }, - "3473": { - "id": 3473, - "name": "SignUpOutput", - "variant": "declaration", - "kind": 2097152, + "3881": { + "id": 3881, + "name": "ctx", + "variant": "param", + "kind": 32768, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Output type for Cognito signUp API." - } - ] - }, "type": { "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/outputs.d.ts", - "qualifiedName": "AuthSignUpOutput" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/core", - "packagePath": "dist/esm/singleton/Auth/types.d.ts", - "qualifiedName": "AuthVerifiableAttributeKey" - }, - "name": "AuthVerifiableAttributeKey", - "package": "@aws-amplify/core" - } - ], - "name": "AuthSignUpOutput", - "package": "@aws-amplify/auth" + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" } }, - "3479": { - "id": 3479, - "name": "UserAttributeKey", - "variant": "declaration", - "kind": 2097152, + "3882": { + "id": 3882, + "name": "setUpTOTP", + "variant": "signature", + "kind": 4096, "flags": {}, "comment": { "summary": [ { - "kind": "text", - "text": "The user attribute types available for Cognito." + "kind": "text", + "text": "Sets up TOTP for the user." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "SetUpTOTPOutput" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AssociateSoftwareTokenException" + }, + { + "kind": "text", + "text": "\nThrown if a service occurs while setting up TOTP." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] } ] }, "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/core", - "packagePath": "dist/esm/singleton/Auth/types.d.ts", - "qualifiedName": "AuthStandardAttributeKey" - }, - "name": "AuthStandardAttributeKey", - "package": "@aws-amplify/core" - }, + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ { "type": "reference", "target": { "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/providers/cognito/types/models.d.ts", - "qualifiedName": "CustomAttribute" + "packagePath": "dist/esm/types/models.d.ts", + "qualifiedName": "AuthTOTPSetupDetails" }, - "name": "CustomAttribute", + "name": "AuthTOTPSetupDetails", "package": "@aws-amplify/auth" } - ] + ], + "name": "Promise", + "package": "typescript" } }, - "3481": { - "id": 3481, - "name": "VerifyTOTPSetupInput", + "3883": { + "id": 3883, + "name": "signIn", "variant": "declaration", - "kind": 2097152, + "kind": 64, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input type for Cognito verifyTOTPSetup API." - } - ] - }, + "signatures": [ + 3884, + 3887 + ] + }, + "3884": { + "id": 3884, + "name": "signIn", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3885, + 3886 + ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "AuthVerifyTOTPSetupInput" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/providers/cognito/types/options.d.ts", - "qualifiedName": "VerifyTOTPSetupOptions" - }, - "name": "VerifyTOTPSetupOptions", + "target": 3766, + "name": "SignInOutput", "package": "@aws-amplify/auth" } ], - "name": "AuthVerifyTOTPSetupInput", - "package": "@aws-amplify/auth" + "name": "Promise", + "package": "typescript" } }, - "3505": { - "id": 3505, - "name": "associateWebAuthnCredential", - "variant": "declaration", - "kind": 64, + "3885": { + "id": 3885, + "name": "ctx", + "variant": "param", + "kind": 32768, "flags": {}, - "signatures": [ - 3506 - ] + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } }, - "3506": { - "id": 3506, - "name": "associateWebAuthnCredential", + "3886": { + "id": 3886, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3765, + "name": "SignInInput", + "package": "@aws-amplify/auth" + } + }, + "3887": { + "id": 3887, + "name": "signIn", "variant": "signature", "kind": 4096, "flags": {}, @@ -1788,7 +6833,7 @@ "summary": [ { "kind": "text", - "text": "Registers a new passkey for an authenticated user" + "text": "Signs a user in" } ], "blockTags": [ @@ -1797,7 +6842,7 @@ "content": [ { "kind": "text", - "text": "Promise" + "text": "SignInOutput" } ] }, @@ -1806,16 +6851,25 @@ "content": [ { "kind": "text", - "text": "- " + "text": "service: " }, { "kind": "inline-tag", "tag": "@link", - "text": "PasskeyError" + "text": "InitiateAuthException" }, { "kind": "text", - "text": ":\n- Thrown when intermediate state is invalid" + "text": ", " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "RespondToAuthChallengeException" + }, + { + "kind": "text", + "text": "\n - Cognito service errors thrown during the sign-in process." } ] }, @@ -1824,17 +6878,16 @@ "content": [ { "kind": "text", - "text": "- " + "text": "validation: " }, { "kind": "inline-tag", "tag": "@link", - "text": "AuthError", - "target": 3370 + "text": "AuthValidationErrorCode" }, { "kind": "text", - "text": ":\n- Thrown when user is unauthenticated" + "text": " - Validation errors thrown when either username or password\n are not defined." } ] }, @@ -1843,16 +6896,145 @@ "content": [ { "kind": "text", - "text": "- " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "StartWebAuthnRegistrationException" - }, + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + } + ] + } + ] + }, + "parameters": [ + 3888 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3766, + "name": "SignInOutput", + "package": "@aws-amplify/auth" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3888": { + "id": 3888, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The SignInInput object" + } + ] + }, + "type": { + "type": "reference", + "target": 3765, + "name": "SignInInput", + "package": "@aws-amplify/auth" + } + }, + "3889": { + "id": 3889, + "name": "signInWithRedirect", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3890, + 3893 + ] + }, + "3890": { + "id": 3890, + "name": "signInWithRedirect", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3891, + 3892 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3891": { + "id": 3891, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3892": { + "id": 3892, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthSignInWithRedirectInput" + }, + "name": "AuthSignInWithRedirectInput", + "package": "@aws-amplify/auth" + } + }, + "3893": { + "id": 3893, + "name": "signInWithRedirect", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signs in a user with OAuth. Redirects the application to an Identity Provider." + } + ], + "blockTags": [ + { + "tag": "@throws", + "content": [ { "kind": "text", - "text": "\n- Thrown due to a service error retrieving WebAuthn registration options" + "text": "AuthTokenConfigException - Thrown when the user pool config is invalid." } ] }, @@ -1861,21 +7043,15 @@ "content": [ { "kind": "text", - "text": "- " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "CompleteWebAuthnRegistrationException" - }, - { - "kind": "text", - "text": "\n- Thrown due to a service error when verifying WebAuthn registration result" + "text": "OAuthNotConfigureException - Thrown when the oauth config is invalid." } ] } ] }, + "parameters": [ + 3894 + ], "type": { "type": "reference", "target": { @@ -1893,19 +7069,106 @@ "package": "typescript" } }, - "3507": { - "id": 3507, - "name": "confirmResetPassword", + "3894": { + "id": 3894, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The SignInWithRedirectInput object, if empty it will redirect to Cognito HostedUI" + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthSignInWithRedirectInput" + }, + "name": "AuthSignInWithRedirectInput", + "package": "@aws-amplify/auth" + } + }, + "3895": { + "id": 3895, + "name": "signOut", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3508 + 3896, + 3899 ] }, - "3508": { - "id": 3508, - "name": "confirmResetPassword", + "3896": { + "id": 3896, + "name": "signOut", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3897, + 3898 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3897": { + "id": 3897, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3898": { + "id": 3898, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthSignOutInput" + }, + "name": "AuthSignOutInput", + "package": "@aws-amplify/auth" + } + }, + "3899": { + "id": 3899, + "name": "signOut", "variant": "signature", "kind": 4096, "flags": {}, @@ -1913,46 +7176,10 @@ "summary": [ { "kind": "text", - "text": "Confirms the new password and verification code to reset the password." + "text": "Signs a user out" } ], "blockTags": [ - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "-" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "ConfirmForgotPasswordException" - }, - { - "kind": "text", - "text": "\nThrown due to an invalid confirmation code or password." - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "-" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "AuthValidationErrorCode" - }, - { - "kind": "text", - "text": "\nThrown due to an empty confirmation code, password or username." - } - ] - }, { "tag": "@throws", "content": [ @@ -1965,7 +7192,7 @@ ] }, "parameters": [ - 3509 + 3900 ], "type": { "type": "reference", @@ -1984,40 +7211,102 @@ "package": "typescript" } }, - "3509": { - "id": 3509, + "3900": { + "id": 3900, "name": "input", "variant": "param", "kind": 32768, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { "kind": "text", - "text": "The ConfirmResetPasswordInput object." + "text": "The SignOutInput object" } ] }, "type": { "type": "reference", - "target": 3449, - "name": "ConfirmResetPasswordInput", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthSignOutInput" + }, + "name": "AuthSignOutInput", "package": "@aws-amplify/auth" } }, - "3510": { - "id": 3510, - "name": "confirmSignIn", + "3901": { + "id": 3901, + "name": "signUp", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3511 + 3902, + 3905 ] }, - "3511": { - "id": 3511, - "name": "confirmSignIn", + "3902": { + "id": 3902, + "name": "signUp", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3903, + 3904 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3770, + "name": "SignUpOutput", + "package": "@aws-amplify/auth" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3903": { + "id": 3903, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3904": { + "id": 3904, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3769, + "name": "SignUpInput", + "package": "@aws-amplify/auth" + } + }, + "3905": { + "id": 3905, + "name": "signUp", "variant": "signature", "kind": 4096, "flags": {}, @@ -2025,15 +7314,7 @@ "summary": [ { "kind": "text", - "text": "Continues or completes the sign in process when required by the initial call to " - }, - { - "kind": "code", - "text": "`signIn`" - }, - { - "kind": "text", - "text": "." + "text": "Creates a user" } ], "blockTags": [ @@ -2042,43 +7323,7 @@ "content": [ { "kind": "text", - "text": "ConfirmSignInOutput" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "-" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "VerifySoftwareTokenException" - }, - { - "kind": "text", - "text": ":\nThrown due to an invalid MFA token." - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "-" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "RespondToAuthChallengeException" - }, - { - "kind": "text", - "text": ":\nThrown due to an invalid auth challenge response." + "text": "SignUpOutput" } ] }, @@ -2087,16 +7332,16 @@ "content": [ { "kind": "text", - "text": "-" + "text": "service: " }, { "kind": "inline-tag", "tag": "@link", - "text": "AssociateSoftwareTokenException" + "text": "SignUpException" }, { "kind": "text", - "text": ":\nThrown due to a service error during the MFA setup process." + "text": " - Cognito service errors thrown during the sign-up process." } ] }, @@ -2105,7 +7350,7 @@ "content": [ { "kind": "text", - "text": "-" + "text": "validation: " }, { "kind": "inline-tag", @@ -2114,15 +7359,7 @@ }, { "kind": "text", - "text": ":\nThrown when " - }, - { - "kind": "code", - "text": "`challengeResponse`" - }, - { - "kind": "text", - "text": " is not defined." + "text": " - Validation errors thrown either username or password\n are not defined." } ] }, @@ -2138,7 +7375,7 @@ ] }, "parameters": [ - 3512 + 3906 ], "type": { "type": "reference", @@ -2150,8 +7387,8 @@ "typeArguments": [ { "type": "reference", - "target": 3451, - "name": "ConfirmSignInOutput", + "target": 3770, + "name": "SignUpOutput", "package": "@aws-amplify/auth" } ], @@ -2159,8 +7396,8 @@ "package": "typescript" } }, - "3512": { - "id": 3512, + "3906": { + "id": 3906, "name": "input", "variant": "param", "kind": 32768, @@ -2169,30 +7406,84 @@ "summary": [ { "kind": "text", - "text": "The ConfirmSignInInput object" + "text": "The SignUpInput object" } ] }, "type": { "type": "reference", - "target": 3450, - "name": "ConfirmSignInInput", + "target": 3769, + "name": "SignUpInput", "package": "@aws-amplify/auth" } }, - "3513": { - "id": 3513, - "name": "confirmSignUp", + "3907": { + "id": 3907, + "name": "updateMFAPreference", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3514 + 3908, + 3911 ] }, - "3514": { - "id": 3514, - "name": "confirmSignUp", + "3908": { + "id": 3908, + "name": "updateMFAPreference", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3909, + 3910 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3909": { + "id": 3909, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3910": { + "id": 3910, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3740, + "name": "UpdateMFAPreferenceInput", + "package": "@aws-amplify/auth" + } + }, + "3911": { + "id": 3911, + "name": "updateMFAPreference", "variant": "signature", "kind": 4096, "flags": {}, @@ -2200,37 +7491,10 @@ "summary": [ { "kind": "text", - "text": "Confirms a new user account." + "text": "Updates the MFA preference of the user." } ], "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "ConfirmSignUpOutput" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "-" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "ConfirmSignUpException" - }, - { - "kind": "text", - "text": "\nThrown due to an invalid confirmation code." - } - ] - }, { "tag": "@throws", "content": [ @@ -2241,11 +7505,11 @@ { "kind": "inline-tag", "tag": "@link", - "text": "AuthValidationErrorCode" + "text": "SetUserMFAPreferenceException" }, { "kind": "text", - "text": "\nThrown due to an empty confirmation code" + "text": " - Service error thrown when the MFA preference cannot be updated." } ] }, @@ -2261,7 +7525,7 @@ ] }, "parameters": [ - 3515 + 3912 ], "type": { "type": "reference", @@ -2272,18 +7536,16 @@ }, "typeArguments": [ { - "type": "reference", - "target": 3453, - "name": "ConfirmSignUpOutput", - "package": "@aws-amplify/auth" + "type": "intrinsic", + "name": "void" } ], "name": "Promise", "package": "typescript" } }, - "3515": { - "id": 3515, + "3912": { + "id": 3912, "name": "input", "variant": "param", "kind": 32768, @@ -2292,30 +7554,88 @@ "summary": [ { "kind": "text", - "text": "The ConfirmSignUpInput object." + "text": "The UpdateMFAPreferenceInput object." } ] }, "type": { "type": "reference", - "target": 3452, - "name": "ConfirmSignUpInput", + "target": 3740, + "name": "UpdateMFAPreferenceInput", "package": "@aws-amplify/auth" } }, - "3516": { - "id": 3516, - "name": "confirmUserAttribute", + "3913": { + "id": 3913, + "name": "updatePassword", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3517 + 3914, + 3917 ] }, - "3517": { - "id": 3517, - "name": "confirmUserAttribute", + "3914": { + "id": 3914, + "name": "updatePassword", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3915, + 3916 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3915": { + "id": 3915, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3916": { + "id": 3916, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthUpdatePasswordInput" + }, + "name": "AuthUpdatePasswordInput", + "package": "@aws-amplify/auth" + } + }, + "3917": { + "id": 3917, + "name": "updatePassword", "variant": "signature", "kind": 4096, "flags": {}, @@ -2323,7 +7643,7 @@ "summary": [ { "kind": "text", - "text": "Confirms a user attribute with the confirmation code." + "text": "Updates user's password while authenticated." } ], "blockTags": [ @@ -2332,24 +7652,16 @@ "content": [ { "kind": "text", - "text": "-" + "text": "- " }, { "kind": "inline-tag", "tag": "@link", - "text": "AuthValidationErrorCode" - }, - { - "kind": "text", - "text": " -\nThrown when " - }, - { - "kind": "code", - "text": "`confirmationCode`" + "text": "ChangePasswordException" }, { "kind": "text", - "text": " is not defined." + "text": " - Cognito service errors thrown when updating a password." } ] }, @@ -2358,16 +7670,16 @@ "content": [ { "kind": "text", - "text": "-" + "text": "- " }, { "kind": "inline-tag", "tag": "@link", - "text": "VerifyUserAttributeException" + "text": "AuthValidationErrorCode" }, { "kind": "text", - "text": " - Thrown due to an invalid confirmation code or attribute." + "text": " - Validation errors thrown when oldPassword or newPassword are empty." } ] }, @@ -2383,7 +7695,7 @@ ] }, "parameters": [ - 3518 + 3918 ], "type": { "type": "reference", @@ -2402,8 +7714,8 @@ "package": "typescript" } }, - "3518": { - "id": 3518, + "3918": { + "id": 3918, "name": "input", "variant": "param", "kind": 32768, @@ -2412,30 +7724,90 @@ "summary": [ { "kind": "text", - "text": "The ConfirmUserAttributeInput object" + "text": "The UpdatePasswordInput object." } ] }, "type": { "type": "reference", - "target": 3454, - "name": "ConfirmUserAttributeInput", + "target": { + "packageName": "@aws-amplify/auth", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "AuthUpdatePasswordInput" + }, + "name": "AuthUpdatePasswordInput", "package": "@aws-amplify/auth" } }, - "3519": { - "id": 3519, - "name": "decodeJWT", + "3919": { + "id": 3919, + "name": "updateUserAttributes", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3520 + 3920, + 3923 ] }, - "3520": { - "id": 3520, - "name": "decodeJWT", + "3920": { + "id": 3920, + "name": "updateUserAttributes", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 3921, + 3922 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3775, + "name": "UpdateUserAttributesOutput", + "package": "@aws-amplify/auth" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "3921": { + "id": 3921, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "3922": { + "id": 3922, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3774, + "name": "UpdateUserAttributesInput", + "package": "@aws-amplify/auth" + } + }, + "3923": { + "id": 3923, + "name": "updateUserAttributes", "variant": "signature", "kind": 4096, "flags": {}, @@ -2443,39 +7815,69 @@ "summary": [ { "kind": "text", - "text": "Decodes payload of JWT token" + "text": "Updates user's attributes while authenticated." } ], "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "UpdateUserAttributesOutput" + } + ] + }, { "tag": "@throws", "content": [ + { + "kind": "text", + "text": "- " + }, { "kind": "inline-tag", "tag": "@link", - "text": "Error" - }, + "text": "UpdateUserAttributesException" + } + ] + }, + { + "tag": "@throws", + "content": [ { "kind": "text", - "text": " - Throws error when token is invalid or payload malformed." + "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." } ] } ] }, "parameters": [ - 3521 + 3924 ], "type": { "type": "reference", - "target": 3427, - "name": "JWT", - "package": "@aws-amplify/core" + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3775, + "name": "UpdateUserAttributesOutput", + "package": "@aws-amplify/auth" + } + ], + "name": "Promise", + "package": "typescript" } }, - "3521": { - "id": 3521, - "name": "token", + "3924": { + "id": 3924, + "name": "input", "variant": "param", "kind": 32768, "flags": {}, @@ -2483,64 +7885,38 @@ "summary": [ { "kind": "text", - "text": "A string representing a token to be decoded" + "text": "The UpdateUserAttributesInput object" } ] }, "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": 3774, + "name": "UpdateUserAttributesInput", + "package": "@aws-amplify/auth" } }, - "3522": { - "id": 3522, - "name": "deleteUser", + "3925": { + "id": 3925, + "name": "verifyTOTPSetup", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3523 + 3926, + 3929 ] }, - "3523": { - "id": 3523, - "name": "deleteUser", + "3926": { + "id": 3926, + "name": "verifyTOTPSetup", "variant": "signature", "kind": 4096, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a user from the user pool while authenticated." - } - ], - "blockTags": [ - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "DeleteUserException" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." - } - ] - } - ] - }, + "parameters": [ + 3927, + 3928 + ], "type": { "type": "reference", "target": { @@ -2558,19 +7934,35 @@ "package": "typescript" } }, - "3524": { - "id": 3524, - "name": "deleteUserAttributes", - "variant": "declaration", - "kind": 64, + "3927": { + "id": 3927, + "name": "ctx", + "variant": "param", + "kind": 32768, "flags": {}, - "signatures": [ - 3525 - ] + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } }, - "3525": { - "id": 3525, - "name": "deleteUserAttributes", + "3928": { + "id": 3928, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3778, + "name": "VerifyTOTPSetupInput", + "package": "@aws-amplify/auth" + } + }, + "3929": { + "id": 3929, + "name": "verifyTOTPSetup", "variant": "signature", "kind": 4096, "flags": {}, @@ -2578,7 +7970,7 @@ "summary": [ { "kind": "text", - "text": "Deletes user attributes." + "text": "Verifies an OTP code retrieved from an associated authentication app." } ], "blockTags": [ @@ -2592,11 +7984,37 @@ { "kind": "inline-tag", "tag": "@link", - "text": "DeleteUserAttributesException" + "text": "VerifySoftwareTokenException" }, { "kind": "text", - "text": " - Thrown due to invalid attribute." + "text": ":\nThrown due to an invalid MFA token." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "-" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AuthValidationErrorCode" + }, + { + "kind": "text", + "text": ":\nThrown when " + }, + { + "kind": "code", + "text": "`code`" + }, + { + "kind": "text", + "text": " is not defined." } ] }, @@ -2612,7 +8030,7 @@ ] }, "parameters": [ - 3526 + 3930 ], "type": { "type": "reference", @@ -2631,534 +8049,779 @@ "package": "typescript" } }, - "3526": { - "id": 3526, - "name": "input", - "variant": "param", - "kind": 32768, + "3930": { + "id": 3930, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The VerifyTOTPSetupInput" + } + ] + }, + "type": { + "type": "reference", + "target": 3778, + "name": "VerifyTOTPSetupInput", + "package": "@aws-amplify/auth" + } + }, + "5027": { + "id": 5027, + "name": "in-app-messaging", + "variant": "declaration", + "kind": 2, + "flags": {}, + "children": [ + { + "id": 5069, + "name": "clearMessages", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5070 + ] + }, + { + "id": 5071, + "name": "dispatchEvent", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5072 + ] + }, + { + "id": 5074, + "name": "identifyUser", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5075, + 5078 + ] + }, + { + "id": 5080, + "name": "initializeInAppMessaging", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5081, + 5083 + ] + }, + { + "id": 5084, + "name": "notifyMessageInteraction", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5085 + ] + }, + { + "id": 5087, + "name": "onMessageActionTaken", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5088 + ] + }, + { + "id": 5090, + "name": "onMessageDismissed", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5091 + ] + }, + { + "id": 5093, + "name": "onMessageDisplayed", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5094 + ] + }, + { + "id": 5096, + "name": "onMessageReceived", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5097 + ] + }, + { + "id": 5099, + "name": "setConflictHandler", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5100 + ] + }, + { + "id": 5102, + "name": "syncMessages", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5103, + 5105 + ] + } + ], + "groups": [ + { + "title": "Interfaces", + "children": [ + 5028, + 5033, + 5038, + 5045, + 5047, + 5052 + ] + }, + { + "title": "Type Aliases", + "children": [ + 5055, + 5056, + 5057, + 5058, + 5059, + 5060, + 5061, + 5062, + 5063, + 5064, + 5065, + 5066, + 5067, + 5068 + ] + }, + { + "title": "Functions", + "children": [ + 5069, + 5071, + 5074, + 5080, + 5084, + 5087, + 5090, + 5093, + 5096, + 5099, + 5102 + ] + } + ] + }, + "5028": { + "id": 5028, + "name": "InAppMessage", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + 5029, + 5030, + 5031, + 5032 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5029, + 5030, + 5031, + 5032 + ] + } + ] + }, + "5029": { + "id": 5029, + "name": "content", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5038, + "name": "InAppMessageContent", + "package": "@aws-amplify/notifications" + } + } + }, + "5030": { + "id": 5030, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + "5031": { + "id": 5031, + "name": "layout", + "variant": "declaration", + "kind": 1024, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The DeleteUserAttributesInput object" - } - ] - }, "type": { "type": "reference", - "target": 3455, - "name": "DeleteUserAttributesInput", - "package": "@aws-amplify/auth" + "target": 5058, + "name": "InAppMessageLayout", + "package": "@aws-amplify/notifications" } }, - "3527": { - "id": 3527, - "name": "deleteWebAuthnCredential", + "5032": { + "id": 5032, + "name": "metadata", "variant": "declaration", - "kind": 64, + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + "5033": { + "id": 5033, + "name": "InAppMessageButton", + "variant": "declaration", + "kind": 256, "flags": {}, - "signatures": [ - 3528 + "children": [ + 5034, + 5035, + 5036, + 5037 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5034, + 5035, + 5036, + 5037 + ] + } ] }, - "3528": { - "id": 3528, - "name": "deleteWebAuthnCredential", - "variant": "signature", - "kind": 4096, + "5034": { + "id": 5034, + "name": "action", + "variant": "declaration", + "kind": 1024, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete a registered credential for an authenticated user by credentialId" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "AuthError", - "target": 3370 - }, - { - "kind": "text", - "text": ":\n- Thrown when user is unauthenticated" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "DeleteWebAuthnCredentialException" - }, - { - "kind": "text", - "text": "\n- Thrown due to a service error when deleting a WebAuthn credential" - } - ] - } - ] + "type": { + "type": "reference", + "target": 5057, + "name": "InAppMessageAction", + "package": "@aws-amplify/notifications" + } + }, + "5035": { + "id": 5035, + "name": "style", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, - "parameters": [ - 3529 - ], "type": { "type": "reference", - "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" + "target": 5047, + "name": "InAppMessageStyle", + "package": "@aws-amplify/notifications" } }, - "3529": { - "id": 3529, - "name": "input", - "variant": "param", - "kind": 32768, + "5036": { + "id": 5036, + "name": "title", + "variant": "declaration", + "kind": 1024, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The delete input parameters including the credentialId" - } - ] + "type": { + "type": "intrinsic", + "name": "string" + } + }, + "5037": { + "id": 5037, + "name": "url", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, "type": { - "type": "reference", - "target": 3419, - "name": "DeleteWebAuthnCredentialInput", - "package": "@aws-amplify/auth" + "type": "intrinsic", + "name": "string" } }, - "3530": { - "id": 3530, - "name": "fetchDevices", + "5038": { + "id": 5038, + "name": "InAppMessageContent", "variant": "declaration", - "kind": 64, + "kind": 256, "flags": {}, - "signatures": [ - 3531 + "children": [ + 5039, + 5040, + 5041, + 5042, + 5043, + 5044 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5039, + 5040, + 5041, + 5042, + 5043, + 5044 + ] + } ] }, - "3531": { - "id": 3531, - "name": "fetchDevices", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fetches devices that have been remembered using " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "rememberDevice", - "target": 3540 - }, - { - "kind": "text", - "text": "\nfor the currently authenticated user." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "FetchDevicesOutput" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "ListDevicesException" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." - } - ] - } - ] + "5039": { + "id": 5039, + "name": "body", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/inAppMessaging/types/message.d.ts", + "qualifiedName": "InAppMessageBody" + }, + "name": "InAppMessageBody", + "package": "@aws-amplify/notifications" + } + }, + "5040": { + "id": 5040, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/inAppMessaging/types/message.d.ts", + "qualifiedName": "InAppMessageContainer" + }, + "name": "InAppMessageContainer", + "package": "@aws-amplify/notifications" + } + }, + "5041": { + "id": 5041, + "name": "header", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, "type": { "type": "reference", "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Promise" + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/inAppMessaging/types/message.d.ts", + "qualifiedName": "InAppMessageHeader" }, - "typeArguments": [ - { - "type": "reference", - "target": 3456, - "name": "FetchDevicesOutput", - "package": "@aws-amplify/auth" - } - ], - "name": "Promise", - "package": "typescript" + "name": "InAppMessageHeader", + "package": "@aws-amplify/notifications" } }, - "3532": { - "id": 3532, - "name": "fetchMFAPreference", + "5042": { + "id": 5042, + "name": "image", "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3533 - ] + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 5045, + "name": "InAppMessageImage", + "package": "@aws-amplify/notifications" + } }, - "3533": { - "id": 3533, - "name": "fetchMFAPreference", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fetches the preferred MFA setting and enabled MFA settings for the user." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "FetchMFAPreferenceOutput" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "-" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GetUserException" - }, - { - "kind": "text", - "text": " : error thrown when the service fails to fetch MFA preference\nand settings." - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." - } - ] - } - ] + "5043": { + "id": 5043, + "name": "primaryButton", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, "type": { "type": "reference", - "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3424, - "name": "FetchMFAPreferenceOutput", - "package": "@aws-amplify/auth" - } - ], - "name": "Promise", - "package": "typescript" + "target": 5033, + "name": "InAppMessageButton", + "package": "@aws-amplify/notifications" } }, - "3534": { - "id": 3534, - "name": "forgetDevice", + "5044": { + "id": 5044, + "name": "secondaryButton", "variant": "declaration", - "kind": 64, + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 5033, + "name": "InAppMessageButton", + "package": "@aws-amplify/notifications" + } + }, + "5045": { + "id": 5045, + "name": "InAppMessageImage", + "variant": "declaration", + "kind": 256, "flags": {}, - "signatures": [ - 3535 + "children": [ + 5046 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5046 + ] + } ] }, - "3535": { - "id": 3535, - "name": "forgetDevice", - "variant": "signature", - "kind": 4096, + "5046": { + "id": 5046, + "name": "src", + "variant": "declaration", + "kind": 1024, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Forget a remembered device while authenticated." - } - ], - "blockTags": [ - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "ForgetDeviceException" - }, - { - "kind": "text", - "text": " - Cognito service errors thrown when\nforgetting device with invalid device key" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." - } - ] - } - ] - }, - "parameters": [ - 3536 + "type": { + "type": "intrinsic", + "name": "string" + } + }, + "5047": { + "id": 5047, + "name": "InAppMessageStyle", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + 5048, + 5049, + 5050, + 5051 ], + "groups": [ + { + "title": "Properties", + "children": [ + 5048, + 5049, + 5050, + 5051 + ] + } + ] + }, + "5048": { + "id": 5048, + "name": "backgroundColor", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, "type": { - "type": "reference", - "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" + "type": "intrinsic", + "name": "string" } }, - "3536": { - "id": 3536, - "name": "input", - "variant": "param", - "kind": 32768, + "5049": { + "id": 5049, + "name": "borderRadius", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + "5050": { + "id": 5050, + "name": "color", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + "5051": { + "id": 5051, + "name": "textAlign", + "variant": "declaration", + "kind": 1024, "flags": { "isOptional": true }, + "type": { + "type": "reference", + "target": 5059, + "name": "InAppMessageTextAlign", + "package": "@aws-amplify/notifications" + } + }, + "5052": { + "id": 5052, + "name": "NotifyMessageInteractionInput", + "variant": "declaration", + "kind": 256, + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The ForgetDeviceInput object." + "text": "Input type for NotifyMessageInteraction API." } ] }, + "children": [ + 5053, + 5054 + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5053, + 5054 + ] + } + ] + }, + "5053": { + "id": 5053, + "name": "message", + "variant": "declaration", + "kind": 1024, + "flags": {}, "type": { "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "AuthForgetDeviceInput" - }, - "name": "AuthForgetDeviceInput", - "package": "@aws-amplify/auth" + "target": 5028, + "name": "InAppMessage", + "package": "@aws-amplify/notifications" } }, - "3537": { - "id": 3537, - "name": "listWebAuthnCredentials", + "5054": { + "id": 5054, + "name": "type", "variant": "declaration", - "kind": 64, + "kind": 1024, "flags": {}, - "signatures": [ - 3538 - ] + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/inAppMessaging/types/event.d.ts", + "qualifiedName": "InAppMessageInteractionEvent" + }, + "name": "InAppMessageInteractionEvent", + "package": "@aws-amplify/notifications" + } }, - "3538": { - "id": 3538, - "name": "listWebAuthnCredentials", - "variant": "signature", - "kind": 4096, + "5056": { + "id": 5056, + "name": "IdentifyUserInput", + "variant": "declaration", + "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Lists registered credentials for an authenticated user" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "AuthError", - "target": 3370 - }, - { - "kind": "text", - "text": ":\n- Thrown when user is unauthenticated" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "ListWebAuthnCredentialsException" - }, - { - "kind": "text", - "text": "\n- Thrown due to a service error when listing WebAuthn credentials" - } - ] + "text": "Input type for Pinpoint identifyUser API." } ] }, - "parameters": [ - 3539 - ], "type": { "type": "reference", "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Promise" + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/inAppMessaging/types/inputs.d.ts", + "qualifiedName": "InAppMessagingIdentifyUserInput" }, "typeArguments": [ { "type": "reference", - "target": 3434, - "name": "ListWebAuthnCredentialsOutput", - "package": "@aws-amplify/auth" + "target": { + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/inAppMessaging/providers/pinpoint/types/options.d.ts", + "qualifiedName": "IdentifyUserOptions" + }, + "name": "IdentifyUserOptions", + "package": "@aws-amplify/notifications" } ], - "name": "Promise", - "package": "typescript" + "name": "InAppMessagingIdentifyUserInput", + "package": "@aws-amplify/notifications" } }, - "3539": { - "id": 3539, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ + "5057": { + "id": 5057, + "name": "InAppMessageAction", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ { - "kind": "text", - "text": "The list input parameters including page size and next token." + "type": "literal", + "value": "CLOSE" + }, + { + "type": "literal", + "value": "DEEP_LINK" + }, + { + "type": "literal", + "value": "LINK" } ] - }, + } + }, + "5058": { + "id": 5058, + "name": "InAppMessageLayout", + "variant": "declaration", + "kind": 2097152, + "flags": {}, "type": { - "type": "reference", - "target": 3431, - "name": "ListWebAuthnCredentialsInput", - "package": "@aws-amplify/auth" + "type": "union", + "types": [ + { + "type": "literal", + "value": "BOTTOM_BANNER" + }, + { + "type": "literal", + "value": "CAROUSEL" + }, + { + "type": "literal", + "value": "FULL_SCREEN" + }, + { + "type": "literal", + "value": "MIDDLE_BANNER" + }, + { + "type": "literal", + "value": "MODAL" + }, + { + "type": "literal", + "value": "TOP_BANNER" + } + ] } }, - "3540": { - "id": 3540, - "name": "rememberDevice", + "5059": { + "id": 5059, + "name": "InAppMessageTextAlign", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "center" + }, + { + "type": "literal", + "value": "left" + }, + { + "type": "literal", + "value": "right" + } + ] + } + }, + "5069": { + "id": 5069, + "name": "clearMessages", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3541 + 5070 ] }, - "3541": { - "id": 3541, - "name": "rememberDevice", + "5070": { + "id": 5070, + "name": "clearMessages", "variant": "signature", "kind": 4096, "flags": {}, @@ -3166,34 +8829,52 @@ "summary": [ { "kind": "text", - "text": "Marks device as remembered while authenticated." + "text": "Clear locally cached messages." } ], "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." + } + ] + }, { "tag": "@throws", "content": [ { "kind": "text", - "text": "- " + "text": "validation: " }, { "kind": "inline-tag", "tag": "@link", - "text": "UpdateDeviceStatusException" + "text": "InAppMessagingValidationErrorCode" }, { "kind": "text", - "text": " - Cognito service errors thrown when\nsetting device status to remembered using an invalid device key." + "text": " - Thrown if In App messaging hasn't been initialized." } ] }, { - "tag": "@throws", + "tag": "@returns", "content": [ { "kind": "text", - "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + "text": "A promise that will resolve when the operation is complete." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// Clear locally cached messages.\nawait clearMessages();\n\n```" } ] } @@ -3216,19 +8897,19 @@ "package": "typescript" } }, - "3542": { - "id": 3542, - "name": "resendSignUpCode", + "5071": { + "id": 5071, + "name": "dispatchEvent", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3543 + 5072 ] }, - "3543": { - "id": 3543, - "name": "resendSignUpCode", + "5072": { + "id": 5072, + "name": "dispatchEvent", "variant": "signature", "kind": 4096, "flags": {}, @@ -3236,34 +8917,45 @@ "summary": [ { "kind": "text", - "text": "Resend the confirmation code while signing up" + "text": "Triggers an In-App message to be displayed. Use this after your campaigns have been synced to the device using\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "syncMessages", + "target": 5102 + }, + { + "kind": "text", + "text": ". Based on the messages synced and the event passed to this API, it triggers the display\nof the In-App message that meets the criteria." } ], "blockTags": [ { - "tag": "@returns", + "tag": "@deprecated", "content": [ { "kind": "text", - "text": "ResendSignUpCodeOutput" + "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." } ] }, { - "tag": "@throws", + "tag": "@remark", "content": [ { "kind": "text", - "text": "service: " + "text": "If an event would trigger multiple messages, the message closest to expiry will be chosen by default.\nTo change this behavior, you can use the " }, { "kind": "inline-tag", "tag": "@link", - "text": "ResendConfirmationException" + "text": "setConflictHandler", + "target": 5099 }, { "kind": "text", - "text": " - Cognito service errors thrown when resending the code." + "text": " API to provide\nyour own logic for resolving message conflicts." } ] }, @@ -3277,11 +8969,11 @@ { "kind": "inline-tag", "tag": "@link", - "text": "AuthValidationErrorCode" + "text": "InAppMessagingValidationErrorCode" }, { "kind": "text", - "text": " - Validation errors thrown either username are not defined." + "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." } ] }, @@ -3290,14 +8982,32 @@ "content": [ { "kind": "text", - "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + "text": "service exceptions - Thrown when the underlying Pinpoint service returns an error." + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A promise that will resolve when the operation is complete." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// Sync message before disptaching an event\nawait syncMessages();\n\n// Dispatch an event\nawait dispatchEvent({ name: 'test_event' });\n```" } ] } ] }, "parameters": [ - 3544 + 5073 ], "type": { "type": "reference", @@ -3308,18 +9018,16 @@ }, "typeArguments": [ { - "type": "reference", - "target": 3462, - "name": "ResendSignUpCodeOutput", - "package": "@aws-amplify/auth" + "type": "intrinsic", + "name": "void" } ], "name": "Promise", "package": "typescript" } }, - "3544": { - "id": 3544, + "5073": { + "id": 5073, "name": "input", "variant": "param", "kind": 32768, @@ -3328,30 +9036,106 @@ "summary": [ { "kind": "text", - "text": "The ResendSignUpCodeInput object" + "text": "The input object that holds the event to be dispatched." } ] }, "type": { "type": "reference", - "target": 3461, - "name": "ResendSignUpCodeInput", - "package": "@aws-amplify/auth" + "target": { + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/inAppMessaging/types/event.d.ts", + "qualifiedName": "InAppMessagingEvent" + }, + "name": "InAppMessagingEvent", + "package": "@aws-amplify/notifications" } }, - "3545": { - "id": 3545, - "name": "resetPassword", + "5074": { + "id": 5074, + "name": "identifyUser", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3546 + 5075, + 5078 ] }, - "3546": { - "id": 3546, - "name": "resetPassword", + "5075": { + "id": 5075, + "name": "identifyUser", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 5076, + 5077 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "5076": { + "id": 5076, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AmplifyContext", + "target": 5131 + }, + { + "kind": "text", + "text": " to use for config and credentials." + } + ] + }, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "5077": { + "id": 5077, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 5056, + "name": "IdentifyUserInput", + "package": "@aws-amplify/notifications" + } + }, + "5078": { + "id": 5078, + "name": "identifyUser", "variant": "signature", "kind": 4096, "flags": {}, @@ -3359,16 +9143,24 @@ "summary": [ { "kind": "text", - "text": "Resets a user's password." + "text": "Sends information about a user to Pinpoint. Sending user information allows you to associate a user to their user\nprofile and activities or actions in your application. Activity can be tracked across devices & platforms by using\nthe same " + }, + { + "kind": "code", + "text": "`userId`" + }, + { + "kind": "text", + "text": "." } ], "blockTags": [ { - "tag": "@returns", + "tag": "@deprecated", "content": [ { "kind": "text", - "text": "ResetPasswordOutput" + "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." } ] }, @@ -3377,16 +9169,16 @@ "content": [ { "kind": "text", - "text": "-" + "text": "service: " }, { "kind": "inline-tag", "tag": "@link", - "text": "ForgotPasswordException" + "text": "UpdateEndpointException" }, { "kind": "text", - "text": "\nThrown due to an invalid confirmation code or password." + "text": " - Thrown when the underlying Pinpoint service returns an error." } ] }, @@ -3395,32 +9187,50 @@ "content": [ { "kind": "text", - "text": "-" + "text": "validation: " }, { "kind": "inline-tag", "tag": "@link", - "text": "AuthValidationErrorCode" + "text": "InAppMessagingValidationErrorCode" }, { "kind": "text", - "text": "\nThrown due to an empty username." + "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." } ] }, { - "tag": "@throws", + "tag": "@returns", "content": [ { "kind": "text", - "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + "text": "A promise that will resolve when the operation is complete." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// Identify a user with Pinpoint\nawait identifyUser({\n userId,\n userProfile: {\n email: 'userEmail@example.com'\n customProperties: {\n phoneNumber: ['555-555-5555'],\n },\n }\n});\n```" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// Identify a user with Pinpoint specific options\nawait identifyUser({\n userId,\n userProfile: {\n email: 'userEmail@example.com'\n customProperties: {\n phoneNumber: ['555-555-5555'],\n },\n demographic: {\n platform: 'ios',\n timezone: 'America/Los_Angeles'\n }\n },\n options: {\n address: 'device-address',\n optOut: 'NONE',\n userAttributes: {\n interests: ['food']\n },\n },\n});" } ] } ] }, "parameters": [ - 3547 + 5079 ], "type": { "type": "reference", @@ -3431,18 +9241,16 @@ }, "typeArguments": [ { - "type": "reference", - "target": 3464, - "name": "ResetPasswordOutput", - "package": "@aws-amplify/auth" + "type": "intrinsic", + "name": "void" } ], "name": "Promise", "package": "typescript" } }, - "3547": { - "id": 3547, + "5079": { + "id": 5079, "name": "input", "variant": "param", "kind": 32768, @@ -3451,115 +9259,144 @@ "summary": [ { "kind": "text", - "text": "The ResetPasswordInput object." + "text": "The input object that conforms to " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "IdentifyUserInput", + "target": 5056 + }, + { + "kind": "text", + "text": " used to construct requests sent to Pinpoint's UpdateEndpoint\n API." } ] }, "type": { "type": "reference", - "target": 3463, - "name": "ResetPasswordInput", - "package": "@aws-amplify/auth" + "target": 5056, + "name": "IdentifyUserInput", + "package": "@aws-amplify/notifications" } }, - "3548": { - "id": 3548, - "name": "setUpTOTP", + "5080": { + "id": 5080, + "name": "initializeInAppMessaging", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3549 + 5081, + 5083 ] }, - "3549": { - "id": 3549, - "name": "setUpTOTP", + "5081": { + "id": 5081, + "name": "initializeInAppMessaging", "variant": "signature", "kind": 4096, "flags": {}, + "parameters": [ + 5082 + ], + "type": { + "type": "intrinsic", + "name": "void" + } + }, + "5082": { + "id": 5082, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Sets up TOTP for the user." + "text": "The " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AmplifyContext", + "target": 5131 + }, + { + "kind": "text", + "text": " to use for config and credentials." + } + ] + }, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "5083": { + "id": 5083, + "name": "initializeInAppMessaging", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize and set up in-app messaging category. This API needs to be called to enable other InAppMessaging APIs." } ], "blockTags": [ { - "tag": "@returns", + "tag": "@deprecated", "content": [ { "kind": "text", - "text": "SetUpTOTPOutput" + "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." } ] }, { - "tag": "@throws", + "tag": "@remarks", "content": [ { "kind": "text", - "text": "-" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "AssociateSoftwareTokenException" - }, - { - "kind": "text", - "text": "\nThrown if a service occurs while setting up TOTP." + "text": "Make sure to call this early in your app at the root entry point after configuring Amplify.\nInitialization runs once per session; subsequent calls are no-ops, so a context\npassed on a later call will not replace the one captured at first initialization." } ] }, { - "tag": "@throws", + "tag": "@example", "content": [ { - "kind": "text", - "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + "kind": "code", + "text": "```ts\nAmplify.configure(config);\ninitializeInAppMessaging();\n```" } ] } ] }, "type": { - "type": "reference", - "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/models.d.ts", - "qualifiedName": "AuthTOTPSetupDetails" - }, - "name": "AuthTOTPSetupDetails", - "package": "@aws-amplify/auth" - } - ], - "name": "Promise", - "package": "typescript" + "type": "intrinsic", + "name": "void" } }, - "3550": { - "id": 3550, - "name": "signIn", + "5084": { + "id": 5084, + "name": "notifyMessageInteraction", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3551 + 5085 ] }, - "3551": { - "id": 3551, - "name": "signIn", + "5085": { + "id": 5085, + "name": "notifyMessageInteraction", "variant": "signature", "kind": 4096, "flags": {}, @@ -3567,43 +9404,16 @@ "summary": [ { "kind": "text", - "text": "Signs a user in" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "SignInOutput" - } - ] - }, + "text": "Notifies the respective listener of the specified type with the message given." + } + ], + "blockTags": [ { - "tag": "@throws", + "tag": "@deprecated", "content": [ { "kind": "text", - "text": "service: " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "InitiateAuthException" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "RespondToAuthChallengeException" - }, - { - "kind": "text", - "text": "\n - Cognito service errors thrown during the sign-in process." + "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." } ] }, @@ -3617,49 +9427,35 @@ { "kind": "inline-tag", "tag": "@link", - "text": "AuthValidationErrorCode" + "text": "InAppMessagingValidationErrorCode" }, { "kind": "text", - "text": " - Validation errors thrown when either username or password\n are not defined." + "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." } ] }, { - "tag": "@throws", + "tag": "@example", "content": [ { - "kind": "text", - "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + "kind": "code", + "text": "```ts\nonMessageRecieved((message) => {\n // Show end users the In-App message and notify event listeners\n notifyMessageInteraction({ type: 'messageDisplayed', message });\n});\n```" } ] } ] }, "parameters": [ - 3552 + 5086 ], "type": { - "type": "reference", - "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3469, - "name": "SignInOutput", - "package": "@aws-amplify/auth" - } - ], - "name": "Promise", - "package": "typescript" + "type": "intrinsic", + "name": "void" } }, - "3552": { - "id": 3552, + "5086": { + "id": 5086, "name": "input", "variant": "param", "kind": 32768, @@ -3668,30 +9464,30 @@ "summary": [ { "kind": "text", - "text": "The SignInInput object" + "text": "The input object that holds the type and message." } ] }, "type": { "type": "reference", - "target": 3468, - "name": "SignInInput", - "package": "@aws-amplify/auth" + "target": 5052, + "name": "NotifyMessageInteractionInput", + "package": "@aws-amplify/notifications" } }, - "3553": { - "id": 3553, - "name": "signInWithRedirect", + "5087": { + "id": 5087, + "name": "onMessageActionTaken", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3554 + 5088 ] }, - "3554": { - "id": 3554, - "name": "signInWithRedirect", + "5088": { + "id": 5088, + "name": "onMessageActionTaken", "variant": "signature", "kind": 4096, "flags": {}, @@ -3699,16 +9495,24 @@ "summary": [ { "kind": "text", - "text": "Signs in a user with OAuth. Redirects the application to an Identity Provider." + "text": "Registers a callback that will be invoked on " + }, + { + "kind": "code", + "text": "`messageActionTaken`" + }, + { + "kind": "text", + "text": " events." } ], "blockTags": [ { - "tag": "@throws", + "tag": "@deprecated", "content": [ { "kind": "text", - "text": "AuthTokenConfigException - Thrown when the user pool config is invalid." + "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." } ] }, @@ -3717,72 +9521,91 @@ "content": [ { "kind": "text", - "text": "OAuthNotConfigureException - Thrown when the oauth config is invalid." + "text": "validation: " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "InAppMessagingValidationErrorCode" + }, + { + "kind": "text", + "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "- An object that holds a remove method to stop listening to events." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nonMessageActionTaken((message) => {\n // use the message\n console.log(message.id);\n});\n```" } ] } ] }, "parameters": [ - 3555 + 5089 ], "type": { "type": "reference", "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Promise" + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/eventListeners/types.d.ts", + "qualifiedName": "EventListenerRemover" }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" + "name": "EventListenerRemover", + "package": "@aws-amplify/notifications" } }, - "3555": { - "id": 3555, + "5089": { + "id": 5089, "name": "input", "variant": "param", "kind": 32768, - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The SignInWithRedirectInput object, if empty it will redirect to Cognito HostedUI" + "text": "The input object that holds the callback handler." } ] }, "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "AuthSignInWithRedirectInput" + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/inAppMessaging/providers/pinpoint/types/types.d.ts", + "qualifiedName": "OnMessageInteractionEventHandler" }, - "name": "AuthSignInWithRedirectInput", - "package": "@aws-amplify/auth" + "name": "OnMessageInteractionEventHandler", + "package": "@aws-amplify/notifications" } }, - "3556": { - "id": 3556, - "name": "signOut", + "5090": { + "id": 5090, + "name": "onMessageDismissed", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3557 + 5091 ] }, - "3557": { - "id": 3557, - "name": "signOut", + "5091": { + "id": 5091, + "name": "onMessageDismissed", "variant": "signature", "kind": 4096, "flags": {}, @@ -3790,81 +9613,117 @@ "summary": [ { "kind": "text", - "text": "Signs a user out" + "text": "Registers a callback that will be invoked on " + }, + { + "kind": "code", + "text": "`messageDismissed`" + }, + { + "kind": "text", + "text": " events." } ], "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." + } + ] + }, { "tag": "@throws", "content": [ { "kind": "text", - "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + "text": "validation: " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "InAppMessagingValidationErrorCode" + }, + { + "kind": "text", + "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "- An object that holds a remove method to stop listening to events." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nonMessageDismissed((message) => {\n // use the message\n console.log(message.id);\n});\n```" } ] } ] }, "parameters": [ - 3558 + 5092 ], "type": { "type": "reference", "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Promise" + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/eventListeners/types.d.ts", + "qualifiedName": "EventListenerRemover" }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" + "name": "EventListenerRemover", + "package": "@aws-amplify/notifications" } }, - "3558": { - "id": 3558, + "5092": { + "id": 5092, "name": "input", "variant": "param", "kind": 32768, - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The SignOutInput object" + "text": "The input object that holds the callback handler." } ] }, "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "AuthSignOutInput" + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/inAppMessaging/providers/pinpoint/types/types.d.ts", + "qualifiedName": "OnMessageInteractionEventHandler" }, - "name": "AuthSignOutInput", - "package": "@aws-amplify/auth" + "name": "OnMessageInteractionEventHandler", + "package": "@aws-amplify/notifications" } }, - "3559": { - "id": 3559, - "name": "signUp", + "5093": { + "id": 5093, + "name": "onMessageDisplayed", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3560 + 5094 ] }, - "3560": { - "id": 3560, - "name": "signUp", + "5094": { + "id": 5094, + "name": "onMessageDisplayed", "variant": "signature", "kind": 4096, "flags": {}, @@ -3872,34 +9731,24 @@ "summary": [ { "kind": "text", - "text": "Creates a user" - } - ], - "blockTags": [ + "text": "Registers a callback that will be invoked on " + }, { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "SignUpOutput" - } - ] + "kind": "code", + "text": "`messageDisplayed`" }, { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "service: " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "SignUpException" - }, + "kind": "text", + "text": " events." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ { "kind": "text", - "text": " - Cognito service errors thrown during the sign-up process." + "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." } ] }, @@ -3913,49 +9762,50 @@ { "kind": "inline-tag", "tag": "@link", - "text": "AuthValidationErrorCode" + "text": "InAppMessagingValidationErrorCode" }, { "kind": "text", - "text": " - Validation errors thrown either username or password\n are not defined." + "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." } ] }, { - "tag": "@throws", + "tag": "@returns", "content": [ { "kind": "text", - "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + "text": "- An object that holds a remove method to stop listening to events." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nonMessageDisplayed((message) => {\n // use the message\n\t console.log(message.id);\n});\n```" } ] } ] }, "parameters": [ - 3561 + 5095 ], "type": { "type": "reference", "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Promise" + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/eventListeners/types.d.ts", + "qualifiedName": "EventListenerRemover" }, - "typeArguments": [ - { - "type": "reference", - "target": 3473, - "name": "SignUpOutput", - "package": "@aws-amplify/auth" - } - ], - "name": "Promise", - "package": "typescript" + "name": "EventListenerRemover", + "package": "@aws-amplify/notifications" } }, - "3561": { - "id": 3561, + "5095": { + "id": 5095, "name": "input", "variant": "param", "kind": 32768, @@ -3964,30 +9814,34 @@ "summary": [ { "kind": "text", - "text": "The SignUpInput object" + "text": "The input object that holds the callback handler." } ] }, "type": { "type": "reference", - "target": 3472, - "name": "SignUpInput", - "package": "@aws-amplify/auth" + "target": { + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/inAppMessaging/providers/pinpoint/types/types.d.ts", + "qualifiedName": "OnMessageInteractionEventHandler" + }, + "name": "OnMessageInteractionEventHandler", + "package": "@aws-amplify/notifications" } }, - "3562": { - "id": 3562, - "name": "updateMFAPreference", + "5096": { + "id": 5096, + "name": "onMessageReceived", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3563 + 5097 ] }, - "3563": { - "id": 3563, - "name": "updateMFAPreference", + "5097": { + "id": 5097, + "name": "onMessageReceived", "variant": "signature", "kind": 4096, "flags": {}, @@ -3995,61 +9849,81 @@ "summary": [ { "kind": "text", - "text": "Updates the MFA preference of the user." + "text": "Registers a callback that will be invoked on " + }, + { + "kind": "code", + "text": "`messageReceived`" + }, + { + "kind": "text", + "text": " events." } ], "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." + } + ] + }, { "tag": "@throws", "content": [ { "kind": "text", - "text": "-" + "text": "validation: " }, { "kind": "inline-tag", "tag": "@link", - "text": "SetUserMFAPreferenceException" + "text": "InAppMessagingValidationErrorCode" }, { "kind": "text", - "text": " - Service error thrown when the MFA preference cannot be updated." + "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." } ] }, { - "tag": "@throws", + "tag": "@returns", "content": [ { "kind": "text", - "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + "text": "- An object that holds a remove method to stop listening to events." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nonMessageReceived((message) => {\n // use the message\n console.log(message.id);\n});\n```" } ] } ] }, "parameters": [ - 3564 + 5098 ], "type": { "type": "reference", "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Promise" + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/eventListeners/types.d.ts", + "qualifiedName": "EventListenerRemover" }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" + "name": "EventListenerRemover", + "package": "@aws-amplify/notifications" } }, - "3564": { - "id": 3564, + "5098": { + "id": 5098, "name": "input", "variant": "param", "kind": 32768, @@ -4058,30 +9932,34 @@ "summary": [ { "kind": "text", - "text": "The UpdateMFAPreferenceInput object." + "text": "The input object that holds the callback handler." } ] }, "type": { "type": "reference", - "target": 3443, - "name": "UpdateMFAPreferenceInput", - "package": "@aws-amplify/auth" + "target": { + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/inAppMessaging/providers/pinpoint/types/types.d.ts", + "qualifiedName": "OnMessageInteractionEventHandler" + }, + "name": "OnMessageInteractionEventHandler", + "package": "@aws-amplify/notifications" } }, - "3565": { - "id": 3565, - "name": "updatePassword", + "5099": { + "id": 5099, + "name": "setConflictHandler", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3566 + 5100 ] }, - "3566": { - "id": 3566, - "name": "updatePassword", + "5100": { + "id": 5100, + "name": "setConflictHandler", "variant": "signature", "kind": 4096, "flags": {}, @@ -4089,25 +9967,25 @@ "summary": [ { "kind": "text", - "text": "Updates user's password while authenticated." + "text": "Set a conflict handler that will be used to resolve conflicts that may emerge\nwhen matching events with synced messages." } ], "blockTags": [ { - "tag": "@throws", + "tag": "@deprecated", "content": [ { "kind": "text", - "text": "- " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "ChangePasswordException" - }, + "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." + } + ] + }, + { + "tag": "@remark", + "content": [ { "kind": "text", - "text": " - Cognito service errors thrown when updating a password." + "text": "The conflict handler is not persisted across app restarts and so must be set again before dispatching an event for\nany custom handling to take effect." } ] }, @@ -4116,32 +9994,82 @@ "content": [ { "kind": "text", - "text": "- " + "text": "validation: " }, { "kind": "inline-tag", "tag": "@link", - "text": "AuthValidationErrorCode" + "text": "InAppMessagingValidationErrorCode" }, { "kind": "text", - "text": " - Validation errors thrown when oldPassword or newPassword are empty." + "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." } ] }, { - "tag": "@throws", + "tag": "@example", "content": [ { - "kind": "text", - "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + "kind": "code", + "text": "```ts\n// Sync messages before dispatching an event\nawait syncMessages();\n\n// Example custom conflict handler\nconst myConflictHandler = (messages) => {\n\t\t// Return a random message\n\t\tconst randomIndex = Math.floor(Math.random() * messages.length);\n\t\treturn messages[randomIndex];\n };\n\n// Set the conflict handler\nsetConflictHandler(myConflictHandler);\n\n// Dispatch an event\nawait dispatchEvent({ name: 'test_event' });\n```" } ] } ] }, "parameters": [ - 3567 + 5101 + ], + "type": { + "type": "intrinsic", + "name": "void" + } + }, + "5101": { + "id": 5101, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The input object that holds the conflict handler to be used." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/notifications", + "packagePath": "dist/esm/inAppMessaging/providers/pinpoint/types/types.d.ts", + "qualifiedName": "InAppMessageConflictHandler" + }, + "name": "InAppMessageConflictHandler", + "package": "@aws-amplify/notifications" + } + }, + "5102": { + "id": 5102, + "name": "syncMessages", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5103, + 5105 + ] + }, + "5103": { + "id": 5103, + "name": "syncMessages", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 5104 ], "type": { "type": "reference", @@ -4160,9 +10088,9 @@ "package": "typescript" } }, - "3567": { - "id": 3567, - "name": "input", + "5104": { + "id": 5104, + "name": "ctx", "variant": "param", "kind": 32768, "flags": {}, @@ -4170,34 +10098,30 @@ "summary": [ { "kind": "text", - "text": "The UpdatePasswordInput object." + "text": "The " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AmplifyContext", + "target": 5131 + }, + { + "kind": "text", + "text": " to use for config and credentials." } ] }, "type": { "type": "reference", - "target": { - "packageName": "@aws-amplify/auth", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "AuthUpdatePasswordInput" - }, - "name": "AuthUpdatePasswordInput", - "package": "@aws-amplify/auth" + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" } }, - "3568": { - "id": 3568, - "name": "verifyTOTPSetup", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 3569 - ] - }, - "3569": { - "id": 3569, - "name": "verifyTOTPSetup", + "5105": { + "id": 5105, + "name": "syncMessages", "variant": "signature", "kind": 4096, "flags": {}, @@ -4205,25 +10129,25 @@ "summary": [ { "kind": "text", - "text": "Verifies an OTP code retrieved from an associated authentication app." + "text": "Fetch and persist messages from Pinpoint campaigns.\nCalling this API is necessary to trigger InApp messages on the device." } ], "blockTags": [ { - "tag": "@throws", + "tag": "@deprecated", "content": [ { "kind": "text", - "text": "-" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "VerifySoftwareTokenException" - }, + "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." + } + ] + }, + { + "tag": "@throws", + "content": [ { "kind": "text", - "text": ":\nThrown due to an invalid MFA token." + "text": "service exceptions - Thrown when the underlying Pinpoint service returns an error." } ] }, @@ -4232,41 +10156,39 @@ "content": [ { "kind": "text", - "text": "-" + "text": "validation: " }, { "kind": "inline-tag", "tag": "@link", - "text": "AuthValidationErrorCode" + "text": "InAppMessagingValidationErrorCode" }, { "kind": "text", - "text": ":\nThrown when " - }, - { - "kind": "code", - "text": "`code`" - }, + "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." + } + ] + }, + { + "tag": "@returns", + "content": [ { "kind": "text", - "text": " is not defined." + "text": "A promise that will resolve when the operation is complete." } ] }, { - "tag": "@throws", + "tag": "@example", "content": [ { - "kind": "text", - "text": "AuthTokenConfigException - Thrown when the token provider config is invalid." + "kind": "code", + "text": "```ts\n// Sync InApp messages with Pinpoint and device.\nawait syncMessages();\n\n```" } ] } ] }, - "parameters": [ - 3570 - ], "type": { "type": "reference", "target": { @@ -4284,373 +10206,343 @@ "package": "typescript" } }, - "3570": { - "id": 3570, - "name": "input", - "variant": "param", - "kind": 32768, + "5131": { + "id": 5131, + "name": "AmplifyContext", + "variant": "declaration", + "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The VerifyTOTPSetupInput" + "text": "The context object returned by " + }, + { + "kind": "code", + "text": "`createAmplifyContext()`" + }, + { + "kind": "text", + "text": ". Pass this as the first argument\nto every Amplify category API to provide configuration and auth credentials\nwithout relying on global singleton state." } ] }, - "type": { - "type": "reference", - "target": 3481, - "name": "VerifyTOTPSetupInput", - "package": "@aws-amplify/auth" - } - }, - "4673": { - "id": 4673, - "name": "in-app-messaging", - "variant": "declaration", - "kind": 2, - "flags": {}, "children": [ - { - "id": 4719, - "name": "clearMessages", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4720 - ] - }, - { - "id": 4721, - "name": "dispatchEvent", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4722 - ] - }, - { - "id": 4724, - "name": "initializeInAppMessaging", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4725 - ] - }, - { - "id": 4726, - "name": "notifyMessageInteraction", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4727 - ] - }, - { - "id": 4729, - "name": "onMessageActionTaken", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4730 - ] - }, - { - "id": 4732, - "name": "onMessageDismissed", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4733 - ] - }, - { - "id": 4735, - "name": "onMessageDisplayed", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4736 - ] - }, - { - "id": 4738, - "name": "onMessageReceived", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4739 - ] - }, - { - "id": 4741, - "name": "setConflictHandler", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4742 - ] - }, - { - "id": 4744, - "name": "syncMessages", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4745 - ] - } + 5132, + 5133, + 5134, + 5135, + 5137, + 5140 ], "groups": [ { - "title": "Interfaces", - "children": [ - 4674, - 4679, - 4684, - 4691, - 4693, - 4698 - ] - }, - { - "title": "Type Aliases", - "children": [ - 4701, - 4702, - 4703, - 4704, - 4705, - 4706, - 4707, - 4708, - 4709, - 4710, - 4711, - 4712, - 4713, - 4714 - ] - }, - { - "title": "Variables", + "title": "Properties", "children": [ - 4715 + 5132, + 5133, + 5134 ] }, { - "title": "Functions", - "children": [ - 4719, - 4721, - 4724, - 4726, - 4729, - 4732, - 4735, - 4738, - 4741, - 4744 - ] - } - ] - }, - "4674": { - "id": 4674, - "name": "InAppMessage", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - 4675, - 4676, - 4677, - 4678 - ], - "groups": [ - { - "title": "Properties", + "title": "Methods", "children": [ - 4675, - 4676, - 4677, - 4678 + 5135, + 5137, + 5140 ] } ] }, - "4675": { - "id": 4675, - "name": "content", + "5132": { + "id": 5132, + "name": "libraryOptions", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isReadonly": true + }, "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4684, - "name": "InAppMessageContent", - "package": "@aws-amplify/notifications" - } + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Readonly" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/types.d.ts", + "qualifiedName": "LibraryOptions" + }, + "name": "LibraryOptions", + "package": "@aws-amplify/core" + } + ], + "name": "Readonly", + "package": "typescript" } }, - "4676": { - "id": 4676, - "name": "id", + "5133": { + "id": 5133, + "name": "resourcesConfig", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isReadonly": true + }, "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Readonly" + }, + "typeArguments": [ + { + "type": "reference", + "target": 5183, + "name": "ResourcesConfig", + "package": "@aws-amplify/core" + } + ], + "name": "Readonly", + "package": "typescript" } }, - "4677": { - "id": 4677, - "name": "layout", + "5134": { + "id": 5134, + "name": "token", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Per-context identity handle; see " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "AmplifyContextToken", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/context/AmplifyContext.d.ts", + "qualifiedName": "AmplifyContextToken" + } + }, + { + "kind": "text", + "text": ". All\nlegitimate producers are the Amplify context factories, which attach a\nfresh, frozen token per context." + } + ] + }, "type": { "type": "reference", - "target": 4704, - "name": "InAppMessageLayout", - "package": "@aws-amplify/notifications" + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/context/AmplifyContext.d.ts", + "qualifiedName": "AmplifyContextToken" + }, + "name": "AmplifyContextToken", + "package": "@aws-amplify/core" } }, - "4678": { - "id": 4678, - "name": "metadata", + "5135": { + "id": 5135, + "name": "clearCredentials", "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, + "kind": 2048, + "flags": {}, + "signatures": [ + 5136 + ] + }, + "5136": { + "id": 5136, + "name": "clearCredentials", + "variant": "signature", + "kind": 4096, + "flags": {}, "type": { - "type": "intrinsic", - "name": "any" + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" } }, - "4679": { - "id": 4679, - "name": "InAppMessageButton", + "5137": { + "id": 5137, + "name": "fetchAuthSession", "variant": "declaration", - "kind": 256, + "kind": 2048, "flags": {}, - "children": [ - 4680, - 4681, - 4682, - 4683 - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4680, - 4681, - 4682, - 4683 - ] - } + "signatures": [ + 5138 ] }, - "4680": { - "id": 4680, - "name": "action", - "variant": "declaration", - "kind": 1024, + "5138": { + "id": 5138, + "name": "fetchAuthSession", + "variant": "signature", + "kind": 4096, "flags": {}, + "parameters": [ + 5139 + ], "type": { "type": "reference", - "target": 4703, - "name": "InAppMessageAction", - "package": "@aws-amplify/notifications" + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3687, + "name": "AuthSession", + "package": "@aws-amplify/core" + } + ], + "name": "Promise", + "package": "typescript" } }, - "4681": { - "id": 4681, - "name": "style", - "variant": "declaration", - "kind": 1024, + "5139": { + "id": 5139, + "name": "options", + "variant": "param", + "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", - "target": 4693, - "name": "InAppMessageStyle", - "package": "@aws-amplify/notifications" + "target": 3718, + "name": "FetchAuthSessionOptions", + "package": "@aws-amplify/core" } }, - "4682": { - "id": 4682, - "name": "title", + "5140": { + "id": 5140, + "name": "getTokens", "variant": "declaration", - "kind": 1024, + "kind": 2048, + "flags": {}, + "signatures": [ + 5141 + ] + }, + "5141": { + "id": 5141, + "name": "getTokens", + "variant": "signature", + "kind": 4096, "flags": {}, + "parameters": [ + 5142 + ], "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": 3692, + "name": "AuthTokens", + "package": "@aws-amplify/core" + }, + { + "type": "intrinsic", + "name": "undefined" + } + ] + } + ], + "name": "Promise", + "package": "typescript" } }, - "4683": { - "id": 4683, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, + "5142": { + "id": 5142, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": {}, "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": 3718, + "name": "FetchAuthSessionOptions", + "package": "@aws-amplify/core" } }, - "4684": { - "id": 4684, - "name": "InAppMessageContent", + "5183": { + "id": 5183, + "name": "ResourcesConfig", "variant": "declaration", "kind": 256, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Amplify library configuration type. Used to specify back-end resource configuration across the library." + } + ] + }, "children": [ - 4685, - 4686, - 4687, - 4688, - 4689, - 4690 + 5184, + 5185, + 5186, + 5187, + 5188, + 5189, + 5190, + 5191 ], "groups": [ { "title": "Properties", "children": [ - 4685, - 4686, - 4687, - 4688, - 4689, - 4690 + 5184, + 5185, + 5186, + 5187, + 5188, + 5189, + 5190, + 5191 ] } ] }, - "4685": { - "id": 4685, - "name": "body", + "5184": { + "id": 5184, + "name": "Analytics", "variant": "declaration", "kind": 1024, "flags": { @@ -4659,17 +10551,17 @@ "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/notifications", - "packagePath": "dist/esm/inAppMessaging/types/message.d.ts", - "qualifiedName": "InAppMessageBody" + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Analytics/types.d.ts", + "qualifiedName": "AnalyticsConfig" }, - "name": "InAppMessageBody", - "package": "@aws-amplify/notifications" + "name": "AnalyticsConfig", + "package": "@aws-amplify/core" } }, - "4686": { - "id": 4686, - "name": "container", + "5185": { + "id": 5185, + "name": "API", "variant": "declaration", "kind": 1024, "flags": { @@ -4678,17 +10570,17 @@ "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/notifications", - "packagePath": "dist/esm/inAppMessaging/types/message.d.ts", - "qualifiedName": "InAppMessageContainer" + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/API/types.d.ts", + "qualifiedName": "APIConfig" }, - "name": "InAppMessageContainer", - "package": "@aws-amplify/notifications" + "name": "APIConfig", + "package": "@aws-amplify/core" } }, - "4687": { - "id": 4687, - "name": "header", + "5186": { + "id": 5186, + "name": "Auth", "variant": "declaration", "kind": 1024, "flags": { @@ -4697,17 +10589,17 @@ "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/notifications", - "packagePath": "dist/esm/inAppMessaging/types/message.d.ts", - "qualifiedName": "InAppMessageHeader" + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Auth/types.d.ts", + "qualifiedName": "AuthConfig" }, - "name": "InAppMessageHeader", - "package": "@aws-amplify/notifications" + "name": "AuthConfig", + "package": "@aws-amplify/core" } }, - "4688": { - "id": 4688, - "name": "image", + "5187": { + "id": 5187, + "name": "Geo", "variant": "declaration", "kind": 1024, "flags": { @@ -4715,14 +10607,14 @@ }, "type": { "type": "reference", - "target": 4691, - "name": "InAppMessageImage", - "package": "@aws-amplify/notifications" + "target": 5876, + "name": "GeoConfig", + "package": "@aws-amplify/core" } }, - "4689": { - "id": 4689, - "name": "primaryButton", + "5188": { + "id": 5188, + "name": "Interactions", "variant": "declaration", "kind": 1024, "flags": { @@ -4730,14 +10622,18 @@ }, "type": { "type": "reference", - "target": 4679, - "name": "InAppMessageButton", - "package": "@aws-amplify/notifications" + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Interactions/types.d.ts", + "qualifiedName": "InteractionsConfig" + }, + "name": "InteractionsConfig", + "package": "@aws-amplify/core" } }, - "4690": { - "id": 4690, - "name": "secondaryButton", + "5189": { + "id": 5189, + "name": "Notifications", "variant": "declaration", "kind": 1024, "flags": { @@ -4745,106 +10641,37 @@ }, "type": { "type": "reference", - "target": 4679, - "name": "InAppMessageButton", - "package": "@aws-amplify/notifications" - } - }, - "4691": { - "id": 4691, - "name": "InAppMessageImage", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - 4692 - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4692 - ] - } - ] - }, - "4692": { - "id": 4692, - "name": "src", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - "4693": { - "id": 4693, - "name": "InAppMessageStyle", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - 4694, - 4695, - 4696, - 4697 - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4694, - 4695, - 4696, - 4697 - ] - } - ] - }, - "4694": { - "id": 4694, - "name": "backgroundColor", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - "4695": { - "id": 4695, - "name": "borderRadius", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Notifications/types.d.ts", + "qualifiedName": "NotificationsConfig" + }, + "name": "NotificationsConfig", + "package": "@aws-amplify/core" } }, - "4696": { - "id": 4696, - "name": "color", + "5190": { + "id": 5190, + "name": "Predictions", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Predictions/types.d.ts", + "qualifiedName": "PredictionsConfig" + }, + "name": "PredictionsConfig", + "package": "@aws-amplify/core" } }, - "4697": { - "id": 4697, - "name": "textAlign", + "5191": { + "id": 5191, + "name": "Storage", "variant": "declaration", "kind": 1024, "flags": { @@ -4852,219 +10679,382 @@ }, "type": { "type": "reference", - "target": 4705, - "name": "InAppMessageTextAlign", - "package": "@aws-amplify/notifications" + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Storage/types.d.ts", + "qualifiedName": "StorageConfig" + }, + "name": "StorageConfig", + "package": "@aws-amplify/core" } }, - "4698": { - "id": 4698, - "name": "NotifyMessageInteractionInput", + "5304": { + "id": 5304, + "name": "storage", "variant": "declaration", - "kind": 256, + "kind": 2, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input type for NotifyMessageInteraction API." - } - ] - }, "children": [ - 4699, - 4700 + { + "id": 5375, + "name": "copy", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5376, + 5379, + 5382, + 5384 + ] + }, + { + "id": 5386, + "name": "downloadData", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5387, + 5390, + 5393, + 5395 + ] + }, + { + "id": 5397, + "name": "getProperties", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5398, + 5401, + 5404, + 5406 + ] + }, + { + "id": 5408, + "name": "getUrl", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5409, + 5412, + 5415, + 5417 + ] + }, + { + "id": 5419, + "name": "list", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5420, + 5423, + 5426, + 5429, + 5432, + 5434, + 5436, + 5438 + ] + }, + { + "id": 5440, + "name": "remove", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5441, + 5444, + 5447, + 5449 + ] + }, + { + "id": 5451, + "name": "uploadData", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5452, + 5455, + 5458, + 5460 + ] + } ], "groups": [ { - "title": "Properties", + "title": "Classes", + "children": [ + 5305 + ] + }, + { + "title": "Interfaces", + "children": [ + 5325 + ] + }, + { + "title": "Type Aliases", + "children": [ + 5328, + 5329, + 5330, + 5331, + 5332, + 5333, + 5334, + 5335, + 5336, + 5337, + 5338, + 5339, + 5340, + 5341, + 5342, + 5343, + 5344, + 5345, + 5346, + 5347, + 5348, + 5349, + 5352, + 5353, + 5356, + 5357, + 5358, + 5363, + 5364, + 5365, + 5366, + 5367, + 5368, + 5369 + ] + }, + { + "title": "Variables", + "children": [ + 5370, + 5371 + ] + }, + { + "title": "Functions", "children": [ - 4699, - 4700 + 5375, + 5386, + 5397, + 5408, + 5419, + 5440, + 5451 ] } ] }, - "4699": { - "id": 4699, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 4674, - "name": "InAppMessage", - "package": "@aws-amplify/notifications" - } - }, - "4700": { - "id": 4700, - "name": "type", + "5328": { + "id": 5328, + "name": "CopyInput", "variant": "declaration", - "kind": 1024, + "kind": 2097152, "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "CopyWithPathInput", + "target": 5330 + }, + { + "kind": "text", + "text": " instead.\nInput type for S3 copy API." + } + ] + } + ] + }, "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/notifications", - "packagePath": "dist/esm/inAppMessaging/types/event.d.ts", - "qualifiedName": "InAppMessageInteractionEvent" + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "StorageCopyInputWithKey" }, - "name": "InAppMessageInteractionEvent", - "package": "@aws-amplify/notifications" - } - }, - "4703": { - "id": 4703, - "name": "InAppMessageAction", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "CLOSE" - }, + "typeArguments": [ { - "type": "literal", - "value": "DEEP_LINK" + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/options.d.ts", + "qualifiedName": "CopySourceWithKeyOptions" + }, + "name": "CopySourceWithKeyOptions", + "package": "@aws-amplify/storage" }, { - "type": "literal", - "value": "LINK" + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/options.d.ts", + "qualifiedName": "CopyDestinationWithKeyOptions" + }, + "name": "CopyDestinationWithKeyOptions", + "package": "@aws-amplify/storage" } - ] + ], + "name": "StorageCopyInputWithKey", + "package": "@aws-amplify/storage" } }, - "4704": { - "id": 4704, - "name": "InAppMessageLayout", + "5329": { + "id": 5329, + "name": "CopyOutput", "variant": "declaration", "kind": 2097152, "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "BOTTOM_BANNER" - }, - { - "type": "literal", - "value": "CAROUSEL" - }, - { - "type": "literal", - "value": "FULL_SCREEN" - }, - { - "type": "literal", - "value": "MIDDLE_BANNER" - }, + "comment": { + "summary": [ { - "type": "literal", - "value": "MODAL" - }, + "kind": "text", + "text": "Output type with path for S3 copy API." + } + ], + "blockTags": [ { - "type": "literal", - "value": "TOP_BANNER" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "CopyWithPathOutput", + "target": 5331 + }, + { + "kind": "text", + "text": " instead." + } + ] } ] - } - }, - "4705": { - "id": 4705, - "name": "InAppMessageTextAlign", - "variant": "declaration", - "kind": 2097152, - "flags": {}, + }, "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "center" - }, + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Pick" + }, + "typeArguments": [ { - "type": "literal", - "value": "left" + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", + "qualifiedName": "ItemWithKey" + }, + "name": "ItemWithKey", + "package": "@aws-amplify/storage" }, { "type": "literal", - "value": "right" + "value": "key" } - ] + ], + "name": "Pick", + "package": "typescript" } }, - "4719": { - "id": 4719, - "name": "clearMessages", + "5331": { + "id": 5331, + "name": "CopyWithPathOutput", "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4720 - ] - }, - "4720": { - "id": 4720, - "name": "clearMessages", - "variant": "signature", - "kind": 4096, + "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Clear locally cached messages." + "text": "Output type with path for S3 copy API." } - ], - "blockTags": [ + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Pick" + }, + "typeArguments": [ { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." - } - ] + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", + "qualifiedName": "ItemWithPath" + }, + "name": "ItemWithPath", + "package": "@aws-amplify/storage" }, { - "tag": "@throws", + "type": "literal", + "value": "path" + } + ], + "name": "Pick", + "package": "typescript" + } + }, + "5332": { + "id": 5332, + "name": "DownloadDataInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@deprecated", "content": [ { "kind": "text", - "text": "validation: " + "text": "Use " }, { "kind": "inline-tag", "tag": "@link", - "text": "InAppMessagingValidationErrorCode" + "text": "DownloadDataWithPathInput", + "target": 5334 }, { "kind": "text", - "text": " - Thrown if In App messaging hasn't been initialized." - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A promise that will resolve when the operation is complete." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Clear locally cached messages.\nawait clearMessages();\n\n```" + "text": " instead.\nInput type for S3 downloadData API." } ] } @@ -5073,51 +11063,37 @@ "type": { "type": "reference", "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Promise" + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "StorageDownloadDataInputWithKey" }, "typeArguments": [ { - "type": "intrinsic", - "name": "void" + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/options.d.ts", + "qualifiedName": "DownloadDataWithKeyOptions" + }, + "name": "DownloadDataWithKeyOptions", + "package": "@aws-amplify/storage" } ], - "name": "Promise", - "package": "typescript" + "name": "StorageDownloadDataInputWithKey", + "package": "@aws-amplify/storage" } }, - "4721": { - "id": 4721, - "name": "dispatchEvent", + "5333": { + "id": 5333, + "name": "DownloadDataOutput", "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4722 - ] - }, - "4722": { - "id": 4722, - "name": "dispatchEvent", - "variant": "signature", - "kind": 4096, + "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Triggers an In-App message to be displayed. Use this after your campaigns have been synced to the device using\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "syncMessages", - "target": 4744 - }, - { - "kind": "text", - "text": ". Based on the messages synced and the event passed to this API, it triggers the display\nof the In-App message that meets the criteria." + "text": "Output type for S3 downloadData API." } ], "blockTags": [ @@ -5126,299 +11102,207 @@ "content": [ { "kind": "text", - "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." - } - ] - }, - { - "tag": "@remark", - "content": [ - { - "kind": "text", - "text": "If an event would trigger multiple messages, the message closest to expiry will be chosen by default.\nTo change this behavior, you can use the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "setConflictHandler", - "target": 4741 - }, - { - "kind": "text", - "text": " API to provide\nyour own logic for resolving message conflicts." - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "validation: " + "text": "Use " }, { "kind": "inline-tag", "tag": "@link", - "text": "InAppMessagingValidationErrorCode" + "text": "DownloadDataWithPathOutput", + "target": 5335 }, { "kind": "text", - "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "service exceptions - Thrown when the underlying Pinpoint service returns an error." - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A promise that will resolve when the operation is complete." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Sync message before disptaching an event\nawait syncMessages();\n\n// Dispatch an event\nawait dispatchEvent({ name: 'test_event' });\n```" + "text": " instead." } ] } ] }, - "parameters": [ - 4723 - ], "type": { "type": "reference", "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Promise" + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/common.d.ts", + "qualifiedName": "DownloadTask" }, "typeArguments": [ { - "type": "intrinsic", - "name": "void" + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "StorageDownloadDataOutput" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", + "qualifiedName": "ItemWithKey" + }, + "name": "ItemWithKey", + "package": "@aws-amplify/storage" + } + ], + "name": "StorageDownloadDataOutput", + "package": "@aws-amplify/storage" } ], - "name": "Promise", - "package": "typescript" + "name": "DownloadTask", + "package": "@aws-amplify/storage" } }, - "4723": { - "id": 4723, - "name": "input", - "variant": "param", - "kind": 32768, + "5334": { + "id": 5334, + "name": "DownloadDataWithPathInput", + "variant": "declaration", + "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The input object that holds the event to be dispatched." + "text": "Input type with path for S3 downloadData API." } ] }, "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/notifications", - "packagePath": "dist/esm/inAppMessaging/types/event.d.ts", - "qualifiedName": "InAppMessagingEvent" + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "StorageDownloadDataInputWithPath" }, - "name": "InAppMessagingEvent", - "package": "@aws-amplify/notifications" + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/options.d.ts", + "qualifiedName": "DownloadDataWithPathOptions" + }, + "name": "DownloadDataWithPathOptions", + "package": "@aws-amplify/storage" + } + ], + "name": "StorageDownloadDataInputWithPath", + "package": "@aws-amplify/storage" } }, - "4724": { - "id": 4724, - "name": "initializeInAppMessaging", + "5335": { + "id": 5335, + "name": "DownloadDataWithPathOutput", "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4725 - ] - }, - "4725": { - "id": 4725, - "name": "initializeInAppMessaging", - "variant": "signature", - "kind": 4096, + "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize and set up in-app messaging category. This API needs to be called to enable other InAppMessaging APIs." + "text": "Output type with path for S3 downloadData API." } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "Make sure to call this early in your app at the root entry point after configuring Amplify." - } - ] - }, + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/common.d.ts", + "qualifiedName": "DownloadTask" + }, + "typeArguments": [ { - "tag": "@example", - "content": [ + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "StorageDownloadDataOutput" + }, + "typeArguments": [ { - "kind": "code", - "text": "```ts\nAmplify.configure(config);\ninitializeInAppMessaging();\n```" + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", + "qualifiedName": "ItemWithPath" + }, + "name": "ItemWithPath", + "package": "@aws-amplify/storage" } - ] + ], + "name": "StorageDownloadDataOutput", + "package": "@aws-amplify/storage" } - ] - }, - "type": { - "type": "intrinsic", - "name": "void" + ], + "name": "DownloadTask", + "package": "@aws-amplify/storage" } }, - "4726": { - "id": 4726, - "name": "notifyMessageInteraction", + "5336": { + "id": 5336, + "name": "GetPropertiesInput", "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4727 - ] - }, - "4727": { - "id": 4727, - "name": "notifyMessageInteraction", - "variant": "signature", - "kind": 4096, + "kind": 2097152, "flags": {}, "comment": { - "summary": [ - { - "kind": "text", - "text": "Notifies the respective listener of the specified type with the message given." - } - ], + "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", - "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "validation: " + "text": "Use " }, { "kind": "inline-tag", "tag": "@link", - "text": "InAppMessagingValidationErrorCode" + "text": "GetPropertiesWithPathInput", + "target": 5338 }, { "kind": "text", - "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nonMessageRecieved((message) => {\n // Show end users the In-App message and notify event listeners\n notifyMessageInteraction({ type: 'messageDisplayed', message });\n});\n```" + "text": " instead.\nInput type for S3 getProperties API." } ] } ] }, - "parameters": [ - 4728 - ], "type": { - "type": "intrinsic", - "name": "void" - } - }, - "4728": { - "id": 4728, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "StorageGetPropertiesInputWithKey" + }, + "typeArguments": [ { - "kind": "text", - "text": "The input object that holds the type and message." + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/options.d.ts", + "qualifiedName": "GetPropertiesWithKeyOptions" + }, + "name": "GetPropertiesWithKeyOptions", + "package": "@aws-amplify/storage" } - ] - }, - "type": { - "type": "reference", - "target": 4698, - "name": "NotifyMessageInteractionInput", - "package": "@aws-amplify/notifications" + ], + "name": "StorageGetPropertiesInputWithKey", + "package": "@aws-amplify/storage" } }, - "4729": { - "id": 4729, - "name": "onMessageActionTaken", + "5337": { + "id": 5337, + "name": "GetPropertiesOutput", "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4730 - ] - }, - "4730": { - "id": 4730, - "name": "onMessageActionTaken", - "variant": "signature", - "kind": 4096, + "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Registers a callback that will be invoked on " - }, - { - "kind": "code", - "text": "`messageActionTaken`" - }, - { - "kind": "text", - "text": " events." + "text": "Output type for S3 getProperties API." } ], "blockTags": [ @@ -5427,805 +11311,712 @@ "content": [ { "kind": "text", - "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "validation: " + "text": "Use " }, { "kind": "inline-tag", "tag": "@link", - "text": "InAppMessagingValidationErrorCode" + "text": "GetPropertiesWithPathOutput", + "target": 5339 }, { "kind": "text", - "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." + "text": " instead." } ] - }, + } + ] + }, + "type": { + "type": "intersection", + "types": [ { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "- An object that holds a remove method to stop listening to events." - } - ] + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", + "qualifiedName": "ItemBase" + }, + "name": "ItemBase", + "package": "@aws-amplify/storage" }, { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nonMessageActionTaken((message) => {\n // use the message\n console.log(message.id);\n});\n```" - } - ] + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "StorageItemWithKey" + }, + "name": "StorageItemWithKey", + "package": "@aws-amplify/storage" } ] - }, - "parameters": [ - 4731 - ], - "type": { - "type": "reference", - "target": { - "packageName": "@aws-amplify/notifications", - "packagePath": "dist/esm/eventListeners/types.d.ts", - "qualifiedName": "EventListenerRemover" - }, - "name": "EventListenerRemover", - "package": "@aws-amplify/notifications" } }, - "4731": { - "id": 4731, - "name": "input", - "variant": "param", - "kind": 32768, + "5338": { + "id": 5338, + "name": "GetPropertiesWithPathInput", + "variant": "declaration", + "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The input object that holds the callback handler." + "text": "Input type with for S3 getProperties API." } ] }, "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/notifications", - "packagePath": "dist/esm/inAppMessaging/providers/pinpoint/types/types.d.ts", - "qualifiedName": "OnMessageInteractionEventHandler" + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "StorageGetPropertiesInputWithPath" }, - "name": "OnMessageInteractionEventHandler", - "package": "@aws-amplify/notifications" + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/options.d.ts", + "qualifiedName": "GetPropertiesWithPathOptions" + }, + "name": "GetPropertiesWithPathOptions", + "package": "@aws-amplify/storage" + } + ], + "name": "StorageGetPropertiesInputWithPath", + "package": "@aws-amplify/storage" } }, - "4732": { - "id": 4732, - "name": "onMessageDismissed", + "5339": { + "id": 5339, + "name": "GetPropertiesWithPathOutput", "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4733 - ] - }, - "4733": { - "id": 4733, - "name": "onMessageDismissed", - "variant": "signature", - "kind": 4096, + "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Registers a callback that will be invoked on " - }, + "text": "Output type with path for S3 getProperties API." + } + ] + }, + "type": { + "type": "intersection", + "types": [ { - "kind": "code", - "text": "`messageDismissed`" + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", + "qualifiedName": "ItemBase" + }, + "name": "ItemBase", + "package": "@aws-amplify/storage" }, { - "kind": "text", - "text": " events." + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "StorageItemWithPath" + }, + "name": "StorageItemWithPath", + "package": "@aws-amplify/storage" } - ], + ] + } + }, + "5340": { + "id": 5340, + "name": "GetUrlInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", - "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "validation: " + "text": "Use " }, { "kind": "inline-tag", "tag": "@link", - "text": "InAppMessagingValidationErrorCode" + "text": "GetUrlWithPathInput", + "target": 5342 }, { "kind": "text", - "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "- An object that holds a remove method to stop listening to events." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nonMessageDismissed((message) => {\n // use the message\n console.log(message.id);\n});\n```" + "text": " instead.\nInput type for S3 getUrl API." } ] } ] }, - "parameters": [ - 4734 - ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/notifications", - "packagePath": "dist/esm/eventListeners/types.d.ts", - "qualifiedName": "EventListenerRemover" + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "StorageGetUrlInputWithKey" }, - "name": "EventListenerRemover", - "package": "@aws-amplify/notifications" + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/options.d.ts", + "qualifiedName": "GetUrlWithKeyOptions" + }, + "name": "GetUrlWithKeyOptions", + "package": "@aws-amplify/storage" + } + ], + "name": "StorageGetUrlInputWithKey", + "package": "@aws-amplify/storage" } }, - "4734": { - "id": 4734, - "name": "input", - "variant": "param", - "kind": 32768, + "5342": { + "id": 5342, + "name": "GetUrlWithPathInput", + "variant": "declaration", + "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The input object that holds the callback handler." + "text": "Input type with path for S3 getUrl API." } ] }, "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/notifications", - "packagePath": "dist/esm/inAppMessaging/providers/pinpoint/types/types.d.ts", - "qualifiedName": "OnMessageInteractionEventHandler" + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "StorageGetUrlInputWithPath" }, - "name": "OnMessageInteractionEventHandler", - "package": "@aws-amplify/notifications" + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/options.d.ts", + "qualifiedName": "GetUrlWithPathOptions" + }, + "name": "GetUrlWithPathOptions", + "package": "@aws-amplify/storage" + } + ], + "name": "StorageGetUrlInputWithPath", + "package": "@aws-amplify/storage" } }, - "4735": { - "id": 4735, - "name": "onMessageDisplayed", + "5344": { + "id": 5344, + "name": "ListAllInput", "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4736 - ] - }, - "4736": { - "id": 4736, - "name": "onMessageDisplayed", - "variant": "signature", - "kind": 4096, + "kind": 2097152, "flags": {}, "comment": { - "summary": [ - { - "kind": "text", - "text": "Registers a callback that will be invoked on " - }, - { - "kind": "code", - "text": "`messageDisplayed`" - }, - { - "kind": "text", - "text": " events." - } - ], + "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", - "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." + "text": "Use " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "ListAllWithPathInput", + "target": 5346 + }, + { + "kind": "text", + "text": " instead.\nInput type for S3 list API. Lists all bucket objects." } ] - }, + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "StorageListInputWithPrefix" + }, + "typeArguments": [ { - "tag": "@throws", + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/options.d.ts", + "qualifiedName": "ListAllWithPrefixOptions" + }, + "name": "ListAllWithPrefixOptions", + "package": "@aws-amplify/storage" + } + ], + "name": "StorageListInputWithPrefix", + "package": "@aws-amplify/storage" + } + }, + "5345": { + "id": 5345, + "name": "ListAllOutput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@deprecated", "content": [ { "kind": "text", - "text": "validation: " + "text": "Use " }, { "kind": "inline-tag", "tag": "@link", - "text": "InAppMessagingValidationErrorCode" + "text": "ListAllWithPathOutput", + "target": 5347 }, { "kind": "text", - "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." + "text": " instead.\nOutput type for S3 list API. Lists all bucket objects." } ] - }, + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ { - "tag": "@returns", - "content": [ + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "StorageListOutput" + }, + "typeArguments": [ { - "kind": "text", - "text": "- An object that holds a remove method to stop listening to events." + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", + "qualifiedName": "ListOutputItem" + }, + "name": "ListOutputItem", + "package": "@aws-amplify/storage" } - ] + ], + "name": "StorageListOutput", + "package": "@aws-amplify/storage" }, { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nonMessageDisplayed((message) => {\n // use the message\n\t console.log(message.id);\n});\n```" - } - ] + "type": "literal", + "value": "excludedSubpaths" + } + ], + "name": "Omit", + "package": "typescript" + } + }, + "5346": { + "id": 5346, + "name": "ListAllWithPathInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type with path for S3 list API. Lists all bucket objects." } ] }, - "parameters": [ - 4737 - ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/notifications", - "packagePath": "dist/esm/eventListeners/types.d.ts", - "qualifiedName": "EventListenerRemover" + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "StorageListInputWithPath" }, - "name": "EventListenerRemover", - "package": "@aws-amplify/notifications" - } - }, - "4737": { - "id": 4737, - "name": "input", - "variant": "param", - "kind": 32768, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/options.d.ts", + "qualifiedName": "ListAllWithPathOptions" + }, + "name": "ListAllWithPathOptions", + "package": "@aws-amplify/storage" + } + ], + "name": "StorageListInputWithPath", + "package": "@aws-amplify/storage" + } + }, + "5347": { + "id": 5347, + "name": "ListAllWithPathOutput", + "variant": "declaration", + "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The input object that holds the callback handler." + "text": "Output type with path for S3 list API. Lists all bucket objects." } ] }, "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/notifications", - "packagePath": "dist/esm/inAppMessaging/providers/pinpoint/types/types.d.ts", - "qualifiedName": "OnMessageInteractionEventHandler" + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "StorageListOutput" }, - "name": "OnMessageInteractionEventHandler", - "package": "@aws-amplify/notifications" + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", + "qualifiedName": "ListOutputItemWithPath" + }, + "name": "ListOutputItemWithPath", + "package": "@aws-amplify/storage" + } + ], + "name": "StorageListOutput", + "package": "@aws-amplify/storage" } }, - "4738": { - "id": 4738, - "name": "onMessageReceived", + "5348": { + "id": 5348, + "name": "ListPaginateInput", "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4739 - ] - }, - "4739": { - "id": 4739, - "name": "onMessageReceived", - "variant": "signature", - "kind": 4096, + "kind": 2097152, "flags": {}, "comment": { - "summary": [ - { - "kind": "text", - "text": "Registers a callback that will be invoked on " - }, - { - "kind": "code", - "text": "`messageReceived`" - }, - { - "kind": "text", - "text": " events." - } - ], + "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", - "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "validation: " + "text": "Use " }, { "kind": "inline-tag", "tag": "@link", - "text": "InAppMessagingValidationErrorCode" + "text": "ListPaginateWithPathInput", + "target": 5352 }, { "kind": "text", - "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "- An object that holds a remove method to stop listening to events." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nonMessageReceived((message) => {\n // use the message\n console.log(message.id);\n});\n```" + "text": " instead.\nInput type for S3 list API. Lists bucket objects with pagination." } ] } ] }, - "parameters": [ - 4740 - ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/notifications", - "packagePath": "dist/esm/eventListeners/types.d.ts", - "qualifiedName": "EventListenerRemover" + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "StorageListInputWithPrefix" }, - "name": "EventListenerRemover", - "package": "@aws-amplify/notifications" - } - }, - "4740": { - "id": 4740, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ + "typeArguments": [ { - "kind": "text", - "text": "The input object that holds the callback handler." + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/options.d.ts", + "qualifiedName": "ListPaginateWithPrefixOptions" + }, + "name": "ListPaginateWithPrefixOptions", + "package": "@aws-amplify/storage" } - ] - }, - "type": { - "type": "reference", - "target": { - "packageName": "@aws-amplify/notifications", - "packagePath": "dist/esm/inAppMessaging/providers/pinpoint/types/types.d.ts", - "qualifiedName": "OnMessageInteractionEventHandler" - }, - "name": "OnMessageInteractionEventHandler", - "package": "@aws-amplify/notifications" + ], + "name": "StorageListInputWithPrefix", + "package": "@aws-amplify/storage" } }, - "4741": { - "id": 4741, - "name": "setConflictHandler", + "5349": { + "id": 5349, + "name": "ListPaginateOutput", "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4742 - ] - }, - "4742": { - "id": 4742, - "name": "setConflictHandler", - "variant": "signature", - "kind": 4096, + "kind": 2097152, "flags": {}, "comment": { - "summary": [ - { - "kind": "text", - "text": "Set a conflict handler that will be used to resolve conflicts that may emerge\nwhen matching events with synced messages." - } - ], + "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", - "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." - } - ] - }, - { - "tag": "@remark", - "content": [ - { - "kind": "text", - "text": "The conflict handler is not persisted across app restarts and so must be set again before dispatching an event for\nany custom handling to take effect." - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "validation: " + "text": "Use " }, { "kind": "inline-tag", "tag": "@link", - "text": "InAppMessagingValidationErrorCode" + "text": "ListPaginateWithPathOutput", + "target": 5353 }, { "kind": "text", - "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." + "text": " instead.\nOutput type for S3 list API. Lists bucket objects with pagination." } ] - }, + } + ] + }, + "type": { + "type": "intersection", + "types": [ { - "tag": "@example", - "content": [ + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ { - "kind": "code", - "text": "```ts\n// Sync messages before dispatching an event\nawait syncMessages();\n\n// Example custom conflict handler\nconst myConflictHandler = (messages) => {\n\t\t// Return a random message\n\t\tconst randomIndex = Math.floor(Math.random() * messages.length);\n\t\treturn messages[randomIndex];\n };\n\n// Set the conflict handler\nsetConflictHandler(myConflictHandler);\n\n// Dispatch an event\nawait dispatchEvent({ name: 'test_event' });\n```" + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "StorageListOutput" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", + "qualifiedName": "ListOutputItem" + }, + "name": "ListOutputItem", + "package": "@aws-amplify/storage" + } + ], + "name": "StorageListOutput", + "package": "@aws-amplify/storage" + }, + { + "type": "literal", + "value": "excludedSubpaths" } - ] + ], + "name": "Omit", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 5350, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5351, + "name": "nextToken", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5351 + ] + } + ] + } } ] + } + }, + "5351": { + "id": 5351, + "name": "nextToken", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, - "parameters": [ - 4743 - ], "type": { "type": "intrinsic", - "name": "void" + "name": "string" } }, - "4743": { - "id": 4743, - "name": "input", - "variant": "param", - "kind": 32768, + "5352": { + "id": 5352, + "name": "ListPaginateWithPathInput", + "variant": "declaration", + "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The input object that holds the conflict handler to be used." + "text": "Input type with path for S3 list API. Lists bucket objects with pagination." } ] }, "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/notifications", - "packagePath": "dist/esm/inAppMessaging/providers/pinpoint/types/types.d.ts", - "qualifiedName": "InAppMessageConflictHandler" + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "StorageListInputWithPath" }, - "name": "InAppMessageConflictHandler", - "package": "@aws-amplify/notifications" + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/options.d.ts", + "qualifiedName": "ListPaginateWithPathOptions" + }, + "name": "ListPaginateWithPathOptions", + "package": "@aws-amplify/storage" + } + ], + "name": "StorageListInputWithPath", + "package": "@aws-amplify/storage" } }, - "4744": { - "id": 4744, - "name": "syncMessages", + "5353": { + "id": 5353, + "name": "ListPaginateWithPathOutput", "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4745 - ] - }, - "4745": { - "id": 4745, - "name": "syncMessages", - "variant": "signature", - "kind": 4096, + "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Fetch and persist messages from Pinpoint campaigns.\nCalling this API is necessary to trigger InApp messages on the device." + "text": "Output type with path for S3 list API. Lists bucket objects with pagination." } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "AWS will end support for Amazon Pinpoint on October 30, 2026." - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "service exceptions - Thrown when the underlying Pinpoint service returns an error." - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "validation: " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "InAppMessagingValidationErrorCode" - }, - { - "kind": "text", - "text": " - Thrown when the provided parameters or library\nconfiguration is incorrect, or if In App messaging hasn't been initialized." - } - ] - }, + ] + }, + "type": { + "type": "intersection", + "types": [ { - "tag": "@returns", - "content": [ + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "StorageListOutput" + }, + "typeArguments": [ { - "kind": "text", - "text": "A promise that will resolve when the operation is complete." + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", + "qualifiedName": "ListOutputItemWithPath" + }, + "name": "ListOutputItemWithPath", + "package": "@aws-amplify/storage" } - ] + ], + "name": "StorageListOutput", + "package": "@aws-amplify/storage" }, { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Sync InApp messages with Pinpoint and device.\nawait syncMessages();\n\n```" - } - ] + "type": "reflection", + "declaration": { + "id": 5354, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5355, + "name": "nextToken", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5355 + ] + } + ] + } } ] - }, - "type": { - "type": "reference", - "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" } }, - "4898": { - "id": 4898, - "name": "storage", + "5355": { + "id": 5355, + "name": "nextToken", "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 4969, - "name": "copy", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4970, - 4972 - ] - }, - { - "id": 4974, - "name": "downloadData", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4975, - 4977 - ] - }, - { - "id": 4979, - "name": "getProperties", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4980, - 4982 - ] - }, - { - "id": 4984, - "name": "getUrl", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4985, - 4987 - ] - }, - { - "id": 4989, - "name": "list", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4990, - 4992, - 4994, - 4996 - ] - }, - { - "id": 4998, - "name": "remove", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4999, - 5001 - ] - }, - { - "id": 5003, - "name": "uploadData", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 5004, - 5006 - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [ - 4899 - ] - }, - { - "title": "Interfaces", - "children": [ - 4919 - ] - }, - { - "title": "Type Aliases", - "children": [ - 4922, - 4923, - 4924, - 4925, - 4926, - 4927, - 4928, - 4929, - 4930, - 4931, - 4932, - 4933, - 4934, - 4935, - 4936, - 4937, - 4938, - 4939, - 4940, - 4941, - 4942, - 4943, - 4946, - 4947, - 4950, - 4951, - 4952, - 4957, - 4958, - 4959, - 4960, - 4961, - 4962, - 4963 - ] - }, - { - "title": "Variables", - "children": [ - 4964, - 4965 - ] - }, - { - "title": "Functions", - "children": [ - 4969, - 4974, - 4979, - 4984, - 4989, - 4998, - 5003 - ] - } - ] + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } }, - "4922": { - "id": 4922, - "name": "CopyInput", + "5356": { + "id": 5356, + "name": "RemoveInput", "variant": "declaration", "kind": 2097152, "flags": {}, @@ -6242,12 +12033,12 @@ { "kind": "inline-tag", "tag": "@link", - "text": "CopyWithPathInput", - "target": 4924 + "text": "RemoveWithPathInput", + "target": 5358 }, { "kind": "text", - "text": " instead.\nInput type for S3 copy API." + "text": " instead.\nInput type with key for S3 remove API." } ] } @@ -6258,7 +12049,7 @@ "target": { "packageName": "@aws-amplify/storage", "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageCopyInputWithKey" + "qualifiedName": "StorageRemoveInputWithKey" }, "typeArguments": [ { @@ -6266,39 +12057,24 @@ "target": { "packageName": "@aws-amplify/storage", "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "CopySourceWithKeyOptions" - }, - "name": "CopySourceWithKeyOptions", - "package": "@aws-amplify/storage" - }, - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "CopyDestinationWithKeyOptions" + "qualifiedName": "RemoveOptions" }, - "name": "CopyDestinationWithKeyOptions", + "name": "RemoveOptions", "package": "@aws-amplify/storage" } ], - "name": "StorageCopyInputWithKey", + "name": "StorageRemoveInputWithKey", "package": "@aws-amplify/storage" } }, - "4923": { - "id": 4923, - "name": "CopyOutput", + "5357": { + "id": 5357, + "name": "RemoveOutput", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { - "summary": [ - { - "kind": "text", - "text": "Output type with path for S3 copy API." - } - ], + "summary": [], "blockTags": [ { "tag": "@deprecated", @@ -6310,12 +12086,12 @@ { "kind": "inline-tag", "tag": "@link", - "text": "CopyWithPathOutput", - "target": 4925 + "text": "RemoveWithPathOutput", + "target": 5363 }, { "kind": "text", - "text": " instead." + "text": " instead.\nOutput type with key for S3 remove API." } ] } @@ -6348,9 +12124,240 @@ "package": "typescript" } }, - "4925": { - "id": 4925, - "name": "CopyWithPathOutput", + "5358": { + "id": 5358, + "name": "RemoveWithPathInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input type with path for S3 remove API." + } + ] + }, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/inputs.d.ts", + "qualifiedName": "StorageRemoveInputWithPath" + }, + "typeArguments": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/options.d.ts", + "qualifiedName": "RemoveOptions" + }, + "name": "RemoveOptions", + "package": "@aws-amplify/storage" + }, + { + "type": "literal", + "value": "accessLevel" + } + ], + "name": "Omit", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 5359, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5360, + "name": "onProgress", + "variant": "declaration", + "kind": 2048, + "flags": { + "isOptional": true + }, + "signatures": [ + { + "id": 5361, + "name": "onProgress", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Callback function invoked after each batch completes, providing progress updates with file counts and error details." + } + ] + }, + "parameters": [ + { + "id": 5362, + "name": "progress", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/inputs.d.ts", + "qualifiedName": "ProgressInfo" + }, + "name": "ProgressInfo", + "package": "@aws-amplify/storage" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 5360 + ] + } + ] + } + } + ] + } + ], + "name": "StorageRemoveInputWithPath", + "package": "@aws-amplify/storage" + } + }, + "5360": { + "id": 5360, + "name": "onProgress", + "variant": "declaration", + "kind": 2048, + "flags": { + "isOptional": true + }, + "signatures": [ + { + "id": 5361, + "name": "onProgress", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Callback function invoked after each batch completes, providing progress updates with file counts and error details." + } + ] + }, + "parameters": [ + { + "id": 5362, + "name": "progress", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/inputs.d.ts", + "qualifiedName": "ProgressInfo" + }, + "name": "ProgressInfo", + "package": "@aws-amplify/storage" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + "5361": { + "id": 5361, + "name": "onProgress", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Callback function invoked after each batch completes, providing progress updates with file counts and error details." + } + ] + }, + "parameters": [ + { + "id": 5362, + "name": "progress", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/inputs.d.ts", + "qualifiedName": "ProgressInfo" + }, + "name": "ProgressInfo", + "package": "@aws-amplify/storage" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + }, + "5362": { + "id": 5362, + "name": "progress", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/inputs.d.ts", + "qualifiedName": "ProgressInfo" + }, + "name": "ProgressInfo", + "package": "@aws-amplify/storage" + } + }, + "5363": { + "id": 5363, + "name": "RemoveWithPathOutput", "variant": "declaration", "kind": 2097152, "flags": {}, @@ -6358,7 +12365,7 @@ "summary": [ { "kind": "text", - "text": "Output type with path for S3 copy API." + "text": "Output type with path for S3 remove API." } ] }, @@ -6389,9 +12396,9 @@ "package": "typescript" } }, - "4926": { - "id": 4926, - "name": "DownloadDataInput", + "5364": { + "id": 5364, + "name": "UploadDataInput", "variant": "declaration", "kind": 2097152, "flags": {}, @@ -6408,12 +12415,12 @@ { "kind": "inline-tag", "tag": "@link", - "text": "DownloadDataWithPathInput", - "target": 4928 + "text": "UploadDataWithPathInput", + "target": 5368 }, { "kind": "text", - "text": " instead.\nInput type for S3 downloadData API." + "text": " instead.\nInput type for S3 uploadData API." } ] } @@ -6424,7 +12431,7 @@ "target": { "packageName": "@aws-amplify/storage", "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageDownloadDataInputWithKey" + "qualifiedName": "StorageUploadDataInputWithKey" }, "typeArguments": [ { @@ -6432,19 +12439,19 @@ "target": { "packageName": "@aws-amplify/storage", "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "DownloadDataWithKeyOptions" + "qualifiedName": "UploadDataWithKeyOptions" }, - "name": "DownloadDataWithKeyOptions", + "name": "UploadDataWithKeyOptions", "package": "@aws-amplify/storage" } ], - "name": "StorageDownloadDataInputWithKey", + "name": "StorageUploadDataInputWithKey", "package": "@aws-amplify/storage" } }, - "4927": { - "id": 4927, - "name": "DownloadDataOutput", + "5365": { + "id": 5365, + "name": "UploadDataOutput", "variant": "declaration", "kind": 2097152, "flags": {}, @@ -6452,7 +12459,7 @@ "summary": [ { "kind": "text", - "text": "Output type for S3 downloadData API." + "text": "Output type for S3 uploadData API." } ], "blockTags": [ @@ -6466,8 +12473,8 @@ { "kind": "inline-tag", "tag": "@link", - "text": "DownloadDataWithPathOutput", - "target": 4929 + "text": "UploadDataWithPathOutput", + "target": 5369 }, { "kind": "text", @@ -6482,39 +12489,27 @@ "target": { "packageName": "@aws-amplify/storage", "packagePath": "dist/esm/types/common.d.ts", - "qualifiedName": "DownloadTask" + "qualifiedName": "UploadTask" }, "typeArguments": [ { "type": "reference", "target": { "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/outputs.d.ts", - "qualifiedName": "StorageDownloadDataOutput" + "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", + "qualifiedName": "ItemWithKey" }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", - "qualifiedName": "ItemWithKey" - }, - "name": "ItemWithKey", - "package": "@aws-amplify/storage" - } - ], - "name": "StorageDownloadDataOutput", + "name": "ItemWithKey", "package": "@aws-amplify/storage" } ], - "name": "DownloadTask", + "name": "UploadTask", "package": "@aws-amplify/storage" } }, - "4928": { - "id": 4928, - "name": "DownloadDataWithPathInput", + "5368": { + "id": 5368, + "name": "UploadDataWithPathInput", "variant": "declaration", "kind": 2097152, "flags": {}, @@ -6522,7 +12517,7 @@ "summary": [ { "kind": "text", - "text": "Input type with path for S3 downloadData API." + "text": "Input type with path for S3 uploadData API." } ] }, @@ -6531,7 +12526,7 @@ "target": { "packageName": "@aws-amplify/storage", "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageDownloadDataInputWithPath" + "qualifiedName": "StorageUploadDataInputWithPath" }, "typeArguments": [ { @@ -6539,19 +12534,19 @@ "target": { "packageName": "@aws-amplify/storage", "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "DownloadDataWithPathOptions" + "qualifiedName": "UploadDataWithPathOptions" }, - "name": "DownloadDataWithPathOptions", + "name": "UploadDataWithPathOptions", "package": "@aws-amplify/storage" } ], - "name": "StorageDownloadDataInputWithPath", + "name": "StorageUploadDataInputWithPath", "package": "@aws-amplify/storage" } }, - "4929": { - "id": 4929, - "name": "DownloadDataWithPathOutput", + "5369": { + "id": 5369, + "name": "UploadDataWithPathOutput", "variant": "declaration", "kind": 2097152, "flags": {}, @@ -6559,7 +12554,7 @@ "summary": [ { "kind": "text", - "text": "Output type with path for S3 downloadData API." + "text": "Output type with path for S3 uploadData API." } ] }, @@ -6568,161 +12563,106 @@ "target": { "packageName": "@aws-amplify/storage", "packagePath": "dist/esm/types/common.d.ts", - "qualifiedName": "DownloadTask" + "qualifiedName": "UploadTask" }, "typeArguments": [ { "type": "reference", "target": { "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/outputs.d.ts", - "qualifiedName": "StorageDownloadDataOutput" + "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", + "qualifiedName": "ItemWithPath" }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", - "qualifiedName": "ItemWithPath" - }, - "name": "ItemWithPath", - "package": "@aws-amplify/storage" - } - ], - "name": "StorageDownloadDataOutput", + "name": "ItemWithPath", "package": "@aws-amplify/storage" } ], - "name": "DownloadTask", + "name": "UploadTask", "package": "@aws-amplify/storage" } }, - "4930": { - "id": 4930, - "name": "GetPropertiesInput", + "5375": { + "id": 5375, + "name": "copy", "variant": "declaration", - "kind": 2097152, + "kind": 64, "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GetPropertiesWithPathInput", - "target": 4932 - }, - { - "kind": "text", - "text": " instead.\nInput type for S3 getProperties API." - } - ] - } - ] - }, + "signatures": [ + 5376, + 5379, + 5382, + 5384 + ] + }, + "5376": { + "id": 5376, + "name": "copy", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 5377, + 5378 + ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageGetPropertiesInputWithKey" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "GetPropertiesWithKeyOptions" - }, - "name": "GetPropertiesWithKeyOptions", + "target": 5331, + "name": "CopyWithPathOutput", "package": "@aws-amplify/storage" } ], - "name": "StorageGetPropertiesInputWithKey", - "package": "@aws-amplify/storage" + "name": "Promise", + "package": "typescript" } }, - "4931": { - "id": 4931, - "name": "GetPropertiesOutput", - "variant": "declaration", - "kind": 2097152, + "5377": { + "id": 5377, + "name": "ctx", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Output type for S3 getProperties API." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GetPropertiesWithPathOutput", - "target": 4933 - }, - { - "kind": "text", - "text": " instead." - } - ] + "text": "The AmplifyContext to operate on." } ] }, "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", - "qualifiedName": "ItemBase" - }, - "name": "ItemBase", - "package": "@aws-amplify/storage" - }, - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/outputs.d.ts", - "qualifiedName": "StorageItemWithKey" - }, - "name": "StorageItemWithKey", - "package": "@aws-amplify/storage" - } - ] + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" } }, - "4932": { - "id": 4932, - "name": "GetPropertiesWithPathInput", - "variant": "declaration", - "kind": 2097152, + "5378": { + "id": 5378, + "name": "input", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Input type with for S3 getProperties API." + "text": "The " + }, + { + "kind": "code", + "text": "`CopyWithPathInput`" + }, + { + "kind": "text", + "text": " object." } ] }, @@ -6731,128 +12671,191 @@ "target": { "packageName": "@aws-amplify/storage", "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageGetPropertiesInputWithPath" + "qualifiedName": "StorageCopyInputWithPath" + }, + "name": "StorageCopyInputWithPath", + "package": "@aws-amplify/storage" + } + }, + "5379": { + "id": 5379, + "name": "copy", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 5380, + 5381 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "GetPropertiesWithPathOptions" - }, - "name": "GetPropertiesWithPathOptions", + "target": 5329, + "name": "CopyOutput", "package": "@aws-amplify/storage" } ], - "name": "StorageGetPropertiesInputWithPath", - "package": "@aws-amplify/storage" + "name": "Promise", + "package": "typescript" } }, - "4933": { - "id": 4933, - "name": "GetPropertiesWithPathOutput", - "variant": "declaration", - "kind": 2097152, + "5380": { + "id": 5380, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The AmplifyContext to operate on." + } + ] + }, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "5381": { + "id": 5381, + "name": "input", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Output type with path for S3 getProperties API." - } - ] - }, - "type": { - "type": "intersection", - "types": [ + "text": "The " + }, { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", - "qualifiedName": "ItemBase" - }, - "name": "ItemBase", - "package": "@aws-amplify/storage" + "kind": "code", + "text": "`CopyInput`" }, { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/outputs.d.ts", - "qualifiedName": "StorageItemWithPath" - }, - "name": "StorageItemWithPath", - "package": "@aws-amplify/storage" + "kind": "text", + "text": " object." } ] + }, + "type": { + "type": "reference", + "target": 5328, + "name": "CopyInput", + "package": "@aws-amplify/storage" } }, - "4934": { - "id": 4934, - "name": "GetUrlInput", - "variant": "declaration", - "kind": 2097152, + "5382": { + "id": 5382, + "name": "copy", + "variant": "signature", + "kind": 4096, "flags": {}, "comment": { - "summary": [], + "summary": [ + { + "kind": "text", + "text": "Copy an object from a source to a destination object within the same bucket." + } + ], "blockTags": [ { - "tag": "@deprecated", + "tag": "@returns", "content": [ { "kind": "text", - "text": "Use " + "text": "Output containing the destination object path." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "service: " }, { - "kind": "inline-tag", - "tag": "@link", - "text": "GetUrlWithPathInput", - "target": 4936 + "kind": "code", + "text": "`S3Exception`" }, { "kind": "text", - "text": " instead.\nInput type for S3 getUrl API." + "text": " - Thrown when checking for existence of the object" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "validation: " + }, + { + "kind": "code", + "text": "`StorageValidationErrorCode`" + }, + { + "kind": "text", + "text": " - Thrown when\nsource or destination path is not defined." } ] } ] }, + "parameters": [ + 5383 + ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageGetUrlInputWithKey" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "GetUrlWithKeyOptions" - }, - "name": "GetUrlWithKeyOptions", + "target": 5331, + "name": "CopyWithPathOutput", "package": "@aws-amplify/storage" } ], - "name": "StorageGetUrlInputWithKey", - "package": "@aws-amplify/storage" + "name": "Promise", + "package": "typescript" } }, - "4936": { - "id": 4936, - "name": "GetUrlWithPathInput", - "variant": "declaration", - "kind": 2097152, + "5383": { + "id": 5383, + "name": "input", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Input type with path for S3 getUrl API." + "text": "The " + }, + { + "kind": "code", + "text": "`CopyWithPathInput`" + }, + { + "kind": "text", + "text": " object." } ] }, @@ -6861,29 +12864,17 @@ "target": { "packageName": "@aws-amplify/storage", "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageGetUrlInputWithPath" + "qualifiedName": "StorageCopyInputWithPath" }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "GetUrlWithPathOptions" - }, - "name": "GetUrlWithPathOptions", - "package": "@aws-amplify/storage" - } - ], - "name": "StorageGetUrlInputWithPath", + "name": "StorageCopyInputWithPath", "package": "@aws-amplify/storage" } }, - "4938": { - "id": 4938, - "name": "ListAllInput", - "variant": "declaration", - "kind": 2097152, + "5384": { + "id": 5384, + "name": "copy", + "variant": "signature", + "kind": 4096, "flags": {}, "comment": { "summary": [], @@ -6893,491 +12884,408 @@ "content": [ { "kind": "text", - "text": "Use " + "text": "The " + }, + { + "kind": "code", + "text": "`key`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`accessLevel`" + }, + { + "kind": "text", + "text": " parameters are deprecated and may be removed in the next major version.\nPlease use " }, { "kind": "inline-tag", "tag": "@link", - "text": "ListAllWithPathInput", - "target": 4940 + "text": "path", + "target": "https://docs.amplify.aws/react/build-a-backend/storage/copy" }, { "kind": "text", - "text": " instead.\nInput type for S3 list API. Lists all bucket objects." + "text": " instead.\n\nCopy an object from a source to a destination object within the same bucket. Can optionally copy files across\ndifferent accessLevel or identityId (if source object's accessLevel is 'protected')." } ] - } - ] - }, - "type": { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageListInputWithPrefix" - }, - "typeArguments": [ + }, { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "ListAllWithPrefixOptions" - }, - "name": "ListAllWithPrefixOptions", - "package": "@aws-amplify/storage" - } - ], - "name": "StorageListInputWithPrefix", - "package": "@aws-amplify/storage" - } - }, - "4939": { - "id": 4939, - "name": "ListAllOutput", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Output containing the destination object key." + } + ] + }, { - "tag": "@deprecated", + "tag": "@throws", "content": [ { "kind": "text", - "text": "Use " + "text": "service: " }, { - "kind": "inline-tag", - "tag": "@link", - "text": "ListAllWithPathOutput", - "target": 4941 + "kind": "code", + "text": "`S3Exception`" }, { "kind": "text", - "text": " instead.\nOutput type for S3 list API. Lists all bucket objects." + "text": " - Thrown when checking for existence of the object" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "validation: " + }, + { + "kind": "code", + "text": "`StorageValidationErrorCode`" + }, + { + "kind": "text", + "text": " - Thrown when\nsource or destination key is not defined." } ] } ] }, + "parameters": [ + 5385 + ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Omit" + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/outputs.d.ts", - "qualifiedName": "StorageListOutput" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", - "qualifiedName": "ListOutputItem" - }, - "name": "ListOutputItem", - "package": "@aws-amplify/storage" - } - ], - "name": "StorageListOutput", + "target": 5329, + "name": "CopyOutput", "package": "@aws-amplify/storage" - }, - { - "type": "literal", - "value": "excludedSubpaths" } ], - "name": "Omit", + "name": "Promise", "package": "typescript" } }, - "4940": { - "id": 4940, - "name": "ListAllWithPathInput", - "variant": "declaration", - "kind": 2097152, + "5385": { + "id": 5385, + "name": "input", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Input type with path for S3 list API. Lists all bucket objects." + "text": "The " + }, + { + "kind": "code", + "text": "`CopyInput`" + }, + { + "kind": "text", + "text": " object." } ] }, "type": { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageListInputWithPath" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "ListAllWithPathOptions" - }, - "name": "ListAllWithPathOptions", - "package": "@aws-amplify/storage" - } - ], - "name": "StorageListInputWithPath", + "target": 5328, + "name": "CopyInput", "package": "@aws-amplify/storage" } }, - "4941": { - "id": 4941, - "name": "ListAllWithPathOutput", + "5386": { + "id": 5386, + "name": "downloadData", "variant": "declaration", - "kind": 2097152, + "kind": 64, + "flags": {}, + "signatures": [ + 5387, + 5390, + 5393, + 5395 + ] + }, + "5387": { + "id": 5387, + "name": "downloadData", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 5388, + 5389 + ], + "type": { + "type": "reference", + "target": 5335, + "name": "DownloadDataWithPathOutput", + "package": "@aws-amplify/storage" + } + }, + "5388": { + "id": 5388, + "name": "ctx", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Output type with path for S3 list API. Lists all bucket objects." + "text": "The AmplifyContext to operate on." } ] }, "type": { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/outputs.d.ts", - "qualifiedName": "StorageListOutput" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", - "qualifiedName": "ListOutputItemWithPath" - }, - "name": "ListOutputItemWithPath", - "package": "@aws-amplify/storage" - } - ], - "name": "StorageListOutput", - "package": "@aws-amplify/storage" + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" } }, - "4942": { - "id": 4942, - "name": "ListPaginateInput", - "variant": "declaration", - "kind": 2097152, + "5389": { + "id": 5389, + "name": "input", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { - "summary": [], - "blockTags": [ + "summary": [ { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "ListPaginateWithPathInput", - "target": 4946 - }, - { - "kind": "text", - "text": " instead.\nInput type for S3 list API. Lists bucket objects with pagination." - } - ] + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`DownloadDataWithPathInput`" + }, + { + "kind": "text", + "text": " object." } ] }, "type": { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageListInputWithPrefix" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "ListPaginateWithPrefixOptions" - }, - "name": "ListPaginateWithPrefixOptions", - "package": "@aws-amplify/storage" - } - ], - "name": "StorageListInputWithPrefix", + "target": 5334, + "name": "DownloadDataWithPathInput", "package": "@aws-amplify/storage" } }, - "4943": { - "id": 4943, - "name": "ListPaginateOutput", - "variant": "declaration", - "kind": 2097152, + "5390": { + "id": 5390, + "name": "downloadData", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 5391, + 5392 + ], + "type": { + "type": "reference", + "target": 5333, + "name": "DownloadDataOutput", + "package": "@aws-amplify/storage" + } + }, + "5391": { + "id": 5391, + "name": "ctx", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { - "summary": [], - "blockTags": [ + "summary": [ { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "ListPaginateWithPathOutput", - "target": 4947 - }, - { - "kind": "text", - "text": " instead.\nOutput type for S3 list API. Lists bucket objects with pagination." - } - ] + "kind": "text", + "text": "The AmplifyContext to operate on." } ] }, "type": { - "type": "intersection", - "types": [ + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "5392": { + "id": 5392, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/outputs.d.ts", - "qualifiedName": "StorageListOutput" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", - "qualifiedName": "ListOutputItem" - }, - "name": "ListOutputItem", - "package": "@aws-amplify/storage" - } - ], - "name": "StorageListOutput", - "package": "@aws-amplify/storage" - }, - { - "type": "literal", - "value": "excludedSubpaths" - } - ], - "name": "Omit", - "package": "typescript" + "kind": "text", + "text": "The " }, { - "type": "reflection", - "declaration": { - "id": 4944, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4945, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4945 - ] - } - ] - } + "kind": "code", + "text": "`DownloadDataInput`" + }, + { + "kind": "text", + "text": " object." } ] - } - }, - "4945": { - "id": 4945, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true }, "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": 5332, + "name": "DownloadDataInput", + "package": "@aws-amplify/storage" } }, - "4946": { - "id": 4946, - "name": "ListPaginateWithPathInput", - "variant": "declaration", - "kind": 2097152, + "5393": { + "id": 5393, + "name": "downloadData", + "variant": "signature", + "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Input type with path for S3 list API. Lists bucket objects with pagination." + "text": "Download S3 object data to memory" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A cancelable task exposing result promise from " + }, + { + "kind": "code", + "text": "`result`" + }, + { + "kind": "text", + "text": " property." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "service: " + }, + { + "kind": "code", + "text": "`S3Exception`" + }, + { + "kind": "text", + "text": " - thrown when checking for existence of the object" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "validation: " + }, + { + "kind": "code", + "text": "`StorageValidationErrorCode`" + }, + { + "kind": "text", + "text": " - Validation errors" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// Download a file from s3 bucket\nconst { body, eTag } = await downloadData({ path, options: {\n onProgress, // Optional progress callback.\n} }).result;\n```" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// Cancel a task\nconst downloadTask = downloadData({ path });\n//...\ndownloadTask.cancel();\ntry {\n\tawait downloadTask.result;\n} catch (error) {\n\tif(isCancelError(error)) {\n // Handle error thrown by task cancelation.\n\t}\n}\n```" + } + ] } ] }, + "parameters": [ + 5394 + ], "type": { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageListInputWithPath" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "ListPaginateWithPathOptions" - }, - "name": "ListPaginateWithPathOptions", - "package": "@aws-amplify/storage" - } - ], - "name": "StorageListInputWithPath", + "target": 5335, + "name": "DownloadDataWithPathOutput", "package": "@aws-amplify/storage" } }, - "4947": { - "id": 4947, - "name": "ListPaginateWithPathOutput", - "variant": "declaration", - "kind": 2097152, + "5394": { + "id": 5394, + "name": "input", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Output type with path for S3 list API. Lists bucket objects with pagination." - } - ] - }, - "type": { - "type": "intersection", - "types": [ + "text": "The " + }, { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/outputs.d.ts", - "qualifiedName": "StorageListOutput" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", - "qualifiedName": "ListOutputItemWithPath" - }, - "name": "ListOutputItemWithPath", - "package": "@aws-amplify/storage" - } - ], - "name": "StorageListOutput", - "package": "@aws-amplify/storage" + "kind": "code", + "text": "`DownloadDataWithPathInput`" }, { - "type": "reflection", - "declaration": { - "id": 4948, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4949, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4949 - ] - } - ] - } + "kind": "text", + "text": " object." } ] - } - }, - "4949": { - "id": 4949, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true }, "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": 5334, + "name": "DownloadDataWithPathInput", + "package": "@aws-amplify/storage" } }, - "4950": { - "id": 4950, - "name": "RemoveInput", - "variant": "declaration", - "kind": 2097152, + "5395": { + "id": 5395, + "name": "downloadData", + "variant": "signature", + "kind": 4096, "flags": {}, "comment": { "summary": [], @@ -7387,573 +13295,320 @@ "content": [ { "kind": "text", - "text": "Use " + "text": "The " + }, + { + "kind": "code", + "text": "`key`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`accessLevel`" + }, + { + "kind": "text", + "text": " parameters are deprecated and may be removed in the next major version.\nPlease use " }, { "kind": "inline-tag", "tag": "@link", - "text": "RemoveWithPathInput", - "target": 4952 + "text": "path", + "target": "https://docs.amplify.aws/react/build-a-backend/storage/download/#downloaddata" }, { "kind": "text", - "text": " instead.\nInput type with key for S3 remove API." + "text": " instead.\n\nDownload S3 object data to memory" } ] - } - ] - }, - "type": { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageRemoveInputWithKey" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "RemoveOptions" - }, - "name": "RemoveOptions", - "package": "@aws-amplify/storage" - } - ], - "name": "StorageRemoveInputWithKey", - "package": "@aws-amplify/storage" - } - }, - "4951": { - "id": 4951, - "name": "RemoveOutput", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ + }, { - "tag": "@deprecated", + "tag": "@returns", "content": [ { "kind": "text", - "text": "Use " + "text": "A cancelable task exposing result promise from " }, { - "kind": "inline-tag", - "tag": "@link", - "text": "RemoveWithPathOutput", - "target": 4957 + "kind": "code", + "text": "`result`" }, { "kind": "text", - "text": " instead.\nOutput type with key for S3 remove API." + "text": " property." } ] - } - ] - }, - "type": { - "type": "reference", - "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", - "qualifiedName": "ItemWithKey" - }, - "name": "ItemWithKey", - "package": "@aws-amplify/storage" }, { - "type": "literal", - "value": "key" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - "4952": { - "id": 4952, - "name": "RemoveWithPathInput", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input type with path for S3 remove API." - } - ] - }, - "type": { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageRemoveInputWithPath" - }, - "typeArguments": [ - { - "type": "intersection", - "types": [ + "tag": "@throws", + "content": [ { - "type": "reference", - "target": { - "packageName": "typescript", - "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "RemoveOptions" - }, - "name": "RemoveOptions", - "package": "@aws-amplify/storage" - }, - { - "type": "literal", - "value": "accessLevel" - } - ], - "name": "Omit", - "package": "typescript" + "kind": "text", + "text": "service: " }, { - "type": "reflection", - "declaration": { - "id": 4953, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4954, - "name": "onProgress", - "variant": "declaration", - "kind": 2048, - "flags": { - "isOptional": true - }, - "signatures": [ - { - "id": 4955, - "name": "onProgress", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Callback function invoked after each batch completes, providing progress updates with file counts and error details." - } - ] - }, - "parameters": [ - { - "id": 4956, - "name": "progress", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/inputs.d.ts", - "qualifiedName": "ProgressInfo" - }, - "name": "ProgressInfo", - "package": "@aws-amplify/storage" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [ - 4954 - ] - } - ] - } + "kind": "code", + "text": "`S3Exception`" + }, + { + "kind": "text", + "text": " - thrown when checking for existence of the object" } ] - } - ], - "name": "StorageRemoveInputWithPath", - "package": "@aws-amplify/storage" - } - }, - "4954": { - "id": 4954, - "name": "onProgress", - "variant": "declaration", - "kind": 2048, - "flags": { - "isOptional": true - }, - "signatures": [ - { - "id": 4955, - "name": "onProgress", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ + }, + { + "tag": "@throws", + "content": [ { "kind": "text", - "text": "Callback function invoked after each batch completes, providing progress updates with file counts and error details." + "text": "validation: " + }, + { + "kind": "code", + "text": "`StorageValidationErrorCode`" + }, + { + "kind": "text", + "text": " - Validation errors" } ] }, - "parameters": [ - { - "id": 4956, - "name": "progress", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/inputs.d.ts", - "qualifiedName": "ProgressInfo" - }, - "name": "ProgressInfo", - "package": "@aws-amplify/storage" + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// Download a file from s3 bucket\nconst { body, eTag } = await downloadData({ key, options: {\n onProgress, // Optional progress callback.\n} }).result;\n```" } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - "4955": { - "id": 4955, - "name": "onProgress", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ + ] + }, { - "kind": "text", - "text": "Callback function invoked after each batch completes, providing progress updates with file counts and error details." + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// Cancel a task\nconst downloadTask = downloadData({ key });\n//...\ndownloadTask.cancel();\ntry {\n\tawait downloadTask.result;\n} catch (error) {\n\tif(isCancelError(error)) {\n // Handle error thrown by task cancelation.\n\t}\n}\n```" + } + ] } ] }, "parameters": [ - { - "id": 4956, - "name": "progress", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/inputs.d.ts", - "qualifiedName": "ProgressInfo" - }, - "name": "ProgressInfo", - "package": "@aws-amplify/storage" - } - } + 5396 ], - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "4956": { - "id": 4956, - "name": "progress", - "variant": "param", - "kind": 32768, - "flags": {}, "type": { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/inputs.d.ts", - "qualifiedName": "ProgressInfo" - }, - "name": "ProgressInfo", + "target": 5333, + "name": "DownloadDataOutput", "package": "@aws-amplify/storage" } }, - "4957": { - "id": 4957, - "name": "RemoveWithPathOutput", - "variant": "declaration", - "kind": 2097152, + "5396": { + "id": 5396, + "name": "input", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Output type with path for S3 remove API." + "text": "The " + }, + { + "kind": "code", + "text": "`DownloadDataInput`" + }, + { + "kind": "text", + "text": " object." } ] }, + "type": { + "type": "reference", + "target": 5332, + "name": "DownloadDataInput", + "package": "@aws-amplify/storage" + } + }, + "5397": { + "id": 5397, + "name": "getProperties", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5398, + 5401, + 5404, + 5406 + ] + }, + "5398": { + "id": 5398, + "name": "getProperties", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 5399, + 5400 + ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", - "qualifiedName": "Pick" + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", - "qualifiedName": "ItemWithPath" - }, - "name": "ItemWithPath", + "target": 5339, + "name": "GetPropertiesWithPathOutput", "package": "@aws-amplify/storage" - }, - { - "type": "literal", - "value": "path" } ], - "name": "Pick", + "name": "Promise", "package": "typescript" } }, - "4958": { - "id": 4958, - "name": "UploadDataInput", - "variant": "declaration", - "kind": 2097152, + "5399": { + "id": 5399, + "name": "ctx", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { - "summary": [], - "blockTags": [ + "summary": [ { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "UploadDataWithPathInput", - "target": 4962 - }, - { - "kind": "text", - "text": " instead.\nInput type for S3 uploadData API." - } - ] + "kind": "text", + "text": "The AmplifyContext to operate on." } ] }, "type": { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageUploadDataInputWithKey" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "UploadDataWithKeyOptions" - }, - "name": "UploadDataWithKeyOptions", - "package": "@aws-amplify/storage" - } - ], - "name": "StorageUploadDataInputWithKey", - "package": "@aws-amplify/storage" + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" } }, - "4959": { - "id": 4959, - "name": "UploadDataOutput", - "variant": "declaration", - "kind": 2097152, + "5400": { + "id": 5400, + "name": "input", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Output type for S3 uploadData API." - } - ], - "blockTags": [ + "text": "The " + }, { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "UploadDataWithPathOutput", - "target": 4963 - }, - { - "kind": "text", - "text": " instead." - } - ] + "kind": "code", + "text": "`GetPropertiesWithPathInput`" + }, + { + "kind": "text", + "text": " object." } ] }, + "type": { + "type": "reference", + "target": 5338, + "name": "GetPropertiesWithPathInput", + "package": "@aws-amplify/storage" + } + }, + "5401": { + "id": 5401, + "name": "getProperties", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 5402, + 5403 + ], "type": { "type": "reference", "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/common.d.ts", - "qualifiedName": "UploadTask" + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", - "qualifiedName": "ItemWithKey" - }, - "name": "ItemWithKey", + "target": 5337, + "name": "GetPropertiesOutput", "package": "@aws-amplify/storage" } ], - "name": "UploadTask", - "package": "@aws-amplify/storage" + "name": "Promise", + "package": "typescript" } }, - "4962": { - "id": 4962, - "name": "UploadDataWithPathInput", - "variant": "declaration", - "kind": 2097152, + "5402": { + "id": 5402, + "name": "ctx", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Input type with path for S3 uploadData API." + "text": "The AmplifyContext to operate on." } ] }, "type": { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageUploadDataInputWithPath" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/options.d.ts", - "qualifiedName": "UploadDataWithPathOptions" - }, - "name": "UploadDataWithPathOptions", - "package": "@aws-amplify/storage" - } - ], - "name": "StorageUploadDataInputWithPath", - "package": "@aws-amplify/storage" + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" } }, - "4963": { - "id": 4963, - "name": "UploadDataWithPathOutput", - "variant": "declaration", - "kind": 2097152, + "5403": { + "id": 5403, + "name": "input", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Output type with path for S3 uploadData API." + "text": "The " + }, + { + "kind": "code", + "text": "`GetPropertiesInput`" + }, + { + "kind": "text", + "text": " object." } ] }, "type": { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/common.d.ts", - "qualifiedName": "UploadTask" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/outputs.d.ts", - "qualifiedName": "ItemWithPath" - }, - "name": "ItemWithPath", - "package": "@aws-amplify/storage" - } - ], - "name": "UploadTask", + "target": 5336, + "name": "GetPropertiesInput", "package": "@aws-amplify/storage" } }, - "4969": { - "id": 4969, - "name": "copy", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4970, - 4972 - ] - }, - "4970": { - "id": 4970, - "name": "copy", + "5404": { + "id": 5404, + "name": "getProperties", "variant": "signature", "kind": 4096, "flags": {}, @@ -7961,7 +13616,7 @@ "summary": [ { "kind": "text", - "text": "Copy an object from a source to a destination object within the same bucket." + "text": "Gets the properties of a file. The properties include S3 system metadata and\nthe user metadata that was provided when uploading the file." } ], "blockTags": [ @@ -7970,7 +13625,7 @@ "content": [ { "kind": "text", - "text": "Output containing the destination object path." + "text": "Requested object properties." } ] }, @@ -7979,7 +13634,7 @@ "content": [ { "kind": "text", - "text": "service: " + "text": "An " }, { "kind": "code", @@ -7987,7 +13642,7 @@ }, { "kind": "text", - "text": " - Thrown when checking for existence of the object" + "text": " when the underlying S3 service returned error." } ] }, @@ -7996,7 +13651,7 @@ "content": [ { "kind": "text", - "text": "validation: " + "text": "A " }, { "kind": "code", @@ -8004,14 +13659,14 @@ }, { "kind": "text", - "text": " - Thrown when\nsource or destination path is not defined." + "text": " when API call parameters are invalid." } ] } ] }, "parameters": [ - 4971 + 5405 ], "type": { "type": "reference", @@ -8023,8 +13678,8 @@ "typeArguments": [ { "type": "reference", - "target": 4925, - "name": "CopyWithPathOutput", + "target": 5339, + "name": "GetPropertiesWithPathOutput", "package": "@aws-amplify/storage" } ], @@ -8032,8 +13687,8 @@ "package": "typescript" } }, - "4971": { - "id": 4971, + "5405": { + "id": 5405, "name": "input", "variant": "param", "kind": 32768, @@ -8046,7 +13701,7 @@ }, { "kind": "code", - "text": "`CopyWithPathInput`" + "text": "`GetPropertiesWithPathInput`" }, { "kind": "text", @@ -8056,18 +13711,14 @@ }, "type": { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/inputs.d.ts", - "qualifiedName": "StorageCopyInputWithPath" - }, - "name": "StorageCopyInputWithPath", + "target": 5338, + "name": "GetPropertiesWithPathInput", "package": "@aws-amplify/storage" } }, - "4972": { - "id": 4972, - "name": "copy", + "5406": { + "id": 5406, + "name": "getProperties", "variant": "signature", "kind": 4096, "flags": {}, @@ -8101,11 +13752,11 @@ "kind": "inline-tag", "tag": "@link", "text": "path", - "target": "https://docs.amplify.aws/react/build-a-backend/storage/copy" + "target": "https://docs.amplify.aws/javascript/build-a-backend/storage/get-properties/" }, { "kind": "text", - "text": " instead.\n\nCopy an object from a source to a destination object within the same bucket. Can optionally copy files across\ndifferent accessLevel or identityId (if source object's accessLevel is 'protected')." + "text": " instead.\n\nGets the properties of a file. The properties include S3 system metadata and\nthe user metadata that was provided when uploading the file." } ] }, @@ -8114,7 +13765,7 @@ "content": [ { "kind": "text", - "text": "Output containing the destination object key." + "text": "Requested object properties." } ] }, @@ -8123,7 +13774,7 @@ "content": [ { "kind": "text", - "text": "service: " + "text": "An " }, { "kind": "code", @@ -8131,7 +13782,7 @@ }, { "kind": "text", - "text": " - Thrown when checking for existence of the object" + "text": " when the underlying S3 service returned error." } ] }, @@ -8140,7 +13791,7 @@ "content": [ { "kind": "text", - "text": "validation: " + "text": "A " }, { "kind": "code", @@ -8148,14 +13799,14 @@ }, { "kind": "text", - "text": " - Thrown when\nsource or destination key is not defined." + "text": " when API call parameters are invalid." } ] } ] }, "parameters": [ - 4973 + 5407 ], "type": { "type": "reference", @@ -8167,8 +13818,8 @@ "typeArguments": [ { "type": "reference", - "target": 4923, - "name": "CopyOutput", + "target": 5337, + "name": "GetPropertiesOutput", "package": "@aws-amplify/storage" } ], @@ -8176,8 +13827,8 @@ "package": "typescript" } }, - "4973": { - "id": 4973, + "5407": { + "id": 5407, "name": "input", "variant": "param", "kind": 32768, @@ -8190,7 +13841,7 @@ }, { "kind": "code", - "text": "`CopyInput`" + "text": "`GetPropertiesInput`" }, { "kind": "text", @@ -8200,119 +13851,80 @@ }, "type": { "type": "reference", - "target": 4922, - "name": "CopyInput", + "target": 5336, + "name": "GetPropertiesInput", "package": "@aws-amplify/storage" } }, - "4974": { - "id": 4974, - "name": "downloadData", + "5408": { + "id": 5408, + "name": "getUrl", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4975, - 4977 + 5409, + 5412, + 5415, + 5417 ] }, - "4975": { - "id": 4975, - "name": "downloadData", + "5409": { + "id": 5409, + "name": "getUrl", "variant": "signature", "kind": 4096, "flags": {}, - "comment": { - "summary": [ + "parameters": [ + 5410, + 5411 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ { - "kind": "text", - "text": "Download S3 object data to memory" + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "StorageGetUrlOutput" + }, + "name": "StorageGetUrlOutput", + "package": "@aws-amplify/storage" } ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A cancelable task exposing result promise from " - }, - { - "kind": "code", - "text": "`result`" - }, - { - "kind": "text", - "text": " property." - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "service: " - }, - { - "kind": "code", - "text": "`S3Exception`" - }, - { - "kind": "text", - "text": " - thrown when checking for existence of the object" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "validation: " - }, - { - "kind": "code", - "text": "`StorageValidationErrorCode`" - }, - { - "kind": "text", - "text": " - Validation errors" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Download a file from s3 bucket\nconst { body, eTag } = await downloadData({ path, options: {\n onProgress, // Optional progress callback.\n} }).result;\n```" - } - ] - }, + "name": "Promise", + "package": "typescript" + } + }, + "5410": { + "id": 5410, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Cancel a task\nconst downloadTask = downloadData({ path });\n//...\ndownloadTask.cancel();\ntry {\n\tawait downloadTask.result;\n} catch (error) {\n\tif(isCancelError(error)) {\n // Handle error thrown by task cancelation.\n\t}\n}\n```" - } - ] + "kind": "text", + "text": "The AmplifyContext to operate on." } ] }, - "parameters": [ - 4976 - ], "type": { "type": "reference", - "target": 4929, - "name": "DownloadDataWithPathOutput", - "package": "@aws-amplify/storage" + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" } }, - "4976": { - "id": 4976, + "5411": { + "id": 5411, "name": "input", "variant": "param", "kind": 32768, @@ -8325,7 +13937,7 @@ }, { "kind": "code", - "text": "`DownloadDataWithPathInput`" + "text": "`GetUrlWithPathInput`" }, { "kind": "text", @@ -8335,138 +13947,67 @@ }, "type": { "type": "reference", - "target": 4928, - "name": "DownloadDataWithPathInput", + "target": 5342, + "name": "GetUrlWithPathInput", "package": "@aws-amplify/storage" } }, - "4977": { - "id": 4977, - "name": "downloadData", + "5412": { + "id": 5412, + "name": "getUrl", "variant": "signature", "kind": 4096, "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`key`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`accessLevel`" - }, - { - "kind": "text", - "text": " parameters are deprecated and may be removed in the next major version.\nPlease use " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "path", - "target": "https://docs.amplify.aws/react/build-a-backend/storage/download/#downloaddata" - }, - { - "kind": "text", - "text": " instead.\n\nDownload S3 object data to memory" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A cancelable task exposing result promise from " - }, - { - "kind": "code", - "text": "`result`" - }, - { - "kind": "text", - "text": " property." - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "service: " - }, - { - "kind": "code", - "text": "`S3Exception`" - }, - { - "kind": "text", - "text": " - thrown when checking for existence of the object" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "validation: " - }, - { - "kind": "code", - "text": "`StorageValidationErrorCode`" - }, - { - "kind": "text", - "text": " - Validation errors" - } - ] - }, + "parameters": [ + 5413, + 5414 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Download a file from s3 bucket\nconst { body, eTag } = await downloadData({ key, options: {\n onProgress, // Optional progress callback.\n} }).result;\n```" - } - ] - }, + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "StorageGetUrlOutput" + }, + "name": "StorageGetUrlOutput", + "package": "@aws-amplify/storage" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "5413": { + "id": 5413, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Cancel a task\nconst downloadTask = downloadData({ key });\n//...\ndownloadTask.cancel();\ntry {\n\tawait downloadTask.result;\n} catch (error) {\n\tif(isCancelError(error)) {\n // Handle error thrown by task cancelation.\n\t}\n}\n```" - } - ] + "kind": "text", + "text": "The AmplifyContext to operate on." } ] }, - "parameters": [ - 4978 - ], "type": { "type": "reference", - "target": 4927, - "name": "DownloadDataOutput", - "package": "@aws-amplify/storage" + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" } }, - "4978": { - "id": 4978, + "5414": { + "id": 5414, "name": "input", "variant": "param", "kind": 32768, @@ -8479,7 +14020,7 @@ }, { "kind": "code", - "text": "`DownloadDataInput`" + "text": "`GetUrlInput`" }, { "kind": "text", @@ -8489,25 +14030,14 @@ }, "type": { "type": "reference", - "target": 4926, - "name": "DownloadDataInput", + "target": 5340, + "name": "GetUrlInput", "package": "@aws-amplify/storage" } }, - "4979": { - "id": 4979, - "name": "getProperties", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4980, - 4982 - ] - }, - "4980": { - "id": 4980, - "name": "getProperties", + "5415": { + "id": 5415, + "name": "getUrl", "variant": "signature", "kind": 4096, "flags": {}, @@ -8515,7 +14045,39 @@ "summary": [ { "kind": "text", - "text": "Gets the properties of a file. The properties include S3 system metadata and\nthe user metadata that was provided when uploading the file." + "text": "Get a temporary presigned URL to download or upload the specified S3 object.\nThe presigned URL expires when the associated role used to sign the request expires or\nthe option " + }, + { + "kind": "code", + "text": "`expiresIn`" + }, + { + "kind": "text", + "text": " is reached. The " + }, + { + "kind": "code", + "text": "`expiresAt`" + }, + { + "kind": "text", + "text": " property in the output object indicates when the URL MAY expire.\n\nBy default, it will not validate the object that exists in S3. If you set the " + }, + { + "kind": "code", + "text": "`options.validateObjectExistence`" + }, + { + "kind": "text", + "text": "\nto true, this method will verify the given object already exists in S3 before returning a presigned\nURL, and will throw " + }, + { + "kind": "code", + "text": "`StorageError`" + }, + { + "kind": "text", + "text": " if the object does not exist." } ], "blockTags": [ @@ -8524,7 +14086,7 @@ "content": [ { "kind": "text", - "text": "Requested object properties." + "text": "Presigned URL and timestamp when the URL may expire." } ] }, @@ -8533,7 +14095,7 @@ "content": [ { "kind": "text", - "text": "An " + "text": "service: " }, { "kind": "code", @@ -8541,7 +14103,7 @@ }, { "kind": "text", - "text": " when the underlying S3 service returned error." + "text": " - thrown when checking for existence of the object" } ] }, @@ -8550,7 +14112,7 @@ "content": [ { "kind": "text", - "text": "A " + "text": "validation: " }, { "kind": "code", @@ -8558,14 +14120,14 @@ }, { "kind": "text", - "text": " when API call parameters are invalid." + "text": " - Validation errors\nthrown either username or key are not defined." } ] } ] }, "parameters": [ - 4981 + 5416 ], "type": { "type": "reference", @@ -8577,8 +14139,12 @@ "typeArguments": [ { "type": "reference", - "target": 4933, - "name": "GetPropertiesWithPathOutput", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "StorageGetUrlOutput" + }, + "name": "StorageGetUrlOutput", "package": "@aws-amplify/storage" } ], @@ -8586,8 +14152,8 @@ "package": "typescript" } }, - "4981": { - "id": 4981, + "5416": { + "id": 5416, "name": "input", "variant": "param", "kind": 32768, @@ -8600,7 +14166,7 @@ }, { "kind": "code", - "text": "`GetPropertiesWithPathInput`" + "text": "`GetUrlWithPathInput`" }, { "kind": "text", @@ -8610,14 +14176,14 @@ }, "type": { "type": "reference", - "target": 4932, - "name": "GetPropertiesWithPathInput", + "target": 5342, + "name": "GetUrlWithPathInput", "package": "@aws-amplify/storage" } }, - "4982": { - "id": 4982, - "name": "getProperties", + "5417": { + "id": 5417, + "name": "getUrl", "variant": "signature", "kind": 4096, "flags": {}, @@ -8651,11 +14217,43 @@ "kind": "inline-tag", "tag": "@link", "text": "path", - "target": "https://docs.amplify.aws/javascript/build-a-backend/storage/get-properties/" + "target": "https://docs.amplify.aws/javascript/build-a-backend/storage/download/#generate-a-download-url" }, { "kind": "text", - "text": " instead.\n\nGets the properties of a file. The properties include S3 system metadata and\nthe user metadata that was provided when uploading the file." + "text": " instead.\n\nGet a temporary presigned URL to download the specified S3 object.\nThe presigned URL expires when the associated role used to sign the request expires or\nthe option " + }, + { + "kind": "code", + "text": "`expiresIn`" + }, + { + "kind": "text", + "text": " is reached. The " + }, + { + "kind": "code", + "text": "`expiresAt`" + }, + { + "kind": "text", + "text": " property in the output object indicates when the URL MAY expire.\n\nBy default, it will not validate the object that exists in S3. If you set the " + }, + { + "kind": "code", + "text": "`options.validateObjectExistence`" + }, + { + "kind": "text", + "text": "\nto true, this method will verify the given object already exists in S3 before returning a presigned\nURL, and will throw " + }, + { + "kind": "code", + "text": "`StorageError`" + }, + { + "kind": "text", + "text": " if the object does not exist." } ] }, @@ -8664,7 +14262,7 @@ "content": [ { "kind": "text", - "text": "Requested object properties." + "text": "Presigned URL and timestamp when the URL may expire." } ] }, @@ -8673,7 +14271,7 @@ "content": [ { "kind": "text", - "text": "An " + "text": "service: " }, { "kind": "code", @@ -8681,7 +14279,7 @@ }, { "kind": "text", - "text": " when the underlying S3 service returned error." + "text": " - thrown when checking for existence of the object" } ] }, @@ -8690,7 +14288,7 @@ "content": [ { "kind": "text", - "text": "A " + "text": "validation: " }, { "kind": "code", @@ -8698,14 +14296,14 @@ }, { "kind": "text", - "text": " when API call parameters are invalid." + "text": " - Validation errors\nthrown either username or key are not defined." } ] } ] }, "parameters": [ - 4983 + 5418 ], "type": { "type": "reference", @@ -8717,8 +14315,12 @@ "typeArguments": [ { "type": "reference", - "target": 4931, - "name": "GetPropertiesOutput", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/types/outputs.d.ts", + "qualifiedName": "StorageGetUrlOutput" + }, + "name": "StorageGetUrlOutput", "package": "@aws-amplify/storage" } ], @@ -8726,8 +14328,8 @@ "package": "typescript" } }, - "4983": { - "id": 4983, + "5418": { + "id": 5418, "name": "input", "variant": "param", "kind": 32768, @@ -8740,7 +14342,7 @@ }, { "kind": "code", - "text": "`GetPropertiesInput`" + "text": "`GetUrlInput`" }, { "kind": "text", @@ -8750,115 +14352,116 @@ }, "type": { "type": "reference", - "target": 4930, - "name": "GetPropertiesInput", + "target": 5340, + "name": "GetUrlInput", "package": "@aws-amplify/storage" } }, - "4984": { - "id": 4984, - "name": "getUrl", + "5419": { + "id": 5419, + "name": "list", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4985, - 4987 + 5420, + 5423, + 5426, + 5429, + 5432, + 5434, + 5436, + 5438 ] }, - "4985": { - "id": 4985, - "name": "getUrl", + "5420": { + "id": 5420, + "name": "list", "variant": "signature", "kind": 4096, "flags": {}, + "parameters": [ + 5421, + 5422 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 5353, + "name": "ListPaginateWithPathOutput", + "package": "@aws-amplify/storage" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "5421": { + "id": 5421, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Get a temporary presigned URL to download or upload the specified S3 object.\nThe presigned URL expires when the associated role used to sign the request expires or\nthe option " - }, - { - "kind": "code", - "text": "`expiresIn`" - }, - { - "kind": "text", - "text": " is reached. The " - }, - { - "kind": "code", - "text": "`expiresAt`" - }, - { - "kind": "text", - "text": " property in the output object indicates when the URL MAY expire.\n\nBy default, it will not validate the object that exists in S3. If you set the " - }, - { - "kind": "code", - "text": "`options.validateObjectExistence`" - }, + "text": "The AmplifyContext to operate on." + } + ] + }, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "5422": { + "id": 5422, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ { "kind": "text", - "text": "\nto true, this method will verify the given object already exists in S3 before returning a presigned\nURL, and will throw " + "text": "The " }, { "kind": "code", - "text": "`StorageError`" - }, - { - "kind": "text", - "text": " if the object does not exist." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Presigned URL and timestamp when the URL may expire." - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "service: " - }, - { - "kind": "code", - "text": "`S3Exception`" - }, - { - "kind": "text", - "text": " - thrown when checking for existence of the object" - } - ] + "text": "`ListPaginateWithPathInput`" }, { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "validation: " - }, - { - "kind": "code", - "text": "`StorageValidationErrorCode`" - }, - { - "kind": "text", - "text": " - Validation errors\nthrown either username or key are not defined." - } - ] + "kind": "text", + "text": " object." } ] }, + "type": { + "type": "reference", + "target": 5352, + "name": "ListPaginateWithPathInput", + "package": "@aws-amplify/storage" + } + }, + "5423": { + "id": 5423, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, "parameters": [ - 4986 + 5424, + 5425 ], "type": { "type": "reference", @@ -8870,12 +14473,8 @@ "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/outputs.d.ts", - "qualifiedName": "StorageGetUrlOutput" - }, - "name": "StorageGetUrlOutput", + "target": 5347, + "name": "ListAllWithPathOutput", "package": "@aws-amplify/storage" } ], @@ -8883,8 +14482,29 @@ "package": "typescript" } }, - "4986": { - "id": 4986, + "5424": { + "id": 5424, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The AmplifyContext to operate on." + } + ] + }, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "5425": { + "id": 5425, "name": "input", "variant": "param", "kind": 32768, @@ -8897,7 +14517,7 @@ }, { "kind": "code", - "text": "`GetUrlWithPathInput`" + "text": "`ListAllWithPathInput`" }, { "kind": "text", @@ -8907,134 +14527,101 @@ }, "type": { "type": "reference", - "target": 4936, - "name": "GetUrlWithPathInput", + "target": 5346, + "name": "ListAllWithPathInput", "package": "@aws-amplify/storage" } }, - "4987": { - "id": 4987, - "name": "getUrl", + "5426": { + "id": 5426, + "name": "list", "variant": "signature", "kind": 4096, "flags": {}, + "parameters": [ + 5427, + 5428 + ], + "type": { + "type": "reference", + "target": { + "packageName": "typescript", + "packagePath": "lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 5349, + "name": "ListPaginateOutput", + "package": "@aws-amplify/storage" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + "5427": { + "id": 5427, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, "comment": { - "summary": [], - "blockTags": [ + "summary": [ { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`key`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`accessLevel`" - }, - { - "kind": "text", - "text": " parameters are deprecated and may be removed in the next major version.\nPlease use " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "path", - "target": "https://docs.amplify.aws/javascript/build-a-backend/storage/download/#generate-a-download-url" - }, - { - "kind": "text", - "text": " instead.\n\nGet a temporary presigned URL to download the specified S3 object.\nThe presigned URL expires when the associated role used to sign the request expires or\nthe option " - }, - { - "kind": "code", - "text": "`expiresIn`" - }, - { - "kind": "text", - "text": " is reached. The " - }, - { - "kind": "code", - "text": "`expiresAt`" - }, - { - "kind": "text", - "text": " property in the output object indicates when the URL MAY expire.\n\nBy default, it will not validate the object that exists in S3. If you set the " - }, - { - "kind": "code", - "text": "`options.validateObjectExistence`" - }, - { - "kind": "text", - "text": "\nto true, this method will verify the given object already exists in S3 before returning a presigned\nURL, and will throw " - }, - { - "kind": "code", - "text": "`StorageError`" - }, - { - "kind": "text", - "text": " if the object does not exist." - } - ] - }, + "kind": "text", + "text": "The AmplifyContext to operate on." + } + ] + }, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "5428": { + "id": 5428, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Presigned URL and timestamp when the URL may expire." - } - ] + "kind": "text", + "text": "The " }, { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "service: " - }, - { - "kind": "code", - "text": "`S3Exception`" - }, - { - "kind": "text", - "text": " - thrown when checking for existence of the object" - } - ] + "kind": "code", + "text": "`ListPaginateInput`" }, { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "validation: " - }, - { - "kind": "code", - "text": "`StorageValidationErrorCode`" - }, - { - "kind": "text", - "text": " - Validation errors\nthrown either username or key are not defined." - } - ] + "kind": "text", + "text": " object." } ] }, + "type": { + "type": "reference", + "target": 5348, + "name": "ListPaginateInput", + "package": "@aws-amplify/storage" + } + }, + "5429": { + "id": 5429, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, "parameters": [ - 4988 + 5430, + 5431 ], "type": { "type": "reference", @@ -9046,12 +14633,8 @@ "typeArguments": [ { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/types/outputs.d.ts", - "qualifiedName": "StorageGetUrlOutput" - }, - "name": "StorageGetUrlOutput", + "target": 5345, + "name": "ListAllOutput", "package": "@aws-amplify/storage" } ], @@ -9059,12 +14642,35 @@ "package": "typescript" } }, - "4988": { - "id": 4988, - "name": "input", + "5430": { + "id": 5430, + "name": "ctx", "variant": "param", "kind": 32768, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The AmplifyContext to operate on." + } + ] + }, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "5431": { + "id": 5431, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { @@ -9073,7 +14679,7 @@ }, { "kind": "code", - "text": "`GetUrlInput`" + "text": "`ListAllInput`" }, { "kind": "text", @@ -9083,26 +14689,13 @@ }, "type": { "type": "reference", - "target": 4934, - "name": "GetUrlInput", - "package": "@aws-amplify/storage" - } - }, - "4989": { - "id": 4989, - "name": "list", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 4990, - 4992, - 4994, - 4996 - ] + "target": 5344, + "name": "ListAllInput", + "package": "@aws-amplify/storage" + } }, - "4990": { - "id": 4990, + "5432": { + "id": 5432, "name": "list", "variant": "signature", "kind": 4096, @@ -9185,7 +14778,7 @@ ] }, "parameters": [ - 4991 + 5433 ], "type": { "type": "reference", @@ -9197,7 +14790,7 @@ "typeArguments": [ { "type": "reference", - "target": 4947, + "target": 5353, "name": "ListPaginateWithPathOutput", "package": "@aws-amplify/storage" } @@ -9206,8 +14799,8 @@ "package": "typescript" } }, - "4991": { - "id": 4991, + "5433": { + "id": 5433, "name": "input", "variant": "param", "kind": 32768, @@ -9230,13 +14823,13 @@ }, "type": { "type": "reference", - "target": 4946, + "target": 5352, "name": "ListPaginateWithPathInput", "package": "@aws-amplify/storage" } }, - "4992": { - "id": 4992, + "5434": { + "id": 5434, "name": "list", "variant": "signature", "kind": 4096, @@ -9319,7 +14912,7 @@ ] }, "parameters": [ - 4993 + 5435 ], "type": { "type": "reference", @@ -9331,7 +14924,7 @@ "typeArguments": [ { "type": "reference", - "target": 4941, + "target": 5347, "name": "ListAllWithPathOutput", "package": "@aws-amplify/storage" } @@ -9340,8 +14933,8 @@ "package": "typescript" } }, - "4993": { - "id": 4993, + "5435": { + "id": 5435, "name": "input", "variant": "param", "kind": 32768, @@ -9364,13 +14957,13 @@ }, "type": { "type": "reference", - "target": 4940, + "target": 5346, "name": "ListAllWithPathInput", "package": "@aws-amplify/storage" } }, - "4994": { - "id": 4994, + "5436": { + "id": 5436, "name": "list", "variant": "signature", "kind": 4096, @@ -9483,7 +15076,7 @@ ] }, "parameters": [ - 4995 + 5437 ], "type": { "type": "reference", @@ -9495,7 +15088,7 @@ "typeArguments": [ { "type": "reference", - "target": 4943, + "target": 5349, "name": "ListPaginateOutput", "package": "@aws-amplify/storage" } @@ -9504,8 +15097,8 @@ "package": "typescript" } }, - "4995": { - "id": 4995, + "5437": { + "id": 5437, "name": "input", "variant": "param", "kind": 32768, @@ -9530,13 +15123,13 @@ }, "type": { "type": "reference", - "target": 4942, + "target": 5348, "name": "ListPaginateInput", "package": "@aws-amplify/storage" } }, - "4996": { - "id": 4996, + "5438": { + "id": 5438, "name": "list", "variant": "signature", "kind": 4096, @@ -9649,7 +15242,7 @@ ] }, "parameters": [ - 4997 + 5439 ], "type": { "type": "reference", @@ -9661,7 +15254,7 @@ "typeArguments": [ { "type": "reference", - "target": 4939, + "target": 5345, "name": "ListAllOutput", "package": "@aws-amplify/storage" } @@ -9670,8 +15263,8 @@ "package": "typescript" } }, - "4997": { - "id": 4997, + "5439": { + "id": 5439, "name": "input", "variant": "param", "kind": 32768, @@ -9696,24 +15289,184 @@ }, "type": { "type": "reference", - "target": 4938, + "target": 5344, "name": "ListAllInput", "package": "@aws-amplify/storage" } }, - "4998": { - "id": 4998, + "5440": { + "id": 5440, "name": "remove", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4999, - 5001 + 5441, + 5444, + 5447, + 5449 ] }, - "4999": { - "id": 4999, + "5441": { + "id": 5441, + "name": "remove", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 5442, + 5443 + ], + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/inputs.d.ts", + "qualifiedName": "RemoveOperation" + }, + "typeArguments": [ + { + "type": "reference", + "target": 5363, + "name": "RemoveWithPathOutput", + "package": "@aws-amplify/storage" + } + ], + "name": "RemoveOperation", + "package": "@aws-amplify/storage" + } + }, + "5442": { + "id": 5442, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The AmplifyContext to operate on." + } + ] + }, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "5443": { + "id": 5443, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`RemoveWithPathInput`" + }, + { + "kind": "text", + "text": " object." + } + ] + }, + "type": { + "type": "reference", + "target": 5358, + "name": "RemoveWithPathInput", + "package": "@aws-amplify/storage" + } + }, + "5444": { + "id": 5444, + "name": "remove", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 5445, + 5446 + ], + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/inputs.d.ts", + "qualifiedName": "RemoveOperation" + }, + "typeArguments": [ + { + "type": "reference", + "target": 5357, + "name": "RemoveOutput", + "package": "@aws-amplify/storage" + } + ], + "name": "RemoveOperation", + "package": "@aws-amplify/storage" + } + }, + "5445": { + "id": 5445, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The AmplifyContext to operate on." + } + ] + }, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "5446": { + "id": 5446, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`RemoveInput`" + }, + { + "kind": "text", + "text": " object." + } + ] + }, + "type": { + "type": "reference", + "target": 5356, + "name": "RemoveInput", + "package": "@aws-amplify/storage" + } + }, + "5447": { + "id": 5447, "name": "remove", "variant": "signature", "kind": 4096, @@ -9772,7 +15525,7 @@ ] }, "parameters": [ - 5000 + 5448 ], "type": { "type": "reference", @@ -9784,7 +15537,7 @@ "typeArguments": [ { "type": "reference", - "target": 4957, + "target": 5363, "name": "RemoveWithPathOutput", "package": "@aws-amplify/storage" } @@ -9793,8 +15546,8 @@ "package": "@aws-amplify/storage" } }, - "5000": { - "id": 5000, + "5448": { + "id": 5448, "name": "input", "variant": "param", "kind": 32768, @@ -9817,13 +15570,13 @@ }, "type": { "type": "reference", - "target": 4952, + "target": 5358, "name": "RemoveWithPathInput", "package": "@aws-amplify/storage" } }, - "5001": { - "id": 5001, + "5449": { + "id": 5449, "name": "remove", "variant": "signature", "kind": 4096, @@ -9867,74 +15620,221 @@ ] }, { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Operation handle with result promise and cancellation capability." - } - ] + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Operation handle with result promise and cancellation capability." + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "service: " + }, + { + "kind": "code", + "text": "`S3Exception`" + }, + { + "kind": "text", + "text": " - S3 service errors thrown while while removing the object" + } + ] + }, + { + "tag": "@throws", + "content": [ + { + "kind": "text", + "text": "validation: " + }, + { + "kind": "code", + "text": "`StorageValidationErrorCode`" + }, + { + "kind": "text", + "text": " - Validation errors thrown\nwhen there is no key or its empty." + } + ] + } + ] + }, + "parameters": [ + 5450 + ], + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/storage", + "packagePath": "dist/esm/providers/s3/types/inputs.d.ts", + "qualifiedName": "RemoveOperation" + }, + "typeArguments": [ + { + "type": "reference", + "target": 5357, + "name": "RemoveOutput", + "package": "@aws-amplify/storage" + } + ], + "name": "RemoveOperation", + "package": "@aws-amplify/storage" + } + }, + "5450": { + "id": 5450, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`RemoveInput`" + }, + { + "kind": "text", + "text": " object." + } + ] + }, + "type": { + "type": "reference", + "target": 5356, + "name": "RemoveInput", + "package": "@aws-amplify/storage" + } + }, + "5451": { + "id": 5451, + "name": "uploadData", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5452, + 5455, + 5458, + 5460 + ] + }, + "5452": { + "id": 5452, + "name": "uploadData", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + 5453, + 5454 + ], + "type": { + "type": "reference", + "target": 5369, + "name": "UploadDataWithPathOutput", + "package": "@aws-amplify/storage" + } + }, + "5453": { + "id": 5453, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The AmplifyContext to operate on." + } + ] + }, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" + } + }, + "5454": { + "id": 5454, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " }, { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "service: " - }, - { - "kind": "code", - "text": "`S3Exception`" - }, - { - "kind": "text", - "text": " - S3 service errors thrown while while removing the object" - } - ] + "kind": "code", + "text": "`UploadDataWithPathInput`" }, { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "validation: " - }, - { - "kind": "code", - "text": "`StorageValidationErrorCode`" - }, - { - "kind": "text", - "text": " - Validation errors thrown\nwhen there is no key or its empty." - } - ] + "kind": "text", + "text": " object." } ] }, + "type": { + "type": "reference", + "target": 5368, + "name": "UploadDataWithPathInput", + "package": "@aws-amplify/storage" + } + }, + "5455": { + "id": 5455, + "name": "uploadData", + "variant": "signature", + "kind": 4096, + "flags": {}, "parameters": [ - 5002 + 5456, + 5457 ], "type": { "type": "reference", - "target": { - "packageName": "@aws-amplify/storage", - "packagePath": "dist/esm/providers/s3/types/inputs.d.ts", - "qualifiedName": "RemoveOperation" - }, - "typeArguments": [ + "target": 5365, + "name": "UploadDataOutput", + "package": "@aws-amplify/storage" + } + }, + "5456": { + "id": 5456, + "name": "ctx", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "target": 4951, - "name": "RemoveOutput", - "package": "@aws-amplify/storage" + "kind": "text", + "text": "The AmplifyContext to operate on." } - ], - "name": "RemoveOperation", - "package": "@aws-amplify/storage" + ] + }, + "type": { + "type": "reference", + "target": 5131, + "name": "AmplifyContext", + "package": "@aws-amplify/core" } }, - "5002": { - "id": 5002, + "5457": { + "id": 5457, "name": "input", "variant": "param", "kind": 32768, @@ -9947,7 +15847,7 @@ }, { "kind": "code", - "text": "`RemoveInput`" + "text": "`UploadDataInput`" }, { "kind": "text", @@ -9957,24 +15857,13 @@ }, "type": { "type": "reference", - "target": 4950, - "name": "RemoveInput", + "target": 5364, + "name": "UploadDataInput", "package": "@aws-amplify/storage" } }, - "5003": { - "id": 5003, - "name": "uploadData", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - 5004, - 5006 - ] - }, - "5004": { - "id": 5004, + "5458": { + "id": 5458, "name": "uploadData", "variant": "signature", "kind": 4096, @@ -10052,17 +15941,17 @@ ] }, "parameters": [ - 5005 + 5459 ], "type": { "type": "reference", - "target": 4963, + "target": 5369, "name": "UploadDataWithPathOutput", "package": "@aws-amplify/storage" } }, - "5005": { - "id": 5005, + "5459": { + "id": 5459, "name": "input", "variant": "param", "kind": 32768, @@ -10085,13 +15974,13 @@ }, "type": { "type": "reference", - "target": 4962, + "target": 5368, "name": "UploadDataWithPathInput", "package": "@aws-amplify/storage" } }, - "5006": { - "id": 5006, + "5460": { + "id": 5460, "name": "uploadData", "variant": "signature", "kind": 4096, @@ -10204,17 +16093,17 @@ ] }, "parameters": [ - 5007 + 5461 ], "type": { "type": "reference", - "target": 4959, + "target": 5365, "name": "UploadDataOutput", "package": "@aws-amplify/storage" } }, - "5007": { - "id": 5007, + "5461": { + "id": 5461, "name": "input", "variant": "param", "kind": 32768, @@ -10237,257 +16126,361 @@ }, "type": { "type": "reference", - "target": 4958, + "target": 5364, "name": "UploadDataInput", "package": "@aws-amplify/storage" } }, + "5876": { + "id": 5876, + "name": "GeoConfig", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/types.d.ts", + "qualifiedName": "AtLeastOne" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "packageName": "@aws-amplify/core", + "packagePath": "dist/esm/singleton/Geo/types.d.ts", + "qualifiedName": "LocationServiceConfig" + }, + "name": "LocationServiceConfig", + "package": "@aws-amplify/core" + } + ], + "name": "AtLeastOne", + "package": "@aws-amplify/core" + } + }, "categories": [ { - "id": 3369, + "id": 3666, "name": "auth", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { - "id": 3505, + "id": 3784, "name": "associateWebAuthnCredential", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3506 + 3785 ] }, { - "id": 3507, + "id": 3786, "name": "confirmResetPassword", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3508 + 3787, + 3790 ] }, { - "id": 3510, + "id": 3792, "name": "confirmSignIn", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3511 + 3793, + 3796 ] }, { - "id": 3513, + "id": 3798, "name": "confirmSignUp", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3514 + 3799, + 3802 ] }, { - "id": 3516, + "id": 3804, "name": "confirmUserAttribute", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3517 + 3805, + 3808 ] }, { - "id": 3519, + "id": 3810, "name": "decodeJWT", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3520 + 3811 ] }, { - "id": 3522, + "id": 3813, "name": "deleteUser", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3523 + 3814, + 3816 ] }, { - "id": 3524, + "id": 3817, "name": "deleteUserAttributes", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3525 + 3818, + 3821 ] }, { - "id": 3527, + "id": 3823, "name": "deleteWebAuthnCredential", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3528 + 3824 ] }, { - "id": 3530, + "id": 3826, + "name": "fetchAuthSession", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3827, + 3830 + ] + }, + { + "id": 3832, "name": "fetchDevices", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3531 + 3833, + 3835 ] }, { - "id": 3532, + "id": 3836, "name": "fetchMFAPreference", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3533 + 3837, + 3839 + ] + }, + { + "id": 3840, + "name": "fetchUserAttributes", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3841, + 3843 ] }, { - "id": 3534, + "id": 3844, "name": "forgetDevice", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3535 + 3845, + 3848 + ] + }, + { + "id": 3850, + "name": "getCurrentUser", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3851, + 3853 ] }, { - "id": 3537, + "id": 3854, "name": "listWebAuthnCredentials", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3538 + 3855 ] }, { - "id": 3540, + "id": 3857, "name": "rememberDevice", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3541 + 3858, + 3860 ] }, { - "id": 3542, + "id": 3861, "name": "resendSignUpCode", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3543 + 3862, + 3865 ] }, { - "id": 3545, + "id": 3867, "name": "resetPassword", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3546 + 3868, + 3871 + ] + }, + { + "id": 3873, + "name": "sendUserAttributeVerificationCode", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3874, + 3877 ] }, { - "id": 3548, + "id": 3879, "name": "setUpTOTP", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3549 + 3880, + 3882 ] }, { - "id": 3550, + "id": 3883, "name": "signIn", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3551 + 3884, + 3887 ] }, { - "id": 3553, + "id": 3889, "name": "signInWithRedirect", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3554 + 3890, + 3893 ] }, { - "id": 3556, + "id": 3895, "name": "signOut", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3557 + 3896, + 3899 ] }, { - "id": 3559, + "id": 3901, "name": "signUp", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3560 + 3902, + 3905 ] }, { - "id": 3562, + "id": 3907, "name": "updateMFAPreference", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3563 + 3908, + 3911 ] }, { - "id": 3565, + "id": 3913, "name": "updatePassword", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3566 + 3914, + 3917 + ] + }, + { + "id": 3919, + "name": "updateUserAttributes", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3920, + 3923 ] }, { - "id": 3568, + "id": 3925, "name": "verifyTOTPSetup", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3569 + 3926, + 3929 ] } ], @@ -10495,194 +16488,210 @@ { "title": "Classes", "children": [ - 3370 + 3667 ] }, { "title": "Interfaces", "children": [ - 3390, - 3395, - 3399, - 3403, - 3410, - 3413, - 3419, - 3421, - 3424, - 3427, - 3431, - 3434, - 3437, - 3443 + 3687, + 3692, + 3696, + 3700, + 3707, + 3710, + 3716, + 3718, + 3721, + 3724, + 3728, + 3731, + 3734, + 3740 ] }, { "title": "Type Aliases", "children": [ - 3447, - 3449, - 3450, - 3451, - 3452, - 3453, - 3454, - 3455, - 3456, - 3457, - 3458, - 3459, - 3460, - 3461, - 3462, - 3463, - 3464, - 3465, - 3466, - 3467, - 3468, - 3469, - 3470, - 3471, - 3472, - 3473, - 3474, - 3475, - 3476, - 3477, - 3478, - 3479, - 3480, - 3481 + 3744, + 3746, + 3747, + 3748, + 3749, + 3750, + 3751, + 3752, + 3753, + 3754, + 3755, + 3756, + 3757, + 3758, + 3759, + 3760, + 3761, + 3762, + 3763, + 3764, + 3765, + 3766, + 3767, + 3768, + 3769, + 3770, + 3771, + 3772, + 3773, + 3774, + 3775, + 3776, + 3777, + 3778 ] }, { "title": "Variables", "children": [ - 3482, - 3483, - 3487, - 3490, - 3493, - 3497, - 3501 + 3779, + 3780 ] }, { "title": "Functions", "children": [ - 3505, - 3507, - 3510, - 3513, - 3516, - 3519, - 3522, - 3524, - 3527, - 3530, - 3532, - 3534, - 3537, - 3540, - 3542, - 3545, - 3548, - 3550, - 3553, - 3556, - 3559, - 3562, - 3565, - 3568 + 3784, + 3786, + 3792, + 3798, + 3804, + 3810, + 3813, + 3817, + 3823, + 3826, + 3832, + 3836, + 3840, + 3844, + 3850, + 3854, + 3857, + 3861, + 3867, + 3873, + 3879, + 3883, + 3889, + 3895, + 3901, + 3907, + 3913, + 3919, + 3925 ] } ] }, { - "id": 4898, + "id": 5304, "name": "storage", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { - "id": 4969, + "id": 5375, "name": "copy", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4970, - 4972 + 5376, + 5379, + 5382, + 5384 ] }, { - "id": 4974, + "id": 5386, "name": "downloadData", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4975, - 4977 + 5387, + 5390, + 5393, + 5395 ] }, { - "id": 4979, + "id": 5397, "name": "getProperties", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4980, - 4982 + 5398, + 5401, + 5404, + 5406 ] }, { - "id": 4984, + "id": 5408, "name": "getUrl", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4985, - 4987 + 5409, + 5412, + 5415, + 5417 ] }, { - "id": 4989, + "id": 5419, "name": "list", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4990, - 4992, - 4994, - 4996 + 5420, + 5423, + 5426, + 5429, + 5432, + 5434, + 5436, + 5438 ] }, { - "id": 4998, + "id": 5440, "name": "remove", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4999, - 5001 + 5441, + 5444, + 5447, + 5449 ] }, { - "id": 5003, + "id": 5451, "name": "uploadData", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 5004, - 5006 + 5452, + 5455, + 5458, + 5460 ] } ], @@ -10690,90 +16699,157 @@ { "title": "Classes", "children": [ - 4899 + 5305 ] }, { "title": "Interfaces", "children": [ - 4919 + 5325 ] }, { "title": "Type Aliases", "children": [ - 4922, - 4923, - 4924, - 4925, - 4926, - 4927, - 4928, - 4929, - 4930, - 4931, - 4932, - 4933, - 4934, - 4935, - 4936, - 4937, - 4938, - 4939, - 4940, - 4941, - 4942, - 4943, - 4946, - 4947, - 4950, - 4951, - 4952, - 4957, - 4958, - 4959, - 4960, - 4961, - 4962, - 4963 + 5328, + 5329, + 5330, + 5331, + 5332, + 5333, + 5334, + 5335, + 5336, + 5337, + 5338, + 5339, + 5340, + 5341, + 5342, + 5343, + 5344, + 5345, + 5346, + 5347, + 5348, + 5349, + 5352, + 5353, + 5356, + 5357, + 5358, + 5363, + 5364, + 5365, + 5366, + 5367, + 5368, + 5369 ] }, { "title": "Variables", "children": [ - 4964, - 4965 + 5370, + 5371 ] }, { "title": "Functions", "children": [ - 4969, - 4974, - 4979, - 4984, - 4989, - 4998, - 5003 + 5375, + 5386, + 5397, + 5408, + 5419, + 5440, + 5451 ] } ] }, { - "id": 3210, + "id": 3505, "name": "api", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { - "id": 3325, + "id": 3605, + "name": "del", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3606, + 3609 + ] + }, + { + "id": 3611, "name": "generateClient", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3326 + 3612, + 3617 + ] + }, + { + "id": 3621, + "name": "get", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3622, + 3625 + ] + }, + { + "id": 3627, + "name": "head", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3628, + 3631 + ] + }, + { + "id": 3633, + "name": "patch", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3634, + 3637 + ] + }, + { + "id": 3639, + "name": "post", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3640, + 3643 + ] + }, + { + "id": 3645, + "name": "put", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3646, + 3649 ] } ], @@ -10781,63 +16857,63 @@ { "title": "Namespaces", "children": [ - 3211 + 3506 ] }, { "title": "Enumerations", "children": [ - 3223, - 3232 + 3527, + 3536 ] }, { "title": "Classes", "children": [ - 3238 + 3542 ] }, { "title": "Interfaces", "children": [ - 3260, - 3271, - 3275 + 3564, + 3575, + 3579 ] }, { "title": "Type Aliases", "children": [ - 3280, - 3282, - 3286, - 3288, - 3292 + 3584, + 3586, + 3590, + 3592, + 3596 ] }, { "title": "Variables", "children": [ - 3296, - 3297, - 3301, - 3305, - 3309, - 3313, - 3317, - 3321 + 3600, + 3601 ] }, { "title": "Functions", "children": [ - 3325 + 3605, + 3611, + 3621, + 3627, + 3633, + 3639, + 3645 ] } ] }, { - "id": 3110, + "id": 3396, "name": "analytics", "variant": "declaration", "kind": 2, @@ -10847,39 +16923,106 @@ { "title": "Type Aliases", "children": [ - 3111, - 3112, - 3113 + 3397, + 3398, + 3399 ] }, { "title": "Variables", "children": [ - 3114, - 3118, - 3121, - 3124, - 3127, - 3131 + 3400, + 3401, + 3404, + 3407, + 3408, + 3409 ] } ] }, { - "id": 3210, + "id": 3505, "name": "api", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { - "id": 3325, + "id": 3605, + "name": "del", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3606, + 3609 + ] + }, + { + "id": 3611, "name": "generateClient", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 3326 + 3612, + 3617 + ] + }, + { + "id": 3621, + "name": "get", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3622, + 3625 + ] + }, + { + "id": 3627, + "name": "head", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3628, + 3631 + ] + }, + { + "id": 3633, + "name": "patch", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3634, + 3637 + ] + }, + { + "id": 3639, + "name": "post", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3640, + 3643 + ] + }, + { + "id": 3645, + "name": "put", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 3646, + 3649 ] } ], @@ -10887,166 +17030,179 @@ { "title": "Namespaces", "children": [ - 3211 + 3506 ] }, { "title": "Enumerations", "children": [ - 3223, - 3232 + 3527, + 3536 ] }, { "title": "Classes", "children": [ - 3238 + 3542 ] }, { "title": "Interfaces", "children": [ - 3260, - 3271, - 3275 + 3564, + 3575, + 3579 ] }, { "title": "Type Aliases", "children": [ - 3280, - 3282, - 3286, - 3288, - 3292 + 3584, + 3586, + 3590, + 3592, + 3596 ] }, { "title": "Variables", "children": [ - 3296, - 3297, - 3301, - 3305, - 3309, - 3313, - 3317, - 3321 + 3600, + 3601 ] }, { "title": "Functions", "children": [ - 3325 + 3605, + 3611, + 3621, + 3627, + 3633, + 3639, + 3645 ] } ] }, { - "id": 4673, + "id": 5027, "name": "in-app-messaging", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { - "id": 4719, + "id": 5069, "name": "clearMessages", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4720 + 5070 ] }, { - "id": 4721, + "id": 5071, "name": "dispatchEvent", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4722 + 5072 + ] + }, + { + "id": 5074, + "name": "identifyUser", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + 5075, + 5078 ] }, { - "id": 4724, + "id": 5080, "name": "initializeInAppMessaging", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4725 + 5081, + 5083 ] }, { - "id": 4726, + "id": 5084, "name": "notifyMessageInteraction", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4727 + 5085 ] }, { - "id": 4729, + "id": 5087, "name": "onMessageActionTaken", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4730 + 5088 ] }, { - "id": 4732, + "id": 5090, "name": "onMessageDismissed", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4733 + 5091 ] }, { - "id": 4735, + "id": 5093, "name": "onMessageDisplayed", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4736 + 5094 ] }, { - "id": 4738, + "id": 5096, "name": "onMessageReceived", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4739 + 5097 ] }, { - "id": 4741, + "id": 5099, "name": "setConflictHandler", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4742 + 5100 ] }, { - "id": 4744, + "id": 5102, "name": "syncMessages", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ - 4745 + 5103, + 5105 ] } ], @@ -11054,52 +17210,47 @@ { "title": "Interfaces", "children": [ - 4674, - 4679, - 4684, - 4691, - 4693, - 4698 + 5028, + 5033, + 5038, + 5045, + 5047, + 5052 ] }, { "title": "Type Aliases", "children": [ - 4701, - 4702, - 4703, - 4704, - 4705, - 4706, - 4707, - 4708, - 4709, - 4710, - 4711, - 4712, - 4713, - 4714 - ] - }, - { - "title": "Variables", - "children": [ - 4715 + 5055, + 5056, + 5057, + 5058, + 5059, + 5060, + 5061, + 5062, + 5063, + 5064, + 5065, + 5066, + 5067, + 5068 ] }, { "title": "Functions", "children": [ - 4719, - 4721, - 4724, - 4726, - 4729, - 4732, - 4735, - 4738, - 4741, - 4744 + 5069, + 5071, + 5074, + 5080, + 5084, + 5087, + 5090, + 5093, + 5096, + 5099, + 5102 ] } ]