Ejemplos de Amazon S3 Control que utilizan la AWS CLI

Para crear un punto de acceso

En el siguiente ejemplo de create-access-point, se crea un punto de acceso denominado finance-ap para el bucket business-records de la cuenta 123456789012. Antes de ejecutar este ejemplo, reemplace el nombre del punto de acceso, el nombre del bucket y el número de cuenta con valores adecuados para su caso de uso.

aws s3control create-access-point \
    --account-id 123456789012 \
    --bucket business-records \
    --name finance-ap

Este comando no genera ninguna salida.

Para obtener más información, consulte Crear puntos de acceso en la Guía del usuario de Amazon Simple Storage Service.

Para crear un trabajo de Operaciones por lotes de Amazon S3

En el siguiente ejemplo de create-job, se crea un trabajo de operaciones por lotes de Amazon S3 para etiquetar objetos como confidential` in the bucket ``employee-records.

aws s3control create-job \
    --account-id 123456789012 \
    --operation '{"S3PutObjectTagging": { "TagSet": [{"Key":"confidential", "Value":"true"}] }}' \
    --report '{"Bucket":"arn:aws:s3:::employee-records-logs","Prefix":"batch-op-create-job", "Format":"Report_CSV_20180820","Enabled":true,"ReportScope":"AllTasks"}' \
    --manifest '{"Spec":{"Format":"S3BatchOperations_CSV_20180820","Fields":["Bucket","Key"]},"Location":{"ObjectArn":"arn:aws:s3:::employee-records-logs/inv-report/7a6a9be4-072c-407e-85a2-ec3e982f773e.csv","ETag":"69f52a4e9f797e987155d9c8f5880897"}}' \
    --priority 42 \
    --role-arn arn:aws:iam::123456789012:role/S3BatchJobRole

Salida:

{
    "JobId": "93735294-df46-44d5-8638-6356f335324e"
}

Para eliminar una política de punto de acceso

En el siguiente ejemplo de delete-access-point-policy, se elimina la política de puntos de acceso del punto de acceso denominado finance-ap en la cuenta 123456789012. Antes de ejecutar este ejemplo, reemplace el nombre del punto de acceso y el número de cuenta con valores adecuados para su caso de uso.

aws s3control delete-access-point-policy \
    --account-id 123456789012 \
    --name finance-ap

Este comando no genera ninguna salida.

Para obtener más información, consulte Administración del acceso a conjuntos de datos compartidos con puntos de acceso en la Guía del usuario de Amazon Simple Storage Service.

Para eliminar un punto de acceso

En el ejemplo siguiente de delete-access-point, se elimina un punto de acceso denominado finance-ap de la cuenta 123456789012. Antes de ejecutar este ejemplo, reemplace el nombre del punto de acceso y el número de cuenta con valores adecuados para su caso de uso.

aws s3control delete-access-point \
    --account-id 123456789012 \
    --name finance-ap

Este comando no genera ninguna salida.

Para obtener más información, consulte Administración del acceso a conjuntos de datos compartidos con puntos de acceso en la Guía del usuario de Amazon Simple Storage Service.

Para eliminar la configuración de Bloqueo de acceso público de una cuenta

En el siguiente ejemplo de delete-public-access-block, se elimina la configuración de bloqueo de acceso público de la cuenta especificada.

aws s3control delete-public-access-block \
    --account-id 123456789012

Este comando no genera ninguna salida.

Para describir un trabajo de Operaciones por lotes de Amazon S3

En el siguiente ejemplo de describe-job, se proporcionan los parámetros de configuración y el estado del trabajo de operaciones por lotes especificado.

aws s3control describe-job \
    --account-id 123456789012 \
    --job-id 93735294-df46-44d5-8638-6356f335324e

Salida:

{
    "Job": {
        "TerminationDate": "2019-10-03T21:49:53.944Z",
        "JobId": "93735294-df46-44d5-8638-6356f335324e",
        "FailureReasons": [],
        "Manifest": {
            "Spec": {
                "Fields": [
                    "Bucket",
                    "Key"
                ],
                "Format": "S3BatchOperations_CSV_20180820"
            },
            "Location": {
                "ETag": "69f52a4e9f797e987155d9c8f5880897",
                "ObjectArn": "arn:aws:s3:::employee-records-logs/inv-report/7a6a9be4-072c-407e-85a2-ec3e982f773e.csv"
            }
        },
        "Operation": {
            "S3PutObjectTagging": {
                "TagSet": [
                    {
                        "Value": "true",
                        "Key": "confidential"
                    }
                ]
            }
        },
        "RoleArn": "arn:aws:iam::123456789012:role/S3BatchJobRole",
        "ProgressSummary": {
            "TotalNumberOfTasks": 8,
            "NumberOfTasksFailed": 0,
            "NumberOfTasksSucceeded": 8
        },
        "Priority": 42,
        "Report": {
            "ReportScope": "AllTasks",
            "Format": "Report_CSV_20180820",
            "Enabled": true,
            "Prefix": "batch-op-create-job",
            "Bucket": "arn:aws:s3:::employee-records-logs"
        },
        "JobArn": "arn:aws:s3:us-west-2:123456789012:job/93735294-df46-44d5-8638-6356f335324e",
        "CreationTime": "2019-10-03T21:48:48.048Z",
        "Status": "Complete"
    }
}

Para recuperar el estado de la política del punto de acceso

En el siguiente ejemplo de get-access-point-policy-status, se recupera el estado de la política de puntos de acceso del punto de acceso denominado finance-ap en la cuenta 123456789012. El estado de la política del punto de acceso indica si la política del punto de acceso permite el acceso público. Antes de ejecutar este ejemplo, reemplace el nombre del punto de acceso y el número de cuenta con valores adecuados para su caso de uso.

aws s3control get-access-point-policy-status \
    --account-id 123456789012 \
    --name finance-ap

Salida:

{
    "PolicyStatus": {
        "IsPublic": false
    }
}

Para obtener más información acerca de cuándo se considera que una política de punto de acceso es pública, consulte la sección Qué significa "pública" en la Guía del usuario de Amazon Simple Storage Service.

Para recuperar una política de punto de acceso

En el siguiente ejemplo de get-access-point-policy, se recupera la política del punto de acceso del punto de acceso denominado finance-ap en la cuenta 123456789012. Antes de ejecutar este ejemplo, reemplace el nombre del punto de acceso y el número de cuenta con valores adecuados para su caso de uso.

aws s3control get-access-point-policy \
    --account-id 123456789012 \
    --name finance-ap

Salida:

{
    "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:role/Admin\"},\"Action\":\"s3:GetObject\",\"Resource\":\"arn:aws:s3:us-west-2:123456789012:accesspoint/finance-ap/object/records/*\"}]}"
}

Para obtener más información, consulte Administración del acceso a conjuntos de datos compartidos con puntos de acceso en la Guía del usuario de Amazon Simple Storage Service.

Para recuperar los detalles de configuración del punto de acceso

En el siguiente ejemplo de get-access-point, se recuperan los detalles de configuración del punto de acceso denominado finance-ap en la cuenta 123456789012. Antes de ejecutar este ejemplo, reemplace el nombre del punto de acceso y el número de cuenta con valores adecuados para su caso de uso.

aws s3control get-access-point \
    --account-id 123456789012 \
    --name finance-ap

Salida:

{
    "Name": "finance-ap",
    "Bucket": "business-records",
    "NetworkOrigin": "Internet",
    "PublicAccessBlockConfiguration": {
        "BlockPublicAcls": false,
        "IgnorePublicAcls": false,
        "BlockPublicPolicy": false,
        "RestrictPublicBuckets": false
    },
    "CreationDate": "2020-01-01T00:00:00Z"
}

Para obtener más información, consulte Administración del acceso a conjuntos de datos compartidos con puntos de acceso en la Guía del usuario de Amazon Simple Storage Service.

Para consultar la configuración actual de enrutamiento del punto de acceso de varias regiones

En el siguiente ejemplo de get-multi-region-access-point-routes, se devuelve la configuración actual de la ruta del punto de acceso multirregional especificado.

aws s3control get-multi-region-access-point-routes \
    --region Region \
    --account-id 111122223333 \
    --mrap MultiRegionAccessPoint_ARN

Salida:

{
    "Mrap": "arn:aws:s3::111122223333:accesspoint/0000000000000.mrap",
    "Routes": [
        {
            "Bucket": "amzn-s3-demo-bucket1",
            "Region": "ap-southeast-2",
            "TrafficDialPercentage": 100
        },
        {
            "Bucket": "amzn-s3-demo-bucket2",
            "Region": "us-west-1",
            "TrafficDialPercentage": 0
        }
    ]
}

Para enumerar la configuración de Bloqueo de acceso público de una cuenta

En el siguiente ejemplo de get-public-access-block, se muestra la configuración de bloqueo de acceso público de la cuenta especificada.

aws s3control get-public-access-block \
    --account-id 123456789012

Salida:

{
   "PublicAccessBlockConfiguration": {
      "BlockPublicPolicy": true,
      "RestrictPublicBuckets": true,
      "IgnorePublicAcls": true,
      "BlockPublicAcls": true
   }
}

Ejemplo 1: recuperación de una lista de todos los puntos de acceso para una cuenta

En el siguiente ejemplo de list-access-points, se muestra una lista de todos los puntos de acceso asociados a los buckets propiedad de la cuenta 123456789012.

aws s3control list-access-points \
    --account-id 123456789012

Salida:

{
    "AccessPointList": [
        {
            "Name": "finance-ap",
            "NetworkOrigin": "Internet",
            "Bucket": "business-records"
        },
        {
            "Name": "managers-ap",
            "NetworkOrigin": "Internet",
            "Bucket": "business-records"
        },
        {
            "Name": "private-network-ap",
            "NetworkOrigin": "VPC",
            "VpcConfiguration": {
                "VpcId": "1a2b3c"
            },
            "Bucket": "business-records"
        },
        {
            "Name": "customer-ap",
            "NetworkOrigin": "Internet",
            "Bucket": "external-docs"
        },
        {
            "Name": "public-ap",
            "NetworkOrigin": "Internet",
            "Bucket": "external-docs"
        }
    ]
}

Ejemplo 2: recuperación de una lista de todos los puntos de acceso para un bucket

En el siguiente ejemplo de list-access-points, se recupera una lista de todos los puntos de acceso asociados al bucket external-docs propiedad de la cuenta 123456789012.

aws s3control list-access-points \
    --account-id 123456789012 \
    --bucket external-docs

Salida:

{
    "AccessPointList": [
        {
            "Name": "customer-ap",
            "NetworkOrigin": "Internet",
            "Bucket": "external-docs"
        },
        {
            "Name": "public-ap",
            "NetworkOrigin": "Internet",
            "Bucket": "external-docs"
        }
    ]
}

Para obtener más información, consulte Administración del acceso a conjuntos de datos compartidos con puntos de acceso en la Guía del usuario de Amazon Simple Storage Service.

Para enumerar los trabajos de Operaciones por lotes de Amazon S3 de una cuenta

En el siguiente ejemplo de list-jobs, se muestran todos los trabajos de operaciones por lotes recientes de la cuenta especificada.

aws s3control list-jobs \
    --account-id 123456789012

Salida:

{
    "Jobs": [
        {
            "Operation": "S3PutObjectTagging",
            "ProgressSummary": {
                "NumberOfTasksFailed": 0,
                "NumberOfTasksSucceeded": 8,
                "TotalNumberOfTasks": 8
            },
            "CreationTime": "2019-10-03T21:48:48.048Z",
            "Status": "Complete",
            "JobId": "93735294-df46-44d5-8638-6356f335324e",
            "Priority": 42
        },
        {
            "Operation": "S3PutObjectTagging",
            "ProgressSummary": {
                "NumberOfTasksFailed": 0,
                "NumberOfTasksSucceeded": 0,
                "TotalNumberOfTasks": 0
            },
            "CreationTime": "2019-10-03T21:46:07.084Z",
            "Status": "Failed",
            "JobId": "3f3c7619-02d3-4779-97f6-1d98dd313108",
            "Priority": 42
        },
    ]
}

Para definir una política de punto de acceso

En el siguiente ejemplo de put-access-point-policy, se coloca la política de puntos de acceso especificada para el punto de acceso finance-ap en la cuenta 123456789012. Si el punto de acceso finance-ap ya tiene una política, este comando reemplaza la política existente por la especificada en este comando. Antes de ejecutar este ejemplo, reemplace el nombre de la cuenta, el nombre del punto de acceso y las instrucciones de la política con valores adecuados para su caso de uso.

aws s3control put-access-point-policy \
    --account-id 123456789012 \
    --name finance-ap \
    --policy file://ap-policy.json

Contenido de ap-policy.json:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {
                "AWS": "arn:aws:iam::123456789012:user/Alice"
            },
            "Action": "s3:GetObject",
            "Resource": "arn:aws:s3:us-west-2:123456789012:accesspoint/finance-ap/object/Alice/*"
        }
    ]
}

Este comando no genera ninguna salida.

Para obtener más información, consulte Administración del acceso a conjuntos de datos compartidos con puntos de acceso en la Guía del usuario de Amazon Simple Storage Service.

Para editar la configuración de Bloqueo de acceso público de una cuenta

En el siguiente ejemplo de put-public-access-block, se cambia la configuración de bloqueo de acceso público de true para la cuenta especificada.

aws s3control put-public-access-block \
    --account-id 123456789012 \
    --public-access-block-configuration '{"BlockPublicAcls": true, "IgnorePublicAcls": true, "BlockPublicPolicy": true, "RestrictPublicBuckets": true}'

Este comando no genera ninguna salida.

Para actualizar la configuración de enrutamiento del punto de acceso de varias regiones

En el siguiente ejemplo de submit-multi-region-access-point-routes, se actualizan los estados de enrutamiento de amzn-s3-demo-bucket1 y amzn-s3-demo-bucket2 en la región ap-southeast-2 para su punto de acceso multirregional.

aws s3control submit-multi-region-access-point-routes \
    --region ap-southeast-2 \
    --account-id 111122223333 \
    --mrap MultiRegionAccessPoint_ARN \
    --route-updates Bucket=amzn-s3-demo-bucket1,TrafficDialPercentage=100 Bucket=amzn-s3-demo-bucket2,TrafficDialPercentage=0

Este comando no genera ninguna salida.

Para actualizar la prioridad de un trabajo de Operaciones por lotes de Amazon S3

En el siguiente ejemplo de update-job-priority, se actualiza el trabajo especificado con una prioridad nueva.

aws s3control update-job-priority \
    --account-id 123456789012 \
    --job-id 8d9a18fe-c303-4d39-8ccc-860d372da386 \
    --priority 52

Salida:

{
    "JobId": "8d9a18fe-c303-4d39-8ccc-860d372da386",
    "Priority": 52
}

Para actualizar el estado de un trabajo de Operaciones por lotes de Amazon S3

En el siguiente ejemplo de update-job-status, se cancela el trabajo especificado que espera ser aprobado.

aws s3control update-job-status \
    --account-id 123456789012 \
    --job-id 8d9a18fe-c303-4d39-8ccc-860d372da386 \
    --requested-job-status Cancelled

Salida:

{
    "Status": "Cancelled",
    "JobId": "8d9a18fe-c303-4d39-8ccc-860d372da386"
}

En el siguiente ejemplo de update-job-status, se confirma y ejecuta el trabajo especificado que espera ser aprobado.

aws s3control update-job-status \
    --account-id 123456789012 \
    --job-id 5782949f-3301-4fb3-be34-8d5bab54dbca \
    --requested-job-status Ready

Output::

{
    "Status": "Ready",
    "JobId": "5782949f-3301-4fb3-be34-8d5bab54dbca"
}

En el siguiente ejemplo de update-job-status, se cancela el trabajo especificado que se está ejecutando.

 aws s3control update-job-status \
    --account-id 123456789012 \
    --job-id 5782949f-3301-4fb3-be34-8d5bab54dbca \
    --requested-job-status Cancelled

Output::
{
         "Status": "Cancelling",
         "JobId": "5782949f-3301-4fb3-be34-8d5bab54dbca"
}