controlla se esiste una chiave in un bucket in s3 usando boto3

Vorrei sapere se esiste una chiave in boto3. Posso eseguire il loop del contenuto del bucket e controllare la chiave se corrisponde.

Ma questo sembra più lungo e eccessivo. I documenti ufficiali di Boto3 affermano esplicitamente come farlo.

Forse mi manca l'ovvio. Qualcuno può indicarmi come posso raggiungere questo obiettivo.

L' boto.s3.key.Keyoggetto di Boto 2 aveva un existsmetodo che controllava l'esistenza della chiave su S3 eseguendo una richiesta HEAD e osservando il risultato, ma sembra che non esista più. Devi farlo da solo:

import boto3
import botocore

s3 = boto3.resource('s3')

try:
    s3.Object('my-bucket', 'dootdoot.jpg').load()
except botocore.exceptions.ClientError as e:
    if e.response['Error']['Code'] == "404":
        # The object does not exist.
        ...
    else:
        # Something else has gone wrong.
        raise
else:
    # The object does exist.
    ...

load() fa una richiesta HEAD per una singola chiave, che è veloce, anche se l'oggetto in questione è grande o se hai molti oggetti nel tuo bucket.

Certo, potresti verificare se l'oggetto esiste perché stai pianificando di usarlo. Se questo è il caso, puoi semplicemente dimenticare load()e fare un get()o download_file()direttamente, quindi gestire il caso di errore lì.

Non sono un grande fan dell'uso delle eccezioni per il flusso di controllo. Questo è un approccio alternativo che funziona in boto3:

import boto3

s3 = boto3.resource('s3')
bucket = s3.Bucket('my-bucket')
key = 'dootdoot.jpg'
objs = list(bucket.objects.filter(Prefix=key))
if any([w.key == path_s3 for w in objs]):
    print("Exists!")
else:
    print("Doesn't exist")

Il modo più semplice che ho trovato (e probabilmente il più efficiente) è questo:

import boto3
from botocore.errorfactory import ClientError

s3 = boto3.client('s3')
try:
    s3.head_object(Bucket='bucket_name', Key='file_path')
except ClientError:
    # Not found
    pass

In Boto3, se stai cercando una cartella (prefisso) o un file usando list_objects. È possibile utilizzare l'esistenza di "Contenuti" nel dict di risposta come controllo dell'esistenza dell'oggetto. È un altro modo per evitare il tentativo / tranne le catture come suggerisce @EvilPuppetMaster

import boto3
client = boto3.client('s3')
results = client.list_objects(Bucket='my-bucket', Prefix='dootdoot.jpg')
return 'Contents' in results

Non solo clientma bucketanche:

import boto3
import botocore
bucket = boto3.resource('s3', region_name='eu-west-1').Bucket('my-bucket')

try:
  bucket.Object('my-file').get()
except botocore.exceptions.ClientError as ex:
  if ex.response['Error']['Code'] == 'NoSuchKey':
    print('NoSuchKey')

È possibile utilizzare S3F , che è essenzialmente un wrapper per boto3 che espone le tipiche operazioni in stile file system:

import s3fs
s3 = s3fs.S3FileSystem()
s3.exists('myfile.txt')

import boto3
client = boto3.client('s3')
s3_key = 'Your file without bucket name e.g. abc/bcd.txt'
bucket = 'your bucket name'
content = client.head_object(Bucket=bucket,Key=s3_key)
    if content.get('ResponseMetadata',None) is not None:
        print "File exists - s3://%s/%s " %(bucket,s3_key) 
    else:
        print "File does not exist - s3://%s/%s " %(bucket,s3_key)

FWIW, ecco le funzioni molto semplici che sto usando

import boto3

def get_resource(config: dict={}):
    """Loads the s3 resource.

    Expects AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY to be in the environment
    or in a config dictionary.
    Looks in the environment first."""

    s3 = boto3.resource('s3',
                        aws_access_key_id=os.environ.get(
                            "AWS_ACCESS_KEY_ID", config.get("AWS_ACCESS_KEY_ID")),
                        aws_secret_access_key=os.environ.get("AWS_SECRET_ACCESS_KEY", config.get("AWS_SECRET_ACCESS_KEY")))
    return s3


def get_bucket(s3, s3_uri: str):
    """Get the bucket from the resource.
    A thin wrapper, use with caution.

    Example usage:

    >> bucket = get_bucket(get_resource(), s3_uri_prod)"""
    return s3.Bucket(s3_uri)


def isfile_s3(bucket, key: str) -> bool:
    """Returns T/F whether the file exists."""
    objs = list(bucket.objects.filter(Prefix=key))
    return len(objs) == 1 and objs[0].key == key


def isdir_s3(bucket, key: str) -> bool:
    """Returns T/F whether the directory exists."""
    objs = list(bucket.objects.filter(Prefix=key))
    return len(objs) > 1

Supponendo che tu voglia solo verificare se esiste una chiave (invece di sovrascriverla silenziosamente), fai prima questo controllo:

import boto3

def key_exists(mykey, mybucket):
  s3_client = boto3.client('s3')
  response = s3_client.list_objects_v2(Bucket=mybucket, Prefix=mykey)
  if response:
      for obj in response['Contents']:
          if mykey == obj['Key']:
              return True
  return False

if key_exists('someprefix/myfile-abc123', 'my-bucket-name'):
    print("key exists")
else:
    print("safe to put new bucket object")
    # try:
    #     resp = s3_client.put_object(Body="Your string or file-like object",
    #                                 Bucket=mybucket,Key=mykey)
    # ...check resp success and ClientError exception for errors...

Questo potrebbe controllare sia il prefisso che la chiave e recupera al massimo 1 chiave.

def prefix_exits(bucket, prefix):
    s3_client = boto3.client('s3')
    res = s3_client.list_objects_v2(Bucket=bucket, Prefix=prefix, MaxKeys=1)
    return 'Contents' in res

Prova questo semplice

import boto3
s3 = boto3.resource('s3')
bucket = s3.Bucket('mybucket_name') # just Bucket name
file_name = 'A/B/filename.txt'      # full file path
obj = list(bucket.objects.filter(Prefix=file_name))
if len(obj) > 0:
    print("Exists")
else:
    print("Not Exists")

Se hai meno di 1000 in una directory o bucket, puoi ottenerne un set e dopo controllare se tale chiave in questo set:

files_in_dir = {d['Key'].split('/')[-1] for d in s3_client.list_objects_v2(
Bucket='mybucket',
Prefix='my/dir').get('Contents') or []}

Tale codice funziona anche se my/dirnon esiste.

http://boto3.readthedocs.io/en/latest/reference/services/s3.html#S3.Client.list_objects_v2

S3_REGION="eu-central-1"
bucket="mybucket1"
name="objectname"

import boto3
from botocore.client import Config
client = boto3.client('s3',region_name=S3_REGION,config=Config(signature_version='s3v4'))
list = client.list_objects_v2(Bucket=bucket,Prefix=name)
for obj in list.get('Contents', []):
    if obj['Key'] == name: return True
return False

Per boto3, ObjectSummary può essere utilizzato per verificare l'esistenza di un oggetto.

Contiene il riepilogo di un oggetto archiviato in un bucket Amazon S3. Questo oggetto non contiene i metadati completi dell'oggetto o il suo contenuto

import boto3
from botocore.errorfactory import ClientError
def path_exists(path, bucket_name):
    """Check to see if an object exists on S3"""
    s3 = boto3.resource('s3')
    try:
        s3.ObjectSummary(bucket_name=bucket_name, key=path).load()
    except ClientError as e:
        if e.response['Error']['Code'] == "404":
            return False
        else:
            raise e
    return True

path_exists('path/to/file.html')

In ObjectSummary.load

Chiama s3.Client.head_object per aggiornare gli attributi della risorsa ObjectSummary.

Ciò dimostra che è possibile utilizzare ObjectSummaryanziché Objectse si prevede di non utilizzare get(). La load()funzione non recupera l'oggetto ma ottiene solo il riepilogo.

Ecco una soluzione che funziona per me. Un avvertimento è che conosco in anticipo il formato esatto della chiave, quindi sto solo elencando il singolo file

import boto3

# The s3 base class to interact with S3
class S3(object):
  def __init__(self):
    self.s3_client = boto3.client('s3')

  def check_if_object_exists(self, s3_bucket, s3_key):
    response = self.s3_client.list_objects(
      Bucket = s3_bucket,
      Prefix = s3_key
      )
    if 'ETag' in str(response):
      return True
    else:
      return False

if __name__ == '__main__':
  s3  = S3()
  if s3.check_if_object_exists(bucket, key):
    print "Found S3 object."
  else:
    print "No object found."

puoi usare Boto3 per questo.

import boto3
s3 = boto3.resource('s3')
bucket = s3.Bucket('my-bucket')
objs = list(bucket.objects.filter(Prefix=key))
if(len(objs)>0):
    print("key exists!!")
else:
    print("key doesn't exist!")

Qui chiave è il percorso che si desidera verificare esiste o meno

È davvero semplice con il get()metodo

import botocore
from boto3.session import Session
session = Session(aws_access_key_id='AWS_ACCESS_KEY',
                aws_secret_access_key='AWS_SECRET_ACCESS_KEY')
s3 = session.resource('s3')
bucket_s3 = s3.Bucket('bucket_name')

def not_exist(file_key):
    try:
        file_details = bucket_s3.Object(file_key).get()
        # print(file_details) # This line prints the file details
        return False
    except botocore.exceptions.ClientError as e:
        if e.response['Error']['Code'] == "NoSuchKey": # or you can check with e.reponse['HTTPStatusCode'] == '404'
            return True
        return False # For any other error it's hard to determine whether it exists or not. so based on the requirement feel free to change it to True/ False / raise Exception

print(not_exist('hello_world.txt')) 

Esiste un modo semplice per verificare se il file esiste o meno nel bucket S3. Non è necessario utilizzare l'eccezione per questo

sesssion = boto3.Session(aws_access_key_id, aws_secret_access_key)
s3 = session.client('s3')

object_name = 'filename'
bucket = 'bucketname'
obj_status = s3.list_objects(Bucket = bucket, Prefix = object_name)
if obj_status.get('Contents'):
    print("File exists")
else:
    print("File does not exists")

Se si cerca una chiave equivalente a una directory, è possibile che si desideri questo approccio

session = boto3.session.Session()
resource = session.resource("s3")
bucket = resource.Bucket('mybucket')

key = 'dir-like-or-file-like-key'
objects = [o for o in bucket.objects.filter(Prefix=key).limit(1)]    
has_key = len(objects) > 0

Funziona con una chiave padre o una chiave che equivale a un file o una chiave che non esiste. Ho provato l'approccio preferito sopra e non sono riuscito sulle chiavi padre.

Ho notato che solo per catturare l'eccezione usando botocore.exceptions.ClientErrordobbiamo installare botocore. botocore occupa 36M di spazio su disco. Ciò ha un impatto particolare se usiamo le funzioni di aws lambda. Al posto di ciò se usiamo solo l'eccezione, possiamo saltare usando la libreria extra!

• Sto convalidando che l'estensione del file sia '.csv'
• Ciò non genererà un'eccezione se il bucket non esiste!
• Ciò non genererà un'eccezione se il bucket esiste ma l'oggetto non esiste!
• Questo genera un'eccezione se il secchio è vuoto!
• Questo genera un'eccezione se il bucket non ha autorizzazioni!

Il codice è simile al seguente. Per favore, condividi i tuoi pensieri:

import boto3
import traceback

def download4mS3(s3bucket, s3Path, localPath):
    s3 = boto3.resource('s3')

    print('Looking for the csv data file ending with .csv in bucket: ' + s3bucket + ' path: ' + s3Path)
    if s3Path.endswith('.csv') and s3Path != '':
        try:
            s3.Bucket(s3bucket).download_file(s3Path, localPath)
        except Exception as e:
            print(e)
            print(traceback.format_exc())
            if e.response['Error']['Code'] == "404":
                print("Downloading the file from: [", s3Path, "] failed")
                exit(12)
            else:
                raise
        print("Downloading the file from: [", s3Path, "] succeeded")
    else:
        print("csv file not found in in : [", s3Path, "]")
        exit(12)

Solo seguendo il thread, qualcuno può concludere qual è il modo più efficiente per verificare se esiste un oggetto in S3?

Penso che head_object potrebbe vincere in quanto controlla solo i metadati che sono più leggeri dell'oggetto reale stesso

Da https://www.peterbe.com/plog/fastest-way-to-find-out-if-a-file-exists-in-s3 questo è indicato per essere il metodo più veloce:

import boto3

boto3_session = boto3.session.Session()
s3_session_client = boto3_session.client("s3")
response = s3_session_client.list_objects_v2(
    Bucket=bc_df_caches_bucket, Prefix=s3_key
)
for obj in response.get("Contents", []):
    if obj["Key"] == s3_key:
        return True
return False

Check-out

bucket.get_key(
    key_name, 
    headers=None, 
    version_id=None, 
    response_headers=None, 
    validate=True
)

Controlla se esiste una chiave particolare all'interno del bucket. Questo metodo utilizza una richiesta HEAD per verificare l'esistenza della chiave. Restituisce: un'istanza di un oggetto Key o None

da Boto S3 Docs

Puoi semplicemente chiamare bucket.get_key (nome chiave) e verificare se l'oggetto restituito è Nessuno.