@aws-amplify/amplify-category-storage/API.md

amplify-cli storage plugin

## API Report File for "@aws-amplify/amplify-category-storage"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { $TSAny } from '@aws-amplify/amplify-cli-core';
import { $TSContext } from '@aws-amplify/amplify-cli-core';
import { IAmplifyResource } from '@aws-amplify/amplify-cli-core';

// @public (undocumented)
export function add(context: any, providerName: any, service: any): Promise<any>;

// @public (undocumented)
export function canResourceBeTransformed(context: $TSContext, resourceName: string): boolean;

// @public (undocumented)
export const category = "storage";

// @public (undocumented)
const console_2: (context: $TSContext) => Promise<void>;
export { console_2 as console }

// @public (undocumented)
export function executeAmplifyCommand(context: any): Promise<void>;

// @public (undocumented)
export const executeAmplifyHeadlessCommand: (context: $TSContext, headlessPayload: string) => Promise<void>;

// Warning: (ae-forgotten-export) The symbol "S3PermissionType" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function getDefaultAuthPermissions(): Promise<S3PermissionType[]>;

// @public (undocumented)
export function getPermissionPolicies(context: any, resourceOpsMapping: any): Promise<{
    permissionPolicies: any;
    resourceAttributes: any;
}>;

// @public (undocumented)
export function handleAmplifyEvent(context: $TSContext, args: $TSAny): Promise<void>;

// @public (undocumented)
export function initEnv(context: any): Promise<void>;

// @public (undocumented)
export function migrateStorageCategory(context: any): Promise<void>;

// @public (undocumented)
export function s3AddStorageLambdaTrigger(context: $TSContext, s3ResourceName: string, storageLambdaTrigger: S3UserInputTriggerFunctionParams): Promise<S3UserInputs>;

// @public (undocumented)
export function s3CreateStorageResource(context: $TSContext, storageInput: S3UserInputs): Promise<S3UserInputs>;

// Warning: (ae-forgotten-export) The symbol "S3AccessType" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function s3GetBucketUserInputDefault(project: $TSAny, shortId: string, accessType: S3AccessType): Promise<S3UserInputs>;

// @public (undocumented)
export function s3GetResourceName(): string | undefined;

// @public (undocumented)
export function s3GetUserInput(context: $TSContext, s3ResourceName: string): Promise<S3UserInputs>;

// @public (undocumented)
export function s3RegisterAdminTrigger(context: $TSContext, s3ResourceName: string, adminLambdaTrigger: S3UserInputTriggerFunctionParams): Promise<S3UserInputs>;

// @public (undocumented)
export function s3RemoveAdminLambdaTrigger(context: $TSContext, s3ResourceName: string): Promise<S3UserInputs>;

// @public (undocumented)
export function s3RemoveStorageLambdaTrigger(context: $TSContext, s3ResourceName: string): Promise<void>;

// @public (undocumented)
export interface S3UserInputs {
    // (undocumented)
    additionalTriggerFunctions?: S3UserInputTriggerFunctionParams[] | undefined;
    // (undocumented)
    adminTriggerFunction?: S3UserInputTriggerFunctionParams | undefined;
    // (undocumented)
    authAccess: S3PermissionType[];
    // (undocumented)
    bucketName: string | undefined;
    // Warning: (ae-forgotten-export) The symbol "GroupAccessType" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    groupAccess?: GroupAccessType | undefined;
    // (undocumented)
    guestAccess: S3PermissionType[];
    // (undocumented)
    policyUUID: string | undefined;
    // (undocumented)
    resourceName: string | undefined;
    // (undocumented)
    storageAccess: S3AccessType | undefined;
    // (undocumented)
    triggerFunction?: string | undefined;
}

// @public (undocumented)
export interface S3UserInputTriggerFunctionParams {
    // (undocumented)
    category: string;
    // (undocumented)
    permissions: S3PermissionType[];
    // (undocumented)
    tag?: string;
    // Warning: (ae-forgotten-export) The symbol "S3TriggerEventType" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    triggerEvents: S3TriggerEventType[];
    // (undocumented)
    triggerFunction: string;
    // Warning: (ae-forgotten-export) The symbol "S3TriggerPrefixType" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    triggerPrefix?: S3TriggerPrefixType[];
}

// @public (undocumented)
export function transformCategoryStack(context: $TSContext, resource: IAmplifyResource): Promise<void>;

// (No @packageDocumentation comment for this package)

```