aws-sdk-freetier 1.22.0 → 1.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ecec7cc37ee0c8711729bd4b68c5f590cdcbb574eb3b630252cad76413e548f9
4
- data.tar.gz: 83b50befccba40741853e9c4d9dab7ebf49564ebedb5af7825958769f08e2b02
3
+ metadata.gz: 7b2746ded3aa3c137ce131f7cbe3591c2620450db5b487b1ef4ebeb06b50a166
4
+ data.tar.gz: 0163f943f6bb7f88a0705641a8f8dcb8c9516a51be9a7dd69dee230f0395c0aa
5
5
  SHA512:
6
- metadata.gz: eb1cf8d6d1c64e1a6c0d6284db6812925fe5100ebcb1788b0cd2d416e6147d79f1c9ac74ac890282f51654abe73822cc0b7439b9646c5fd65f1f0968c97b8677
7
- data.tar.gz: cfcd3317bd45b9963d3049aa0250985bbb6e09b7726014be80a4e92f6a9fd28d4557e409e1bd7676335ff5f431b7ceb234b1b632a3e9fc4c9373141a9cbd4bc2
6
+ metadata.gz: e785bb3128b220d601551a266d1bd638a695532af377edcda1a8005b13572d00b689f6a9e70a28ad83c7fadeddc972e03bee9c4d7a412e60c5fa2f387aba6fde
7
+ data.tar.gz: 4f333fceacf9e970dacb5f4d33cad3a6c8bb375083bef55cb3183a25ec5a7419a0b55fd4ddd32ae86b9afb637a7bd039857b83fbd48018973a64bcab54f9b70f
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.24.0 (2025-07-21)
5
+ ------------------
6
+
7
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
8
+
9
+ 1.23.0 (2025-07-09)
10
+ ------------------
11
+
12
+ * Feature - This release introduces four new APIs: GetAccountPlanState and UpgradeAccountPlan for AWS account plan management; ListAccountActivities and GetAccountActivity that provide activity tracking capabilities.
13
+
4
14
  1.22.0 (2025-06-02)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.22.0
1
+ 1.24.0
@@ -95,7 +95,7 @@ module Aws::FreeTier
95
95
  # class name or an instance of a plugin class.
96
96
  #
97
97
  # @option options [required, Aws::CredentialProvider] :credentials
98
- # Your AWS credentials. This can be an instance of any one of the
98
+ # Your AWS credentials used for authentication. This can be an instance of any one of the
99
99
  # following classes:
100
100
  #
101
101
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
@@ -128,18 +128,23 @@ module Aws::FreeTier
128
128
  # locations will be searched for credentials:
129
129
  #
130
130
  # * `Aws.config[:credentials]`
131
+ #
131
132
  # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
132
133
  # `:account_id` options.
133
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
134
- # ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
134
+ #
135
+ # * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
136
+ # `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
137
+ #
135
138
  # * `~/.aws/credentials`
139
+ #
136
140
  # * `~/.aws/config`
141
+ #
137
142
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
138
143
  # are very aggressive. Construct and pass an instance of
139
144
  # `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
140
145
  # enable retries and extended timeouts. Instance profile credential
141
- # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
142
- # to true.
146
+ # fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
147
+ # to `true`.
143
148
  #
144
149
  # @option options [required, String] :region
145
150
  # The AWS region to connect to. The configured `:region` is
@@ -167,6 +172,11 @@ module Aws::FreeTier
167
172
  # When false, the request will raise a `RetryCapacityNotAvailableError` and will
168
173
  # not retry instead of sleeping.
169
174
  #
175
+ # @option options [Array<String>] :auth_scheme_preference
176
+ # A list of preferred authentication schemes to use when making a request. Supported values are:
177
+ # `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
178
+ # shared config as `auth_scheme_preference`, the value should be a comma-separated list.
179
+ #
170
180
  # @option options [Boolean] :client_side_monitoring (false)
171
181
  # When `true`, client-side metrics will be collected for all API requests from
172
182
  # this client.
@@ -253,8 +263,8 @@ module Aws::FreeTier
253
263
  # 4 times. Used in `standard` and `adaptive` retry modes.
254
264
  #
255
265
  # @option options [String] :profile ("default")
256
- # Used when loading credentials from the shared credentials file
257
- # at HOME/.aws/credentials. When not specified, 'default' is used.
266
+ # Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
267
+ # When not specified, 'default' is used.
258
268
  #
259
269
  # @option options [String] :request_checksum_calculation ("when_supported")
260
270
  # Determines when a checksum will be calculated for request payloads. Values are:
@@ -374,7 +384,7 @@ module Aws::FreeTier
374
384
  # `Aws::Telemetry::OTelProvider` for telemetry provider.
375
385
  #
376
386
  # @option options [Aws::TokenProvider] :token_provider
377
- # A Bearer Token Provider. This can be an instance of any one of the
387
+ # Your Bearer token used for authentication. This can be an instance of any one of the
378
388
  # following classes:
379
389
  #
380
390
  # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
@@ -476,6 +486,152 @@ module Aws::FreeTier
476
486
 
477
487
  # @!group API Operations
478
488
 
489
+ # Returns a specific activity record that is available to the customer.
490
+ #
491
+ # @option params [required, String] :activity_id
492
+ # A unique identifier that identifies the activity.
493
+ #
494
+ # @option params [String] :language_code
495
+ # The language code used to return translated title and description
496
+ # fields.
497
+ #
498
+ # @return [Types::GetAccountActivityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
499
+ #
500
+ # * {Types::GetAccountActivityResponse#activity_id #activity_id} => String
501
+ # * {Types::GetAccountActivityResponse#title #title} => String
502
+ # * {Types::GetAccountActivityResponse#description #description} => String
503
+ # * {Types::GetAccountActivityResponse#status #status} => String
504
+ # * {Types::GetAccountActivityResponse#instructions_url #instructions_url} => String
505
+ # * {Types::GetAccountActivityResponse#reward #reward} => Types::ActivityReward
506
+ # * {Types::GetAccountActivityResponse#estimated_time_to_complete_in_minutes #estimated_time_to_complete_in_minutes} => Integer
507
+ # * {Types::GetAccountActivityResponse#expires_at #expires_at} => Time
508
+ # * {Types::GetAccountActivityResponse#started_at #started_at} => Time
509
+ # * {Types::GetAccountActivityResponse#completed_at #completed_at} => Time
510
+ #
511
+ #
512
+ # @example Example: Fetching an Account activity by id
513
+ #
514
+ # resp = client.get_account_activity({
515
+ # activity_id: "d622f48bf4014286a2686ab10cacfb2e",
516
+ # language_code: "en-US",
517
+ # })
518
+ #
519
+ # resp.to_h outputs the following:
520
+ # {
521
+ # activity_id: "d622f48bf4014286a2686ab10cacfb2e",
522
+ # completed_at: Time.parse("1985-06-12T23:20:50.520Z"),
523
+ # description: "Set up three notifications: one for your costs reach ...",
524
+ # estimated_time_to_complete_in_minutes: 15,
525
+ # expires_at: Time.parse("1985-10-12T23:20:50.520Z"),
526
+ # instructions_url: "https://catalog.us-east-1.prod.workshops.aws/workshops/2a5fc82d-2b5f-4105-83c2-91a1b4d7abfe/en-US/2-foundation/lab1-create",
527
+ # reward: {
528
+ # credit: {
529
+ # amount: 20.0,
530
+ # unit: "USD",
531
+ # },
532
+ # },
533
+ # started_at: Time.parse("1985-04-12T23:20:50.520Z"),
534
+ # status: "COMPLETED",
535
+ # title: "Configure Your Access in the AWS Identity and Access Management (IAM) center",
536
+ # }
537
+ #
538
+ # @example Request syntax with placeholder values
539
+ #
540
+ # resp = client.get_account_activity({
541
+ # activity_id: "ActivityId", # required
542
+ # language_code: "en-US", # accepts en-US, en-GB, id-ID, de-DE, es-ES, fr-FR, ja-JP, it-IT, pt-PT, ko-KR, zh-CN, zh-TW, tr-TR
543
+ # })
544
+ #
545
+ # @example Response structure
546
+ #
547
+ # resp.activity_id #=> String
548
+ # resp.title #=> String
549
+ # resp.description #=> String
550
+ # resp.status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED", "EXPIRING"
551
+ # resp.instructions_url #=> String
552
+ # resp.reward.credit.amount #=> Float
553
+ # resp.reward.credit.unit #=> String, one of "USD"
554
+ # resp.estimated_time_to_complete_in_minutes #=> Integer
555
+ # resp.expires_at #=> Time
556
+ # resp.started_at #=> Time
557
+ # resp.completed_at #=> Time
558
+ #
559
+ # @see http://docs.aws.amazon.com/goto/WebAPI/freetier-2023-09-07/GetAccountActivity AWS API Documentation
560
+ #
561
+ # @overload get_account_activity(params = {})
562
+ # @param [Hash] params ({})
563
+ def get_account_activity(params = {}, options = {})
564
+ req = build_request(:get_account_activity, params)
565
+ req.send_request(options)
566
+ end
567
+
568
+ # This returns all of the information related to the state of the
569
+ # account plan related to Free Tier.
570
+ #
571
+ # @return [Types::GetAccountPlanStateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
572
+ #
573
+ # * {Types::GetAccountPlanStateResponse#account_id #account_id} => String
574
+ # * {Types::GetAccountPlanStateResponse#account_plan_type #account_plan_type} => String
575
+ # * {Types::GetAccountPlanStateResponse#account_plan_status #account_plan_status} => String
576
+ # * {Types::GetAccountPlanStateResponse#account_plan_remaining_credits #account_plan_remaining_credits} => Types::MonetaryAmount
577
+ # * {Types::GetAccountPlanStateResponse#account_plan_expiration_date #account_plan_expiration_date} => Time
578
+ #
579
+ #
580
+ # @example Example: Fetching account plan state by id
581
+ #
582
+ # resp = client.get_account_plan_state({
583
+ # })
584
+ #
585
+ # resp.to_h outputs the following:
586
+ # {
587
+ # account_id: "111122223333",
588
+ # account_plan_expiration_date: Time.parse("2025-06-30T23:59:59Z"),
589
+ # account_plan_remaining_credits: {
590
+ # amount: 25.0,
591
+ # unit: "USD",
592
+ # },
593
+ # account_plan_status: "ACTIVE",
594
+ # account_plan_type: "FREE",
595
+ # }
596
+ #
597
+ # @example Example: Attempt to fetch account plan state by id with insufficient permissions
598
+ #
599
+ # resp = client.get_account_plan_state({
600
+ # })
601
+ #
602
+ # @example Example: Internal service error
603
+ #
604
+ # resp = client.get_account_plan_state({
605
+ # })
606
+ #
607
+ # @example Example: Attempt to fetch plan state by id for an account without account plan
608
+ #
609
+ # resp = client.get_account_plan_state({
610
+ # })
611
+ #
612
+ # @example Example: Request rate exceeds limits
613
+ #
614
+ # resp = client.get_account_plan_state({
615
+ # })
616
+ #
617
+ # @example Response structure
618
+ #
619
+ # resp.account_id #=> String
620
+ # resp.account_plan_type #=> String, one of "FREE", "PAID"
621
+ # resp.account_plan_status #=> String, one of "NOT_STARTED", "ACTIVE", "EXPIRED"
622
+ # resp.account_plan_remaining_credits.amount #=> Float
623
+ # resp.account_plan_remaining_credits.unit #=> String, one of "USD"
624
+ # resp.account_plan_expiration_date #=> Time
625
+ #
626
+ # @see http://docs.aws.amazon.com/goto/WebAPI/freetier-2023-09-07/GetAccountPlanState AWS API Documentation
627
+ #
628
+ # @overload get_account_plan_state(params = {})
629
+ # @param [Hash] params ({})
630
+ def get_account_plan_state(params = {}, options = {})
631
+ req = build_request(:get_account_plan_state, params)
632
+ req.send_request(options)
633
+ end
634
+
479
635
  # Returns a list of all Free Tier usage objects that match your filters.
480
636
  #
481
637
  # @option params [Types::Expression] :filter
@@ -502,24 +658,24 @@ module Aws::FreeTier
502
658
  #
503
659
  # resp = client.get_free_tier_usage({
504
660
  # filter: {
661
+ # or: [
662
+ # {
663
+ # # recursive Expression
664
+ # },
665
+ # ],
505
666
  # and: [
506
667
  # {
507
668
  # # recursive Expression
508
669
  # },
509
670
  # ],
671
+ # not: {
672
+ # # recursive Expression
673
+ # },
510
674
  # dimensions: {
511
675
  # key: "SERVICE", # required, accepts SERVICE, OPERATION, USAGE_TYPE, REGION, FREE_TIER_TYPE, DESCRIPTION, USAGE_PERCENTAGE
512
- # match_options: ["EQUALS"], # required, accepts EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL
513
676
  # values: ["Value"], # required
677
+ # match_options: ["EQUALS"], # required, accepts EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL
514
678
  # },
515
- # not: {
516
- # # recursive Expression
517
- # },
518
- # or: [
519
- # {
520
- # # recursive Expression
521
- # },
522
- # ],
523
679
  # },
524
680
  # max_results: 1,
525
681
  # next_token: "NextPageToken",
@@ -528,16 +684,16 @@ module Aws::FreeTier
528
684
  # @example Response structure
529
685
  #
530
686
  # resp.free_tier_usages #=> Array
687
+ # resp.free_tier_usages[0].service #=> String
688
+ # resp.free_tier_usages[0].operation #=> String
689
+ # resp.free_tier_usages[0].usage_type #=> String
690
+ # resp.free_tier_usages[0].region #=> String
531
691
  # resp.free_tier_usages[0].actual_usage_amount #=> Float
532
- # resp.free_tier_usages[0].description #=> String
533
692
  # resp.free_tier_usages[0].forecasted_usage_amount #=> Float
534
- # resp.free_tier_usages[0].free_tier_type #=> String
535
693
  # resp.free_tier_usages[0].limit #=> Float
536
- # resp.free_tier_usages[0].operation #=> String
537
- # resp.free_tier_usages[0].region #=> String
538
- # resp.free_tier_usages[0].service #=> String
539
694
  # resp.free_tier_usages[0].unit #=> String
540
- # resp.free_tier_usages[0].usage_type #=> String
695
+ # resp.free_tier_usages[0].description #=> String
696
+ # resp.free_tier_usages[0].free_tier_type #=> String
541
697
  # resp.next_token #=> String
542
698
  #
543
699
  # @see http://docs.aws.amazon.com/goto/WebAPI/freetier-2023-09-07/GetFreeTierUsage AWS API Documentation
@@ -549,6 +705,167 @@ module Aws::FreeTier
549
705
  req.send_request(options)
550
706
  end
551
707
 
708
+ # Returns a list of activities that are available. This operation
709
+ # supports pagination and filtering by status.
710
+ #
711
+ # @option params [Array<String>] :filter_activity_statuses
712
+ # The activity status filter. This field can be used to filter the
713
+ # response by activities status.
714
+ #
715
+ # @option params [String] :next_token
716
+ # A token from a previous paginated response. If this is specified, the
717
+ # response includes records beginning from this token (inclusive), up to
718
+ # the number specified by `maxResults`.
719
+ #
720
+ # @option params [Integer] :max_results
721
+ # The maximum number of items to return for this request. To get the
722
+ # next page of items, make another request with the token returned in
723
+ # the output.
724
+ #
725
+ # @option params [String] :language_code
726
+ # The language code used to return translated titles.
727
+ #
728
+ # @return [Types::ListAccountActivitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
729
+ #
730
+ # * {Types::ListAccountActivitiesResponse#activities #activities} => Array&lt;Types::ActivitySummary&gt;
731
+ # * {Types::ListAccountActivitiesResponse#next_token #next_token} => String
732
+ #
733
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
734
+ #
735
+ #
736
+ # @example Example: Fetching a page of completed activities
737
+ #
738
+ # resp = client.list_account_activities({
739
+ # filter_activity_statuses: [
740
+ # "COMPLETED",
741
+ # ],
742
+ # language_code: "en-US",
743
+ # max_results: 1,
744
+ # })
745
+ #
746
+ # resp.to_h outputs the following:
747
+ # {
748
+ # activities: [
749
+ # {
750
+ # activity_id: "d622f48bf4014286a2686ab10cacfb2e",
751
+ # reward: {
752
+ # credit: {
753
+ # amount: 20.0,
754
+ # unit: "USD",
755
+ # },
756
+ # },
757
+ # status: "COMPLETED",
758
+ # title: "Configure Your Access in the AWS Identity and Access Management (IAM) center",
759
+ # },
760
+ # ],
761
+ # next_token: "a95f3d9e7710c6ca8ba4f640b40bbc40",
762
+ # }
763
+ #
764
+ # @example Request syntax with placeholder values
765
+ #
766
+ # resp = client.list_account_activities({
767
+ # filter_activity_statuses: ["NOT_STARTED"], # accepts NOT_STARTED, IN_PROGRESS, COMPLETED, EXPIRING
768
+ # next_token: "NextPageToken",
769
+ # max_results: 1,
770
+ # language_code: "en-US", # accepts en-US, en-GB, id-ID, de-DE, es-ES, fr-FR, ja-JP, it-IT, pt-PT, ko-KR, zh-CN, zh-TW, tr-TR
771
+ # })
772
+ #
773
+ # @example Response structure
774
+ #
775
+ # resp.activities #=> Array
776
+ # resp.activities[0].activity_id #=> String
777
+ # resp.activities[0].title #=> String
778
+ # resp.activities[0].reward.credit.amount #=> Float
779
+ # resp.activities[0].reward.credit.unit #=> String, one of "USD"
780
+ # resp.activities[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED", "EXPIRING"
781
+ # resp.next_token #=> String
782
+ #
783
+ # @see http://docs.aws.amazon.com/goto/WebAPI/freetier-2023-09-07/ListAccountActivities AWS API Documentation
784
+ #
785
+ # @overload list_account_activities(params = {})
786
+ # @param [Hash] params ({})
787
+ def list_account_activities(params = {}, options = {})
788
+ req = build_request(:list_account_activities, params)
789
+ req.send_request(options)
790
+ end
791
+
792
+ # The account plan type for the Amazon Web Services account.
793
+ #
794
+ # @option params [required, String] :account_plan_type
795
+ # The target account plan type. This makes it explicit about the change
796
+ # and latest value of the `accountPlanType`.
797
+ #
798
+ # @return [Types::UpgradeAccountPlanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
799
+ #
800
+ # * {Types::UpgradeAccountPlanResponse#account_id #account_id} => String
801
+ # * {Types::UpgradeAccountPlanResponse#account_plan_type #account_plan_type} => String
802
+ # * {Types::UpgradeAccountPlanResponse#account_plan_status #account_plan_status} => String
803
+ #
804
+ #
805
+ # @example Example: Upgrading an account plan to PAID
806
+ #
807
+ # resp = client.upgrade_account_plan({
808
+ # account_plan_type: "PAID",
809
+ # })
810
+ #
811
+ # resp.to_h outputs the following:
812
+ # {
813
+ # account_id: "111122223333",
814
+ # account_plan_status: "NOT_STARTED",
815
+ # account_plan_type: "PAID",
816
+ # }
817
+ #
818
+ # @example Example: Attempt to upgrade an account with insufficient permissions
819
+ #
820
+ # resp = client.upgrade_account_plan({
821
+ # account_plan_type: "PAID",
822
+ # })
823
+ #
824
+ # @example Example: Attempt to downgrade an account from PAID to FREE
825
+ #
826
+ # resp = client.upgrade_account_plan({
827
+ # account_plan_type: "FREE",
828
+ # })
829
+ #
830
+ # @example Example: Internal service error
831
+ #
832
+ # resp = client.upgrade_account_plan({
833
+ # account_plan_type: "PAID",
834
+ # })
835
+ #
836
+ # @example Example: Attempt to upgrade a non-existent account plan
837
+ #
838
+ # resp = client.upgrade_account_plan({
839
+ # account_plan_type: "PAID",
840
+ # })
841
+ #
842
+ # @example Example: Request rate exceeds limits
843
+ #
844
+ # resp = client.upgrade_account_plan({
845
+ # account_plan_type: "PAID",
846
+ # })
847
+ #
848
+ # @example Request syntax with placeholder values
849
+ #
850
+ # resp = client.upgrade_account_plan({
851
+ # account_plan_type: "FREE", # required, accepts FREE, PAID
852
+ # })
853
+ #
854
+ # @example Response structure
855
+ #
856
+ # resp.account_id #=> String
857
+ # resp.account_plan_type #=> String, one of "FREE", "PAID"
858
+ # resp.account_plan_status #=> String, one of "NOT_STARTED", "ACTIVE", "EXPIRED"
859
+ #
860
+ # @see http://docs.aws.amazon.com/goto/WebAPI/freetier-2023-09-07/UpgradeAccountPlan AWS API Documentation
861
+ #
862
+ # @overload upgrade_account_plan(params = {})
863
+ # @param [Hash] params ({})
864
+ def upgrade_account_plan(params = {}, options = {})
865
+ req = build_request(:upgrade_account_plan, params)
866
+ req.send_request(options)
867
+ end
868
+
552
869
  # @!endgroup
553
870
 
554
871
  # @param params ({})
@@ -567,7 +884,7 @@ module Aws::FreeTier
567
884
  tracer: tracer
568
885
  )
569
886
  context[:gem_name] = 'aws-sdk-freetier'
570
- context[:gem_version] = '1.22.0'
887
+ context[:gem_version] = '1.24.0'
571
888
  Seahorse::Client::Request.new(handlers, context)
572
889
  end
573
890