• Parameters

    • configuration: GCSConfiguration
    • storage_gateway_id: string
    • Optionaloptions: {
          query?: {
              include?: ("private_policies" | "accounts")[];
          };
      } & {
          headers?: Headers;
          query?: {
              [key: string]:
                  | string
                  | number
                  | boolean
                  | (
                      | string
                      | number
                      | null
                      | undefined)[]
                  | null
                  | undefined;
          };
      }
    • OptionalsdkOptions: SDKOptions

    Returns Promise<JSONFetchResponse<{
        code?: "success";
        data?: ({
            allowed_domains?: string[];
            authentication_assurance_timeout?: null | number;
            authentication_timeout_mins?: null | number;
            connector_id?: string;
            DATA_TYPE: "storage_gateway#1.0.0";
            deleted?: boolean;
            display_name?: string;
            high_assurance?: null | boolean;
            id?: string;
            identity_mappings?: null | ((...) | (...))[];
            load_dsi_module?: null | string;
            policies?:
                | {
                    DATA_TYPE: "s3_storage_policies#1.0.0";
                    s3_buckets?: (...) | (...);
                    s3_endpoint?: (...) | (...);
                    s3_user_credential_required?: (...) | (...) | (...);
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.1.0";
                    s3_buckets?: (...) | (...);
                    s3_endpoint?: (...) | (...);
                    s3_requester_pays?: (...) | (...) | (...);
                    s3_user_credential_required?: (...) | (...) | (...);
                }
                | {
                    account: (...) | (...);
                    adls: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    auth_type: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                    secret: (...) | (...);
                    tenant: (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    account: (...) | (...);
                    adls: (...) | (...) | (...);
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    auth_type: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                    secret: (...) | (...);
                    tenant: (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    bp_access_id_file?: (...) | (...);
                    DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                    s3_endpoint?: (...) | (...);
                }
                | {
                    boxAppSettings: {
                        appAuth: ...;
                        clientID: ...;
                        clientSecret: ...;
                    };
                    DATA_TYPE: "box_storage_policies#1.0.0";
                    enterpriseID: string;
                }
                | {
                    auth_callback?: (...) | (...);
                    boxAppSettings?: (...) | (...);
                    client_id?: (...) | (...);
                    DATA_TYPE: "box_storage_policies#1.1.0";
                    enterpriseID?: (...) | (...);
                    secret?: (...) | (...);
                    user_api_rate_limit?: (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    boxAppSettings?: (...) | (...);
                    client_id?: (...) | (...);
                    DATA_TYPE: "box_storage_policies#1.2.0";
                    enterpriseID?: (...) | (...);
                    secret?: (...) | (...);
                    user_api_rate_limit?: (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    ceph_admin_key_id?: (...) | (...);
                    ceph_admin_secret_key?: (...) | (...);
                    DATA_TYPE: "ceph_storage_policies#1.0.0";
                    s3_buckets?: (...) | (...);
                    s3_endpoint?: (...) | (...);
                }
                | {
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "dropbox_storage_policies#1.0.0";
                    secret: (...) | (...);
                    user_api_rate_limit?: (...) | (...);
                }
                | {
                    auth_callback?: (...) | (...);
                    buckets?: (...) | (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                    projects?: (...) | (...) | (...);
                    secret: (...) | (...);
                    service_account_key?: (...) | (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    buckets?: (...) | (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                    projects?: (...) | (...) | (...);
                    secret: (...) | (...);
                    service_account_key?: (...) | (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    auth_callback?: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "google_drive_storage_policies#1.0.0";
                    secret: (...) | (...);
                    user_api_rate_quota?: (...) | (...);
                }
                | {
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "google_drive_storage_policies#1.1.0";
                    secret: (...) | (...);
                    user_api_rate_quota?: (...) | (...);
                }
                | {
                    authentication_mech: (...) | (...);
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.0.0";
                    uda_checksum: boolean;
                }
                | {
                    authentication_mech: (...) | (...);
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.1.0";
                    login_name?: (...) | (...);
                    uda_checksum: boolean;
                }
                | {
                    DATA_TYPE: "irods_storage_policies#1.0.0";
                    environment?: (...) | (...);
                    irods_authentication_file?: (...) | (...);
                    irods_environment_file: string;
                }
                | {
                    auth_callback?: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "onedrive_storage_policies#1.0.0";
                    secret: (...) | (...);
                    tenant?: (...) | (...) | (...);
                    user_api_rate_limit?: (...) | (...);
                }
                | {
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "onedrive_storage_policies#1.1.0";
                    secret: (...) | (...);
                    tenant?: (...) | (...) | (...);
                    user_api_rate_limit?: (...) | (...);
                }
                | {
                    DATA_TYPE: "posix_storage_policies#1.0.0";
                    groups_allow?: (...) | (...) | (...);
                    groups_deny?: (...) | (...) | (...);
                }
                | {
                    DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                    environment?: (...) | (...);
                    groups_allow?: (...) | (...) | (...);
                    groups_deny?: (...) | (...) | (...);
                    stage_app: string;
                };
            process_user?: null | string;
            require_high_assurance?: null | boolean;
            restrict_paths?: unknown;
            users_allow?: null | string[];
            users_deny?: null | string[];
        } | {
            allowed_domains?: string[];
            authentication_assurance_timeout?: null | number;
            authentication_timeout_mins?: null | number;
            connector_id?: string;
            DATA_TYPE: "storage_gateway#1.1.0";
            deleted?: boolean;
            display_name?: string;
            high_assurance?: null | boolean;
            id?: string;
            identity_mappings?: null | ((...) | (...))[];
            load_dsi_module?: null | string;
            policies?:
                | {
                    DATA_TYPE: "s3_storage_policies#1.0.0";
                    s3_buckets?: (...) | (...);
                    s3_endpoint?: (...) | (...);
                    s3_user_credential_required?: (...) | (...) | (...);
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.1.0";
                    s3_buckets?: (...) | (...);
                    s3_endpoint?: (...) | (...);
                    s3_requester_pays?: (...) | (...) | (...);
                    s3_user_credential_required?: (...) | (...) | (...);
                }
                | {
                    account: (...) | (...);
                    adls: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    auth_type: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                    secret: (...) | (...);
                    tenant: (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    account: (...) | (...);
                    adls: (...) | (...) | (...);
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    auth_type: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                    secret: (...) | (...);
                    tenant: (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    bp_access_id_file?: (...) | (...);
                    DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                    s3_endpoint?: (...) | (...);
                }
                | {
                    boxAppSettings: {
                        appAuth: ...;
                        clientID: ...;
                        clientSecret: ...;
                    };
                    DATA_TYPE: "box_storage_policies#1.0.0";
                    enterpriseID: string;
                }
                | {
                    auth_callback?: (...) | (...);
                    boxAppSettings?: (...) | (...);
                    client_id?: (...) | (...);
                    DATA_TYPE: "box_storage_policies#1.1.0";
                    enterpriseID?: (...) | (...);
                    secret?: (...) | (...);
                    user_api_rate_limit?: (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    boxAppSettings?: (...) | (...);
                    client_id?: (...) | (...);
                    DATA_TYPE: "box_storage_policies#1.2.0";
                    enterpriseID?: (...) | (...);
                    secret?: (...) | (...);
                    user_api_rate_limit?: (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    ceph_admin_key_id?: (...) | (...);
                    ceph_admin_secret_key?: (...) | (...);
                    DATA_TYPE: "ceph_storage_policies#1.0.0";
                    s3_buckets?: (...) | (...);
                    s3_endpoint?: (...) | (...);
                }
                | {
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "dropbox_storage_policies#1.0.0";
                    secret: (...) | (...);
                    user_api_rate_limit?: (...) | (...);
                }
                | {
                    auth_callback?: (...) | (...);
                    buckets?: (...) | (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                    projects?: (...) | (...) | (...);
                    secret: (...) | (...);
                    service_account_key?: (...) | (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    buckets?: (...) | (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                    projects?: (...) | (...) | (...);
                    secret: (...) | (...);
                    service_account_key?: (...) | (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    auth_callback?: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "google_drive_storage_policies#1.0.0";
                    secret: (...) | (...);
                    user_api_rate_quota?: (...) | (...);
                }
                | {
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "google_drive_storage_policies#1.1.0";
                    secret: (...) | (...);
                    user_api_rate_quota?: (...) | (...);
                }
                | {
                    authentication_mech: (...) | (...);
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.0.0";
                    uda_checksum: boolean;
                }
                | {
                    authentication_mech: (...) | (...);
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.1.0";
                    login_name?: (...) | (...);
                    uda_checksum: boolean;
                }
                | {
                    DATA_TYPE: "irods_storage_policies#1.0.0";
                    environment?: (...) | (...);
                    irods_authentication_file?: (...) | (...);
                    irods_environment_file: string;
                }
                | {
                    auth_callback?: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "onedrive_storage_policies#1.0.0";
                    secret: (...) | (...);
                    tenant?: (...) | (...) | (...);
                    user_api_rate_limit?: (...) | (...);
                }
                | {
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "onedrive_storage_policies#1.1.0";
                    secret: (...) | (...);
                    tenant?: (...) | (...) | (...);
                    user_api_rate_limit?: (...) | (...);
                }
                | {
                    DATA_TYPE: "posix_storage_policies#1.0.0";
                    groups_allow?: (...) | (...) | (...);
                    groups_deny?: (...) | (...) | (...);
                }
                | {
                    DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                    environment?: (...) | (...);
                    groups_allow?: (...) | (...) | (...);
                    groups_deny?: (...) | (...) | (...);
                    stage_app: string;
                };
            process_user?: null | string;
            require_high_assurance?: null | boolean;
            require_mfa?: boolean;
            restrict_paths?: unknown;
            users_allow?: null | string[];
            users_deny?: null | string[];
        } | {
            admin_managed_credentials?: boolean;
            allowed_domains?: string[];
            authentication_assurance_timeout?: null | number;
            authentication_timeout_mins?: null | number;
            connector_id?: string;
            DATA_TYPE: "storage_gateway#1.2.0";
            deleted?: boolean;
            display_name?: string;
            high_assurance?: null | boolean;
            id?: string;
            identity_mappings?: null | ((...) | (...))[];
            load_dsi_module?: null | string;
            policies?:
                | {
                    DATA_TYPE: "s3_storage_policies#1.0.0";
                    s3_buckets?: (...) | (...);
                    s3_endpoint?: (...) | (...);
                    s3_user_credential_required?: (...) | (...) | (...);
                }
                | {
                    DATA_TYPE: "s3_storage_policies#1.1.0";
                    s3_buckets?: (...) | (...);
                    s3_endpoint?: (...) | (...);
                    s3_requester_pays?: (...) | (...) | (...);
                    s3_user_credential_required?: (...) | (...) | (...);
                }
                | {
                    account: (...) | (...);
                    adls: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    auth_type: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "azure_blob_storage_policies#1.0.0";
                    secret: (...) | (...);
                    tenant: (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    account: (...) | (...);
                    adls: (...) | (...) | (...);
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    auth_type: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "azure_blob_storage_policies#1.1.0";
                    secret: (...) | (...);
                    tenant: (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    bp_access_id_file?: (...) | (...);
                    DATA_TYPE: "blackpearl_storage_policies#1.0.0";
                    s3_endpoint?: (...) | (...);
                }
                | {
                    boxAppSettings: {
                        appAuth: ...;
                        clientID: ...;
                        clientSecret: ...;
                    };
                    DATA_TYPE: "box_storage_policies#1.0.0";
                    enterpriseID: string;
                }
                | {
                    auth_callback?: (...) | (...);
                    boxAppSettings?: (...) | (...);
                    client_id?: (...) | (...);
                    DATA_TYPE: "box_storage_policies#1.1.0";
                    enterpriseID?: (...) | (...);
                    secret?: (...) | (...);
                    user_api_rate_limit?: (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    boxAppSettings?: (...) | (...);
                    client_id?: (...) | (...);
                    DATA_TYPE: "box_storage_policies#1.2.0";
                    enterpriseID?: (...) | (...);
                    secret?: (...) | (...);
                    user_api_rate_limit?: (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    ceph_admin_key_id?: (...) | (...);
                    ceph_admin_secret_key?: (...) | (...);
                    DATA_TYPE: "ceph_storage_policies#1.0.0";
                    s3_buckets?: (...) | (...);
                    s3_endpoint?: (...) | (...);
                }
                | {
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "dropbox_storage_policies#1.0.0";
                    secret: (...) | (...);
                    user_api_rate_limit?: (...) | (...);
                }
                | {
                    auth_callback?: (...) | (...);
                    buckets?: (...) | (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "google_cloud_storage_policies#1.0.0";
                    projects?: (...) | (...) | (...);
                    secret: (...) | (...);
                    service_account_key?: (...) | (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    buckets?: (...) | (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "google_cloud_storage_policies#1.1.0";
                    projects?: (...) | (...) | (...);
                    secret: (...) | (...);
                    service_account_key?: (...) | (...) | (...);
                    user_credential_required?: (...) | (...) | (...);
                }
                | {
                    auth_callback?: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "google_drive_storage_policies#1.0.0";
                    secret: (...) | (...);
                    user_api_rate_quota?: (...) | (...);
                }
                | {
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "google_drive_storage_policies#1.1.0";
                    secret: (...) | (...);
                    user_api_rate_quota?: (...) | (...);
                }
                | {
                    authentication_mech: (...) | (...);
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.0.0";
                    uda_checksum: boolean;
                }
                | {
                    authentication_mech: (...) | (...);
                    authenticator: string;
                    DATA_TYPE: "hpss_storage_policies#1.1.0";
                    login_name?: (...) | (...);
                    uda_checksum: boolean;
                }
                | {
                    DATA_TYPE: "irods_storage_policies#1.0.0";
                    environment?: (...) | (...);
                    irods_authentication_file?: (...) | (...);
                    irods_environment_file: string;
                }
                | {
                    auth_callback?: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "onedrive_storage_policies#1.0.0";
                    secret: (...) | (...);
                    tenant?: (...) | (...) | (...);
                    user_api_rate_limit?: (...) | (...);
                }
                | {
                    allow_any_account?: (...) | (...) | (...);
                    auth_callback?: (...) | (...);
                    client_id: (...) | (...);
                    DATA_TYPE: "onedrive_storage_policies#1.1.0";
                    secret: (...) | (...);
                    tenant?: (...) | (...) | (...);
                    user_api_rate_limit?: (...) | (...);
                }
                | {
                    DATA_TYPE: "posix_storage_policies#1.0.0";
                    groups_allow?: (...) | (...) | (...);
                    groups_deny?: (...) | (...) | (...);
                }
                | {
                    DATA_TYPE: "posix_staging_storage_policies#1.0.0";
                    environment?: (...) | (...);
                    groups_allow?: (...) | (...) | (...);
                    groups_deny?: (...) | (...) | (...);
                    stage_app: string;
                };
            process_user?: null | string;
            require_high_assurance?: null | boolean;
            require_mfa?: boolean;
            restrict_paths?: unknown;
            users_allow?: null | string[];
            users_deny?: null | string[];
        })[];
    } & ({
        code: string;
        data?: Record<string, unknown>[];
        DATA_TYPE: "result#1.0.0";
        detail?: unknown;
        has_next_page?: boolean;
        http_response_code: number;
        marker?: null | string;
        message?: string;
    } | {
        authorization_parameters?: null | {
            [key: string]: unknown;
        };
        code: string;
        data?: Record<string, unknown>[];
        DATA_TYPE: "result#1.1.0";
        detail?: unknown;
        has_next_page?: boolean;
        http_response_code: number;
        marker?: null | string;
        message?: string;
    })>>