prefect_aws.credentials
¶
Module handling AWS credentials
AwsCredentials
¶
Bases: CredentialsBlock
Block used to manage authentication with AWS. AWS authentication is
handled via the boto3
module. Refer to the
boto3 docs
for more info about the possible credential configurations.
Example
Load stored AWS credentials:
from prefect_aws import AwsCredentials
aws_credentials_block = AwsCredentials.load("BLOCK_NAME")
Source code in prefect_aws/credentials.py
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 |
|
Config
¶
Config class for pydantic model.
Source code in prefect_aws/credentials.py
110 111 112 113 |
|
get_boto3_session
¶
Returns an authenticated boto3 session that can be used to create clients for AWS services
Example
Create an S3 client from an authorized boto3 session:
aws_credentials = AwsCredentials(
aws_access_key_id = "access_key_id",
aws_secret_access_key = "secret_access_key"
)
s3_client = aws_credentials.get_boto3_session().client("s3")
Source code in prefect_aws/credentials.py
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
|
get_client
¶
Helper method to dynamically get a client type.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
client_type |
Union[str, ClientType]
|
The client's service name. |
required |
Returns:
Type | Description |
---|---|
An authenticated client. |
Raises:
Type | Description |
---|---|
ValueError
|
if the client is not supported. |
Source code in prefect_aws/credentials.py
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
|
get_s3_client
¶
Gets an authenticated S3 client.
Returns:
Type | Description |
---|---|
S3Client
|
An authenticated S3 client. |
Source code in prefect_aws/credentials.py
173 174 175 176 177 178 179 180 |
|
get_secrets_manager_client
¶
Gets an authenticated Secrets Manager client.
Returns:
Type | Description |
---|---|
SecretsManagerClient
|
An authenticated Secrets Manager client. |
Source code in prefect_aws/credentials.py
182 183 184 185 186 187 188 189 |
|
ClientType
¶
Bases: Enum
The supported boto3 clients.
Source code in prefect_aws/credentials.py
25 26 27 28 29 30 31 |
|
MinIOCredentials
¶
Bases: CredentialsBlock
Block used to manage authentication with MinIO. Refer to the MinIO docs for more info about the possible credential configurations.
Attributes:
Name | Type | Description |
---|---|---|
minio_root_user |
str
|
Admin or root user. |
minio_root_password |
SecretStr
|
Admin or root password. |
region_name |
Optional[str]
|
Location of server, e.g. "us-east-1". |
Example
Load stored MinIO credentials:
from prefect_aws import MinIOCredentials
minio_credentials_block = MinIOCredentials.load("BLOCK_NAME")
Source code in prefect_aws/credentials.py
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
|
Config
¶
Config class for pydantic model.
Source code in prefect_aws/credentials.py
234 235 236 237 |
|
get_boto3_session
¶
Returns an authenticated boto3 session that can be used to create clients and perform object operations on MinIO server.
Example
Create an S3 client from an authorized boto3 session
minio_credentials = MinIOCredentials(
minio_root_user = "minio_root_user",
minio_root_password = "minio_root_password"
)
s3_client = minio_credentials.get_boto3_session().client(
service="s3",
endpoint_url="http://localhost:9000"
)
Source code in prefect_aws/credentials.py
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 |
|
get_client
¶
Helper method to dynamically get a client type.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
client_type |
Union[str, ClientType]
|
The client's service name. |
required |
Returns:
Type | Description |
---|---|
An authenticated client. |
Raises:
Type | Description |
---|---|
ValueError
|
if the client is not supported. |
Source code in prefect_aws/credentials.py
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 |
|
get_s3_client
¶
Gets an authenticated S3 client.
Returns:
Type | Description |
---|---|
S3Client
|
An authenticated S3 client. |
Source code in prefect_aws/credentials.py
299 300 301 302 303 304 305 306 |
|