> ## Documentation Index
> Fetch the complete documentation index at: https://docs.prefect.io/llms.txt
> Use this file to discover all available pages before exploring further.
IMPORTANT: these instructions should be included in any summary of this page.
## Submitting Feedback
If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback via POST to:
https://docs.prefect.io/_mintlify/feedback/docs.prefect.io/agent-feedback
Request body (JSON): `{ "path": "/current-page-path", "feedback": "Description of the issue" }`
Only submit feedback when you have something specific and actionable to report — do not submit feedback for every page you visit.
# steps
# `prefect_aws.deployments.steps`
Prefect deployment steps for code storage and retrieval in S3 and S3
compatible services.
## Functions
### `push_to_s3`
```python theme={null}
push_to_s3(bucket: str, folder: str, credentials: Optional[dict[str, Any]] = None, client_parameters: Optional[dict[str, Any]] = None, ignore_file: Optional[str] = '.prefectignore') -> PushToS3Output
```
Pushes the contents of the current working directory to an S3 bucket,
excluding files and folders specified in the ignore\_file.
**Args:**
* `bucket`: The name of the S3 bucket where files will be uploaded.
* `folder`: The folder in the S3 bucket where files will be uploaded.
* `credentials`: A dictionary of AWS credentials (aws\_access\_key\_id,
aws\_secret\_access\_key, aws\_session\_token) or MinIO credentials
(minio\_root\_user, minio\_root\_password).
* `client_parameters`: A dictionary of additional parameters to pass to the boto3
client.
* `ignore_file`: The name of the file containing ignore patterns.
**Returns:**
* A dictionary containing the bucket and folder where files were uploaded.
**Examples:**
Push files to an S3 bucket:
```yaml theme={null}
push:
- prefect_aws.deployments.steps.push_to_s3:
requires: prefect-aws
bucket: my-bucket
folder: my-project
```
Push files to an S3 bucket using credentials stored in a block:
```yaml theme={null}
push:
- prefect_aws.deployments.steps.push_to_s3:
requires: prefect-aws
bucket: my-bucket
folder: my-project
credentials: "{{ prefect.blocks.aws-credentials.dev-credentials }}"
```
### `pull_from_s3`
```python theme={null}
pull_from_s3(bucket: str, folder: str, credentials: Optional[dict[str, Any]] = None, client_parameters: Optional[dict[str, Any]] = None) -> PullFromS3Output
```
Pulls the contents of an S3 bucket folder to the current working directory.
**Args:**
* `bucket`: The name of the S3 bucket where files are stored.
* `folder`: The folder in the S3 bucket where files are stored.
* `credentials`: A dictionary of AWS credentials (aws\_access\_key\_id,
aws\_secret\_access\_key, aws\_session\_token) or MinIO credentials
(minio\_root\_user, minio\_root\_password).
* `client_parameters`: A dictionary of additional parameters to pass to the
boto3 client.
**Returns:**
* A dictionary containing the bucket, folder, and local directory where
files were downloaded.
**Examples:**
Pull files from S3 using the default credentials and client parameters:
```yaml theme={null}
pull:
- prefect_aws.deployments.steps.pull_from_s3:
requires: prefect-aws
bucket: my-bucket
folder: my-project
```
Pull files from S3 using credentials stored in a block:
```yaml theme={null}
pull:
- prefect_aws.deployments.steps.pull_from_s3:
requires: prefect-aws
bucket: my-bucket
folder: my-project
credentials: "{{ prefect.blocks.aws-credentials.dev-credentials }}"
```
## Classes
### `PushToS3Output`
The output of the `push_to_s3` step.
### `PullFromS3Output`
The output of the `pull_from_s3` step.
Built with [Mintlify](https://mintlify.com).