Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Adds S3 upload for separate ad asset bucket #1438

Closed
wants to merge 1 commit into from

Conversation

kanaabe
Copy link
Contributor

@kanaabe kanaabe commented Nov 14, 2017

Pair sesh with @eessex on getting display assets uploaded to a different bucket!

@artsy-peril
Copy link
Contributor

artsy-peril bot commented Nov 14, 2017

New dependencies added: aws-sdk.

aws-sdk

Author: Amazon Web Services

Description: AWS SDK for JavaScript

Homepage: https://github.com/aws/aws-sdk-js

Createdalmost 5 years ago
Last Updated1 day ago
LicenseApache-2.0
Maintainers13
Releases417
Direct Dependenciesbuffer, crypto-browserify, events, jmespath, querystring, sax, url, uuid, xml2js and xmlbuilder
Keywordsapi, amazon, aws, ec2, simpledb, s3, sqs, ses, sns, route53, rds, elasticache, cloudfront, fps, cloudformation, cloudwatch, dynamodb, iam, swf, autoscaling, cloudsearch, elb, loadbalancing, emr, mapreduce, importexport, storagegateway, workflow, ebs, vpc, beanstalk, glacier, kinesis, cloudtrail and waf
README

AWS SDK for JavaScript

NPM

Gitter chat

Version Build Status Coverage Status

The official AWS SDK for JavaScript, available for browsers and mobile devices,
or Node.js backends

For release notes, see the CHANGELOG. Prior to v2.4.8, release notes can be found at https://aws.amazon.com/releasenotes/?tag=releasenotes%23keywords%23javascript

If you are upgrading from 1.x to 2.0 of the SDK, please see the {file:UPGRADING.md} notes for information on how to migrate existing code to work with the new major version.

Installing

In the Browser

To use the SDK in the browser, simply add the following script tag to your
HTML pages:

<script src="https://sdk.amazonaws.com/js/aws-sdk-2.149.0.min.js"></script>

You can also build a custom browser SDK with your specified set of AWS services.
This can allow you to reduce the SDK's size, specify different API versions of
services, or use AWS services that don't currently support CORS if you are
working in an environment that does not enforce CORS. To get started:

http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/building-sdk-for-browsers.html

The AWS SDK is also compatible with browserify.

In Node.js

The preferred way to install the AWS SDK for Node.js is to use the
npm package manager for Node.js. Simply type the following
into a terminal window:

npm install aws-sdk

In React Native

To use the SDK in a react native project, first install the SDK using npm:

npm install aws-sdk

Then within your application, you can reference the react native compatible version of the SDK with the following:

var AWS = require('aws-sdk/dist/aws-sdk-react-native');

Using Bower

You can also use Bower to install the SDK by typing the
following into a terminal window:

bower install aws-sdk-js

Usage and Getting Started

You can find a getting started guide at:

http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide

Usage with TypeScript

The AWS SDK for JavaScript bundles TypeScript definition files for use in TypeScript projects and to support tools that can read .d.ts files.
Our goal is to keep these TypeScript definition files updated with each release for any public api.

Pre-requisites

Before you can begin using these TypeScript definitions with your project, you need to make sure your project meets a few of these requirements:

  • Use TypeScript v2.x

  • Includes the TypeScript definitions for node. You can use npm to install this by typing the following into a terminal window:

    npm install --save-dev @types/node
  • Your tsconfig.json or jsconfig.json includes 'dom' and 'es2015.promise' under compilerOptions.lib.
    See tsconfig.json for an example.

In the Browser

To use the TypeScript definition files with the global AWS object in a front-end project, add the following line to the top of your JavaScript file:

/// <reference types="aws-sdk" />

This will provide support for the global AWS object.

In Node.js

To use the TypeScript definition files within a Node.js project, simply import aws-sdk as you normally would.

In a TypeScript file:

// import entire SDK
import AWS = require('aws-sdk');
// import AWS object without services
import AWS = require('aws-sdk/global');
// import individual service
import S3 = require('aws-sdk/clients/s3');

In a JavaScript file:

// import entire SDK
var AWS = require('aws-sdk');
// import AWS object without services
var AWS = require('aws-sdk/global');
// import individual service
var S3 = require('aws-sdk/clients/s3');

With Angular

Due to the SDK's reliance on node.js typings, you may encounter compilation
issues when using the
typings provided by the SDK in an Angular project created using the Angular CLI.

To resolve these issues, either add "types": ["node"] to the project's tsconfig.app.json
file, or remove the "types" field entirely.

Known Limitations

There are a few known limitations with the bundled TypeScript definitions at this time:

  • Service client typings reflect the latest apiVersion, regardless of which apiVersion is specified when creating a client.
  • Service-bound parameters use the any type.

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.

  • Ask a question on StackOverflow and tag it with aws-sdk-js
  • Come join the AWS JavaScript community on gitter
  • Open a support ticket with AWS Support
  • If it turns out that you may have found a bug, please open an issue

Opening Issues

If you encounter a bug with the AWS SDK for JavaScript we would like to hear
about it. Search the existing issues
and try to make sure your problem doesn’t already exist before opening a new
issue. It’s helpful if you include the version of the SDK, Node.js or browser
environment and OS you’re using. Please include a stack trace and reduced repro
case when appropriate, too.

The GitHub issues are intended for bug reports and feature requests. For help
and questions with using the AWS SDK for JavaScript please make use of the
resources listed in the Getting Help
section. There are limited resources available for handling issues and by
keeping the list of open issues lean we can respond in a timely manner.

Supported Services

Please see SERVICES.md for a list of supported services.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE.txt and NOTICE.txt for more information.

Generated by 🚫 dangerJS

@kanaabe kanaabe self-assigned this Nov 14, 2017
@kanaabe
Copy link
Contributor Author

kanaabe commented Feb 9, 2018

So old, closing this.

@kanaabe kanaabe closed this Feb 9, 2018
@eessex
Copy link
Contributor

eessex commented Feb 9, 2018

we really should finish this! what were the missing steps?

@kanaabe
Copy link
Contributor Author

kanaabe commented Feb 9, 2018

Lol agree, but it's not being prioritized so no point in keeping it open. Feel free to work on it if you please! Branch is still there. I believe there's some cleanup and tests?

@eessex
Copy link
Contributor

eessex commented Feb 9, 2018

How can we get this on the list for working on in a sprint?

@kanaabe
Copy link
Contributor Author

kanaabe commented Feb 9, 2018

First step is to add it to the backlog, and then if there's similar work to be done in a sprint you can propose a project. People have proposed projects by posting in #dev or alternatively you can speak with a PM.

@kanaabe
Copy link
Contributor Author

kanaabe commented Feb 9, 2018

Do it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants