API Reference¶
Client Module¶
Cognito CLI Authentication Tool Authenticates with AWS Cognito User Pool and Identity Pool to obtain temporary credentials and updates the AWS CLI profile for seamless AWS CLI usage.
AWSProfileManager
¶
Source code in src/aws_cognito_auth/client.py
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
|
update_profile(profile_name, credentials, region)
¶
Update AWS credentials profile
Source code in src/aws_cognito_auth/client.py
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
|
CognitoAuthenticator
¶
Source code in src/aws_cognito_auth/client.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 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 190 191 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 |
|
authenticate_user(username, password)
¶
Authenticate user with Cognito User Pool
Source code in src/aws_cognito_auth/client.py
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 |
|
get_temporary_credentials(id_token, use_lambda_proxy=True, duration_hours=12)
¶
Exchange ID token for temporary AWS credentials
Source code in src/aws_cognito_auth/client.py
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 |
|
cli()
¶
Cognito CLI Authentication Tool
AWS Cognito authentication CLI
Authenticate with AWS Cognito and update AWS CLI profiles with temporary credentials.
Source code in src/aws_cognito_auth/client.py
377 378 379 380 |
|
configure()
¶
Configure Cognito authentication settings
Source code in src/aws_cognito_auth/client.py
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 |
|
load_config()
¶
Load configuration from environment variables or config file
Source code in src/aws_cognito_auth/client.py
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 |
|
login(username, profile, no_lambda_proxy, duration)
¶
Authenticate with Cognito and update AWS profile
Source code in src/aws_cognito_auth/client.py
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 |
|
save_config(config)
¶
Save configuration to config file
Source code in src/aws_cognito_auth/client.py
370 371 372 373 374 |
|
status()
¶
Show current configuration status
Source code in src/aws_cognito_auth/client.py
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
|
Admin Module¶
AWS Cognito Auth Administration Tool Combines all administrative functions for setting up and managing AWS infrastructure
CognitoRoleManager
¶
Source code in src/aws_cognito_auth/admin.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
|
get_authenticated_role()
¶
Get the authenticated role information for the Identity Pool
Source code in src/aws_cognito_auth/admin.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
|
get_inline_policy(role_name, policy_name)
¶
Get inline policy document
Source code in src/aws_cognito_auth/admin.py
58 59 60 61 62 63 64 |
|
get_role_policies(role_name)
¶
Get all policies attached to the role
Source code in src/aws_cognito_auth/admin.py
45 46 47 48 49 50 51 52 53 54 55 56 |
|
update_inline_policy(role_name, policy_name, policy_document)
¶
Update or create inline policy
Source code in src/aws_cognito_auth/admin.py
66 67 68 69 70 71 72 73 74 |
|
LambdaDeployer
¶
Source code in src/aws_cognito_auth/admin.py
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 190 191 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 307 308 309 310 311 312 313 314 |
|
create_lambda_role()
¶
Create minimal IAM role for Lambda function
Source code in src/aws_cognito_auth/admin.py
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 190 191 192 193 194 195 |
|
create_lambda_user()
¶
Create IAM user for Lambda function to avoid role chaining limits
Source code in src/aws_cognito_auth/admin.py
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 |
|
create_long_lived_role(lambda_user_arn)
¶
Create the role that users will assume for long-lived credentials
Source code in src/aws_cognito_auth/admin.py
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 |
|
deploy_lambda_function(lambda_role_arn, user_credentials, lambda_code_path=None)
¶
Create and deploy Lambda function
Source code in src/aws_cognito_auth/admin.py
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 307 308 309 310 311 312 313 314 |
|
admin_cli()
¶
Administrative tools for AWS Cognito Auth
Manage AWS infrastructure for Cognito authentication system.
Source code in src/aws_cognito_auth/admin.py
423 424 425 426 |
|
apply_policy(identity_pool_id, policy_file, policy_name)
¶
Apply a custom policy from JSON file
Source code in src/aws_cognito_auth/admin.py
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
configure()
¶
Configure administrative settings for AWS service names and parameters
Source code in src/aws_cognito_auth/admin.py
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 |
|
create_dynamodb_policy(identity_pool_id, table_name, region)
¶
Create DynamoDB access policy with user isolation
Source code in src/aws_cognito_auth/admin.py
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 |
|
create_s3_policy(identity_pool_id, bucket_name, user_specific)
¶
Create S3 access policy for the authenticated role
Source code in src/aws_cognito_auth/admin.py
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 |
|
deploy(region, access_key_id, secret_access_key, create_user, lambda_code)
¶
Deploy the Lambda credential proxy
Source code in src/aws_cognito_auth/admin.py
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
|
info(identity_pool_id)
¶
Show information about the authenticated role
Source code in src/aws_cognito_auth/admin.py
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 |
|
lambda_proxy()
¶
Lambda function management commands
Source code in src/aws_cognito_auth/admin.py
630 631 632 633 |
|
load_admin_config()
¶
Load administrative configuration for AWS service names and settings
Source code in src/aws_cognito_auth/admin.py
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
load_config()
¶
Load administrative configuration (alias of load_admin_config for tests).
Source code in src/aws_cognito_auth/admin.py
317 318 319 |
|
load_policy_template(policy_name)
¶
Load policy template JSON.
Preference order:
1. Repository-level policies/
directory (useful for development and tests that mock file I/O)
2. Installed package resources under aws_cognito_auth.policies
Source code in src/aws_cognito_auth/admin.py
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 |
|
policy()
¶
IAM policy management commands
Source code in src/aws_cognito_auth/admin.py
530 531 532 533 |
|
role()
¶
IAM role management commands
Source code in src/aws_cognito_auth/admin.py
429 430 431 432 |
|
save_config(config)
¶
Save admin configuration to user's home directory.
Source code in src/aws_cognito_auth/admin.py
768 769 770 771 772 |
|
setup_identity_pool()
¶
Set up Cognito Identity Pool (interactive)
Source code in src/aws_cognito_auth/admin.py
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 |
|
Lambda Function¶
Lambda-based AWS Credential Proxy This Lambda function exchanges Cognito User Pool tokens for longer-lived STS credentials
lambda_handler(event, context)
¶
Lambda function to exchange Cognito tokens for STS credentials
Expected event structure: { "id_token": "cognito_id_token", "duration_seconds": 43200, # optional, default 12 hours "role_arn": "arn:aws:iam::ACCOUNT:role/ROLE_NAME" # optional, uses default }
Source code in src/aws_cognito_auth/lambda_function.py
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 190 191 192 193 |
|
validate_cognito_token(id_token)
¶
Validate Cognito ID token and return claims This is a simplified version - in production, you should verify the signature
Source code in src/aws_cognito_auth/lambda_function.py
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 |
|