aws-sdk-partnercentralselling 1.2.0 → 1.3.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.
@@ -10,6 +10,29 @@
10
10
  module Aws::PartnerCentralSelling
11
11
  module Types
12
12
 
13
+ # @!attribute [rw] catalog
14
+ # The `CatalogType` parameter specifies the catalog associated with
15
+ # the engagement invitation. Accepted values are `AWS` and `Sandbox`,
16
+ # which determine the environment in which the engagement invitation
17
+ # is managed.
18
+ # @return [String]
19
+ #
20
+ # @!attribute [rw] identifier
21
+ # The `Identifier` parameter in the
22
+ # `AcceptEngagementInvitationRequest` specifies the unique identifier
23
+ # of the `EngagementInvitation` to be accepted. Providing the correct
24
+ # identifier ensures that the intended invitation is accepted.
25
+ # @return [String]
26
+ #
27
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/AcceptEngagementInvitationRequest AWS API Documentation
28
+ #
29
+ class AcceptEngagementInvitationRequest < Struct.new(
30
+ :catalog,
31
+ :identifier)
32
+ SENSITIVE = []
33
+ include Aws::Structure
34
+ end
35
+
13
36
  # This error occurs when you don't have permission to perform the
14
37
  # requested action.
15
38
  #
@@ -619,6 +642,138 @@ module Aws::PartnerCentralSelling
619
642
  include Aws::Structure
620
643
  end
621
644
 
645
+ # @!attribute [rw] catalog
646
+ # Specifies the catalog related to the engagement. Accepted values are
647
+ # `AWS` and `Sandbox`, which determine the environment in which the
648
+ # engagement is managed.
649
+ # @return [String]
650
+ #
651
+ # @!attribute [rw] client_token
652
+ # Specifies a unique, client-generated UUID to ensure that the request
653
+ # is handled exactly once. This token helps prevent duplicate
654
+ # invitation creations.
655
+ #
656
+ # **A suitable default value is auto-generated.** You should normally
657
+ # not need to pass this option.
658
+ # @return [String]
659
+ #
660
+ # @!attribute [rw] engagement_identifier
661
+ # The unique identifier of the `Engagement` associated with the
662
+ # invitation. This parameter ensures the invitation is created within
663
+ # the correct `Engagement` context.
664
+ # @return [String]
665
+ #
666
+ # @!attribute [rw] invitation
667
+ # The `Invitation` object all information necessary to initiate an
668
+ # engagement invitation to a partner. It contains a personalized
669
+ # message from the sender, the invitation's receiver, and a payload.
670
+ # The `Payload` can be the `OpportunityInvitation`, which includes
671
+ # detailed structures for sender contacts, partner responsibilities,
672
+ # customer information, and project details.
673
+ # @return [Types::Invitation]
674
+ #
675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CreateEngagementInvitationRequest AWS API Documentation
676
+ #
677
+ class CreateEngagementInvitationRequest < Struct.new(
678
+ :catalog,
679
+ :client_token,
680
+ :engagement_identifier,
681
+ :invitation)
682
+ SENSITIVE = []
683
+ include Aws::Structure
684
+ end
685
+
686
+ # @!attribute [rw] arn
687
+ # The Amazon Resource Name (ARN) that uniquely identifies the
688
+ # engagement invitation.
689
+ # @return [String]
690
+ #
691
+ # @!attribute [rw] id
692
+ # Unique identifier assigned to the newly created engagement
693
+ # invitation.
694
+ # @return [String]
695
+ #
696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CreateEngagementInvitationResponse AWS API Documentation
697
+ #
698
+ class CreateEngagementInvitationResponse < Struct.new(
699
+ :arn,
700
+ :id)
701
+ SENSITIVE = []
702
+ include Aws::Structure
703
+ end
704
+
705
+ # @!attribute [rw] catalog
706
+ # The `CreateEngagementRequest$Catalog` parameter specifies the
707
+ # catalog related to the engagement. Accepted values are `AWS` and
708
+ # `Sandbox`, which determine the environment in which the engagement
709
+ # is managed.
710
+ # @return [String]
711
+ #
712
+ # @!attribute [rw] client_token
713
+ # The `CreateEngagementRequest$ClientToken` parameter specifies a
714
+ # unique, case-sensitive identifier to ensure that the request is
715
+ # handled exactly once. The value must not exceed sixty-four
716
+ # alphanumeric characters.
717
+ #
718
+ # **A suitable default value is auto-generated.** You should normally
719
+ # not need to pass this option.
720
+ # @return [String]
721
+ #
722
+ # @!attribute [rw] contexts
723
+ # The `Contexts` field is a required array of objects, with a maximum
724
+ # of 5 contexts allowed, specifying detailed information about
725
+ # customer projects associated with the Engagement. Each context
726
+ # object contains a `Type` field indicating the context type, which
727
+ # must be `CustomerProject` in this version, and a `Payload` field
728
+ # containing the `CustomerProject` details. The `CustomerProject`
729
+ # object is composed of two main components: `Customer` and `Project`.
730
+ # The `Customer` object includes information such as `CompanyName`,
731
+ # `WebsiteUrl`, `Industry`, and `CountryCode`, providing essential
732
+ # details about the customer. The `Project` object contains `Title`,
733
+ # `BusinessProblem`, and `TargetCompletionDate`, offering insights
734
+ # into the specific project associated with the customer. This
735
+ # structure allows comprehensive context to be included within the
736
+ # Engagement, facilitating effective collaboration between parties by
737
+ # providing relevant customer and project information.
738
+ # @return [Array<Types::EngagementContextDetails>]
739
+ #
740
+ # @!attribute [rw] description
741
+ # Provides a description of the `Engagement`.
742
+ # @return [String]
743
+ #
744
+ # @!attribute [rw] title
745
+ # Specifies the title of the `Engagement`.
746
+ # @return [String]
747
+ #
748
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CreateEngagementRequest AWS API Documentation
749
+ #
750
+ class CreateEngagementRequest < Struct.new(
751
+ :catalog,
752
+ :client_token,
753
+ :contexts,
754
+ :description,
755
+ :title)
756
+ SENSITIVE = []
757
+ include Aws::Structure
758
+ end
759
+
760
+ # @!attribute [rw] arn
761
+ # The Amazon Resource Name (ARN) that identifies the engagement.
762
+ # @return [String]
763
+ #
764
+ # @!attribute [rw] id
765
+ # Unique identifier assigned to the newly created engagement.
766
+ # @return [String]
767
+ #
768
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CreateEngagementResponse AWS API Documentation
769
+ #
770
+ class CreateEngagementResponse < Struct.new(
771
+ :arn,
772
+ :id)
773
+ SENSITIVE = []
774
+ include Aws::Structure
775
+ end
776
+
622
777
  # @!attribute [rw] catalog
623
778
  # Specifies the catalog associated with the request. This field takes
624
779
  # a string value from a predefined list: `AWS` or `Sandbox`. The
@@ -815,6 +970,144 @@ module Aws::PartnerCentralSelling
815
970
  include Aws::Structure
816
971
  end
817
972
 
973
+ # @!attribute [rw] catalog
974
+ # Specifies the catalog in which to create the snapshot job. Valid
975
+ # values are `AWS` and ` Sandbox`.
976
+ # @return [String]
977
+ #
978
+ # @!attribute [rw] client_token
979
+ # Specifies a unique, client-generated UUID to ensure that the request
980
+ # is handled exactly once. This token helps prevent duplicate snapshot
981
+ # job creations.
982
+ #
983
+ # **A suitable default value is auto-generated.** You should normally
984
+ # not need to pass this option.
985
+ # @return [String]
986
+ #
987
+ # @!attribute [rw] engagement_identifier
988
+ # Specifies the identifier of the engagement associated with the
989
+ # resource to be snapshotted.
990
+ # @return [String]
991
+ #
992
+ # @!attribute [rw] resource_identifier
993
+ # Specifies the identifier of the specific resource to be snapshotted.
994
+ # The format depends on the `ResourceType`.
995
+ # @return [String]
996
+ #
997
+ # @!attribute [rw] resource_snapshot_template_identifier
998
+ # Specifies the name of the template that defines the schema for the
999
+ # snapshot.
1000
+ # @return [String]
1001
+ #
1002
+ # @!attribute [rw] resource_type
1003
+ # The type of resource for which the snapshot job is being created.
1004
+ # Must be one of the supported resource types `Opportunity`.
1005
+ # @return [String]
1006
+ #
1007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CreateResourceSnapshotJobRequest AWS API Documentation
1008
+ #
1009
+ class CreateResourceSnapshotJobRequest < Struct.new(
1010
+ :catalog,
1011
+ :client_token,
1012
+ :engagement_identifier,
1013
+ :resource_identifier,
1014
+ :resource_snapshot_template_identifier,
1015
+ :resource_type)
1016
+ SENSITIVE = []
1017
+ include Aws::Structure
1018
+ end
1019
+
1020
+ # @!attribute [rw] arn
1021
+ # The Amazon Resource Name (ARN) of the created snapshot job.
1022
+ # @return [String]
1023
+ #
1024
+ # @!attribute [rw] id
1025
+ # The unique identifier for the created snapshot job.
1026
+ # @return [String]
1027
+ #
1028
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CreateResourceSnapshotJobResponse AWS API Documentation
1029
+ #
1030
+ class CreateResourceSnapshotJobResponse < Struct.new(
1031
+ :arn,
1032
+ :id)
1033
+ SENSITIVE = []
1034
+ include Aws::Structure
1035
+ end
1036
+
1037
+ # @!attribute [rw] catalog
1038
+ # Specifies the catalog where the snapshot is created. Valid values
1039
+ # are `AWS` and `Sandbox`.
1040
+ # @return [String]
1041
+ #
1042
+ # @!attribute [rw] client_token
1043
+ # Specifies a unique, client-generated UUID to ensure that the request
1044
+ # is handled exactly once. This token helps prevent duplicate snapshot
1045
+ # creations.
1046
+ #
1047
+ # **A suitable default value is auto-generated.** You should normally
1048
+ # not need to pass this option.
1049
+ # @return [String]
1050
+ #
1051
+ # @!attribute [rw] engagement_identifier
1052
+ # The unique identifier of the engagement associated with this
1053
+ # snapshot. This field links the snapshot to a specific engagement
1054
+ # context.
1055
+ # @return [String]
1056
+ #
1057
+ # @!attribute [rw] resource_identifier
1058
+ # The unique identifier of the specific resource to be snapshotted.
1059
+ # The format and constraints of this identifier depend on the
1060
+ # `ResourceType` specified. For example: For `Opportunity` type, it
1061
+ # will be an opportunity ID.
1062
+ # @return [String]
1063
+ #
1064
+ # @!attribute [rw] resource_snapshot_template_identifier
1065
+ # The name of the template that defines the schema for the snapshot.
1066
+ # This template determines which subset of the resource data will be
1067
+ # included in the snapshot. Must correspond to an existing and valid
1068
+ # template for the specified `ResourceType`.
1069
+ # @return [String]
1070
+ #
1071
+ # @!attribute [rw] resource_type
1072
+ # Specifies the type of resource for which the snapshot is being
1073
+ # created. This field determines the structure and content of the
1074
+ # snapshot. Must be one of the supported resource types, such as:
1075
+ # `Opportunity`.
1076
+ # @return [String]
1077
+ #
1078
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CreateResourceSnapshotRequest AWS API Documentation
1079
+ #
1080
+ class CreateResourceSnapshotRequest < Struct.new(
1081
+ :catalog,
1082
+ :client_token,
1083
+ :engagement_identifier,
1084
+ :resource_identifier,
1085
+ :resource_snapshot_template_identifier,
1086
+ :resource_type)
1087
+ SENSITIVE = []
1088
+ include Aws::Structure
1089
+ end
1090
+
1091
+ # @!attribute [rw] arn
1092
+ # Specifies the Amazon Resource Name (ARN) that uniquely identifies
1093
+ # the snapshot created.
1094
+ # @return [String]
1095
+ #
1096
+ # @!attribute [rw] revision
1097
+ # Specifies the revision number of the created snapshot. This field
1098
+ # provides important information about the snapshot's place in the
1099
+ # sequence of snapshots for the given resource.
1100
+ # @return [Integer]
1101
+ #
1102
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CreateResourceSnapshotResponse AWS API Documentation
1103
+ #
1104
+ class CreateResourceSnapshotResponse < Struct.new(
1105
+ :arn,
1106
+ :revision)
1107
+ SENSITIVE = []
1108
+ include Aws::Structure
1109
+ end
1110
+
818
1111
  # An object that contains the customer's `Account` and `Contact`.
819
1112
  #
820
1113
  # @!attribute [rw] account
@@ -838,6 +1131,38 @@ module Aws::PartnerCentralSelling
838
1131
  include Aws::Structure
839
1132
  end
840
1133
 
1134
+ # The CustomerProjects structure in Engagements offers a flexible
1135
+ # framework for managing customer-project relationships. It supports
1136
+ # multiple customers per Engagement and multiple projects per customer,
1137
+ # while also allowing for customers without projects and projects
1138
+ # without specific customers.
1139
+ #
1140
+ # All Engagement members have full visibility of customers and their
1141
+ # associated projects, enabling the capture of relevant context even
1142
+ # when project details are not fully defined. This structure also
1143
+ # facilitates targeted invitations, allowing partners to focus on
1144
+ # specific customers and their business problems when sending Engagement
1145
+ # invitations.
1146
+ #
1147
+ # @!attribute [rw] customer
1148
+ # Contains details about the customer associated with the Engagement
1149
+ # Invitation, including company information and industry.
1150
+ # @return [Types::EngagementCustomer]
1151
+ #
1152
+ # @!attribute [rw] project
1153
+ # Information about the customer project associated with the
1154
+ # Engagement.
1155
+ # @return [Types::EngagementCustomerProjectDetails]
1156
+ #
1157
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CustomerProjectsContext AWS API Documentation
1158
+ #
1159
+ class CustomerProjectsContext < Struct.new(
1160
+ :customer,
1161
+ :project)
1162
+ SENSITIVE = []
1163
+ include Aws::Structure
1164
+ end
1165
+
841
1166
  # An object that contains a `Customer` object's subset of fields.
842
1167
  #
843
1168
  # @!attribute [rw] account
@@ -852,6 +1177,24 @@ module Aws::PartnerCentralSelling
852
1177
  include Aws::Structure
853
1178
  end
854
1179
 
1180
+ # @!attribute [rw] catalog
1181
+ # Specifies the catalog from which to delete the snapshot job. Valid
1182
+ # values are `AWS` and `Sandbox`.
1183
+ # @return [String]
1184
+ #
1185
+ # @!attribute [rw] resource_snapshot_job_identifier
1186
+ # The unique identifier of the resource snapshot job to be deleted.
1187
+ # @return [String]
1188
+ #
1189
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/DeleteResourceSnapshotJobRequest AWS API Documentation
1190
+ #
1191
+ class DeleteResourceSnapshotJobRequest < Struct.new(
1192
+ :catalog,
1193
+ :resource_snapshot_job_identifier)
1194
+ SENSITIVE = []
1195
+ include Aws::Structure
1196
+ end
1197
+
855
1198
  # @!attribute [rw] catalog
856
1199
  # Specifies the catalog associated with the request. This field takes
857
1200
  # a string value from a predefined list: `AWS` or `Sandbox`. The
@@ -917,6 +1260,57 @@ module Aws::PartnerCentralSelling
917
1260
  include Aws::Structure
918
1261
  end
919
1262
 
1263
+ # Provides detailed context information for an Engagement. This
1264
+ # structure allows for specifying the type of context and its associated
1265
+ # payload.
1266
+ #
1267
+ # @!attribute [rw] payload
1268
+ # Contains the specific details of the Engagement context. The
1269
+ # structure of this payload varies depending on the Type field.
1270
+ # @return [Types::EngagementContextPayload]
1271
+ #
1272
+ # @!attribute [rw] type
1273
+ # Specifies the type of Engagement context. Valid values are
1274
+ # "CustomerProject" or "Document", indicating whether the context
1275
+ # relates to a customer project or a document respectively.
1276
+ # @return [String]
1277
+ #
1278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementContextDetails AWS API Documentation
1279
+ #
1280
+ class EngagementContextDetails < Struct.new(
1281
+ :payload,
1282
+ :type)
1283
+ SENSITIVE = []
1284
+ include Aws::Structure
1285
+ end
1286
+
1287
+ # Represents the payload of an Engagement context. The structure of this
1288
+ # payload varies based on the context type specified in the
1289
+ # EngagementContextDetails.
1290
+ #
1291
+ # @note EngagementContextPayload is a union - when making an API calls you must set exactly one of the members.
1292
+ #
1293
+ # @note EngagementContextPayload is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EngagementContextPayload corresponding to the set member.
1294
+ #
1295
+ # @!attribute [rw] customer_project
1296
+ # Contains detailed information about a customer project when the
1297
+ # context type is "CustomerProject". This field is present only when
1298
+ # the Type in EngagementContextDetails is set to "CustomerProject".
1299
+ # @return [Types::CustomerProjectsContext]
1300
+ #
1301
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementContextPayload AWS API Documentation
1302
+ #
1303
+ class EngagementContextPayload < Struct.new(
1304
+ :customer_project,
1305
+ :unknown)
1306
+ SENSITIVE = []
1307
+ include Aws::Structure
1308
+ include Aws::Structure::Union
1309
+
1310
+ class CustomerProject < EngagementContextPayload; end
1311
+ class Unknown < EngagementContextPayload; end
1312
+ end
1313
+
920
1314
  # Contains details about the customer associated with the Engagement
921
1315
  # Invitation, including company information and industry.
922
1316
  #
@@ -954,6 +1348,32 @@ module Aws::PartnerCentralSelling
954
1348
  include Aws::Structure
955
1349
  end
956
1350
 
1351
+ # Provides comprehensive details about a customer project associated
1352
+ # with an Engagement. This may include information such as project
1353
+ # goals, timelines, and specific customer requirements.
1354
+ #
1355
+ # @!attribute [rw] business_problem
1356
+ # A description of the business problem the project aims to solve.
1357
+ # @return [String]
1358
+ #
1359
+ # @!attribute [rw] target_completion_date
1360
+ # The target completion date for the customer's project.
1361
+ # @return [String]
1362
+ #
1363
+ # @!attribute [rw] title
1364
+ # The title of the project.
1365
+ # @return [String]
1366
+ #
1367
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementCustomerProjectDetails AWS API Documentation
1368
+ #
1369
+ class EngagementCustomerProjectDetails < Struct.new(
1370
+ :business_problem,
1371
+ :target_completion_date,
1372
+ :title)
1373
+ SENSITIVE = [:business_problem]
1374
+ include Aws::Structure
1375
+ end
1376
+
957
1377
  # Provides a summarized view of the Engagement Invitation, including
958
1378
  # details like the identifier, status, and sender. This summary helps
959
1379
  # partners track and manage AWS originated opportunities.
@@ -970,6 +1390,11 @@ module Aws::PartnerCentralSelling
970
1390
  # whether the opportunity is live or being tested.
971
1391
  # @return [String]
972
1392
  #
1393
+ # @!attribute [rw] engagement_id
1394
+ # The identifier of the Engagement associated with this invitation.
1395
+ # This links the invitation to its parent Engagement.
1396
+ # @return [String]
1397
+ #
973
1398
  # @!attribute [rw] engagement_title
974
1399
  # Provides a short title or description of the Engagement Invitation.
975
1400
  # This title helps partners quickly identify and differentiate between
@@ -994,6 +1419,10 @@ module Aws::PartnerCentralSelling
994
1419
  # and helps in tracking the timeline for engagement.
995
1420
  # @return [Time]
996
1421
  #
1422
+ # @!attribute [rw] participant_type
1423
+ # Identifies the role of the caller in the engagement invitation.
1424
+ # @return [String]
1425
+ #
997
1426
  # @!attribute [rw] payload_type
998
1427
  # Describes the type of payload associated with the Engagement
999
1428
  # Invitation, such as `Opportunity` or `MarketplaceOffer`. This helps
@@ -1029,10 +1458,12 @@ module Aws::PartnerCentralSelling
1029
1458
  class EngagementInvitationSummary < Struct.new(
1030
1459
  :arn,
1031
1460
  :catalog,
1461
+ :engagement_id,
1032
1462
  :engagement_title,
1033
1463
  :expiration_date,
1034
1464
  :id,
1035
1465
  :invitation_date,
1466
+ :participant_type,
1036
1467
  :payload_type,
1037
1468
  :receiver,
1038
1469
  :sender_aws_account_id,
@@ -1042,48 +1473,218 @@ module Aws::PartnerCentralSelling
1042
1473
  include Aws::Structure
1043
1474
  end
1044
1475
 
1045
- # Provides an estimate of the revenue that the partner is expected to
1046
- # generate from the opportunity. This information helps partners assess
1047
- # the financial value of the project.
1476
+ # Engagement members are the participants in an Engagement, which is
1477
+ # likely a collaborative project or business opportunity within the AWS
1478
+ # partner network. Members can be different partner organizations or AWS
1479
+ # accounts that are working together on a specific engagement.
1048
1480
  #
1049
- # @!attribute [rw] amount
1050
- # Represents the estimated monthly revenue that the partner expects to
1051
- # earn from the opportunity. This helps in forecasting financial
1052
- # returns.
1053
- # @return [String]
1481
+ # Each member is represented by their AWS Account ID, Company Name, and
1482
+ # associated details. Members have a status within the Engagement
1483
+ # (PENDING, ACCEPTED, REJECTED, or WITHDRAWN), indicating their current
1484
+ # state of participation. Only existing members of an Engagement can
1485
+ # view the list of other members. This implies a level of privacy and
1486
+ # access control within the Engagement structure.
1054
1487
  #
1055
- # @!attribute [rw] currency_code
1056
- # Indicates the currency in which the revenue estimate is provided.
1057
- # This helps in understanding the financial impact across different
1058
- # markets.
1488
+ # @!attribute [rw] account_id
1489
+ # This is the unique identifier for the AWS account associated with
1490
+ # the member organization. It's used for AWS-related operations and
1491
+ # identity verification.
1059
1492
  # @return [String]
1060
1493
  #
1061
- # @!attribute [rw] frequency
1062
- # Indicates how frequently the customer is expected to spend the
1063
- # projected amount. This can include values such as `Monthly`,
1064
- # `Quarterly`, or `Annually`. The default value is `Monthly`,
1065
- # representing recurring monthly spend.
1494
+ # @!attribute [rw] company_name
1495
+ # The official name of the member's company or organization.
1066
1496
  # @return [String]
1067
1497
  #
1068
- # @!attribute [rw] target_company
1069
- # Specifies the name of the partner company that is expected to
1070
- # generate revenue from the opportunity. This field helps track the
1071
- # partner’s involvement in the opportunity.
1498
+ # @!attribute [rw] website_url
1499
+ # The URL of the member company's website. This offers a way to find
1500
+ # more information about the member organization and serves as an
1501
+ # additional identifier.
1072
1502
  # @return [String]
1073
1503
  #
1074
- # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ExpectedCustomerSpend AWS API Documentation
1504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementMember AWS API Documentation
1075
1505
  #
1076
- class ExpectedCustomerSpend < Struct.new(
1077
- :amount,
1078
- :currency_code,
1079
- :frequency,
1080
- :target_company)
1081
- SENSITIVE = [:currency_code]
1506
+ class EngagementMember < Struct.new(
1507
+ :account_id,
1508
+ :company_name,
1509
+ :website_url)
1510
+ SENSITIVE = [:account_id]
1082
1511
  include Aws::Structure
1083
1512
  end
1084
1513
 
1085
- # @!attribute [rw] catalog
1086
- # Specifies the catalog in which the AWS Opportunity is located.
1514
+ # The EngagementMemberSummary provides a snapshot of essential
1515
+ # information about participants in an AWS Partner Central Engagement.
1516
+ # This compact data structure encapsulates key details of each member,
1517
+ # facilitating efficient collaboration and management within the
1518
+ # Engagement.
1519
+ #
1520
+ # @!attribute [rw] company_name
1521
+ # The official name of the member's company or organization.
1522
+ # @return [String]
1523
+ #
1524
+ # @!attribute [rw] website_url
1525
+ # The URL of the member company's website. This offers a way to find
1526
+ # more information about the member organization and serves as an
1527
+ # additional identifier.
1528
+ # @return [String]
1529
+ #
1530
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementMemberSummary AWS API Documentation
1531
+ #
1532
+ class EngagementMemberSummary < Struct.new(
1533
+ :company_name,
1534
+ :website_url)
1535
+ SENSITIVE = []
1536
+ include Aws::Structure
1537
+ end
1538
+
1539
+ # This provide a streamlined view of the relationships between
1540
+ # engagements and resources. These summaries offer a crucial link
1541
+ # between collaborative engagements and the specific resources involved,
1542
+ # such as opportunities.These summaries are particularly valuable for
1543
+ # partners navigating complex engagements with multiple resources. They
1544
+ # enable quick insights into resource distribution across engagements,
1545
+ # support efficient resource management, and help maintain a clear
1546
+ # overview of collaborative activities.
1547
+ #
1548
+ # @!attribute [rw] catalog
1549
+ # Indicates the environment in which the resource and engagement
1550
+ # exist.
1551
+ # @return [String]
1552
+ #
1553
+ # @!attribute [rw] created_by
1554
+ # The AWS account ID of the entity that created the association.
1555
+ # @return [String]
1556
+ #
1557
+ # @!attribute [rw] engagement_id
1558
+ # A unique identifier for the engagement associated with the resource.
1559
+ # @return [String]
1560
+ #
1561
+ # @!attribute [rw] resource_id
1562
+ # A unique identifier for the specific resource. Varies depending on
1563
+ # the resource type.
1564
+ # @return [String]
1565
+ #
1566
+ # @!attribute [rw] resource_type
1567
+ # Categorizes the type of resource associated with the engagement.
1568
+ # @return [String]
1569
+ #
1570
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementResourceAssociationSummary AWS API Documentation
1571
+ #
1572
+ class EngagementResourceAssociationSummary < Struct.new(
1573
+ :catalog,
1574
+ :created_by,
1575
+ :engagement_id,
1576
+ :resource_id,
1577
+ :resource_type)
1578
+ SENSITIVE = [:created_by]
1579
+ include Aws::Structure
1580
+ end
1581
+
1582
+ # Specifies the sorting parameters for listing Engagements.
1583
+ #
1584
+ # @!attribute [rw] sort_by
1585
+ # The field by which to sort the results.
1586
+ # @return [String]
1587
+ #
1588
+ # @!attribute [rw] sort_order
1589
+ # The order in which to sort the results.
1590
+ # @return [String]
1591
+ #
1592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementSort AWS API Documentation
1593
+ #
1594
+ class EngagementSort < Struct.new(
1595
+ :sort_by,
1596
+ :sort_order)
1597
+ SENSITIVE = []
1598
+ include Aws::Structure
1599
+ end
1600
+
1601
+ # An object that contains an `Engagement`'s subset of fields.
1602
+ #
1603
+ # @!attribute [rw] arn
1604
+ # The Amazon Resource Name (ARN) of the created engagement.
1605
+ # @return [String]
1606
+ #
1607
+ # @!attribute [rw] created_at
1608
+ # The date and time when the engagement was created.
1609
+ # @return [Time]
1610
+ #
1611
+ # @!attribute [rw] created_by
1612
+ # The AWS account ID of the engagement creator.
1613
+ # @return [String]
1614
+ #
1615
+ # @!attribute [rw] id
1616
+ # The unique identifier for the engagement.
1617
+ # @return [String]
1618
+ #
1619
+ # @!attribute [rw] member_count
1620
+ # The number of members in the engagement.
1621
+ # @return [Integer]
1622
+ #
1623
+ # @!attribute [rw] title
1624
+ # The title of the engagement.
1625
+ # @return [String]
1626
+ #
1627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementSummary AWS API Documentation
1628
+ #
1629
+ class EngagementSummary < Struct.new(
1630
+ :arn,
1631
+ :created_at,
1632
+ :created_by,
1633
+ :id,
1634
+ :member_count,
1635
+ :title)
1636
+ SENSITIVE = [:created_by]
1637
+ include Aws::Structure
1638
+ end
1639
+
1640
+ # Provides an estimate of the revenue that the partner is expected to
1641
+ # generate from the opportunity. This information helps partners assess
1642
+ # the financial value of the project.
1643
+ #
1644
+ # @!attribute [rw] amount
1645
+ # Represents the estimated monthly revenue that the partner expects to
1646
+ # earn from the opportunity. This helps in forecasting financial
1647
+ # returns.
1648
+ # @return [String]
1649
+ #
1650
+ # @!attribute [rw] currency_code
1651
+ # Indicates the currency in which the revenue estimate is provided.
1652
+ # This helps in understanding the financial impact across different
1653
+ # markets.
1654
+ # @return [String]
1655
+ #
1656
+ # @!attribute [rw] estimation_url
1657
+ # A URL providing additional information or context about the spend
1658
+ # estimation.
1659
+ # @return [String]
1660
+ #
1661
+ # @!attribute [rw] frequency
1662
+ # Indicates how frequently the customer is expected to spend the
1663
+ # projected amount. This can include values such as `Monthly`,
1664
+ # `Quarterly`, or `Annually`. The default value is `Monthly`,
1665
+ # representing recurring monthly spend.
1666
+ # @return [String]
1667
+ #
1668
+ # @!attribute [rw] target_company
1669
+ # Specifies the name of the partner company that is expected to
1670
+ # generate revenue from the opportunity. This field helps track the
1671
+ # partner’s involvement in the opportunity.
1672
+ # @return [String]
1673
+ #
1674
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ExpectedCustomerSpend AWS API Documentation
1675
+ #
1676
+ class ExpectedCustomerSpend < Struct.new(
1677
+ :amount,
1678
+ :currency_code,
1679
+ :estimation_url,
1680
+ :frequency,
1681
+ :target_company)
1682
+ SENSITIVE = [:currency_code, :estimation_url]
1683
+ include Aws::Structure
1684
+ end
1685
+
1686
+ # @!attribute [rw] catalog
1687
+ # Specifies the catalog in which the AWS Opportunity is located.
1087
1688
  # Accepted values include `AWS` for production opportunities or
1088
1689
  # `Sandbox` for testing purposes. The catalog determines which
1089
1690
  # environment the opportunity data is pulled from.
@@ -1229,11 +1830,31 @@ module Aws::PartnerCentralSelling
1229
1830
  # catalog (e.g., `AWS` or `Sandbox`) used in the request.
1230
1831
  # @return [String]
1231
1832
  #
1833
+ # @!attribute [rw] engagement_description
1834
+ # The description of the engagement associated with this invitation.
1835
+ # @return [String]
1836
+ #
1837
+ # @!attribute [rw] engagement_id
1838
+ # The identifier of the engagement associated with this
1839
+ # invitation.This ID links the invitation to its corresponding
1840
+ # engagement.
1841
+ # @return [String]
1842
+ #
1232
1843
  # @!attribute [rw] engagement_title
1233
1844
  # The title of the engagement invitation, summarizing the purpose or
1234
1845
  # objectives of the opportunity shared by AWS.
1235
1846
  # @return [String]
1236
1847
  #
1848
+ # @!attribute [rw] existing_members
1849
+ # A list of active members currently part of the Engagement. This
1850
+ # array contains a maximum of 10 members, each represented by an
1851
+ # object with the following properties.
1852
+ #
1853
+ # * CompanyName: The name of the member's company.
1854
+ #
1855
+ # * WebsiteUrl: The website URL of the member's company.
1856
+ # @return [Array<Types::EngagementMemberSummary>]
1857
+ #
1237
1858
  # @!attribute [rw] expiration_date
1238
1859
  # Indicates the date on which the engagement invitation will expire if
1239
1860
  # not accepted by the partner.
@@ -1248,6 +1869,11 @@ module Aws::PartnerCentralSelling
1248
1869
  # The date when the engagement invitation was sent to the partner.
1249
1870
  # @return [Time]
1250
1871
  #
1872
+ # @!attribute [rw] invitation_message
1873
+ # The message sent to the invited partner when the invitation was
1874
+ # created.
1875
+ # @return [String]
1876
+ #
1251
1877
  # @!attribute [rw] payload
1252
1878
  # Details of the engagement invitation payload, including specific
1253
1879
  # data relevant to the invitation's contents, such as customer
@@ -1288,10 +1914,14 @@ module Aws::PartnerCentralSelling
1288
1914
  class GetEngagementInvitationResponse < Struct.new(
1289
1915
  :arn,
1290
1916
  :catalog,
1917
+ :engagement_description,
1918
+ :engagement_id,
1291
1919
  :engagement_title,
1920
+ :existing_members,
1292
1921
  :expiration_date,
1293
1922
  :id,
1294
1923
  :invitation_date,
1924
+ :invitation_message,
1295
1925
  :payload,
1296
1926
  :payload_type,
1297
1927
  :receiver,
@@ -1303,6 +1933,82 @@ module Aws::PartnerCentralSelling
1303
1933
  include Aws::Structure
1304
1934
  end
1305
1935
 
1936
+ # @!attribute [rw] catalog
1937
+ # Specifies the catalog related to the engagement request. Valid
1938
+ # values are `AWS` and `Sandbox`.
1939
+ # @return [String]
1940
+ #
1941
+ # @!attribute [rw] identifier
1942
+ # Specifies the identifier of the Engagement record to retrieve.
1943
+ # @return [String]
1944
+ #
1945
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetEngagementRequest AWS API Documentation
1946
+ #
1947
+ class GetEngagementRequest < Struct.new(
1948
+ :catalog,
1949
+ :identifier)
1950
+ SENSITIVE = []
1951
+ include Aws::Structure
1952
+ end
1953
+
1954
+ # @!attribute [rw] arn
1955
+ # The Amazon Resource Name (ARN) of the engagement retrieved.
1956
+ # @return [String]
1957
+ #
1958
+ # @!attribute [rw] contexts
1959
+ # A list of context objects associated with the engagement. Each
1960
+ # context provides additional information related to the Engagement,
1961
+ # such as customer projects or documents.
1962
+ # @return [Array<Types::EngagementContextDetails>]
1963
+ #
1964
+ # @!attribute [rw] created_at
1965
+ # The date and time when the Engagement was created, presented in ISO
1966
+ # 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This
1967
+ # timestamp helps track the lifecycle of the Engagement.
1968
+ # @return [Time]
1969
+ #
1970
+ # @!attribute [rw] created_by
1971
+ # The AWS account ID of the user who originally created the
1972
+ # engagement. This field helps in tracking the origin of the
1973
+ # engagement.
1974
+ # @return [String]
1975
+ #
1976
+ # @!attribute [rw] description
1977
+ # A more detailed description of the engagement. This provides
1978
+ # additional context or information about the engagement's purpose or
1979
+ # scope.
1980
+ # @return [String]
1981
+ #
1982
+ # @!attribute [rw] id
1983
+ # The unique resource identifier of the engagement retrieved.
1984
+ # @return [String]
1985
+ #
1986
+ # @!attribute [rw] member_count
1987
+ # Specifies the current count of members participating in the
1988
+ # Engagement. This count includes all active members regardless of
1989
+ # their roles or permissions within the Engagement.
1990
+ # @return [Integer]
1991
+ #
1992
+ # @!attribute [rw] title
1993
+ # The title of the engagement. It provides a brief, descriptive name
1994
+ # for the engagement that is meaningful and easily recognizable.
1995
+ # @return [String]
1996
+ #
1997
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetEngagementResponse AWS API Documentation
1998
+ #
1999
+ class GetEngagementResponse < Struct.new(
2000
+ :arn,
2001
+ :contexts,
2002
+ :created_at,
2003
+ :created_by,
2004
+ :description,
2005
+ :id,
2006
+ :member_count,
2007
+ :title)
2008
+ SENSITIVE = [:created_by]
2009
+ include Aws::Structure
2010
+ end
2011
+
1306
2012
  # @!attribute [rw] catalog
1307
2013
  # Specifies the catalog associated with the request. This field takes
1308
2014
  # a string value from a predefined list: `AWS` or `Sandbox`. The
@@ -1325,6 +2031,11 @@ module Aws::PartnerCentralSelling
1325
2031
  include Aws::Structure
1326
2032
  end
1327
2033
 
2034
+ # @!attribute [rw] arn
2035
+ # The Amazon Resource Name (ARN) that uniquely identifies the
2036
+ # opportunity.
2037
+ # @return [String]
2038
+ #
1328
2039
  # @!attribute [rw] catalog
1329
2040
  # Specifies the catalog associated with the request. This field takes
1330
2041
  # a string value from a predefined list: `AWS` or `Sandbox`. The
@@ -1461,6 +2172,7 @@ module Aws::PartnerCentralSelling
1461
2172
  # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetOpportunityResponse AWS API Documentation
1462
2173
  #
1463
2174
  class GetOpportunityResponse < Struct.new(
2175
+ :arn,
1464
2176
  :catalog,
1465
2177
  :created_date,
1466
2178
  :customer,
@@ -1480,97 +2192,397 @@ module Aws::PartnerCentralSelling
1480
2192
  include Aws::Structure
1481
2193
  end
1482
2194
 
1483
- # This error occurs when the specified resource can’t be found or
1484
- # doesn't exist. Resource ID and type might be incorrect.
2195
+ # @!attribute [rw] catalog
2196
+ # Specifies the catalog related to the request. Valid values are:
1485
2197
  #
1486
- # Suggested action: This is usually a transient error. Retry after the
1487
- # provided retry delay or a short interval. If the problem persists,
1488
- # contact AWS support.
2198
+ # * AWS: Retrieves the snapshot job from the production AWS
2199
+ # environment.
1489
2200
  #
1490
- # @!attribute [rw] message
2201
+ # * Sandbox: Retrieves the snapshot job from a sandbox environment
2202
+ # used for testing or development purposes.
1491
2203
  # @return [String]
1492
2204
  #
1493
- # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/InternalServerException AWS API Documentation
2205
+ # @!attribute [rw] resource_snapshot_job_identifier
2206
+ # The unique identifier of the resource snapshot job to be retrieved.
2207
+ # This identifier is crucial for pinpointing the specific job you want
2208
+ # to query.
2209
+ # @return [String]
1494
2210
  #
1495
- class InternalServerException < Struct.new(
1496
- :message)
2211
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetResourceSnapshotJobRequest AWS API Documentation
2212
+ #
2213
+ class GetResourceSnapshotJobRequest < Struct.new(
2214
+ :catalog,
2215
+ :resource_snapshot_job_identifier)
1497
2216
  SENSITIVE = []
1498
2217
  include Aws::Structure
1499
2218
  end
1500
2219
 
1501
- # Defines a filter to retrieve opportunities based on the last modified
1502
- # date. This filter is useful for tracking changes or updates to
1503
- # opportunities over time.
2220
+ # @!attribute [rw] arn
2221
+ # he Amazon Resource Name (ARN) of the snapshot job. This globally
2222
+ # unique identifier can be used for resource-specific operations
2223
+ # across AWS services.
2224
+ # @return [String]
1504
2225
  #
1505
- # @!attribute [rw] after_last_modified_date
1506
- # Specifies the date after which the opportunities were modified. Use
1507
- # this filter to retrieve only those opportunities that were modified
1508
- # after a given timestamp.
1509
- # @return [Time]
2226
+ # @!attribute [rw] catalog
2227
+ # The catalog in which the snapshot job was created. This will match
2228
+ # the catalog specified in the request.
2229
+ # @return [String]
1510
2230
  #
1511
- # @!attribute [rw] before_last_modified_date
1512
- # Specifies the date before which the opportunities were modified. Use
1513
- # this filter to retrieve only those opportunities that were modified
1514
- # before a given timestamp.
2231
+ # @!attribute [rw] created_at
2232
+ # The date and time when the snapshot job was created, in ISO 8601
2233
+ # format (UTC). Example: "2023-05-01T20:37:46Z"
1515
2234
  # @return [Time]
1516
2235
  #
1517
- # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/LastModifiedDate AWS API Documentation
2236
+ # @!attribute [rw] engagement_id
2237
+ # The identifier of the engagement associated with this snapshot job.
2238
+ # This links the job to a specific engagement context.
2239
+ # @return [String]
1518
2240
  #
1519
- class LastModifiedDate < Struct.new(
1520
- :after_last_modified_date,
1521
- :before_last_modified_date)
1522
- SENSITIVE = []
1523
- include Aws::Structure
1524
- end
1525
-
1526
- # An object that contains the `Opportunity` lifecycle's details.
2241
+ # @!attribute [rw] id
2242
+ # The unique identifier of the snapshot job. This matches the
2243
+ # `ResourceSnapshotJobIdentifier` provided in the request.
2244
+ # @return [String]
1527
2245
  #
1528
- # @!attribute [rw] closed_lost_reason
1529
- # Specifies the reason code when an opportunity is marked as *Closed
1530
- # Lost*. When you select an appropriate reason code, you communicate
1531
- # the context for closing the `Opportunity`, and aid in accurate
1532
- # reports and analysis of opportunity outcomes. The possible values
1533
- # are:
2246
+ # @!attribute [rw] last_failure
2247
+ # If the job has encountered any failures, this field contains the
2248
+ # error message from the most recent failure. This can be useful for
2249
+ # troubleshooting issues with the job.
2250
+ # @return [String]
1534
2251
  #
1535
- # * Customer Deficiency: The customer lacked necessary resources or
1536
- # capabilities.
2252
+ # @!attribute [rw] last_successful_execution_date
2253
+ # The date and time of the last successful execution of the job, in
2254
+ # ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"
2255
+ # @return [Time]
1537
2256
  #
1538
- # * Delay/Cancellation of Project: The project was delayed or
1539
- # canceled.
2257
+ # @!attribute [rw] resource_arn
2258
+ # The Amazon Resource Name (ARN) of the resource being snapshotted.
2259
+ # This provides a globally unique identifier for the resource across
2260
+ # AWS.
2261
+ # @return [String]
1540
2262
  #
1541
- # * Legal/Tax/Regulatory: Legal, tax, or regulatory issues prevented
1542
- # progress.
2263
+ # @!attribute [rw] resource_id
2264
+ # The identifier of the specific resource being snapshotted. The
2265
+ # format may vary depending on the `ResourceType`.
2266
+ # @return [String]
1543
2267
  #
1544
- # * Lost to Competitor—Google: The opportunity was lost to Google.
2268
+ # @!attribute [rw] resource_snapshot_template_name
2269
+ # The name of the template used for creating the snapshot. This is the
2270
+ # same as the template name. It defines the structure and content of
2271
+ # the snapshot.
2272
+ # @return [String]
1545
2273
  #
1546
- # * Lost to Competitor—Microsoft: The opportunity was lost to
1547
- # Microsoft.
2274
+ # @!attribute [rw] resource_type
2275
+ # The type of resource being snapshotted. This would have
2276
+ # `Opportunity` as a value as it is dependent on the supported
2277
+ # resource type.
2278
+ # @return [String]
1548
2279
  #
1549
- # * Lost to Competitor—SoftLayer: The opportunity was lost to
1550
- # SoftLayer.
2280
+ # @!attribute [rw] status
2281
+ # The current status of the snapshot job. Valid values:
1551
2282
  #
1552
- # * Lost to Competitor—VMWare: The opportunity was lost to VMWare.
2283
+ # * STOPPED: The job is not currently running.
1553
2284
  #
1554
- # * Lost to Competitor—Other: The opportunity was lost to a competitor
1555
- # not listed above.
2285
+ # * RUNNING: The job is actively executing.
2286
+ # @return [String]
1556
2287
  #
1557
- # * No Opportunity: There was no opportunity to pursue.
2288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetResourceSnapshotJobResponse AWS API Documentation
1558
2289
  #
1559
- # * On Premises Deployment: The customer chose an on-premises
1560
- # solution.
2290
+ class GetResourceSnapshotJobResponse < Struct.new(
2291
+ :arn,
2292
+ :catalog,
2293
+ :created_at,
2294
+ :engagement_id,
2295
+ :id,
2296
+ :last_failure,
2297
+ :last_successful_execution_date,
2298
+ :resource_arn,
2299
+ :resource_id,
2300
+ :resource_snapshot_template_name,
2301
+ :resource_type,
2302
+ :status)
2303
+ SENSITIVE = []
2304
+ include Aws::Structure
2305
+ end
2306
+
2307
+ # @!attribute [rw] catalog
2308
+ # Specifies the catalog related to the request. Valid values are:
1561
2309
  #
1562
- # * Partner Gap: The partner lacked necessary resources or
1563
- # capabilities.
2310
+ # * AWS: Retrieves the snapshot from the production AWS environment.
1564
2311
  #
1565
- # * Price: The price was not competitive or acceptable to the
1566
- # customer.
2312
+ # * Sandbox: Retrieves the snapshot from a sandbox environment used
2313
+ # for testing or development purposes.
2314
+ # @return [String]
1567
2315
  #
1568
- # * Security/Compliance: Security or compliance issues prevented
1569
- # progress.
2316
+ # @!attribute [rw] engagement_identifier
2317
+ # The unique identifier of the engagement associated with the
2318
+ # snapshot. This field links the snapshot to a specific engagement
2319
+ # context.
2320
+ # @return [String]
1570
2321
  #
1571
- # * Technical Limitations: Technical limitations prevented progress.
2322
+ # @!attribute [rw] resource_identifier
2323
+ # The unique identifier of the specific resource that was snapshotted.
2324
+ # The format and constraints of this identifier depend on the
2325
+ # ResourceType specified. For `Opportunity` type, it will be an
2326
+ # `opportunity ID`
2327
+ # @return [String]
1572
2328
  #
1573
- # * Customer Experience: Issues related to the customer's experience
2329
+ # @!attribute [rw] resource_snapshot_template_identifier
2330
+ # he name of the template that defines the schema for the snapshot.
2331
+ # This template determines which subset of the resource data is
2332
+ # included in the snapshot and must correspond to an existing and
2333
+ # valid template for the specified `ResourceType`.
2334
+ # @return [String]
2335
+ #
2336
+ # @!attribute [rw] resource_type
2337
+ # Specifies the type of resource that was snapshotted. This field
2338
+ # determines the structure and content of the snapshot payload. Valid
2339
+ # value includes:`Opportunity`: For opportunity-related data.
2340
+ # @return [String]
2341
+ #
2342
+ # @!attribute [rw] revision
2343
+ # Specifies which revision of the snapshot to retrieve. If omitted
2344
+ # returns the latest revision.
2345
+ # @return [Integer]
2346
+ #
2347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetResourceSnapshotRequest AWS API Documentation
2348
+ #
2349
+ class GetResourceSnapshotRequest < Struct.new(
2350
+ :catalog,
2351
+ :engagement_identifier,
2352
+ :resource_identifier,
2353
+ :resource_snapshot_template_identifier,
2354
+ :resource_type,
2355
+ :revision)
2356
+ SENSITIVE = []
2357
+ include Aws::Structure
2358
+ end
2359
+
2360
+ # @!attribute [rw] arn
2361
+ # The Amazon Resource Name (ARN) of the snapshot. This globally unique
2362
+ # identifier can be used for resource-specific operations across AWS
2363
+ # services.
2364
+ # @return [String]
2365
+ #
2366
+ # @!attribute [rw] catalog
2367
+ # The catalog in which the snapshot was created. Matches the Catalog
2368
+ # specified in the request.
2369
+ # @return [String]
2370
+ #
2371
+ # @!attribute [rw] created_at
2372
+ # The timestamp when the snapshot was created, in ISO 8601 format
2373
+ # (e.g., "2023-06-01T14:30:00Z"). This allows for precise tracking
2374
+ # of when the snapshot was taken.
2375
+ # @return [Time]
2376
+ #
2377
+ # @!attribute [rw] created_by
2378
+ # The AWS account ID of the principal (user or role) who created the
2379
+ # snapshot. This helps in tracking the origin of the snapshot.
2380
+ # @return [String]
2381
+ #
2382
+ # @!attribute [rw] engagement_id
2383
+ # The identifier of the engagement associated with this snapshot.
2384
+ # Matches the EngagementIdentifier specified in the request.
2385
+ # @return [String]
2386
+ #
2387
+ # @!attribute [rw] payload
2388
+ # Represents the payload of a resource snapshot. This structure is
2389
+ # designed to accommodate different types of resource snapshots,
2390
+ # currently supporting opportunity summaries.
2391
+ # @return [Types::ResourceSnapshotPayload]
2392
+ #
2393
+ # @!attribute [rw] resource_id
2394
+ # The identifier of the specific resource that was snapshotted.
2395
+ # Matches the `ResourceIdentifier` specified in the request.
2396
+ # @return [String]
2397
+ #
2398
+ # @!attribute [rw] resource_snapshot_template_name
2399
+ # The name of the view used for this snapshot. This is the same as the
2400
+ # template name.
2401
+ # @return [String]
2402
+ #
2403
+ # @!attribute [rw] resource_type
2404
+ # The type of the resource that was snapshotted. Matches the
2405
+ # `ResourceType` specified in the request.
2406
+ # @return [String]
2407
+ #
2408
+ # @!attribute [rw] revision
2409
+ # The revision number of this snapshot. This is a positive integer
2410
+ # that is sequential and unique within the context of a resource view.
2411
+ # @return [Integer]
2412
+ #
2413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetResourceSnapshotResponse AWS API Documentation
2414
+ #
2415
+ class GetResourceSnapshotResponse < Struct.new(
2416
+ :arn,
2417
+ :catalog,
2418
+ :created_at,
2419
+ :created_by,
2420
+ :engagement_id,
2421
+ :payload,
2422
+ :resource_id,
2423
+ :resource_snapshot_template_name,
2424
+ :resource_type,
2425
+ :revision)
2426
+ SENSITIVE = [:created_by]
2427
+ include Aws::Structure
2428
+ end
2429
+
2430
+ # @!attribute [rw] catalog
2431
+ # Specifies the catalog in which the settings are defined. Acceptable
2432
+ # values include `AWS` for production and `Sandbox` for testing
2433
+ # environments.
2434
+ # @return [String]
2435
+ #
2436
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetSellingSystemSettingsRequest AWS API Documentation
2437
+ #
2438
+ class GetSellingSystemSettingsRequest < Struct.new(
2439
+ :catalog)
2440
+ SENSITIVE = []
2441
+ include Aws::Structure
2442
+ end
2443
+
2444
+ # @!attribute [rw] catalog
2445
+ # Specifies the catalog in which the settings are defined. Acceptable
2446
+ # values include `AWS` for production and `Sandbox` for testing
2447
+ # environments.
2448
+ # @return [String]
2449
+ #
2450
+ # @!attribute [rw] resource_snapshot_job_role_arn
2451
+ # Specifies the ARN of the IAM Role used for resource snapshot job
2452
+ # executions.
2453
+ # @return [String]
2454
+ #
2455
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetSellingSystemSettingsResponse AWS API Documentation
2456
+ #
2457
+ class GetSellingSystemSettingsResponse < Struct.new(
2458
+ :catalog,
2459
+ :resource_snapshot_job_role_arn)
2460
+ SENSITIVE = []
2461
+ include Aws::Structure
2462
+ end
2463
+
2464
+ # This error occurs when the specified resource can’t be found or
2465
+ # doesn't exist. Resource ID and type might be incorrect.
2466
+ #
2467
+ # Suggested action: This is usually a transient error. Retry after the
2468
+ # provided retry delay or a short interval. If the problem persists,
2469
+ # contact AWS support.
2470
+ #
2471
+ # @!attribute [rw] message
2472
+ # @return [String]
2473
+ #
2474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/InternalServerException AWS API Documentation
2475
+ #
2476
+ class InternalServerException < Struct.new(
2477
+ :message)
2478
+ SENSITIVE = []
2479
+ include Aws::Structure
2480
+ end
2481
+
2482
+ # The Invitation structure represents an invitation exchanged between
2483
+ # partners and AWS. It includes a message, receiver information, and a
2484
+ # payload providing context for the invitation.
2485
+ #
2486
+ # @!attribute [rw] message
2487
+ # A message accompanying the invitation.
2488
+ # @return [String]
2489
+ #
2490
+ # @!attribute [rw] payload
2491
+ # Contains the data payload associated with the Engagement Invitation.
2492
+ # This payload includes essential details related to the AWS
2493
+ # opportunity and is used by partners to evaluate whether to accept or
2494
+ # reject the engagement.
2495
+ # @return [Types::Payload]
2496
+ #
2497
+ # @!attribute [rw] receiver
2498
+ # Represents the entity that received the Engagement Invitation,
2499
+ # including account and company details. This field is essential for
2500
+ # tracking the partner who is being invited to collaborate.
2501
+ # @return [Types::Receiver]
2502
+ #
2503
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/Invitation AWS API Documentation
2504
+ #
2505
+ class Invitation < Struct.new(
2506
+ :message,
2507
+ :payload,
2508
+ :receiver)
2509
+ SENSITIVE = []
2510
+ include Aws::Structure
2511
+ end
2512
+
2513
+ # Defines a filter to retrieve opportunities based on the last modified
2514
+ # date. This filter is useful for tracking changes or updates to
2515
+ # opportunities over time.
2516
+ #
2517
+ # @!attribute [rw] after_last_modified_date
2518
+ # Specifies the date after which the opportunities were modified. Use
2519
+ # this filter to retrieve only those opportunities that were modified
2520
+ # after a given timestamp.
2521
+ # @return [Time]
2522
+ #
2523
+ # @!attribute [rw] before_last_modified_date
2524
+ # Specifies the date before which the opportunities were modified. Use
2525
+ # this filter to retrieve only those opportunities that were modified
2526
+ # before a given timestamp.
2527
+ # @return [Time]
2528
+ #
2529
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/LastModifiedDate AWS API Documentation
2530
+ #
2531
+ class LastModifiedDate < Struct.new(
2532
+ :after_last_modified_date,
2533
+ :before_last_modified_date)
2534
+ SENSITIVE = []
2535
+ include Aws::Structure
2536
+ end
2537
+
2538
+ # An object that contains the `Opportunity` lifecycle's details.
2539
+ #
2540
+ # @!attribute [rw] closed_lost_reason
2541
+ # Specifies the reason code when an opportunity is marked as *Closed
2542
+ # Lost*. When you select an appropriate reason code, you communicate
2543
+ # the context for closing the `Opportunity`, and aid in accurate
2544
+ # reports and analysis of opportunity outcomes. The possible values
2545
+ # are:
2546
+ #
2547
+ # * Customer Deficiency: The customer lacked necessary resources or
2548
+ # capabilities.
2549
+ #
2550
+ # * Delay/Cancellation of Project: The project was delayed or
2551
+ # canceled.
2552
+ #
2553
+ # * Legal/Tax/Regulatory: Legal, tax, or regulatory issues prevented
2554
+ # progress.
2555
+ #
2556
+ # * Lost to Competitor—Google: The opportunity was lost to Google.
2557
+ #
2558
+ # * Lost to Competitor—Microsoft: The opportunity was lost to
2559
+ # Microsoft.
2560
+ #
2561
+ # * Lost to Competitor—SoftLayer: The opportunity was lost to
2562
+ # SoftLayer.
2563
+ #
2564
+ # * Lost to Competitor—VMWare: The opportunity was lost to VMWare.
2565
+ #
2566
+ # * Lost to Competitor—Other: The opportunity was lost to a competitor
2567
+ # not listed above.
2568
+ #
2569
+ # * No Opportunity: There was no opportunity to pursue.
2570
+ #
2571
+ # * On Premises Deployment: The customer chose an on-premises
2572
+ # solution.
2573
+ #
2574
+ # * Partner Gap: The partner lacked necessary resources or
2575
+ # capabilities.
2576
+ #
2577
+ # * Price: The price was not competitive or acceptable to the
2578
+ # customer.
2579
+ #
2580
+ # * Security/Compliance: Security or compliance issues prevented
2581
+ # progress.
2582
+ #
2583
+ # * Technical Limitations: Technical limitations prevented progress.
2584
+ #
2585
+ # * Customer Experience: Issues related to the customer's experience
1574
2586
  # impacted the decision.
1575
2587
  #
1576
2588
  # * Other: Any reason not covered by the other values.
@@ -1723,6 +2735,40 @@ module Aws::PartnerCentralSelling
1723
2735
  include Aws::Structure
1724
2736
  end
1725
2737
 
2738
+ # Provides the lifecycle view of an opportunity resource shared through
2739
+ # a snapshot.
2740
+ #
2741
+ # @!attribute [rw] next_steps
2742
+ # Describes the next steps for the opportunity shared through a
2743
+ # snapshot.
2744
+ # @return [String]
2745
+ #
2746
+ # @!attribute [rw] review_status
2747
+ # Defines the approval status of the opportunity shared through a
2748
+ # snapshot.
2749
+ # @return [String]
2750
+ #
2751
+ # @!attribute [rw] stage
2752
+ # Defines the current stage of the opportunity shared through a
2753
+ # snapshot.
2754
+ # @return [String]
2755
+ #
2756
+ # @!attribute [rw] target_close_date
2757
+ # The projected launch date of the opportunity shared through a
2758
+ # snapshot.
2759
+ # @return [String]
2760
+ #
2761
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/LifeCycleForView AWS API Documentation
2762
+ #
2763
+ class LifeCycleForView < Struct.new(
2764
+ :next_steps,
2765
+ :review_status,
2766
+ :stage,
2767
+ :target_close_date)
2768
+ SENSITIVE = [:next_steps]
2769
+ include Aws::Structure
2770
+ end
2771
+
1726
2772
  # An object that contains a `LifeCycle` object's subset of fields.
1727
2773
  #
1728
2774
  # @!attribute [rw] closed_lost_reason
@@ -1865,67 +2911,388 @@ module Aws::PartnerCentralSelling
1865
2911
  include Aws::Structure
1866
2912
  end
1867
2913
 
1868
- # @!attribute [rw] catalog
1869
- # Specifies the catalog from which to list the engagement invitations.
1870
- # Use `AWS` for production invitations or `Sandbox` for testing
1871
- # environments.
2914
+ # Specifies a subset of fields associated with tasks related to
2915
+ # accepting an engagement invitation.
2916
+ #
2917
+ # @!attribute [rw] engagement_invitation_id
2918
+ # The unique identifier of the engagement invitation that was
2919
+ # accepted.
1872
2920
  # @return [String]
1873
2921
  #
1874
- # @!attribute [rw] max_results
1875
- # Specifies the maximum number of engagement invitations to return in
1876
- # the response. If more results are available, a pagination token will
1877
- # be provided.
1878
- # @return [Integer]
2922
+ # @!attribute [rw] message
2923
+ # Detailed message describing the failure and possible recovery steps.
2924
+ # @return [String]
1879
2925
  #
1880
- # @!attribute [rw] next_token
1881
- # A pagination token used to retrieve additional pages of results when
1882
- # the response to a previous request was truncated. Pass this token to
1883
- # continue listing invitations from where the previous call left off.
2926
+ # @!attribute [rw] opportunity_id
2927
+ # Unique identifier of opportunity that was created.
1884
2928
  # @return [String]
1885
2929
  #
1886
- # @!attribute [rw] participant_type
1887
- # Specifies the type of participant for which to list engagement
1888
- # invitations. Identifies the role of the participant.
2930
+ # @!attribute [rw] reason_code
2931
+ # A code pointing to the specific reason for the failure.
1889
2932
  # @return [String]
1890
2933
  #
1891
- # @!attribute [rw] payload_type
1892
- # Defines the type of payload associated with the engagement
1893
- # invitations to be listed. The attributes in this payload help decide
1894
- # on acceptance or rejection of the invitation.
1895
- # @return [Array<String>]
2934
+ # @!attribute [rw] resource_snapshot_job_id
2935
+ # Unique identifier of the resource snapshot job that was created.
2936
+ # @return [String]
1896
2937
  #
1897
- # @!attribute [rw] sort
1898
- # Specifies the sorting options for listing engagement invitations.
1899
- # Invitations can be sorted by fields such as `InvitationDate` or
1900
- # `Status` to help partners view results in their preferred order.
1901
- # @return [Types::OpportunityEngagementInvitationSort]
2938
+ # @!attribute [rw] start_time
2939
+ # Task start timestamp.
2940
+ # @return [Time]
1902
2941
  #
1903
- # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementInvitationsRequest AWS API Documentation
2942
+ # @!attribute [rw] task_arn
2943
+ # The Amazon Resource Name (ARN) that uniquely identifies the task.
2944
+ # @return [String]
1904
2945
  #
1905
- class ListEngagementInvitationsRequest < Struct.new(
1906
- :catalog,
1907
- :max_results,
1908
- :next_token,
1909
- :participant_type,
1910
- :payload_type,
1911
- :sort)
1912
- SENSITIVE = []
1913
- include Aws::Structure
1914
- end
1915
-
1916
- # @!attribute [rw] engagement_invitation_summaries
1917
- # An array containing summaries of engagement invitations. Each
1918
- # summary includes information such as the invitation title,
1919
- # invitation date, and the current status of the invitation.
1920
- # @return [Array<Types::EngagementInvitationSummary>]
2946
+ # @!attribute [rw] task_id
2947
+ # Unique identifier of the task.
2948
+ # @return [String]
1921
2949
  #
1922
- # @!attribute [rw] next_token
1923
- # A pagination token returned when there are more results available
1924
- # than can be returned in a single call. Use this token to retrieve
1925
- # additional pages of engagement invitation summaries.
2950
+ # @!attribute [rw] task_status
2951
+ # Status of the task.
1926
2952
  # @return [String]
1927
2953
  #
1928
- # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementInvitationsResponse AWS API Documentation
2954
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTaskSummary AWS API Documentation
2955
+ #
2956
+ class ListEngagementByAcceptingInvitationTaskSummary < Struct.new(
2957
+ :engagement_invitation_id,
2958
+ :message,
2959
+ :opportunity_id,
2960
+ :reason_code,
2961
+ :resource_snapshot_job_id,
2962
+ :start_time,
2963
+ :task_arn,
2964
+ :task_id,
2965
+ :task_status)
2966
+ SENSITIVE = []
2967
+ include Aws::Structure
2968
+ end
2969
+
2970
+ # @!attribute [rw] catalog
2971
+ # Specifies the catalog related to the request. Valid values are:
2972
+ #
2973
+ # * AWS: Retrieves the request from the production AWS environment.
2974
+ #
2975
+ # * Sandbox: Retrieves the request from a sandbox environment used for
2976
+ # testing or development purposes.
2977
+ # @return [String]
2978
+ #
2979
+ # @!attribute [rw] engagement_invitation_identifier
2980
+ # Filters tasks by the identifiers of the engagement invitations they
2981
+ # are processing.
2982
+ # @return [Array<String>]
2983
+ #
2984
+ # @!attribute [rw] max_results
2985
+ # Use this parameter to control the number of items returned in each
2986
+ # request, which can be useful for performance tuning and managing
2987
+ # large result sets.
2988
+ # @return [Integer]
2989
+ #
2990
+ # @!attribute [rw] next_token
2991
+ # Use this parameter for pagination when the result set spans multiple
2992
+ # pages. This value is obtained from the NextToken field in the
2993
+ # response of a previous call to this API.
2994
+ # @return [String]
2995
+ #
2996
+ # @!attribute [rw] opportunity_identifier
2997
+ # Filters tasks by the identifiers of the opportunities they created
2998
+ # or are associated with.
2999
+ # @return [Array<String>]
3000
+ #
3001
+ # @!attribute [rw] sort
3002
+ # Specifies the sorting criteria for the returned results. This allows
3003
+ # you to order the tasks based on specific attributes.
3004
+ # @return [Types::ListTasksSortBase]
3005
+ #
3006
+ # @!attribute [rw] task_identifier
3007
+ # Filters tasks by their unique identifiers. Use this when you want to
3008
+ # retrieve information about specific tasks.
3009
+ # @return [Array<String>]
3010
+ #
3011
+ # @!attribute [rw] task_status
3012
+ # Filters the tasks based on their current status. This allows you to
3013
+ # focus on tasks in specific states.
3014
+ # @return [Array<String>]
3015
+ #
3016
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTasksRequest AWS API Documentation
3017
+ #
3018
+ class ListEngagementByAcceptingInvitationTasksRequest < Struct.new(
3019
+ :catalog,
3020
+ :engagement_invitation_identifier,
3021
+ :max_results,
3022
+ :next_token,
3023
+ :opportunity_identifier,
3024
+ :sort,
3025
+ :task_identifier,
3026
+ :task_status)
3027
+ SENSITIVE = []
3028
+ include Aws::Structure
3029
+ end
3030
+
3031
+ # @!attribute [rw] next_token
3032
+ # A token used for pagination to retrieve the next page of results.If
3033
+ # there are more results available, this field will contain a token
3034
+ # that can be used in a subsequent API call to retrieve the next page.
3035
+ # If there are no more results, this field will be null or an empty
3036
+ # string.
3037
+ # @return [String]
3038
+ #
3039
+ # @!attribute [rw] task_summaries
3040
+ # An array of `EngagementByAcceptingInvitationTaskSummary` objects,
3041
+ # each representing a task that matches the specified filters. The
3042
+ # array may be empty if no tasks match the criteria.
3043
+ # @return [Array<Types::ListEngagementByAcceptingInvitationTaskSummary>]
3044
+ #
3045
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTasksResponse AWS API Documentation
3046
+ #
3047
+ class ListEngagementByAcceptingInvitationTasksResponse < Struct.new(
3048
+ :next_token,
3049
+ :task_summaries)
3050
+ SENSITIVE = []
3051
+ include Aws::Structure
3052
+ end
3053
+
3054
+ # Provides a summary of a task related to creating an engagement from an
3055
+ # opportunity. This structure contains key information about the task's
3056
+ # status, associated identifiers, and any failure details.
3057
+ #
3058
+ # @!attribute [rw] engagement_id
3059
+ # The unique identifier of the engagement created as a result of the
3060
+ # task. This field is populated when the task is completed
3061
+ # successfully.
3062
+ # @return [String]
3063
+ #
3064
+ # @!attribute [rw] engagement_invitation_id
3065
+ # The unique identifier of the engagement identifier created as a
3066
+ # result of the task. This field is populated when the task is
3067
+ # completed successfully.
3068
+ # @return [String]
3069
+ #
3070
+ # @!attribute [rw] message
3071
+ # A detailed message providing additional information about the task,
3072
+ # especially useful in case of failures. This field may contain error
3073
+ # details or other relevant information about the task's execution
3074
+ # @return [String]
3075
+ #
3076
+ # @!attribute [rw] opportunity_id
3077
+ # The unique identifier of the original Opportunity from which the
3078
+ # Engagement is being created. This field helps track the source of
3079
+ # the Engagement creation task.
3080
+ # @return [String]
3081
+ #
3082
+ # @!attribute [rw] reason_code
3083
+ # A code indicating the specific reason for a task failure. This field
3084
+ # is populated when the task status is FAILED and provides a
3085
+ # categorized reason for the failure.
3086
+ # @return [String]
3087
+ #
3088
+ # @!attribute [rw] resource_snapshot_job_id
3089
+ # The identifier of the resource snapshot job associated with this
3090
+ # task, if a snapshot was created as part of the Engagement creation
3091
+ # process.
3092
+ # @return [String]
3093
+ #
3094
+ # @!attribute [rw] start_time
3095
+ # The timestamp indicating when the task was initiated, in RFC 3339
3096
+ # 5.6 date-time format.
3097
+ # @return [Time]
3098
+ #
3099
+ # @!attribute [rw] task_arn
3100
+ # The Amazon Resource Name (ARN) uniquely identifying this task within
3101
+ # AWS. This ARN can be used for referencing the task in other AWS
3102
+ # services or APIs.
3103
+ # @return [String]
3104
+ #
3105
+ # @!attribute [rw] task_id
3106
+ # A unique identifier for a specific task.
3107
+ # @return [String]
3108
+ #
3109
+ # @!attribute [rw] task_status
3110
+ # The current status of the task.
3111
+ # @return [String]
3112
+ #
3113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTaskSummary AWS API Documentation
3114
+ #
3115
+ class ListEngagementFromOpportunityTaskSummary < Struct.new(
3116
+ :engagement_id,
3117
+ :engagement_invitation_id,
3118
+ :message,
3119
+ :opportunity_id,
3120
+ :reason_code,
3121
+ :resource_snapshot_job_id,
3122
+ :start_time,
3123
+ :task_arn,
3124
+ :task_id,
3125
+ :task_status)
3126
+ SENSITIVE = []
3127
+ include Aws::Structure
3128
+ end
3129
+
3130
+ # @!attribute [rw] catalog
3131
+ # Specifies the catalog related to the request. Valid values are:
3132
+ #
3133
+ # * AWS: Retrieves the request from the production AWS environment.
3134
+ #
3135
+ # * Sandbox: Retrieves the request from a sandbox environment used for
3136
+ # testing or development purposes.
3137
+ # @return [String]
3138
+ #
3139
+ # @!attribute [rw] engagement_identifier
3140
+ # Filters tasks by the identifiers of the engagements they created or
3141
+ # are associated with.
3142
+ # @return [Array<String>]
3143
+ #
3144
+ # @!attribute [rw] max_results
3145
+ # Specifies the maximum number of results to return in a single page
3146
+ # of the response.Use this parameter to control the number of items
3147
+ # returned in each request, which can be useful for performance tuning
3148
+ # and managing large result sets.
3149
+ # @return [Integer]
3150
+ #
3151
+ # @!attribute [rw] next_token
3152
+ # The token for requesting the next page of results. This value is
3153
+ # obtained from the NextToken field in the response of a previous call
3154
+ # to this API. Use this parameter for pagination when the result set
3155
+ # spans multiple pages.
3156
+ # @return [String]
3157
+ #
3158
+ # @!attribute [rw] opportunity_identifier
3159
+ # The identifier of the original opportunity associated with this
3160
+ # task.
3161
+ # @return [Array<String>]
3162
+ #
3163
+ # @!attribute [rw] sort
3164
+ # Specifies the sorting criteria for the returned results. This allows
3165
+ # you to order the tasks based on specific attributes.
3166
+ # @return [Types::ListTasksSortBase]
3167
+ #
3168
+ # @!attribute [rw] task_identifier
3169
+ # Filters tasks by their unique identifiers. Use this when you want to
3170
+ # retrieve information about specific tasks.
3171
+ # @return [Array<String>]
3172
+ #
3173
+ # @!attribute [rw] task_status
3174
+ # Filters the tasks based on their current status. This allows you to
3175
+ # focus on tasks in specific states.
3176
+ # @return [Array<String>]
3177
+ #
3178
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTasksRequest AWS API Documentation
3179
+ #
3180
+ class ListEngagementFromOpportunityTasksRequest < Struct.new(
3181
+ :catalog,
3182
+ :engagement_identifier,
3183
+ :max_results,
3184
+ :next_token,
3185
+ :opportunity_identifier,
3186
+ :sort,
3187
+ :task_identifier,
3188
+ :task_status)
3189
+ SENSITIVE = []
3190
+ include Aws::Structure
3191
+ end
3192
+
3193
+ # @!attribute [rw] next_token
3194
+ # A token used for pagination to retrieve the next page of results. If
3195
+ # there are more results available, this field will contain a token
3196
+ # that can be used in a subsequent API call to retrieve the next page.
3197
+ # If there are no more results, this field will be null or an empty
3198
+ # string.
3199
+ # @return [String]
3200
+ #
3201
+ # @!attribute [rw] task_summaries
3202
+ # TaskSummaries An array of TaskSummary objects containing details
3203
+ # about each task.
3204
+ # @return [Array<Types::ListEngagementFromOpportunityTaskSummary>]
3205
+ #
3206
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTasksResponse AWS API Documentation
3207
+ #
3208
+ class ListEngagementFromOpportunityTasksResponse < Struct.new(
3209
+ :next_token,
3210
+ :task_summaries)
3211
+ SENSITIVE = []
3212
+ include Aws::Structure
3213
+ end
3214
+
3215
+ # @!attribute [rw] catalog
3216
+ # Specifies the catalog from which to list the engagement invitations.
3217
+ # Use `AWS` for production invitations or `Sandbox` for testing
3218
+ # environments.
3219
+ # @return [String]
3220
+ #
3221
+ # @!attribute [rw] engagement_identifier
3222
+ # Retrieves a list of engagement invitation summaries based on
3223
+ # specified filters. The ListEngagementInvitations operation allows
3224
+ # you to view all invitations that you have sent or received. You must
3225
+ # specify the ParticipantType to filter invitations where you are
3226
+ # either the SENDER or the RECEIVER. Invitations will automatically
3227
+ # expire if not accepted within 15 days.
3228
+ # @return [Array<String>]
3229
+ #
3230
+ # @!attribute [rw] max_results
3231
+ # Specifies the maximum number of engagement invitations to return in
3232
+ # the response. If more results are available, a pagination token will
3233
+ # be provided.
3234
+ # @return [Integer]
3235
+ #
3236
+ # @!attribute [rw] next_token
3237
+ # A pagination token used to retrieve additional pages of results when
3238
+ # the response to a previous request was truncated. Pass this token to
3239
+ # continue listing invitations from where the previous call left off.
3240
+ # @return [String]
3241
+ #
3242
+ # @!attribute [rw] participant_type
3243
+ # Specifies the type of participant for which to list engagement
3244
+ # invitations. Identifies the role of the participant.
3245
+ # @return [String]
3246
+ #
3247
+ # @!attribute [rw] payload_type
3248
+ # Defines the type of payload associated with the engagement
3249
+ # invitations to be listed. The attributes in this payload help decide
3250
+ # on acceptance or rejection of the invitation.
3251
+ # @return [Array<String>]
3252
+ #
3253
+ # @!attribute [rw] sender_aws_account_id
3254
+ # List of sender AWS account IDs to filter the invitations.
3255
+ # @return [Array<String>]
3256
+ #
3257
+ # @!attribute [rw] sort
3258
+ # Specifies the sorting options for listing engagement invitations.
3259
+ # Invitations can be sorted by fields such as `InvitationDate` or
3260
+ # `Status` to help partners view results in their preferred order.
3261
+ # @return [Types::OpportunityEngagementInvitationSort]
3262
+ #
3263
+ # @!attribute [rw] status
3264
+ # Status values to filter the invitations.
3265
+ # @return [Array<String>]
3266
+ #
3267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementInvitationsRequest AWS API Documentation
3268
+ #
3269
+ class ListEngagementInvitationsRequest < Struct.new(
3270
+ :catalog,
3271
+ :engagement_identifier,
3272
+ :max_results,
3273
+ :next_token,
3274
+ :participant_type,
3275
+ :payload_type,
3276
+ :sender_aws_account_id,
3277
+ :sort,
3278
+ :status)
3279
+ SENSITIVE = [:sender_aws_account_id]
3280
+ include Aws::Structure
3281
+ end
3282
+
3283
+ # @!attribute [rw] engagement_invitation_summaries
3284
+ # An array containing summaries of engagement invitations. Each
3285
+ # summary includes information such as the invitation title,
3286
+ # invitation date, and the current status of the invitation.
3287
+ # @return [Array<Types::EngagementInvitationSummary>]
3288
+ #
3289
+ # @!attribute [rw] next_token
3290
+ # A pagination token returned when there are more results available
3291
+ # than can be returned in a single call. Use this token to retrieve
3292
+ # additional pages of engagement invitation summaries.
3293
+ # @return [String]
3294
+ #
3295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementInvitationsResponse AWS API Documentation
1929
3296
  #
1930
3297
  class ListEngagementInvitationsResponse < Struct.new(
1931
3298
  :engagement_invitation_summaries,
@@ -1934,6 +3301,190 @@ module Aws::PartnerCentralSelling
1934
3301
  include Aws::Structure
1935
3302
  end
1936
3303
 
3304
+ # @!attribute [rw] catalog
3305
+ # The catalog related to the request.
3306
+ # @return [String]
3307
+ #
3308
+ # @!attribute [rw] identifier
3309
+ # Identifier of the engagement record to retrieve members from.
3310
+ # @return [String]
3311
+ #
3312
+ # @!attribute [rw] max_results
3313
+ # The maximum number of results to return in a single call.
3314
+ # @return [Integer]
3315
+ #
3316
+ # @!attribute [rw] next_token
3317
+ # The token for the next set of results.
3318
+ # @return [String]
3319
+ #
3320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementMembersRequest AWS API Documentation
3321
+ #
3322
+ class ListEngagementMembersRequest < Struct.new(
3323
+ :catalog,
3324
+ :identifier,
3325
+ :max_results,
3326
+ :next_token)
3327
+ SENSITIVE = []
3328
+ include Aws::Structure
3329
+ end
3330
+
3331
+ # @!attribute [rw] engagement_member_list
3332
+ # Provides a list of engagement members.
3333
+ # @return [Array<Types::EngagementMember>]
3334
+ #
3335
+ # @!attribute [rw] next_token
3336
+ # A pagination token used to retrieve the next set of results. If
3337
+ # there are more results available than can be returned in a single
3338
+ # response, this token will be present. Use this token in a subsequent
3339
+ # request to retrieve the next page of results. If there are no more
3340
+ # results, this value will be null.
3341
+ # @return [String]
3342
+ #
3343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementMembersResponse AWS API Documentation
3344
+ #
3345
+ class ListEngagementMembersResponse < Struct.new(
3346
+ :engagement_member_list,
3347
+ :next_token)
3348
+ SENSITIVE = []
3349
+ include Aws::Structure
3350
+ end
3351
+
3352
+ # @!attribute [rw] catalog
3353
+ # Specifies the catalog in which to search for engagement-resource
3354
+ # associations.
3355
+ # @return [String]
3356
+ #
3357
+ # @!attribute [rw] created_by
3358
+ # Filters the results to include only associations with resources
3359
+ # owned by the specified AWS account. Use this when you want to find
3360
+ # associations related to resources owned by a particular account.
3361
+ # @return [String]
3362
+ #
3363
+ # @!attribute [rw] engagement_identifier
3364
+ # Filters the results to include only associations related to the
3365
+ # specified engagement. Use this when you want to find all resources
3366
+ # associated with a specific engagement.
3367
+ # @return [String]
3368
+ #
3369
+ # @!attribute [rw] max_results
3370
+ # Limits the number of results returned in a single call. Use this to
3371
+ # control the number of results returned, especially useful for
3372
+ # pagination.
3373
+ # @return [Integer]
3374
+ #
3375
+ # @!attribute [rw] next_token
3376
+ # A token used for pagination of results. Include this token in
3377
+ # subsequent requests to retrieve the next set of results.
3378
+ # @return [String]
3379
+ #
3380
+ # @!attribute [rw] resource_identifier
3381
+ # Filters the results to include only associations with the specified
3382
+ # resource. Varies depending on the resource type. Use this when you
3383
+ # want to find all engagements associated with a specific resource.
3384
+ # @return [String]
3385
+ #
3386
+ # @!attribute [rw] resource_type
3387
+ # Filters the results to include only associations with resources of
3388
+ # the specified type.
3389
+ # @return [String]
3390
+ #
3391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementResourceAssociationsRequest AWS API Documentation
3392
+ #
3393
+ class ListEngagementResourceAssociationsRequest < Struct.new(
3394
+ :catalog,
3395
+ :created_by,
3396
+ :engagement_identifier,
3397
+ :max_results,
3398
+ :next_token,
3399
+ :resource_identifier,
3400
+ :resource_type)
3401
+ SENSITIVE = [:created_by]
3402
+ include Aws::Structure
3403
+ end
3404
+
3405
+ # @!attribute [rw] engagement_resource_association_summaries
3406
+ # A list of engagement-resource association summaries.
3407
+ # @return [Array<Types::EngagementResourceAssociationSummary>]
3408
+ #
3409
+ # @!attribute [rw] next_token
3410
+ # A token to retrieve the next set of results. Use this token in a
3411
+ # subsequent request to retrieve additional results if the response
3412
+ # was truncated.
3413
+ # @return [String]
3414
+ #
3415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementResourceAssociationsResponse AWS API Documentation
3416
+ #
3417
+ class ListEngagementResourceAssociationsResponse < Struct.new(
3418
+ :engagement_resource_association_summaries,
3419
+ :next_token)
3420
+ SENSITIVE = []
3421
+ include Aws::Structure
3422
+ end
3423
+
3424
+ # @!attribute [rw] catalog
3425
+ # Specifies the catalog related to the request.
3426
+ # @return [String]
3427
+ #
3428
+ # @!attribute [rw] created_by
3429
+ # A list of AWS account IDs. When specified, the response includes
3430
+ # engagements created by these accounts. This filter is useful for
3431
+ # finding engagements created by specific team members.
3432
+ # @return [Array<String>]
3433
+ #
3434
+ # @!attribute [rw] engagement_identifier
3435
+ # An array of strings representing engagement identifiers to retrieve.
3436
+ # @return [Array<String>]
3437
+ #
3438
+ # @!attribute [rw] exclude_created_by
3439
+ # An array of strings representing AWS Account IDs. Use this to
3440
+ # exclude engagements created by specific users.
3441
+ # @return [Array<String>]
3442
+ #
3443
+ # @!attribute [rw] max_results
3444
+ # The maximum number of results to return in a single call.
3445
+ # @return [Integer]
3446
+ #
3447
+ # @!attribute [rw] next_token
3448
+ # The token for the next set of results. This value is returned from a
3449
+ # previous call.
3450
+ # @return [String]
3451
+ #
3452
+ # @!attribute [rw] sort
3453
+ # An object that specifies the sort order of the results.
3454
+ # @return [Types::EngagementSort]
3455
+ #
3456
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementsRequest AWS API Documentation
3457
+ #
3458
+ class ListEngagementsRequest < Struct.new(
3459
+ :catalog,
3460
+ :created_by,
3461
+ :engagement_identifier,
3462
+ :exclude_created_by,
3463
+ :max_results,
3464
+ :next_token,
3465
+ :sort)
3466
+ SENSITIVE = [:created_by, :exclude_created_by]
3467
+ include Aws::Structure
3468
+ end
3469
+
3470
+ # @!attribute [rw] engagement_summary_list
3471
+ # An array of engagement summary objects.
3472
+ # @return [Array<Types::EngagementSummary>]
3473
+ #
3474
+ # @!attribute [rw] next_token
3475
+ # The token to retrieve the next set of results. This field will be
3476
+ # null if there are no more results.
3477
+ # @return [String]
3478
+ #
3479
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementsResponse AWS API Documentation
3480
+ #
3481
+ class ListEngagementsResponse < Struct.new(
3482
+ :engagement_summary_list,
3483
+ :next_token)
3484
+ SENSITIVE = []
3485
+ include Aws::Structure
3486
+ end
3487
+
1937
3488
  # @!attribute [rw] catalog
1938
3489
  # Specifies the catalog associated with the request. This field takes
1939
3490
  # a string value from a predefined list: `AWS` or `Sandbox`. The
@@ -1981,53 +3532,180 @@ module Aws::PartnerCentralSelling
1981
3532
  # This limits the number of opportunities returned in the response to
1982
3533
  # avoid providing too many results at once.
1983
3534
  #
1984
- # Default: 20
3535
+ # Default: 20
3536
+ # @return [Integer]
3537
+ #
3538
+ # @!attribute [rw] next_token
3539
+ # A pagination token used to retrieve the next set of results in
3540
+ # subsequent calls. This token is included in the response only if
3541
+ # there are additional result pages available.
3542
+ # @return [String]
3543
+ #
3544
+ # @!attribute [rw] sort
3545
+ # An object that specifies how the response is sorted. The default
3546
+ # `Sort.SortBy` value is `LastModifiedDate`.
3547
+ # @return [Types::OpportunitySort]
3548
+ #
3549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListOpportunitiesRequest AWS API Documentation
3550
+ #
3551
+ class ListOpportunitiesRequest < Struct.new(
3552
+ :catalog,
3553
+ :customer_company_name,
3554
+ :identifier,
3555
+ :last_modified_date,
3556
+ :life_cycle_review_status,
3557
+ :life_cycle_stage,
3558
+ :max_results,
3559
+ :next_token,
3560
+ :sort)
3561
+ SENSITIVE = []
3562
+ include Aws::Structure
3563
+ end
3564
+
3565
+ # @!attribute [rw] next_token
3566
+ # A pagination token used to retrieve the next set of results in
3567
+ # subsequent calls. This token is included in the response only if
3568
+ # there are additional result pages available.
3569
+ # @return [String]
3570
+ #
3571
+ # @!attribute [rw] opportunity_summaries
3572
+ # An array that contains minimal details for opportunities that match
3573
+ # the request criteria. This summary view provides a quick overview of
3574
+ # relevant opportunities.
3575
+ # @return [Array<Types::OpportunitySummary>]
3576
+ #
3577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListOpportunitiesResponse AWS API Documentation
3578
+ #
3579
+ class ListOpportunitiesResponse < Struct.new(
3580
+ :next_token,
3581
+ :opportunity_summaries)
3582
+ SENSITIVE = []
3583
+ include Aws::Structure
3584
+ end
3585
+
3586
+ # @!attribute [rw] catalog
3587
+ # Specifies the catalog related to the request.
3588
+ # @return [String]
3589
+ #
3590
+ # @!attribute [rw] engagement_identifier
3591
+ # The identifier of the engagement to filter the response.
3592
+ # @return [String]
3593
+ #
3594
+ # @!attribute [rw] max_results
3595
+ # The maximum number of results to return in a single call. If
3596
+ # omitted, defaults to 50.
3597
+ # @return [Integer]
3598
+ #
3599
+ # @!attribute [rw] next_token
3600
+ # The token for the next set of results.
3601
+ # @return [String]
3602
+ #
3603
+ # @!attribute [rw] sort
3604
+ # Configures the sorting of the response. If omitted, results are
3605
+ # sorted by `CreatedDate` in descending order.
3606
+ # @return [Types::SortObject]
3607
+ #
3608
+ # @!attribute [rw] status
3609
+ # The status of the jobs to filter the response.
3610
+ # @return [String]
3611
+ #
3612
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListResourceSnapshotJobsRequest AWS API Documentation
3613
+ #
3614
+ class ListResourceSnapshotJobsRequest < Struct.new(
3615
+ :catalog,
3616
+ :engagement_identifier,
3617
+ :max_results,
3618
+ :next_token,
3619
+ :sort,
3620
+ :status)
3621
+ SENSITIVE = []
3622
+ include Aws::Structure
3623
+ end
3624
+
3625
+ # @!attribute [rw] next_token
3626
+ # The token to retrieve the next set of results. If there are no
3627
+ # additional results, this value is null.
3628
+ # @return [String]
3629
+ #
3630
+ # @!attribute [rw] resource_snapshot_job_summaries
3631
+ # An array of resource snapshot job summary objects.
3632
+ # @return [Array<Types::ResourceSnapshotJobSummary>]
3633
+ #
3634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListResourceSnapshotJobsResponse AWS API Documentation
3635
+ #
3636
+ class ListResourceSnapshotJobsResponse < Struct.new(
3637
+ :next_token,
3638
+ :resource_snapshot_job_summaries)
3639
+ SENSITIVE = []
3640
+ include Aws::Structure
3641
+ end
3642
+
3643
+ # @!attribute [rw] catalog
3644
+ # Specifies the catalog related to the request.
3645
+ # @return [String]
3646
+ #
3647
+ # @!attribute [rw] created_by
3648
+ # Filters the response to include only snapshots of resources created
3649
+ # by the specified AWS account.
3650
+ # @return [String]
3651
+ #
3652
+ # @!attribute [rw] engagement_identifier
3653
+ # The unique identifier of the engagement associated with the
3654
+ # snapshots.
3655
+ # @return [String]
3656
+ #
3657
+ # @!attribute [rw] max_results
3658
+ # The maximum number of results to return in a single call.
1985
3659
  # @return [Integer]
1986
3660
  #
1987
3661
  # @!attribute [rw] next_token
1988
- # A pagination token used to retrieve the next set of results in
1989
- # subsequent calls. This token is included in the response only if
1990
- # there are additional result pages available.
3662
+ # The token for the next set of results.
1991
3663
  # @return [String]
1992
3664
  #
1993
- # @!attribute [rw] sort
1994
- # An object that specifies how the response is sorted. The default
1995
- # `Sort.SortBy` value is `LastModifiedDate`.
1996
- # @return [Types::OpportunitySort]
3665
+ # @!attribute [rw] resource_identifier
3666
+ # Filters the response to include only snapshots of the specified
3667
+ # resource.
3668
+ # @return [String]
1997
3669
  #
1998
- # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListOpportunitiesRequest AWS API Documentation
3670
+ # @!attribute [rw] resource_snapshot_template_identifier
3671
+ # Filters the response to include only snapshots created using the
3672
+ # specified template.
3673
+ # @return [String]
1999
3674
  #
2000
- class ListOpportunitiesRequest < Struct.new(
3675
+ # @!attribute [rw] resource_type
3676
+ # Filters the response to include only snapshots of the specified
3677
+ # resource type.
3678
+ # @return [String]
3679
+ #
3680
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListResourceSnapshotsRequest AWS API Documentation
3681
+ #
3682
+ class ListResourceSnapshotsRequest < Struct.new(
2001
3683
  :catalog,
2002
- :customer_company_name,
2003
- :identifier,
2004
- :last_modified_date,
2005
- :life_cycle_review_status,
2006
- :life_cycle_stage,
3684
+ :created_by,
3685
+ :engagement_identifier,
2007
3686
  :max_results,
2008
3687
  :next_token,
2009
- :sort)
2010
- SENSITIVE = []
3688
+ :resource_identifier,
3689
+ :resource_snapshot_template_identifier,
3690
+ :resource_type)
3691
+ SENSITIVE = [:created_by]
2011
3692
  include Aws::Structure
2012
3693
  end
2013
3694
 
2014
3695
  # @!attribute [rw] next_token
2015
- # A pagination token used to retrieve the next set of results in
2016
- # subsequent calls. This token is included in the response only if
2017
- # there are additional result pages available.
3696
+ # The token to retrieve the next set of results. If there are no
3697
+ # additional results, this value is null.
2018
3698
  # @return [String]
2019
3699
  #
2020
- # @!attribute [rw] opportunity_summaries
2021
- # An array that contains minimal details for opportunities that match
2022
- # the request criteria. This summary view provides a quick overview of
2023
- # relevant opportunities.
2024
- # @return [Array<Types::OpportunitySummary>]
3700
+ # @!attribute [rw] resource_snapshot_summaries
3701
+ # An array of resource snapshot summary objects.
3702
+ # @return [Array<Types::ResourceSnapshotSummary>]
2025
3703
  #
2026
- # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListOpportunitiesResponse AWS API Documentation
3704
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListResourceSnapshotsResponse AWS API Documentation
2027
3705
  #
2028
- class ListOpportunitiesResponse < Struct.new(
3706
+ class ListResourceSnapshotsResponse < Struct.new(
2029
3707
  :next_token,
2030
- :opportunity_summaries)
3708
+ :resource_snapshot_summaries)
2031
3709
  SENSITIVE = []
2032
3710
  include Aws::Structure
2033
3711
  end
@@ -2111,6 +3789,26 @@ module Aws::PartnerCentralSelling
2111
3789
  include Aws::Structure
2112
3790
  end
2113
3791
 
3792
+ # Defines the sorting parameters for listing tasks. This structure
3793
+ # allows for specifying the field to sort by and the order of sorting.
3794
+ #
3795
+ # @!attribute [rw] sort_by
3796
+ # Specifies the field by which the task list should be sorted.
3797
+ # @return [String]
3798
+ #
3799
+ # @!attribute [rw] sort_order
3800
+ # Determines the order in which the sorted results are presented.
3801
+ # @return [String]
3802
+ #
3803
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListTasksSortBase AWS API Documentation
3804
+ #
3805
+ class ListTasksSortBase < Struct.new(
3806
+ :sort_by,
3807
+ :sort_order)
3808
+ SENSITIVE = []
3809
+ include Aws::Structure
3810
+ end
3811
+
2114
3812
  # An object that contains marketing details for the `Opportunity`.
2115
3813
  #
2116
3814
  # @!attribute [rw] aws_funding_used
@@ -2294,6 +3992,12 @@ module Aws::PartnerCentralSelling
2294
3992
 
2295
3993
  # An object that contains an `Opportunity`'s subset of fields.
2296
3994
  #
3995
+ # @!attribute [rw] arn
3996
+ # The Amazon Resource Name (ARN) for the opportunity. This globally
3997
+ # unique identifier can be used for IAM policies and cross-service
3998
+ # references.
3999
+ # @return [String]
4000
+ #
2297
4001
  # @!attribute [rw] catalog
2298
4002
  # Specifies the catalog associated with the opportunity, either `AWS`
2299
4003
  # or `Sandbox`. This indicates the environment in which the
@@ -2354,6 +4058,7 @@ module Aws::PartnerCentralSelling
2354
4058
  # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/OpportunitySummary AWS API Documentation
2355
4059
  #
2356
4060
  class OpportunitySummary < Struct.new(
4061
+ :arn,
2357
4062
  :catalog,
2358
4063
  :created_date,
2359
4064
  :customer,
@@ -2367,11 +4072,67 @@ module Aws::PartnerCentralSelling
2367
4072
  include Aws::Structure
2368
4073
  end
2369
4074
 
4075
+ # Provides a comprehensive view of an opportunity summary, including
4076
+ # lifecycle information, team details, opportunity type, primary needs
4077
+ # from AWS, and associated project information.
4078
+ #
4079
+ # @!attribute [rw] customer
4080
+ # An object that contains the customer's `Account` and `Contact`.
4081
+ # @return [Types::Customer]
4082
+ #
4083
+ # @!attribute [rw] lifecycle
4084
+ # Contains information about the opportunity's lifecycle, including
4085
+ # its current stage, status, and important dates such as creation and
4086
+ # last modification times.
4087
+ # @return [Types::LifeCycleForView]
4088
+ #
4089
+ # @!attribute [rw] opportunity_team
4090
+ # Represents the internal team handling the opportunity. Specify the
4091
+ # members involved in collaborating on an opportunity within the
4092
+ # partner's organization.
4093
+ # @return [Array<Types::Contact>]
4094
+ #
4095
+ # @!attribute [rw] opportunity_type
4096
+ # Specifies the opportunity type.
4097
+ # @return [String]
4098
+ #
4099
+ # @!attribute [rw] primary_needs_from_aws
4100
+ # Identifies the type of support the partner needs from AWS.
4101
+ # @return [Array<String>]
4102
+ #
4103
+ # @!attribute [rw] project
4104
+ # Contains summary information about the project associated with the
4105
+ # opportunity, including project name, description, timeline, and
4106
+ # other relevant details.
4107
+ # @return [Types::ProjectView]
4108
+ #
4109
+ # @!attribute [rw] related_entity_identifiers
4110
+ # This field provides the associations' information for other
4111
+ # entities with the opportunity. These entities include identifiers
4112
+ # for `AWSProducts`, `Partner Solutions`, and `AWSMarketplaceOffers`.
4113
+ # @return [Types::RelatedEntityIdentifiers]
4114
+ #
4115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/OpportunitySummaryView AWS API Documentation
4116
+ #
4117
+ class OpportunitySummaryView < Struct.new(
4118
+ :customer,
4119
+ :lifecycle,
4120
+ :opportunity_team,
4121
+ :opportunity_type,
4122
+ :primary_needs_from_aws,
4123
+ :project,
4124
+ :related_entity_identifiers)
4125
+ SENSITIVE = []
4126
+ include Aws::Structure
4127
+ end
4128
+
2370
4129
  # Contains the data payload associated with the Engagement Invitation.
2371
4130
  # This payload includes essential details related to the AWS opportunity
2372
4131
  # and is used by partners to evaluate whether to accept or reject the
2373
4132
  # engagement.
2374
4133
  #
4134
+ # @note Payload is a union - when making an API calls you must set exactly one of the members.
4135
+ #
2375
4136
  # @note Payload is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Payload corresponding to the set member.
2376
4137
  #
2377
4138
  # @!attribute [rw] opportunity_invitation
@@ -2668,10 +4429,97 @@ module Aws::PartnerCentralSelling
2668
4429
  include Aws::Structure
2669
4430
  end
2670
4431
 
4432
+ # Provides the project view of an opportunity resource shared through a
4433
+ # snapshot.
4434
+ #
4435
+ # @!attribute [rw] customer_use_case
4436
+ # Specifies the proposed solution focus or type of workload for the
4437
+ # project.
4438
+ # @return [String]
4439
+ #
4440
+ # @!attribute [rw] delivery_models
4441
+ # Describes the deployment or consumption model for the partner
4442
+ # solution or offering. This field indicates how the project's
4443
+ # solution will be delivered or implemented for the customer.
4444
+ # @return [Array<String>]
4445
+ #
4446
+ # @!attribute [rw] expected_customer_spend
4447
+ # Provides information about the anticipated customer spend related to
4448
+ # this project. This may include details such as amount, frequency,
4449
+ # and currency of expected expenditure.
4450
+ # @return [Array<Types::ExpectedCustomerSpend>]
4451
+ #
4452
+ # @!attribute [rw] other_solution_description
4453
+ # Offers a description of other solutions if the standard solutions do
4454
+ # not adequately cover the project's scope.
4455
+ # @return [String]
4456
+ #
4457
+ # @!attribute [rw] sales_activities
4458
+ # Lists the pre-sales activities that have occurred with the
4459
+ # end-customer related to the opportunity. This field is conditionally
4460
+ # mandatory when the project is qualified for Co-Sell and helps drive
4461
+ # assignment priority on the AWS side. It provides insight into the
4462
+ # engagement level with the customer.
4463
+ # @return [Array<String>]
4464
+ #
4465
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ProjectView AWS API Documentation
4466
+ #
4467
+ class ProjectView < Struct.new(
4468
+ :customer_use_case,
4469
+ :delivery_models,
4470
+ :expected_customer_spend,
4471
+ :other_solution_description,
4472
+ :sales_activities)
4473
+ SENSITIVE = [:other_solution_description]
4474
+ include Aws::Structure
4475
+ end
4476
+
4477
+ # @!attribute [rw] catalog
4478
+ # Specifies the catalog in which the settings will be updated.
4479
+ # Acceptable values include `AWS` for production and `Sandbox` for
4480
+ # testing environments.
4481
+ # @return [String]
4482
+ #
4483
+ # @!attribute [rw] resource_snapshot_job_role_identifier
4484
+ # Specifies the ARN of the IAM Role used for resource snapshot job
4485
+ # executions.
4486
+ # @return [String]
4487
+ #
4488
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/PutSellingSystemSettingsRequest AWS API Documentation
4489
+ #
4490
+ class PutSellingSystemSettingsRequest < Struct.new(
4491
+ :catalog,
4492
+ :resource_snapshot_job_role_identifier)
4493
+ SENSITIVE = []
4494
+ include Aws::Structure
4495
+ end
4496
+
4497
+ # @!attribute [rw] catalog
4498
+ # Specifies the catalog in which the settings are defined. Acceptable
4499
+ # values include `AWS` for production and `Sandbox` for testing
4500
+ # environments.
4501
+ # @return [String]
4502
+ #
4503
+ # @!attribute [rw] resource_snapshot_job_role_arn
4504
+ # Specifies the ARN of the IAM Role used for resource snapshot job
4505
+ # executions.
4506
+ # @return [String]
4507
+ #
4508
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/PutSellingSystemSettingsResponse AWS API Documentation
4509
+ #
4510
+ class PutSellingSystemSettingsResponse < Struct.new(
4511
+ :catalog,
4512
+ :resource_snapshot_job_role_arn)
4513
+ SENSITIVE = []
4514
+ include Aws::Structure
4515
+ end
4516
+
2671
4517
  # Represents the entity that received the Engagement Invitation,
2672
4518
  # including account and company details. This field is essential for
2673
4519
  # tracking the partner who is being invited to collaborate.
2674
4520
  #
4521
+ # @note Receiver is a union - when making an API calls you must set exactly one of the members.
4522
+ #
2675
4523
  # @note Receiver is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Receiver corresponding to the set member.
2676
4524
  #
2677
4525
  # @!attribute [rw] account
@@ -2814,6 +4662,110 @@ module Aws::PartnerCentralSelling
2814
4662
  include Aws::Structure
2815
4663
  end
2816
4664
 
4665
+ # An object that contains a `Resource Snapshot Job`'s subset of fields.
4666
+ #
4667
+ # @!attribute [rw] arn
4668
+ # The Amazon Resource Name (ARN) for the resource snapshot job.
4669
+ # @return [String]
4670
+ #
4671
+ # @!attribute [rw] engagement_id
4672
+ # The unique identifier for the engagement within the AWS Partner
4673
+ # Central system. This ID is used for direct references to the
4674
+ # engagement within the service.
4675
+ # @return [String]
4676
+ #
4677
+ # @!attribute [rw] id
4678
+ # The unique identifier for the resource snapshot job within the AWS
4679
+ # Partner Central system. This ID is used for direct references to the
4680
+ # job within the service.
4681
+ # @return [String]
4682
+ #
4683
+ # @!attribute [rw] status
4684
+ # Represents the current status of the resource snapshot job.
4685
+ # @return [String]
4686
+ #
4687
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ResourceSnapshotJobSummary AWS API Documentation
4688
+ #
4689
+ class ResourceSnapshotJobSummary < Struct.new(
4690
+ :arn,
4691
+ :engagement_id,
4692
+ :id,
4693
+ :status)
4694
+ SENSITIVE = []
4695
+ include Aws::Structure
4696
+ end
4697
+
4698
+ # Represents the payload of a resource snapshot. This structure is
4699
+ # designed to accommodate different types of resource snapshots,
4700
+ # currently supporting opportunity summaries.
4701
+ #
4702
+ # @note ResourceSnapshotPayload is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ResourceSnapshotPayload corresponding to the set member.
4703
+ #
4704
+ # @!attribute [rw] opportunity_summary
4705
+ # An object that contains an `opportunity`'s subset of fields.
4706
+ # @return [Types::OpportunitySummaryView]
4707
+ #
4708
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ResourceSnapshotPayload AWS API Documentation
4709
+ #
4710
+ class ResourceSnapshotPayload < Struct.new(
4711
+ :opportunity_summary,
4712
+ :unknown)
4713
+ SENSITIVE = []
4714
+ include Aws::Structure
4715
+ include Aws::Structure::Union
4716
+
4717
+ class OpportunitySummary < ResourceSnapshotPayload; end
4718
+ class Unknown < ResourceSnapshotPayload; end
4719
+ end
4720
+
4721
+ # Provides a concise summary of a resource snapshot, including its
4722
+ # unique identifier and version information. This structure is used to
4723
+ # quickly reference and identify specific versions of resource
4724
+ # snapshots.
4725
+ #
4726
+ # @!attribute [rw] arn
4727
+ # The Amazon Resource Name (ARN) of the snapshot. This globally unique
4728
+ # identifier can be used for cross-service references and in IAM
4729
+ # policies.
4730
+ # @return [String]
4731
+ #
4732
+ # @!attribute [rw] created_by
4733
+ # The AWS account ID of the principal (user or role) who created the
4734
+ # snapshot. This helps in tracking the origin of the snapshot.
4735
+ # @return [String]
4736
+ #
4737
+ # @!attribute [rw] resource_id
4738
+ # The identifier of the specific resource snapshotted. The format
4739
+ # might vary depending on the ResourceType.
4740
+ # @return [String]
4741
+ #
4742
+ # @!attribute [rw] resource_snapshot_template_name
4743
+ # The name of the template used to create the snapshot.
4744
+ # @return [String]
4745
+ #
4746
+ # @!attribute [rw] resource_type
4747
+ # The type of resource snapshotted.
4748
+ # @return [String]
4749
+ #
4750
+ # @!attribute [rw] revision
4751
+ # The revision number of the snapshot. This integer value is
4752
+ # incremented each time the snapshot is updated, allowing for version
4753
+ # tracking of the resource snapshot.
4754
+ # @return [Integer]
4755
+ #
4756
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ResourceSnapshotSummary AWS API Documentation
4757
+ #
4758
+ class ResourceSnapshotSummary < Struct.new(
4759
+ :arn,
4760
+ :created_by,
4761
+ :resource_id,
4762
+ :resource_snapshot_template_name,
4763
+ :resource_type,
4764
+ :revision)
4765
+ SENSITIVE = [:created_by]
4766
+ include Aws::Structure
4767
+ end
4768
+
2817
4769
  # An object that contains the details of the sender-provided contact
2818
4770
  # person for the `EngagementInvitation`.
2819
4771
  #
@@ -2915,6 +4867,11 @@ module Aws::PartnerCentralSelling
2915
4867
  # Specifies minimal information for the solution offered to solve the
2916
4868
  # customer's business problem.
2917
4869
  #
4870
+ # @!attribute [rw] arn
4871
+ # The SolutionBase structure provides essential information about a
4872
+ # solution.
4873
+ # @return [String]
4874
+ #
2918
4875
  # @!attribute [rw] catalog
2919
4876
  # Specifies the catalog in which the solution is hosted, either `AWS`
2920
4877
  # or `Sandbox`. This helps partners differentiate between live
@@ -2955,6 +4912,7 @@ module Aws::PartnerCentralSelling
2955
4912
  # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/SolutionBase AWS API Documentation
2956
4913
  #
2957
4914
  class SolutionBase < Struct.new(
4915
+ :arn,
2958
4916
  :catalog,
2959
4917
  :category,
2960
4918
  :created_date,
@@ -2987,6 +4945,27 @@ module Aws::PartnerCentralSelling
2987
4945
  include Aws::Structure
2988
4946
  end
2989
4947
 
4948
+ # Defines the sorting parameters for listing resource snapshot jobs.
4949
+ # This structure allows you to specify the field to sort by and the
4950
+ # order of sorting.
4951
+ #
4952
+ # @!attribute [rw] sort_by
4953
+ # Specifies the field by which to sort the resource snapshot jobs.
4954
+ # @return [String]
4955
+ #
4956
+ # @!attribute [rw] sort_order
4957
+ # Determines the order in which the sorted results are presented.
4958
+ # @return [String]
4959
+ #
4960
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/SortObject AWS API Documentation
4961
+ #
4962
+ class SortObject < Struct.new(
4963
+ :sort_by,
4964
+ :sort_order)
4965
+ SENSITIVE = []
4966
+ include Aws::Structure
4967
+ end
4968
+
2990
4969
  # @!attribute [rw] catalog
2991
4970
  # Specifies the catalog related to the task. Use `AWS` for production
2992
4971
  # engagements and `Sandbox` for testing scenarios.
@@ -3036,6 +5015,11 @@ module Aws::PartnerCentralSelling
3036
5015
  # Indicates the reason for task failure using an enumerated code.
3037
5016
  # @return [String]
3038
5017
  #
5018
+ # @!attribute [rw] resource_snapshot_job_id
5019
+ # The identifier of the resource snapshot job created as part of this
5020
+ # task.
5021
+ # @return [String]
5022
+ #
3039
5023
  # @!attribute [rw] start_time
3040
5024
  # The timestamp indicating when the task was initiated. The format
3041
5025
  # follows RFC 3339 section 5.6.
@@ -3062,6 +5046,7 @@ module Aws::PartnerCentralSelling
3062
5046
  :message,
3063
5047
  :opportunity_id,
3064
5048
  :reason_code,
5049
+ :resource_snapshot_job_id,
3065
5050
  :start_time,
3066
5051
  :task_arn,
3067
5052
  :task_id,
@@ -3108,6 +5093,16 @@ module Aws::PartnerCentralSelling
3108
5093
  include Aws::Structure
3109
5094
  end
3110
5095
 
5096
+ # @!attribute [rw] engagement_id
5097
+ # The identifier of the newly created engagement. Only populated if
5098
+ # TaskStatus is COMPLETE.
5099
+ # @return [String]
5100
+ #
5101
+ # @!attribute [rw] engagement_invitation_id
5102
+ # The identifier of the new engagement invitation. Only populated if
5103
+ # TaskStatus is COMPLETE.
5104
+ # @return [String]
5105
+ #
3111
5106
  # @!attribute [rw] message
3112
5107
  # If the task fails, this field contains a detailed message describing
3113
5108
  # the failure and possible recovery steps.
@@ -3123,6 +5118,12 @@ module Aws::PartnerCentralSelling
3123
5118
  # Indicates the reason for task failure using an enumerated code.
3124
5119
  # @return [String]
3125
5120
  #
5121
+ # @!attribute [rw] resource_snapshot_job_id
5122
+ # The identifier of the resource snapshot job created to add the
5123
+ # opportunity resource snapshot to the Engagement. Only populated if
5124
+ # TaskStatus is COMPLETE.
5125
+ # @return [String]
5126
+ #
3126
5127
  # @!attribute [rw] start_time
3127
5128
  # The timestamp indicating when the task was initiated. The format
3128
5129
  # follows RFC 3339 section 5.6.
@@ -3147,9 +5148,12 @@ module Aws::PartnerCentralSelling
3147
5148
  # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/StartEngagementFromOpportunityTaskResponse AWS API Documentation
3148
5149
  #
3149
5150
  class StartEngagementFromOpportunityTaskResponse < Struct.new(
5151
+ :engagement_id,
5152
+ :engagement_invitation_id,
3150
5153
  :message,
3151
5154
  :opportunity_id,
3152
5155
  :reason_code,
5156
+ :resource_snapshot_job_id,
3153
5157
  :start_time,
3154
5158
  :task_arn,
3155
5159
  :task_id,
@@ -3158,6 +5162,69 @@ module Aws::PartnerCentralSelling
3158
5162
  include Aws::Structure
3159
5163
  end
3160
5164
 
5165
+ # @!attribute [rw] catalog
5166
+ # Specifies the catalog related to the request.
5167
+ # @return [String]
5168
+ #
5169
+ # @!attribute [rw] resource_snapshot_job_identifier
5170
+ # The identifier of the resource snapshot job to start.
5171
+ # @return [String]
5172
+ #
5173
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/StartResourceSnapshotJobRequest AWS API Documentation
5174
+ #
5175
+ class StartResourceSnapshotJobRequest < Struct.new(
5176
+ :catalog,
5177
+ :resource_snapshot_job_identifier)
5178
+ SENSITIVE = []
5179
+ include Aws::Structure
5180
+ end
5181
+
5182
+ # @!attribute [rw] catalog
5183
+ # Specifies the catalog related to the request.
5184
+ # @return [String]
5185
+ #
5186
+ # @!attribute [rw] resource_snapshot_job_identifier
5187
+ # The identifier of the job to stop.
5188
+ # @return [String]
5189
+ #
5190
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/StopResourceSnapshotJobRequest AWS API Documentation
5191
+ #
5192
+ class StopResourceSnapshotJobRequest < Struct.new(
5193
+ :catalog,
5194
+ :resource_snapshot_job_identifier)
5195
+ SENSITIVE = []
5196
+ include Aws::Structure
5197
+ end
5198
+
5199
+ # @!attribute [rw] catalog
5200
+ # Specifies the catalog related to the request.
5201
+ # @return [String]
5202
+ #
5203
+ # @!attribute [rw] identifier
5204
+ # The identifier of the opportunity previously created by partner and
5205
+ # needs to be submitted.
5206
+ # @return [String]
5207
+ #
5208
+ # @!attribute [rw] involvement_type
5209
+ # Specifies the level of AWS sellers' involvement on the opportunity.
5210
+ # @return [String]
5211
+ #
5212
+ # @!attribute [rw] visibility
5213
+ # Determines whether to restrict visibility of the opportunity from
5214
+ # AWS sales. Default value is Full.
5215
+ # @return [String]
5216
+ #
5217
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/SubmitOpportunityRequest AWS API Documentation
5218
+ #
5219
+ class SubmitOpportunityRequest < Struct.new(
5220
+ :catalog,
5221
+ :identifier,
5222
+ :involvement_type,
5223
+ :visibility)
5224
+ SENSITIVE = []
5225
+ include Aws::Structure
5226
+ end
5227
+
3161
5228
  # This error occurs when there are too many requests sent. Review the
3162
5229
  # provided quotas and adapt your usage to avoid throttling.
3163
5230
  #