aws-sdk-licensemanager 1.26.0 → 1.27.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.
@@ -697,6 +697,93 @@ module Aws::LicenseManager
697
697
  include Aws::Structure
698
698
  end
699
699
 
700
+ # @note When making an API call, you may pass CreateLicenseManagerReportGeneratorRequest
701
+ # data as a hash:
702
+ #
703
+ # {
704
+ # report_generator_name: "ReportGeneratorName", # required
705
+ # type: ["LicenseConfigurationSummaryReport"], # required, accepts LicenseConfigurationSummaryReport, LicenseConfigurationUsageReport
706
+ # report_context: { # required
707
+ # license_configuration_arns: ["Arn"], # required
708
+ # },
709
+ # report_frequency: { # required
710
+ # value: 1,
711
+ # period: "DAY", # accepts DAY, WEEK, MONTH
712
+ # },
713
+ # client_token: "ClientRequestToken", # required
714
+ # description: "String",
715
+ # tags: [
716
+ # {
717
+ # key: "String",
718
+ # value: "String",
719
+ # },
720
+ # ],
721
+ # }
722
+ #
723
+ # @!attribute [rw] report_generator_name
724
+ # Name of the report generator.
725
+ # @return [String]
726
+ #
727
+ # @!attribute [rw] type
728
+ # Type of reports to generate. The following report types an be
729
+ # generated:
730
+ #
731
+ # * License configuration report - Reports on the number and details
732
+ # of consumed licenses for a license configuration.
733
+ #
734
+ # * Resource report - Reports on the tracked licenses and resource
735
+ # consumption for a license configuration.
736
+ # @return [Array<String>]
737
+ #
738
+ # @!attribute [rw] report_context
739
+ # Defines the type of license configuration the report generator
740
+ # tracks.
741
+ # @return [Types::ReportContext]
742
+ #
743
+ # @!attribute [rw] report_frequency
744
+ # Frequency by which reports are generated. Reports can be generated
745
+ # daily, monthly, or weekly.
746
+ # @return [Types::ReportFrequency]
747
+ #
748
+ # @!attribute [rw] client_token
749
+ # Unique, case-sensitive identifier that you provide to ensure the
750
+ # idempotency of the request.
751
+ # @return [String]
752
+ #
753
+ # @!attribute [rw] description
754
+ # Description of the report generator.
755
+ # @return [String]
756
+ #
757
+ # @!attribute [rw] tags
758
+ # Tags to add to the report generator.
759
+ # @return [Array<Types::Tag>]
760
+ #
761
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/CreateLicenseManagerReportGeneratorRequest AWS API Documentation
762
+ #
763
+ class CreateLicenseManagerReportGeneratorRequest < Struct.new(
764
+ :report_generator_name,
765
+ :type,
766
+ :report_context,
767
+ :report_frequency,
768
+ :client_token,
769
+ :description,
770
+ :tags)
771
+ SENSITIVE = []
772
+ include Aws::Structure
773
+ end
774
+
775
+ # @!attribute [rw] license_manager_report_generator_arn
776
+ # The Amazon Resource Number (ARN) of the new report generator.
777
+ # @return [String]
778
+ #
779
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/CreateLicenseManagerReportGeneratorResponse AWS API Documentation
780
+ #
781
+ class CreateLicenseManagerReportGeneratorResponse < Struct.new(
782
+ :license_manager_report_generator_arn)
783
+ SENSITIVE = []
784
+ include Aws::Structure
785
+ end
786
+
700
787
  # @note When making an API call, you may pass CreateLicenseRequest
701
788
  # data as a hash:
702
789
  #
@@ -1137,6 +1224,30 @@ module Aws::LicenseManager
1137
1224
  #
1138
1225
  class DeleteLicenseConfigurationResponse < Aws::EmptyStructure; end
1139
1226
 
1227
+ # @note When making an API call, you may pass DeleteLicenseManagerReportGeneratorRequest
1228
+ # data as a hash:
1229
+ #
1230
+ # {
1231
+ # license_manager_report_generator_arn: "String", # required
1232
+ # }
1233
+ #
1234
+ # @!attribute [rw] license_manager_report_generator_arn
1235
+ # Amazon Resource Number (ARN) of the report generator that will be
1236
+ # deleted.
1237
+ # @return [String]
1238
+ #
1239
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/DeleteLicenseManagerReportGeneratorRequest AWS API Documentation
1240
+ #
1241
+ class DeleteLicenseManagerReportGeneratorRequest < Struct.new(
1242
+ :license_manager_report_generator_arn)
1243
+ SENSITIVE = []
1244
+ include Aws::Structure
1245
+ end
1246
+
1247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/DeleteLicenseManagerReportGeneratorResponse AWS API Documentation
1248
+ #
1249
+ class DeleteLicenseManagerReportGeneratorResponse < Aws::EmptyStructure; end
1250
+
1140
1251
  # @note When making an API call, you may pass DeleteLicenseRequest
1141
1252
  # data as a hash:
1142
1253
  #
@@ -1616,6 +1727,39 @@ module Aws::LicenseManager
1616
1727
  include Aws::Structure
1617
1728
  end
1618
1729
 
1730
+ # @note When making an API call, you may pass GetLicenseManagerReportGeneratorRequest
1731
+ # data as a hash:
1732
+ #
1733
+ # {
1734
+ # license_manager_report_generator_arn: "String", # required
1735
+ # }
1736
+ #
1737
+ # @!attribute [rw] license_manager_report_generator_arn
1738
+ # mazon Resource Number (ARN) of the report generator to retrieve
1739
+ # information on.
1740
+ # @return [String]
1741
+ #
1742
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/GetLicenseManagerReportGeneratorRequest AWS API Documentation
1743
+ #
1744
+ class GetLicenseManagerReportGeneratorRequest < Struct.new(
1745
+ :license_manager_report_generator_arn)
1746
+ SENSITIVE = []
1747
+ include Aws::Structure
1748
+ end
1749
+
1750
+ # @!attribute [rw] report_generator
1751
+ # A report generator that creates periodic reports on your license
1752
+ # configurations.
1753
+ # @return [Types::ReportGenerator]
1754
+ #
1755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/GetLicenseManagerReportGeneratorResponse AWS API Documentation
1756
+ #
1757
+ class GetLicenseManagerReportGeneratorResponse < Struct.new(
1758
+ :report_generator)
1759
+ SENSITIVE = []
1760
+ include Aws::Structure
1761
+ end
1762
+
1619
1763
  # @note When making an API call, you may pass GetLicenseRequest
1620
1764
  # data as a hash:
1621
1765
  #
@@ -1710,7 +1854,7 @@ module Aws::LicenseManager
1710
1854
  #
1711
1855
  # @!attribute [rw] license_manager_resource_share_arn
1712
1856
  # Amazon Resource Name (ARN) of the AWS resource share. The License
1713
- # Manager master account will provide member accounts with access to
1857
+ # Manager management account provides member accounts with access to
1714
1858
  # this share.
1715
1859
  # @return [String]
1716
1860
  #
@@ -2413,13 +2557,15 @@ module Aws::LicenseManager
2413
2557
  # @!attribute [rw] filters
2414
2558
  # Filters to scope the results. The following filters are supported:
2415
2559
  #
2416
- # * `LicenseARN`
2560
+ # * `LicenseArn`
2417
2561
  #
2418
- # * `Status`
2562
+ # * `GrantStatus`
2419
2563
  #
2420
- # * `PrincipalARN`
2564
+ # * `GranteePrincipalARN`
2565
+ #
2566
+ # * `ProductSKU`
2421
2567
  #
2422
- # * `ParentARN`
2568
+ # * `LicenseIssuerName`
2423
2569
  # @return [Array<Types::Filter>]
2424
2570
  #
2425
2571
  # @!attribute [rw] next_token
@@ -2578,6 +2724,64 @@ module Aws::LicenseManager
2578
2724
  include Aws::Structure
2579
2725
  end
2580
2726
 
2727
+ # @note When making an API call, you may pass ListLicenseManagerReportGeneratorsRequest
2728
+ # data as a hash:
2729
+ #
2730
+ # {
2731
+ # filters: [
2732
+ # {
2733
+ # name: "FilterName",
2734
+ # values: ["FilterValue"],
2735
+ # },
2736
+ # ],
2737
+ # next_token: "String",
2738
+ # max_results: 1,
2739
+ # }
2740
+ #
2741
+ # @!attribute [rw] filters
2742
+ # Filters to scope the results. The following filters are supported:
2743
+ #
2744
+ # * `LicenseConfigurationArn`
2745
+ #
2746
+ # ^
2747
+ # @return [Array<Types::Filter>]
2748
+ #
2749
+ # @!attribute [rw] next_token
2750
+ # Token for the next set of results.
2751
+ # @return [String]
2752
+ #
2753
+ # @!attribute [rw] max_results
2754
+ # Maximum number of results to return in a single call.
2755
+ # @return [Integer]
2756
+ #
2757
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/ListLicenseManagerReportGeneratorsRequest AWS API Documentation
2758
+ #
2759
+ class ListLicenseManagerReportGeneratorsRequest < Struct.new(
2760
+ :filters,
2761
+ :next_token,
2762
+ :max_results)
2763
+ SENSITIVE = []
2764
+ include Aws::Structure
2765
+ end
2766
+
2767
+ # @!attribute [rw] report_generators
2768
+ # A report generator that creates periodic reports on your license
2769
+ # configurations.
2770
+ # @return [Array<Types::ReportGenerator>]
2771
+ #
2772
+ # @!attribute [rw] next_token
2773
+ # Token for the next set of results.
2774
+ # @return [String]
2775
+ #
2776
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/ListLicenseManagerReportGeneratorsResponse AWS API Documentation
2777
+ #
2778
+ class ListLicenseManagerReportGeneratorsResponse < Struct.new(
2779
+ :report_generators,
2780
+ :next_token)
2781
+ SENSITIVE = []
2782
+ include Aws::Structure
2783
+ end
2784
+
2581
2785
  # @note When making an API call, you may pass ListLicenseSpecificationsForResourceRequest
2582
2786
  # data as a hash:
2583
2787
  #
@@ -2701,7 +2905,7 @@ module Aws::LicenseManager
2701
2905
  #
2702
2906
  # * `ProductSKU`
2703
2907
  #
2704
- # * `KeyFingerprint`
2908
+ # * `Fingerprint`
2705
2909
  #
2706
2910
  # * `Status`
2707
2911
  # @return [Array<Types::Filter>]
@@ -2764,9 +2968,15 @@ module Aws::LicenseManager
2764
2968
  # @!attribute [rw] filters
2765
2969
  # Filters to scope the results. The following filters are supported:
2766
2970
  #
2767
- # * `LicenseARN`
2971
+ # * `ProductSKU`
2768
2972
  #
2769
- # * `Status`
2973
+ # * `LicenseIssuerName`
2974
+ #
2975
+ # * `LicenseArn`
2976
+ #
2977
+ # * `GrantStatus`
2978
+ #
2979
+ # * `GranterAccountId`
2770
2980
  # @return [Array<Types::Filter>]
2771
2981
  #
2772
2982
  # @!attribute [rw] next_token
@@ -2831,9 +3041,11 @@ module Aws::LicenseManager
2831
3041
  #
2832
3042
  # * `Status`
2833
3043
  #
2834
- # * `KeyFingerprint`
3044
+ # * `Fingerprint`
3045
+ #
3046
+ # * `IssuerName`
2835
3047
  #
2836
- # * `Issuer`
3048
+ # * `Beneficiary`
2837
3049
  # @return [Array<Types::Filter>]
2838
3050
  #
2839
3051
  # @!attribute [rw] next_token
@@ -3001,7 +3213,7 @@ module Aws::LicenseManager
3001
3213
  # @!attribute [rw] filters
3002
3214
  # Filters to scope the results. The following filter is supported:
3003
3215
  #
3004
- # * `licenseArns`
3216
+ # * `LicenseArns`
3005
3217
  #
3006
3218
  # ^
3007
3219
  # @return [Array<Types::Filter>]
@@ -3214,10 +3426,18 @@ module Aws::LicenseManager
3214
3426
  # @return [String]
3215
3427
  #
3216
3428
  # @!attribute [rw] product_information_filter_list
3217
- # Product information filters.
3429
+ # A Product information filter consists of a
3430
+ # `ProductInformationFilterComparator` which is a logical operator, a
3431
+ # `ProductInformationFilterName` which specifies the type of filter
3432
+ # being declared, and a `ProductInformationFilterValue` that specifies
3433
+ # the value to filter on.
3218
3434
  #
3219
- # The following filters and logical operators are supported when the
3220
- # resource type is `SSM_MANAGED`\:
3435
+ # Accepted values for `ProductInformationFilterName` are listed here
3436
+ # along with descriptions and valid options for
3437
+ # `ProductInformationFilterComparator`.
3438
+ #
3439
+ # The following filters and are supported when the resource type is
3440
+ # `SSM_MANAGED`\:
3221
3441
  #
3222
3442
  # * `Application Name` - The name of the application. Logical operator
3223
3443
  # is `EQUALS`.
@@ -3233,6 +3453,17 @@ module Aws::LicenseManager
3233
3453
  #
3234
3454
  # * `Platform Type` - The platform type. Logical operator is `EQUALS`.
3235
3455
  #
3456
+ # * `Tag:key` - The key of a tag attached to an AWS resource you wish
3457
+ # to exclude from automated discovery. Logical operator is
3458
+ # `NOT_EQUALS`. The key for your tag must be appended to `Tag:`
3459
+ # following the example: `Tag:name-of-your-key`.
3460
+ # `ProductInformationFilterValue` is optional if you are not using
3461
+ # values for the key.
3462
+ #
3463
+ # * `AccountId` - The 12-digit ID of an AWS account you wish to
3464
+ # exclude from automated discovery. Logical operator is
3465
+ # `NOT_EQUALS`.
3466
+ #
3236
3467
  # * `License Included` - The type of license included. Logical
3237
3468
  # operators are `EQUALS` and `NOT_EQUALS`. Possible values are:
3238
3469
  # `sql-server-enterprise` \| `sql-server-standard` \|
@@ -3403,6 +3634,132 @@ module Aws::LicenseManager
3403
3634
  include Aws::Structure
3404
3635
  end
3405
3636
 
3637
+ # Details of the license configuration that this generator reports on.
3638
+ #
3639
+ # @note When making an API call, you may pass ReportContext
3640
+ # data as a hash:
3641
+ #
3642
+ # {
3643
+ # license_configuration_arns: ["Arn"], # required
3644
+ # }
3645
+ #
3646
+ # @!attribute [rw] license_configuration_arns
3647
+ # Amazon Resource Number (ARN) of the license configuration that this
3648
+ # generator reports on.
3649
+ # @return [Array<String>]
3650
+ #
3651
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/ReportContext AWS API Documentation
3652
+ #
3653
+ class ReportContext < Struct.new(
3654
+ :license_configuration_arns)
3655
+ SENSITIVE = []
3656
+ include Aws::Structure
3657
+ end
3658
+
3659
+ # Details on how frequently reports are generated.
3660
+ #
3661
+ # @note When making an API call, you may pass ReportFrequency
3662
+ # data as a hash:
3663
+ #
3664
+ # {
3665
+ # value: 1,
3666
+ # period: "DAY", # accepts DAY, WEEK, MONTH
3667
+ # }
3668
+ #
3669
+ # @!attribute [rw] value
3670
+ # Number of times within the frequency period that a report will be
3671
+ # generated. Currently only `1` is supported.
3672
+ # @return [Integer]
3673
+ #
3674
+ # @!attribute [rw] period
3675
+ # Time period between each report. The period can be daily, weekly, or
3676
+ # monthly.
3677
+ # @return [String]
3678
+ #
3679
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/ReportFrequency AWS API Documentation
3680
+ #
3681
+ class ReportFrequency < Struct.new(
3682
+ :value,
3683
+ :period)
3684
+ SENSITIVE = []
3685
+ include Aws::Structure
3686
+ end
3687
+
3688
+ # Describe the details of a report generator.
3689
+ #
3690
+ # @!attribute [rw] report_generator_name
3691
+ # Name of the report generator.
3692
+ # @return [String]
3693
+ #
3694
+ # @!attribute [rw] report_type
3695
+ # Type of reports that are generated.
3696
+ # @return [Array<String>]
3697
+ #
3698
+ # @!attribute [rw] report_context
3699
+ # License configuration type this generator reports on.
3700
+ # @return [Types::ReportContext]
3701
+ #
3702
+ # @!attribute [rw] report_frequency
3703
+ # Details on how frequently reports are generated.
3704
+ # @return [Types::ReportFrequency]
3705
+ #
3706
+ # @!attribute [rw] license_manager_report_generator_arn
3707
+ # Amazon Resource Number (ARN) of the report generator.
3708
+ # @return [String]
3709
+ #
3710
+ # @!attribute [rw] last_run_status
3711
+ # Status of the last report generation attempt.
3712
+ # @return [String]
3713
+ #
3714
+ # @!attribute [rw] last_run_failure_reason
3715
+ # Failure message for the last report generation attempt.
3716
+ # @return [String]
3717
+ #
3718
+ # @!attribute [rw] last_report_generation_time
3719
+ # Time the last report was generated at.
3720
+ # @return [String]
3721
+ #
3722
+ # @!attribute [rw] report_creator_account
3723
+ # The AWS account ID used to create the report generator.
3724
+ # @return [String]
3725
+ #
3726
+ # @!attribute [rw] description
3727
+ # Description of the report generator.
3728
+ # @return [String]
3729
+ #
3730
+ # @!attribute [rw] s3_location
3731
+ # Details of the S3 bucket that report generator reports are published
3732
+ # to.
3733
+ # @return [Types::S3Location]
3734
+ #
3735
+ # @!attribute [rw] create_time
3736
+ # Time the report was created.
3737
+ # @return [String]
3738
+ #
3739
+ # @!attribute [rw] tags
3740
+ # Tags associated with the report generator.
3741
+ # @return [Array<Types::Tag>]
3742
+ #
3743
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/ReportGenerator AWS API Documentation
3744
+ #
3745
+ class ReportGenerator < Struct.new(
3746
+ :report_generator_name,
3747
+ :report_type,
3748
+ :report_context,
3749
+ :report_frequency,
3750
+ :license_manager_report_generator_arn,
3751
+ :last_run_status,
3752
+ :last_run_failure_reason,
3753
+ :last_report_generation_time,
3754
+ :report_creator_account,
3755
+ :description,
3756
+ :s3_location,
3757
+ :create_time,
3758
+ :tags)
3759
+ SENSITIVE = []
3760
+ include Aws::Structure
3761
+ end
3762
+
3406
3763
  # Details about a resource.
3407
3764
  #
3408
3765
  # @!attribute [rw] resource_id
@@ -3468,6 +3825,26 @@ module Aws::LicenseManager
3468
3825
  include Aws::Structure
3469
3826
  end
3470
3827
 
3828
+ # Details of the S3 bucket that report generator reports are published
3829
+ # to.
3830
+ #
3831
+ # @!attribute [rw] bucket
3832
+ # Name of the S3 bucket reports are published to.
3833
+ # @return [String]
3834
+ #
3835
+ # @!attribute [rw] key_prefix
3836
+ # Prefix of the S3 bucket reports are published to.
3837
+ # @return [String]
3838
+ #
3839
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/S3Location AWS API Documentation
3840
+ #
3841
+ class S3Location < Struct.new(
3842
+ :bucket,
3843
+ :key_prefix)
3844
+ SENSITIVE = []
3845
+ include Aws::Structure
3846
+ end
3847
+
3471
3848
  # The server experienced an internal error. Try again.
3472
3849
  #
3473
3850
  # @!attribute [rw] message
@@ -3711,6 +4088,81 @@ module Aws::LicenseManager
3711
4088
  #
3712
4089
  class UpdateLicenseConfigurationResponse < Aws::EmptyStructure; end
3713
4090
 
4091
+ # @note When making an API call, you may pass UpdateLicenseManagerReportGeneratorRequest
4092
+ # data as a hash:
4093
+ #
4094
+ # {
4095
+ # license_manager_report_generator_arn: "String", # required
4096
+ # report_generator_name: "ReportGeneratorName", # required
4097
+ # type: ["LicenseConfigurationSummaryReport"], # required, accepts LicenseConfigurationSummaryReport, LicenseConfigurationUsageReport
4098
+ # report_context: { # required
4099
+ # license_configuration_arns: ["Arn"], # required
4100
+ # },
4101
+ # report_frequency: { # required
4102
+ # value: 1,
4103
+ # period: "DAY", # accepts DAY, WEEK, MONTH
4104
+ # },
4105
+ # client_token: "ClientRequestToken", # required
4106
+ # description: "String",
4107
+ # }
4108
+ #
4109
+ # @!attribute [rw] license_manager_report_generator_arn
4110
+ # Amazon Resource Number (ARN) of the report generator to update.
4111
+ # @return [String]
4112
+ #
4113
+ # @!attribute [rw] report_generator_name
4114
+ # Name of the report generator.
4115
+ # @return [String]
4116
+ #
4117
+ # @!attribute [rw] type
4118
+ # Type of reports to generate. The following report types an be
4119
+ # generated:
4120
+ #
4121
+ # * License configuration report - Reports on the number and details
4122
+ # of consumed licenses for a license configuration.
4123
+ #
4124
+ # * Resource report - Reports on the tracked licenses and resource
4125
+ # consumption for a license configuration.
4126
+ # @return [Array<String>]
4127
+ #
4128
+ # @!attribute [rw] report_context
4129
+ # ?
4130
+ # @return [Types::ReportContext]
4131
+ #
4132
+ # @!attribute [rw] report_frequency
4133
+ # Frequency by which reports are generated. The following options are
4134
+ # avaiable:
4135
+ #
4136
+ # ??? What are the APi value options?
4137
+ # @return [Types::ReportFrequency]
4138
+ #
4139
+ # @!attribute [rw] client_token
4140
+ # Unique, case-sensitive identifier that you provide to ensure the
4141
+ # idempotency of the request.
4142
+ # @return [String]
4143
+ #
4144
+ # @!attribute [rw] description
4145
+ # Description of the report generator.
4146
+ # @return [String]
4147
+ #
4148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/UpdateLicenseManagerReportGeneratorRequest AWS API Documentation
4149
+ #
4150
+ class UpdateLicenseManagerReportGeneratorRequest < Struct.new(
4151
+ :license_manager_report_generator_arn,
4152
+ :report_generator_name,
4153
+ :type,
4154
+ :report_context,
4155
+ :report_frequency,
4156
+ :client_token,
4157
+ :description)
4158
+ SENSITIVE = []
4159
+ include Aws::Structure
4160
+ end
4161
+
4162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/UpdateLicenseManagerReportGeneratorResponse AWS API Documentation
4163
+ #
4164
+ class UpdateLicenseManagerReportGeneratorResponse < Aws::EmptyStructure; end
4165
+
3714
4166
  # @note When making an API call, you may pass UpdateLicenseSpecificationsForResourceRequest
3715
4167
  # data as a hash:
3716
4168
  #