aws-sdk-partnercentralselling 1.2.0 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-partnercentralselling/client.rb +1597 -78
- data/lib/aws-sdk-partnercentralselling/client_api.rb +908 -3
- data/lib/aws-sdk-partnercentralselling/types.rb +2255 -70
- data/lib/aws-sdk-partnercentralselling.rb +2 -2
- data/sig/client.rbs +451 -6
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +527 -4
- metadata +4 -4
@@ -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
|
@@ -748,13 +903,6 @@ module Aws::PartnerCentralSelling
|
|
748
903
|
# * Cosell—Support for Public Tender/RFx: Opportunity related to the
|
749
904
|
# public sector where the partner needs Amazon Web Services RFx
|
750
905
|
# support.
|
751
|
-
#
|
752
|
-
# * Do Not Need Support from AWS Sales Rep: Indicates that a partner
|
753
|
-
# doesn't need support from an Amazon Web Services sales
|
754
|
-
# representative, and the partner solely manages the opportunity.
|
755
|
-
# It's possible to request coselling support on these opportunities
|
756
|
-
# at any stage during their lifecycles. This is also known as a
|
757
|
-
# for-visibility-only (FVO) opportunity.
|
758
906
|
# @return [Array<String>]
|
759
907
|
#
|
760
908
|
# @!attribute [rw] project
|
@@ -815,6 +963,148 @@ module Aws::PartnerCentralSelling
|
|
815
963
|
include Aws::Structure
|
816
964
|
end
|
817
965
|
|
966
|
+
# @!attribute [rw] catalog
|
967
|
+
# Specifies the catalog in which to create the snapshot job. Valid
|
968
|
+
# values are `AWS` and ` Sandbox`.
|
969
|
+
# @return [String]
|
970
|
+
#
|
971
|
+
# @!attribute [rw] client_token
|
972
|
+
# A client-generated UUID used for idempotency check. The token helps
|
973
|
+
# prevent duplicate job creations.
|
974
|
+
#
|
975
|
+
# **A suitable default value is auto-generated.** You should normally
|
976
|
+
# not need to pass this option.
|
977
|
+
# @return [String]
|
978
|
+
#
|
979
|
+
# @!attribute [rw] engagement_identifier
|
980
|
+
# Specifies the identifier of the engagement associated with the
|
981
|
+
# resource to be snapshotted.
|
982
|
+
# @return [String]
|
983
|
+
#
|
984
|
+
# @!attribute [rw] resource_identifier
|
985
|
+
# Specifies the identifier of the specific resource to be snapshotted.
|
986
|
+
# The format depends on the ` ResourceType`.
|
987
|
+
# @return [String]
|
988
|
+
#
|
989
|
+
# @!attribute [rw] resource_snapshot_template_identifier
|
990
|
+
# Specifies the name of the template that defines the schema for the
|
991
|
+
# snapshot.
|
992
|
+
# @return [String]
|
993
|
+
#
|
994
|
+
# @!attribute [rw] resource_type
|
995
|
+
# The type of resource for which the snapshot job is being created.
|
996
|
+
# Must be one of the supported resource types i.e. `Opportunity`
|
997
|
+
# @return [String]
|
998
|
+
#
|
999
|
+
# @!attribute [rw] tags
|
1000
|
+
# A list of objects specifying each tag name and value.
|
1001
|
+
# @return [Array<Types::Tag>]
|
1002
|
+
#
|
1003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CreateResourceSnapshotJobRequest AWS API Documentation
|
1004
|
+
#
|
1005
|
+
class CreateResourceSnapshotJobRequest < Struct.new(
|
1006
|
+
:catalog,
|
1007
|
+
:client_token,
|
1008
|
+
:engagement_identifier,
|
1009
|
+
:resource_identifier,
|
1010
|
+
:resource_snapshot_template_identifier,
|
1011
|
+
:resource_type,
|
1012
|
+
:tags)
|
1013
|
+
SENSITIVE = []
|
1014
|
+
include Aws::Structure
|
1015
|
+
end
|
1016
|
+
|
1017
|
+
# @!attribute [rw] arn
|
1018
|
+
# The Amazon Resource Name (ARN) of the created snapshot job.
|
1019
|
+
# @return [String]
|
1020
|
+
#
|
1021
|
+
# @!attribute [rw] id
|
1022
|
+
# The unique identifier for the created snapshot job.
|
1023
|
+
# @return [String]
|
1024
|
+
#
|
1025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CreateResourceSnapshotJobResponse AWS API Documentation
|
1026
|
+
#
|
1027
|
+
class CreateResourceSnapshotJobResponse < Struct.new(
|
1028
|
+
:arn,
|
1029
|
+
:id)
|
1030
|
+
SENSITIVE = []
|
1031
|
+
include Aws::Structure
|
1032
|
+
end
|
1033
|
+
|
1034
|
+
# @!attribute [rw] catalog
|
1035
|
+
# Specifies the catalog where the snapshot is created. Valid values
|
1036
|
+
# are `AWS` and `Sandbox`.
|
1037
|
+
# @return [String]
|
1038
|
+
#
|
1039
|
+
# @!attribute [rw] client_token
|
1040
|
+
# Specifies a unique, client-generated UUID to ensure that the request
|
1041
|
+
# is handled exactly once. This token helps prevent duplicate snapshot
|
1042
|
+
# creations.
|
1043
|
+
#
|
1044
|
+
# **A suitable default value is auto-generated.** You should normally
|
1045
|
+
# not need to pass this option.
|
1046
|
+
# @return [String]
|
1047
|
+
#
|
1048
|
+
# @!attribute [rw] engagement_identifier
|
1049
|
+
# The unique identifier of the engagement associated with this
|
1050
|
+
# snapshot. This field links the snapshot to a specific engagement
|
1051
|
+
# context.
|
1052
|
+
# @return [String]
|
1053
|
+
#
|
1054
|
+
# @!attribute [rw] resource_identifier
|
1055
|
+
# The unique identifier of the specific resource to be snapshotted.
|
1056
|
+
# The format and constraints of this identifier depend on the
|
1057
|
+
# `ResourceType` specified. For example: For `Opportunity` type, it
|
1058
|
+
# will be an opportunity ID.
|
1059
|
+
# @return [String]
|
1060
|
+
#
|
1061
|
+
# @!attribute [rw] resource_snapshot_template_identifier
|
1062
|
+
# The name of the template that defines the schema for the snapshot.
|
1063
|
+
# This template determines which subset of the resource data will be
|
1064
|
+
# included in the snapshot. Must correspond to an existing and valid
|
1065
|
+
# template for the specified `ResourceType`.
|
1066
|
+
# @return [String]
|
1067
|
+
#
|
1068
|
+
# @!attribute [rw] resource_type
|
1069
|
+
# Specifies the type of resource for which the snapshot is being
|
1070
|
+
# created. This field determines the structure and content of the
|
1071
|
+
# snapshot. Must be one of the supported resource types, such as:
|
1072
|
+
# `Opportunity`.
|
1073
|
+
# @return [String]
|
1074
|
+
#
|
1075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CreateResourceSnapshotRequest AWS API Documentation
|
1076
|
+
#
|
1077
|
+
class CreateResourceSnapshotRequest < Struct.new(
|
1078
|
+
:catalog,
|
1079
|
+
:client_token,
|
1080
|
+
:engagement_identifier,
|
1081
|
+
:resource_identifier,
|
1082
|
+
:resource_snapshot_template_identifier,
|
1083
|
+
:resource_type)
|
1084
|
+
SENSITIVE = []
|
1085
|
+
include Aws::Structure
|
1086
|
+
end
|
1087
|
+
|
1088
|
+
# @!attribute [rw] arn
|
1089
|
+
# Specifies the Amazon Resource Name (ARN) that uniquely identifies
|
1090
|
+
# the snapshot created.
|
1091
|
+
# @return [String]
|
1092
|
+
#
|
1093
|
+
# @!attribute [rw] revision
|
1094
|
+
# Specifies the revision number of the created snapshot. This field
|
1095
|
+
# provides important information about the snapshot's place in the
|
1096
|
+
# sequence of snapshots for the given resource.
|
1097
|
+
# @return [Integer]
|
1098
|
+
#
|
1099
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CreateResourceSnapshotResponse AWS API Documentation
|
1100
|
+
#
|
1101
|
+
class CreateResourceSnapshotResponse < Struct.new(
|
1102
|
+
:arn,
|
1103
|
+
:revision)
|
1104
|
+
SENSITIVE = []
|
1105
|
+
include Aws::Structure
|
1106
|
+
end
|
1107
|
+
|
818
1108
|
# An object that contains the customer's `Account` and `Contact`.
|
819
1109
|
#
|
820
1110
|
# @!attribute [rw] account
|
@@ -838,6 +1128,38 @@ module Aws::PartnerCentralSelling
|
|
838
1128
|
include Aws::Structure
|
839
1129
|
end
|
840
1130
|
|
1131
|
+
# The CustomerProjects structure in Engagements offers a flexible
|
1132
|
+
# framework for managing customer-project relationships. It supports
|
1133
|
+
# multiple customers per Engagement and multiple projects per customer,
|
1134
|
+
# while also allowing for customers without projects and projects
|
1135
|
+
# without specific customers.
|
1136
|
+
#
|
1137
|
+
# All Engagement members have full visibility of customers and their
|
1138
|
+
# associated projects, enabling the capture of relevant context even
|
1139
|
+
# when project details are not fully defined. This structure also
|
1140
|
+
# facilitates targeted invitations, allowing partners to focus on
|
1141
|
+
# specific customers and their business problems when sending Engagement
|
1142
|
+
# invitations.
|
1143
|
+
#
|
1144
|
+
# @!attribute [rw] customer
|
1145
|
+
# Contains details about the customer associated with the Engagement
|
1146
|
+
# Invitation, including company information and industry.
|
1147
|
+
# @return [Types::EngagementCustomer]
|
1148
|
+
#
|
1149
|
+
# @!attribute [rw] project
|
1150
|
+
# Information about the customer project associated with the
|
1151
|
+
# Engagement.
|
1152
|
+
# @return [Types::EngagementCustomerProjectDetails]
|
1153
|
+
#
|
1154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CustomerProjectsContext AWS API Documentation
|
1155
|
+
#
|
1156
|
+
class CustomerProjectsContext < Struct.new(
|
1157
|
+
:customer,
|
1158
|
+
:project)
|
1159
|
+
SENSITIVE = []
|
1160
|
+
include Aws::Structure
|
1161
|
+
end
|
1162
|
+
|
841
1163
|
# An object that contains a `Customer` object's subset of fields.
|
842
1164
|
#
|
843
1165
|
# @!attribute [rw] account
|
@@ -852,6 +1174,24 @@ module Aws::PartnerCentralSelling
|
|
852
1174
|
include Aws::Structure
|
853
1175
|
end
|
854
1176
|
|
1177
|
+
# @!attribute [rw] catalog
|
1178
|
+
# Specifies the catalog from which to delete the snapshot job. Valid
|
1179
|
+
# values are `AWS` and `Sandbox`.
|
1180
|
+
# @return [String]
|
1181
|
+
#
|
1182
|
+
# @!attribute [rw] resource_snapshot_job_identifier
|
1183
|
+
# The unique identifier of the resource snapshot job to be deleted.
|
1184
|
+
# @return [String]
|
1185
|
+
#
|
1186
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/DeleteResourceSnapshotJobRequest AWS API Documentation
|
1187
|
+
#
|
1188
|
+
class DeleteResourceSnapshotJobRequest < Struct.new(
|
1189
|
+
:catalog,
|
1190
|
+
:resource_snapshot_job_identifier)
|
1191
|
+
SENSITIVE = []
|
1192
|
+
include Aws::Structure
|
1193
|
+
end
|
1194
|
+
|
855
1195
|
# @!attribute [rw] catalog
|
856
1196
|
# Specifies the catalog associated with the request. This field takes
|
857
1197
|
# a string value from a predefined list: `AWS` or `Sandbox`. The
|
@@ -917,6 +1257,57 @@ module Aws::PartnerCentralSelling
|
|
917
1257
|
include Aws::Structure
|
918
1258
|
end
|
919
1259
|
|
1260
|
+
# Provides detailed context information for an Engagement. This
|
1261
|
+
# structure allows for specifying the type of context and its associated
|
1262
|
+
# payload.
|
1263
|
+
#
|
1264
|
+
# @!attribute [rw] payload
|
1265
|
+
# Contains the specific details of the Engagement context. The
|
1266
|
+
# structure of this payload varies depending on the Type field.
|
1267
|
+
# @return [Types::EngagementContextPayload]
|
1268
|
+
#
|
1269
|
+
# @!attribute [rw] type
|
1270
|
+
# Specifies the type of Engagement context. Valid values are
|
1271
|
+
# "CustomerProject" or "Document", indicating whether the context
|
1272
|
+
# relates to a customer project or a document respectively.
|
1273
|
+
# @return [String]
|
1274
|
+
#
|
1275
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementContextDetails AWS API Documentation
|
1276
|
+
#
|
1277
|
+
class EngagementContextDetails < Struct.new(
|
1278
|
+
:payload,
|
1279
|
+
:type)
|
1280
|
+
SENSITIVE = []
|
1281
|
+
include Aws::Structure
|
1282
|
+
end
|
1283
|
+
|
1284
|
+
# Represents the payload of an Engagement context. The structure of this
|
1285
|
+
# payload varies based on the context type specified in the
|
1286
|
+
# EngagementContextDetails.
|
1287
|
+
#
|
1288
|
+
# @note EngagementContextPayload is a union - when making an API calls you must set exactly one of the members.
|
1289
|
+
#
|
1290
|
+
# @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.
|
1291
|
+
#
|
1292
|
+
# @!attribute [rw] customer_project
|
1293
|
+
# Contains detailed information about a customer project when the
|
1294
|
+
# context type is "CustomerProject". This field is present only when
|
1295
|
+
# the Type in EngagementContextDetails is set to "CustomerProject".
|
1296
|
+
# @return [Types::CustomerProjectsContext]
|
1297
|
+
#
|
1298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementContextPayload AWS API Documentation
|
1299
|
+
#
|
1300
|
+
class EngagementContextPayload < Struct.new(
|
1301
|
+
:customer_project,
|
1302
|
+
:unknown)
|
1303
|
+
SENSITIVE = []
|
1304
|
+
include Aws::Structure
|
1305
|
+
include Aws::Structure::Union
|
1306
|
+
|
1307
|
+
class CustomerProject < EngagementContextPayload; end
|
1308
|
+
class Unknown < EngagementContextPayload; end
|
1309
|
+
end
|
1310
|
+
|
920
1311
|
# Contains details about the customer associated with the Engagement
|
921
1312
|
# Invitation, including company information and industry.
|
922
1313
|
#
|
@@ -954,6 +1345,32 @@ module Aws::PartnerCentralSelling
|
|
954
1345
|
include Aws::Structure
|
955
1346
|
end
|
956
1347
|
|
1348
|
+
# Provides comprehensive details about a customer project associated
|
1349
|
+
# with an Engagement. This may include information such as project
|
1350
|
+
# goals, timelines, and specific customer requirements.
|
1351
|
+
#
|
1352
|
+
# @!attribute [rw] business_problem
|
1353
|
+
# A description of the business problem the project aims to solve.
|
1354
|
+
# @return [String]
|
1355
|
+
#
|
1356
|
+
# @!attribute [rw] target_completion_date
|
1357
|
+
# The target completion date for the customer's project.
|
1358
|
+
# @return [String]
|
1359
|
+
#
|
1360
|
+
# @!attribute [rw] title
|
1361
|
+
# The title of the project.
|
1362
|
+
# @return [String]
|
1363
|
+
#
|
1364
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementCustomerProjectDetails AWS API Documentation
|
1365
|
+
#
|
1366
|
+
class EngagementCustomerProjectDetails < Struct.new(
|
1367
|
+
:business_problem,
|
1368
|
+
:target_completion_date,
|
1369
|
+
:title)
|
1370
|
+
SENSITIVE = [:business_problem]
|
1371
|
+
include Aws::Structure
|
1372
|
+
end
|
1373
|
+
|
957
1374
|
# Provides a summarized view of the Engagement Invitation, including
|
958
1375
|
# details like the identifier, status, and sender. This summary helps
|
959
1376
|
# partners track and manage AWS originated opportunities.
|
@@ -970,6 +1387,11 @@ module Aws::PartnerCentralSelling
|
|
970
1387
|
# whether the opportunity is live or being tested.
|
971
1388
|
# @return [String]
|
972
1389
|
#
|
1390
|
+
# @!attribute [rw] engagement_id
|
1391
|
+
# The identifier of the Engagement associated with this invitation.
|
1392
|
+
# This links the invitation to its parent Engagement.
|
1393
|
+
# @return [String]
|
1394
|
+
#
|
973
1395
|
# @!attribute [rw] engagement_title
|
974
1396
|
# Provides a short title or description of the Engagement Invitation.
|
975
1397
|
# This title helps partners quickly identify and differentiate between
|
@@ -994,6 +1416,10 @@ module Aws::PartnerCentralSelling
|
|
994
1416
|
# and helps in tracking the timeline for engagement.
|
995
1417
|
# @return [Time]
|
996
1418
|
#
|
1419
|
+
# @!attribute [rw] participant_type
|
1420
|
+
# Identifies the role of the caller in the engagement invitation.
|
1421
|
+
# @return [String]
|
1422
|
+
#
|
997
1423
|
# @!attribute [rw] payload_type
|
998
1424
|
# Describes the type of payload associated with the Engagement
|
999
1425
|
# Invitation, such as `Opportunity` or `MarketplaceOffer`. This helps
|
@@ -1029,10 +1455,12 @@ module Aws::PartnerCentralSelling
|
|
1029
1455
|
class EngagementInvitationSummary < Struct.new(
|
1030
1456
|
:arn,
|
1031
1457
|
:catalog,
|
1458
|
+
:engagement_id,
|
1032
1459
|
:engagement_title,
|
1033
1460
|
:expiration_date,
|
1034
1461
|
:id,
|
1035
1462
|
:invitation_date,
|
1463
|
+
:participant_type,
|
1036
1464
|
:payload_type,
|
1037
1465
|
:receiver,
|
1038
1466
|
:sender_aws_account_id,
|
@@ -1042,43 +1470,215 @@ module Aws::PartnerCentralSelling
|
|
1042
1470
|
include Aws::Structure
|
1043
1471
|
end
|
1044
1472
|
|
1045
|
-
#
|
1046
|
-
#
|
1047
|
-
#
|
1473
|
+
# Engagement members are the participants in an Engagement, which is
|
1474
|
+
# likely a collaborative project or business opportunity within the AWS
|
1475
|
+
# partner network. Members can be different partner organizations or AWS
|
1476
|
+
# accounts that are working together on a specific engagement.
|
1048
1477
|
#
|
1049
|
-
#
|
1050
|
-
#
|
1051
|
-
#
|
1052
|
-
#
|
1053
|
-
#
|
1478
|
+
# Each member is represented by their AWS Account ID, Company Name, and
|
1479
|
+
# associated details. Members have a status within the Engagement
|
1480
|
+
# (PENDING, ACCEPTED, REJECTED, or WITHDRAWN), indicating their current
|
1481
|
+
# state of participation. Only existing members of an Engagement can
|
1482
|
+
# view the list of other members. This implies a level of privacy and
|
1483
|
+
# access control within the Engagement structure.
|
1054
1484
|
#
|
1055
|
-
# @!attribute [rw]
|
1056
|
-
#
|
1057
|
-
#
|
1058
|
-
#
|
1485
|
+
# @!attribute [rw] account_id
|
1486
|
+
# This is the unique identifier for the AWS account associated with
|
1487
|
+
# the member organization. It's used for AWS-related operations and
|
1488
|
+
# identity verification.
|
1059
1489
|
# @return [String]
|
1060
1490
|
#
|
1061
|
-
# @!attribute [rw]
|
1062
|
-
#
|
1063
|
-
# projected amount. This can include values such as `Monthly`,
|
1064
|
-
# `Quarterly`, or `Annually`. The default value is `Monthly`,
|
1065
|
-
# representing recurring monthly spend.
|
1491
|
+
# @!attribute [rw] company_name
|
1492
|
+
# The official name of the member's company or organization.
|
1066
1493
|
# @return [String]
|
1067
1494
|
#
|
1068
|
-
# @!attribute [rw]
|
1069
|
-
#
|
1070
|
-
#
|
1071
|
-
#
|
1495
|
+
# @!attribute [rw] website_url
|
1496
|
+
# The URL of the member company's website. This offers a way to find
|
1497
|
+
# more information about the member organization and serves as an
|
1498
|
+
# additional identifier.
|
1072
1499
|
# @return [String]
|
1073
1500
|
#
|
1074
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/
|
1501
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementMember AWS API Documentation
|
1075
1502
|
#
|
1076
|
-
class
|
1077
|
-
:
|
1078
|
-
:
|
1079
|
-
:
|
1080
|
-
:
|
1081
|
-
|
1503
|
+
class EngagementMember < Struct.new(
|
1504
|
+
:account_id,
|
1505
|
+
:company_name,
|
1506
|
+
:website_url)
|
1507
|
+
SENSITIVE = [:account_id]
|
1508
|
+
include Aws::Structure
|
1509
|
+
end
|
1510
|
+
|
1511
|
+
# The EngagementMemberSummary provides a snapshot of essential
|
1512
|
+
# information about participants in an AWS Partner Central Engagement.
|
1513
|
+
# This compact data structure encapsulates key details of each member,
|
1514
|
+
# facilitating efficient collaboration and management within the
|
1515
|
+
# Engagement.
|
1516
|
+
#
|
1517
|
+
# @!attribute [rw] company_name
|
1518
|
+
# The official name of the member's company or organization.
|
1519
|
+
# @return [String]
|
1520
|
+
#
|
1521
|
+
# @!attribute [rw] website_url
|
1522
|
+
# The URL of the member company's website. This offers a way to find
|
1523
|
+
# more information about the member organization and serves as an
|
1524
|
+
# additional identifier.
|
1525
|
+
# @return [String]
|
1526
|
+
#
|
1527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementMemberSummary AWS API Documentation
|
1528
|
+
#
|
1529
|
+
class EngagementMemberSummary < Struct.new(
|
1530
|
+
:company_name,
|
1531
|
+
:website_url)
|
1532
|
+
SENSITIVE = []
|
1533
|
+
include Aws::Structure
|
1534
|
+
end
|
1535
|
+
|
1536
|
+
# This provide a streamlined view of the relationships between
|
1537
|
+
# engagements and resources. These summaries offer a crucial link
|
1538
|
+
# between collaborative engagements and the specific resources involved,
|
1539
|
+
# such as opportunities.These summaries are particularly valuable for
|
1540
|
+
# partners navigating complex engagements with multiple resources. They
|
1541
|
+
# enable quick insights into resource distribution across engagements,
|
1542
|
+
# support efficient resource management, and help maintain a clear
|
1543
|
+
# overview of collaborative activities.
|
1544
|
+
#
|
1545
|
+
# @!attribute [rw] catalog
|
1546
|
+
# Indicates the environment in which the resource and engagement
|
1547
|
+
# exist.
|
1548
|
+
# @return [String]
|
1549
|
+
#
|
1550
|
+
# @!attribute [rw] created_by
|
1551
|
+
# The AWS account ID of the entity that owns the resource. Identifies
|
1552
|
+
# the account responsible for or having primary control over the
|
1553
|
+
# resource.
|
1554
|
+
# @return [String]
|
1555
|
+
#
|
1556
|
+
# @!attribute [rw] engagement_id
|
1557
|
+
# A unique identifier for the engagement associated with the resource.
|
1558
|
+
# @return [String]
|
1559
|
+
#
|
1560
|
+
# @!attribute [rw] resource_id
|
1561
|
+
# A unique identifier for the specific resource. Varies depending on
|
1562
|
+
# the resource type.
|
1563
|
+
# @return [String]
|
1564
|
+
#
|
1565
|
+
# @!attribute [rw] resource_type
|
1566
|
+
# Categorizes the type of resource associated with the engagement.
|
1567
|
+
# @return [String]
|
1568
|
+
#
|
1569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementResourceAssociationSummary AWS API Documentation
|
1570
|
+
#
|
1571
|
+
class EngagementResourceAssociationSummary < Struct.new(
|
1572
|
+
:catalog,
|
1573
|
+
:created_by,
|
1574
|
+
:engagement_id,
|
1575
|
+
:resource_id,
|
1576
|
+
:resource_type)
|
1577
|
+
SENSITIVE = [:created_by]
|
1578
|
+
include Aws::Structure
|
1579
|
+
end
|
1580
|
+
|
1581
|
+
# Specifies the sorting parameters for listing Engagements.
|
1582
|
+
#
|
1583
|
+
# @!attribute [rw] sort_by
|
1584
|
+
# The field by which to sort the results.
|
1585
|
+
# @return [String]
|
1586
|
+
#
|
1587
|
+
# @!attribute [rw] sort_order
|
1588
|
+
# The order in which to sort the results.
|
1589
|
+
# @return [String]
|
1590
|
+
#
|
1591
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementSort AWS API Documentation
|
1592
|
+
#
|
1593
|
+
class EngagementSort < Struct.new(
|
1594
|
+
:sort_by,
|
1595
|
+
:sort_order)
|
1596
|
+
SENSITIVE = []
|
1597
|
+
include Aws::Structure
|
1598
|
+
end
|
1599
|
+
|
1600
|
+
# An object that contains an `Engagement`'s subset of fields.
|
1601
|
+
#
|
1602
|
+
# @!attribute [rw] arn
|
1603
|
+
# The Amazon Resource Name (ARN) of the created Engagement.
|
1604
|
+
# @return [String]
|
1605
|
+
#
|
1606
|
+
# @!attribute [rw] created_at
|
1607
|
+
# The date and time when the Engagement was created.
|
1608
|
+
# @return [Time]
|
1609
|
+
#
|
1610
|
+
# @!attribute [rw] created_by
|
1611
|
+
# The AWS Account ID of the Engagement creator.
|
1612
|
+
# @return [String]
|
1613
|
+
#
|
1614
|
+
# @!attribute [rw] id
|
1615
|
+
# The unique identifier for the Engagement.
|
1616
|
+
# @return [String]
|
1617
|
+
#
|
1618
|
+
# @!attribute [rw] member_count
|
1619
|
+
# The number of members in the Engagement.
|
1620
|
+
# @return [Integer]
|
1621
|
+
#
|
1622
|
+
# @!attribute [rw] title
|
1623
|
+
# The title of the Engagement.
|
1624
|
+
# @return [String]
|
1625
|
+
#
|
1626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementSummary AWS API Documentation
|
1627
|
+
#
|
1628
|
+
class EngagementSummary < Struct.new(
|
1629
|
+
:arn,
|
1630
|
+
:created_at,
|
1631
|
+
:created_by,
|
1632
|
+
:id,
|
1633
|
+
:member_count,
|
1634
|
+
:title)
|
1635
|
+
SENSITIVE = [:created_by]
|
1636
|
+
include Aws::Structure
|
1637
|
+
end
|
1638
|
+
|
1639
|
+
# Provides an estimate of the revenue that the partner is expected to
|
1640
|
+
# generate from the opportunity. This information helps partners assess
|
1641
|
+
# the financial value of the project.
|
1642
|
+
#
|
1643
|
+
# @!attribute [rw] amount
|
1644
|
+
# Represents the estimated monthly revenue that the partner expects to
|
1645
|
+
# earn from the opportunity. This helps in forecasting financial
|
1646
|
+
# returns.
|
1647
|
+
# @return [String]
|
1648
|
+
#
|
1649
|
+
# @!attribute [rw] currency_code
|
1650
|
+
# Indicates the currency in which the revenue estimate is provided.
|
1651
|
+
# This helps in understanding the financial impact across different
|
1652
|
+
# markets.
|
1653
|
+
# @return [String]
|
1654
|
+
#
|
1655
|
+
# @!attribute [rw] estimation_url
|
1656
|
+
# A URL providing additional information or context about the spend
|
1657
|
+
# estimation.
|
1658
|
+
# @return [String]
|
1659
|
+
#
|
1660
|
+
# @!attribute [rw] frequency
|
1661
|
+
# Indicates how frequently the customer is expected to spend the
|
1662
|
+
# projected amount. This can include values such as `Monthly`,
|
1663
|
+
# `Quarterly`, or `Annually`. The default value is `Monthly`,
|
1664
|
+
# representing recurring monthly spend.
|
1665
|
+
# @return [String]
|
1666
|
+
#
|
1667
|
+
# @!attribute [rw] target_company
|
1668
|
+
# Specifies the name of the partner company that is expected to
|
1669
|
+
# generate revenue from the opportunity. This field helps track the
|
1670
|
+
# partner’s involvement in the opportunity.
|
1671
|
+
# @return [String]
|
1672
|
+
#
|
1673
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ExpectedCustomerSpend AWS API Documentation
|
1674
|
+
#
|
1675
|
+
class ExpectedCustomerSpend < Struct.new(
|
1676
|
+
:amount,
|
1677
|
+
:currency_code,
|
1678
|
+
:estimation_url,
|
1679
|
+
:frequency,
|
1680
|
+
:target_company)
|
1681
|
+
SENSITIVE = [:currency_code, :estimation_url]
|
1082
1682
|
include Aws::Structure
|
1083
1683
|
end
|
1084
1684
|
|
@@ -1229,11 +1829,31 @@ module Aws::PartnerCentralSelling
|
|
1229
1829
|
# catalog (e.g., `AWS` or `Sandbox`) used in the request.
|
1230
1830
|
# @return [String]
|
1231
1831
|
#
|
1832
|
+
# @!attribute [rw] engagement_description
|
1833
|
+
# The description of the engagement associated with this invitation.
|
1834
|
+
# @return [String]
|
1835
|
+
#
|
1836
|
+
# @!attribute [rw] engagement_id
|
1837
|
+
# The identifier of the engagement associated with this
|
1838
|
+
# invitation.This ID links the invitation to its corresponding
|
1839
|
+
# engagement.
|
1840
|
+
# @return [String]
|
1841
|
+
#
|
1232
1842
|
# @!attribute [rw] engagement_title
|
1233
1843
|
# The title of the engagement invitation, summarizing the purpose or
|
1234
1844
|
# objectives of the opportunity shared by AWS.
|
1235
1845
|
# @return [String]
|
1236
1846
|
#
|
1847
|
+
# @!attribute [rw] existing_members
|
1848
|
+
# A list of active members currently part of the Engagement. This
|
1849
|
+
# array contains a maximum of 10 members, each represented by an
|
1850
|
+
# object with the following properties.
|
1851
|
+
#
|
1852
|
+
# * CompanyName: The name of the member's company.
|
1853
|
+
#
|
1854
|
+
# * WebsiteUrl: The website URL of the member's company.
|
1855
|
+
# @return [Array<Types::EngagementMemberSummary>]
|
1856
|
+
#
|
1237
1857
|
# @!attribute [rw] expiration_date
|
1238
1858
|
# Indicates the date on which the engagement invitation will expire if
|
1239
1859
|
# not accepted by the partner.
|
@@ -1248,6 +1868,11 @@ module Aws::PartnerCentralSelling
|
|
1248
1868
|
# The date when the engagement invitation was sent to the partner.
|
1249
1869
|
# @return [Time]
|
1250
1870
|
#
|
1871
|
+
# @!attribute [rw] invitation_message
|
1872
|
+
# The message sent to the invited partner when the invitation was
|
1873
|
+
# created.
|
1874
|
+
# @return [String]
|
1875
|
+
#
|
1251
1876
|
# @!attribute [rw] payload
|
1252
1877
|
# Details of the engagement invitation payload, including specific
|
1253
1878
|
# data relevant to the invitation's contents, such as customer
|
@@ -1288,10 +1913,14 @@ module Aws::PartnerCentralSelling
|
|
1288
1913
|
class GetEngagementInvitationResponse < Struct.new(
|
1289
1914
|
:arn,
|
1290
1915
|
:catalog,
|
1916
|
+
:engagement_description,
|
1917
|
+
:engagement_id,
|
1291
1918
|
:engagement_title,
|
1919
|
+
:existing_members,
|
1292
1920
|
:expiration_date,
|
1293
1921
|
:id,
|
1294
1922
|
:invitation_date,
|
1923
|
+
:invitation_message,
|
1295
1924
|
:payload,
|
1296
1925
|
:payload_type,
|
1297
1926
|
:receiver,
|
@@ -1303,6 +1932,82 @@ module Aws::PartnerCentralSelling
|
|
1303
1932
|
include Aws::Structure
|
1304
1933
|
end
|
1305
1934
|
|
1935
|
+
# @!attribute [rw] catalog
|
1936
|
+
# Specifies the catalog related to the engagement request. Valid
|
1937
|
+
# values are `AWS` and `Sandbox`.
|
1938
|
+
# @return [String]
|
1939
|
+
#
|
1940
|
+
# @!attribute [rw] identifier
|
1941
|
+
# Specifies the identifier of the Engagement record to retrieve.
|
1942
|
+
# @return [String]
|
1943
|
+
#
|
1944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetEngagementRequest AWS API Documentation
|
1945
|
+
#
|
1946
|
+
class GetEngagementRequest < Struct.new(
|
1947
|
+
:catalog,
|
1948
|
+
:identifier)
|
1949
|
+
SENSITIVE = []
|
1950
|
+
include Aws::Structure
|
1951
|
+
end
|
1952
|
+
|
1953
|
+
# @!attribute [rw] arn
|
1954
|
+
# The Amazon Resource Name (ARN) of the engagement retrieved.
|
1955
|
+
# @return [String]
|
1956
|
+
#
|
1957
|
+
# @!attribute [rw] contexts
|
1958
|
+
# A list of context objects associated with the engagement. Each
|
1959
|
+
# context provides additional information related to the Engagement,
|
1960
|
+
# such as customer projects or documents.
|
1961
|
+
# @return [Array<Types::EngagementContextDetails>]
|
1962
|
+
#
|
1963
|
+
# @!attribute [rw] created_at
|
1964
|
+
# The date and time when the Engagement was created, presented in ISO
|
1965
|
+
# 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This
|
1966
|
+
# timestamp helps track the lifecycle of the Engagement.
|
1967
|
+
# @return [Time]
|
1968
|
+
#
|
1969
|
+
# @!attribute [rw] created_by
|
1970
|
+
# The AWS account ID of the user who originally created the
|
1971
|
+
# engagement. This field helps in tracking the origin of the
|
1972
|
+
# engagement.
|
1973
|
+
# @return [String]
|
1974
|
+
#
|
1975
|
+
# @!attribute [rw] description
|
1976
|
+
# A more detailed description of the engagement. This provides
|
1977
|
+
# additional context or information about the engagement's purpose or
|
1978
|
+
# scope.
|
1979
|
+
# @return [String]
|
1980
|
+
#
|
1981
|
+
# @!attribute [rw] id
|
1982
|
+
# The unique resource identifier of the engagement retrieved.
|
1983
|
+
# @return [String]
|
1984
|
+
#
|
1985
|
+
# @!attribute [rw] member_count
|
1986
|
+
# Specifies the current count of members participating in the
|
1987
|
+
# Engagement. This count includes all active members regardless of
|
1988
|
+
# their roles or permissions within the Engagement.
|
1989
|
+
# @return [Integer]
|
1990
|
+
#
|
1991
|
+
# @!attribute [rw] title
|
1992
|
+
# The title of the engagement. It provides a brief, descriptive name
|
1993
|
+
# for the engagement that is meaningful and easily recognizable.
|
1994
|
+
# @return [String]
|
1995
|
+
#
|
1996
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetEngagementResponse AWS API Documentation
|
1997
|
+
#
|
1998
|
+
class GetEngagementResponse < Struct.new(
|
1999
|
+
:arn,
|
2000
|
+
:contexts,
|
2001
|
+
:created_at,
|
2002
|
+
:created_by,
|
2003
|
+
:description,
|
2004
|
+
:id,
|
2005
|
+
:member_count,
|
2006
|
+
:title)
|
2007
|
+
SENSITIVE = [:created_by]
|
2008
|
+
include Aws::Structure
|
2009
|
+
end
|
2010
|
+
|
1306
2011
|
# @!attribute [rw] catalog
|
1307
2012
|
# Specifies the catalog associated with the request. This field takes
|
1308
2013
|
# a string value from a predefined list: `AWS` or `Sandbox`. The
|
@@ -1325,6 +2030,11 @@ module Aws::PartnerCentralSelling
|
|
1325
2030
|
include Aws::Structure
|
1326
2031
|
end
|
1327
2032
|
|
2033
|
+
# @!attribute [rw] arn
|
2034
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the
|
2035
|
+
# opportunity.
|
2036
|
+
# @return [String]
|
2037
|
+
#
|
1328
2038
|
# @!attribute [rw] catalog
|
1329
2039
|
# Specifies the catalog associated with the request. This field takes
|
1330
2040
|
# a string value from a predefined list: `AWS` or `Sandbox`. The
|
@@ -1433,13 +2143,6 @@ module Aws::PartnerCentralSelling
|
|
1433
2143
|
# * Cosell—Support for Public Tender/RFx: Opportunity related to the
|
1434
2144
|
# public sector where the partner needs Amazon Web Services RFx
|
1435
2145
|
# support.
|
1436
|
-
#
|
1437
|
-
# * Do Not Need Support from Amazon Web Services Sales Rep: Indicates
|
1438
|
-
# that a partner doesn't need support from an Amazon Web Services
|
1439
|
-
# sales representative, and the partner solely manages the
|
1440
|
-
# opportunity. It's possible to request coselling support on these
|
1441
|
-
# opportunities at any stage during their lifecycle. Also known as,
|
1442
|
-
# for-visibility-only (FVO) opportunity.
|
1443
2146
|
# @return [Array<String>]
|
1444
2147
|
#
|
1445
2148
|
# @!attribute [rw] project
|
@@ -1461,6 +2164,7 @@ module Aws::PartnerCentralSelling
|
|
1461
2164
|
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetOpportunityResponse AWS API Documentation
|
1462
2165
|
#
|
1463
2166
|
class GetOpportunityResponse < Struct.new(
|
2167
|
+
:arn,
|
1464
2168
|
:catalog,
|
1465
2169
|
:created_date,
|
1466
2170
|
:customer,
|
@@ -1480,6 +2184,274 @@ module Aws::PartnerCentralSelling
|
|
1480
2184
|
include Aws::Structure
|
1481
2185
|
end
|
1482
2186
|
|
2187
|
+
# @!attribute [rw] catalog
|
2188
|
+
# Specifies the catalog related to the request. Valid values are:
|
2189
|
+
#
|
2190
|
+
# * AWS: Retrieves the snapshot job from the production AWS
|
2191
|
+
# environment.
|
2192
|
+
#
|
2193
|
+
# * Sandbox: Retrieves the snapshot job from a sandbox environment
|
2194
|
+
# used for testing or development purposes.
|
2195
|
+
# @return [String]
|
2196
|
+
#
|
2197
|
+
# @!attribute [rw] resource_snapshot_job_identifier
|
2198
|
+
# The unique identifier of the resource snapshot job to be retrieved.
|
2199
|
+
# This identifier is crucial for pinpointing the specific job you want
|
2200
|
+
# to query.
|
2201
|
+
# @return [String]
|
2202
|
+
#
|
2203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetResourceSnapshotJobRequest AWS API Documentation
|
2204
|
+
#
|
2205
|
+
class GetResourceSnapshotJobRequest < Struct.new(
|
2206
|
+
:catalog,
|
2207
|
+
:resource_snapshot_job_identifier)
|
2208
|
+
SENSITIVE = []
|
2209
|
+
include Aws::Structure
|
2210
|
+
end
|
2211
|
+
|
2212
|
+
# @!attribute [rw] arn
|
2213
|
+
# The Amazon Resource Name (ARN) of the snapshot job. This globally
|
2214
|
+
# unique identifier can be used for resource-specific operations
|
2215
|
+
# across AWS services.
|
2216
|
+
# @return [String]
|
2217
|
+
#
|
2218
|
+
# @!attribute [rw] catalog
|
2219
|
+
# The catalog in which the snapshot job was created. This will match
|
2220
|
+
# the Catalog specified in the request.
|
2221
|
+
# @return [String]
|
2222
|
+
#
|
2223
|
+
# @!attribute [rw] created_at
|
2224
|
+
# The date and time when the snapshot job was created in ISO 8601
|
2225
|
+
# format (UTC). Example: "2023-05-01T20:37:46Z"
|
2226
|
+
# @return [Time]
|
2227
|
+
#
|
2228
|
+
# @!attribute [rw] engagement_id
|
2229
|
+
# The identifier of the engagement associated with this snapshot job.
|
2230
|
+
# This links the job to a specific engagement context.
|
2231
|
+
# @return [String]
|
2232
|
+
#
|
2233
|
+
# @!attribute [rw] id
|
2234
|
+
# The unique identifier of the snapshot job. This matches the
|
2235
|
+
# ResourceSnapshotJobIdentifier provided in the request.
|
2236
|
+
# @return [String]
|
2237
|
+
#
|
2238
|
+
# @!attribute [rw] last_failure
|
2239
|
+
# If the job has encountered any failures, this field contains the
|
2240
|
+
# error message from the most recent failure. This can be useful for
|
2241
|
+
# troubleshooting issues with the job.
|
2242
|
+
# @return [String]
|
2243
|
+
#
|
2244
|
+
# @!attribute [rw] last_successful_execution_date
|
2245
|
+
# The date and time of the last successful execution of the job, in
|
2246
|
+
# ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"
|
2247
|
+
# @return [Time]
|
2248
|
+
#
|
2249
|
+
# @!attribute [rw] resource_arn
|
2250
|
+
# The Amazon Resource Name (ARN) of the resource being snapshotted.
|
2251
|
+
# This provides a globally unique identifier for the resource across
|
2252
|
+
# AWS.
|
2253
|
+
# @return [String]
|
2254
|
+
#
|
2255
|
+
# @!attribute [rw] resource_id
|
2256
|
+
# The identifier of the specific resource being snapshotted. The
|
2257
|
+
# format might vary depending on the ResourceType.
|
2258
|
+
# @return [String]
|
2259
|
+
#
|
2260
|
+
# @!attribute [rw] resource_snapshot_template_name
|
2261
|
+
# The name of the template used for creating the snapshot. This is the
|
2262
|
+
# same as the template name. It defines the structure and content of
|
2263
|
+
# the snapshot.
|
2264
|
+
# @return [String]
|
2265
|
+
#
|
2266
|
+
# @!attribute [rw] resource_type
|
2267
|
+
# The type of resource being snapshotted. This would have
|
2268
|
+
# "Opportunity" as a value as it is dependent on the supported
|
2269
|
+
# resource type.
|
2270
|
+
# @return [String]
|
2271
|
+
#
|
2272
|
+
# @!attribute [rw] status
|
2273
|
+
# The current status of the snapshot job. Valid values:
|
2274
|
+
#
|
2275
|
+
# * STOPPED: The job is not currently running.
|
2276
|
+
#
|
2277
|
+
# * RUNNING: The job is actively executing.
|
2278
|
+
# @return [String]
|
2279
|
+
#
|
2280
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetResourceSnapshotJobResponse AWS API Documentation
|
2281
|
+
#
|
2282
|
+
class GetResourceSnapshotJobResponse < Struct.new(
|
2283
|
+
:arn,
|
2284
|
+
:catalog,
|
2285
|
+
:created_at,
|
2286
|
+
:engagement_id,
|
2287
|
+
:id,
|
2288
|
+
:last_failure,
|
2289
|
+
:last_successful_execution_date,
|
2290
|
+
:resource_arn,
|
2291
|
+
:resource_id,
|
2292
|
+
:resource_snapshot_template_name,
|
2293
|
+
:resource_type,
|
2294
|
+
:status)
|
2295
|
+
SENSITIVE = []
|
2296
|
+
include Aws::Structure
|
2297
|
+
end
|
2298
|
+
|
2299
|
+
# @!attribute [rw] catalog
|
2300
|
+
# Specifies the catalog related to the request. Valid values are:
|
2301
|
+
#
|
2302
|
+
# * AWS: Retrieves the snapshot from the production AWS environment.
|
2303
|
+
#
|
2304
|
+
# * Sandbox: Retrieves the snapshot from a sandbox environment used
|
2305
|
+
# for testing or development purposes.
|
2306
|
+
# @return [String]
|
2307
|
+
#
|
2308
|
+
# @!attribute [rw] engagement_identifier
|
2309
|
+
# The unique identifier of the engagement associated with the
|
2310
|
+
# snapshot. This field links the snapshot to a specific engagement
|
2311
|
+
# context.
|
2312
|
+
# @return [String]
|
2313
|
+
#
|
2314
|
+
# @!attribute [rw] resource_identifier
|
2315
|
+
# The unique identifier of the specific resource that was snapshotted.
|
2316
|
+
# The format and constraints of this identifier depend on the
|
2317
|
+
# ResourceType specified. For `Opportunity` type, it will be an
|
2318
|
+
# `opportunity ID`
|
2319
|
+
# @return [String]
|
2320
|
+
#
|
2321
|
+
# @!attribute [rw] resource_snapshot_template_identifier
|
2322
|
+
# he name of the template that defines the schema for the snapshot.
|
2323
|
+
# This template determines which subset of the resource data is
|
2324
|
+
# included in the snapshot and must correspond to an existing and
|
2325
|
+
# valid template for the specified `ResourceType`.
|
2326
|
+
# @return [String]
|
2327
|
+
#
|
2328
|
+
# @!attribute [rw] resource_type
|
2329
|
+
# Specifies the type of resource that was snapshotted. This field
|
2330
|
+
# determines the structure and content of the snapshot payload. Valid
|
2331
|
+
# value includes:`Opportunity`: For opportunity-related data.
|
2332
|
+
# @return [String]
|
2333
|
+
#
|
2334
|
+
# @!attribute [rw] revision
|
2335
|
+
# Specifies which revision of the snapshot to retrieve. If omitted
|
2336
|
+
# returns the latest revision.
|
2337
|
+
# @return [Integer]
|
2338
|
+
#
|
2339
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetResourceSnapshotRequest AWS API Documentation
|
2340
|
+
#
|
2341
|
+
class GetResourceSnapshotRequest < Struct.new(
|
2342
|
+
:catalog,
|
2343
|
+
:engagement_identifier,
|
2344
|
+
:resource_identifier,
|
2345
|
+
:resource_snapshot_template_identifier,
|
2346
|
+
:resource_type,
|
2347
|
+
:revision)
|
2348
|
+
SENSITIVE = []
|
2349
|
+
include Aws::Structure
|
2350
|
+
end
|
2351
|
+
|
2352
|
+
# @!attribute [rw] arn
|
2353
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the resource
|
2354
|
+
# snapshot.
|
2355
|
+
# @return [String]
|
2356
|
+
#
|
2357
|
+
# @!attribute [rw] catalog
|
2358
|
+
# The catalog in which the snapshot was created. Matches the Catalog
|
2359
|
+
# specified in the request.
|
2360
|
+
# @return [String]
|
2361
|
+
#
|
2362
|
+
# @!attribute [rw] created_at
|
2363
|
+
# The timestamp when the snapshot was created, in ISO 8601 format
|
2364
|
+
# (e.g., "2023-06-01T14:30:00Z"). This allows for precise tracking
|
2365
|
+
# of when the snapshot was taken.
|
2366
|
+
# @return [Time]
|
2367
|
+
#
|
2368
|
+
# @!attribute [rw] created_by
|
2369
|
+
# The AWS account ID of the principal (user or role) who created the
|
2370
|
+
# snapshot. This helps in tracking the origin of the snapshot.
|
2371
|
+
# @return [String]
|
2372
|
+
#
|
2373
|
+
# @!attribute [rw] engagement_id
|
2374
|
+
# The identifier of the engagement associated with this snapshot.
|
2375
|
+
# Matches the EngagementIdentifier specified in the request.
|
2376
|
+
# @return [String]
|
2377
|
+
#
|
2378
|
+
# @!attribute [rw] payload
|
2379
|
+
# Represents the payload of a resource snapshot. This structure is
|
2380
|
+
# designed to accommodate different types of resource snapshots,
|
2381
|
+
# currently supporting opportunity summaries.
|
2382
|
+
# @return [Types::ResourceSnapshotPayload]
|
2383
|
+
#
|
2384
|
+
# @!attribute [rw] resource_id
|
2385
|
+
# The identifier of the specific resource that was snapshotted.
|
2386
|
+
# Matches the ResourceIdentifier specified in the request.
|
2387
|
+
# @return [String]
|
2388
|
+
#
|
2389
|
+
# @!attribute [rw] resource_snapshot_template_name
|
2390
|
+
# The name of the view used for this snapshot. This is the same as the
|
2391
|
+
# template name.
|
2392
|
+
# @return [String]
|
2393
|
+
#
|
2394
|
+
# @!attribute [rw] resource_type
|
2395
|
+
# The type of the resource that was snapshotted. Matches the
|
2396
|
+
# ResourceType specified in the request.
|
2397
|
+
# @return [String]
|
2398
|
+
#
|
2399
|
+
# @!attribute [rw] revision
|
2400
|
+
# The revision number of this snapshot. This is a positive integer
|
2401
|
+
# that is sequential and unique within the context of a resource view.
|
2402
|
+
# @return [Integer]
|
2403
|
+
#
|
2404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetResourceSnapshotResponse AWS API Documentation
|
2405
|
+
#
|
2406
|
+
class GetResourceSnapshotResponse < Struct.new(
|
2407
|
+
:arn,
|
2408
|
+
:catalog,
|
2409
|
+
:created_at,
|
2410
|
+
:created_by,
|
2411
|
+
:engagement_id,
|
2412
|
+
:payload,
|
2413
|
+
:resource_id,
|
2414
|
+
:resource_snapshot_template_name,
|
2415
|
+
:resource_type,
|
2416
|
+
:revision)
|
2417
|
+
SENSITIVE = [:created_by]
|
2418
|
+
include Aws::Structure
|
2419
|
+
end
|
2420
|
+
|
2421
|
+
# @!attribute [rw] catalog
|
2422
|
+
# Specifies the catalog in which the settings are defined. Acceptable
|
2423
|
+
# values include `AWS` for production and `Sandbox` for testing
|
2424
|
+
# environments.
|
2425
|
+
# @return [String]
|
2426
|
+
#
|
2427
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetSellingSystemSettingsRequest AWS API Documentation
|
2428
|
+
#
|
2429
|
+
class GetSellingSystemSettingsRequest < Struct.new(
|
2430
|
+
:catalog)
|
2431
|
+
SENSITIVE = []
|
2432
|
+
include Aws::Structure
|
2433
|
+
end
|
2434
|
+
|
2435
|
+
# @!attribute [rw] catalog
|
2436
|
+
# Specifies the catalog in which the settings are defined. Acceptable
|
2437
|
+
# values include `AWS` for production and `Sandbox` for testing
|
2438
|
+
# environments.
|
2439
|
+
# @return [String]
|
2440
|
+
#
|
2441
|
+
# @!attribute [rw] resource_snapshot_job_role_arn
|
2442
|
+
# Specifies the ARN of the IAM Role used for resource snapshot job
|
2443
|
+
# executions.
|
2444
|
+
# @return [String]
|
2445
|
+
#
|
2446
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetSellingSystemSettingsResponse AWS API Documentation
|
2447
|
+
#
|
2448
|
+
class GetSellingSystemSettingsResponse < Struct.new(
|
2449
|
+
:catalog,
|
2450
|
+
:resource_snapshot_job_role_arn)
|
2451
|
+
SENSITIVE = []
|
2452
|
+
include Aws::Structure
|
2453
|
+
end
|
2454
|
+
|
1483
2455
|
# This error occurs when the specified resource can’t be found or
|
1484
2456
|
# doesn't exist. Resource ID and type might be incorrect.
|
1485
2457
|
#
|
@@ -1498,6 +2470,37 @@ module Aws::PartnerCentralSelling
|
|
1498
2470
|
include Aws::Structure
|
1499
2471
|
end
|
1500
2472
|
|
2473
|
+
# The Invitation structure represents an invitation exchanged between
|
2474
|
+
# partners and AWS. It includes a message, receiver information, and a
|
2475
|
+
# payload providing context for the invitation.
|
2476
|
+
#
|
2477
|
+
# @!attribute [rw] message
|
2478
|
+
# A message accompanying the invitation.
|
2479
|
+
# @return [String]
|
2480
|
+
#
|
2481
|
+
# @!attribute [rw] payload
|
2482
|
+
# Contains the data payload associated with the Engagement Invitation.
|
2483
|
+
# This payload includes essential details related to the AWS
|
2484
|
+
# opportunity and is used by partners to evaluate whether to accept or
|
2485
|
+
# reject the engagement.
|
2486
|
+
# @return [Types::Payload]
|
2487
|
+
#
|
2488
|
+
# @!attribute [rw] receiver
|
2489
|
+
# Represents the entity that received the Engagement Invitation,
|
2490
|
+
# including account and company details. This field is essential for
|
2491
|
+
# tracking the partner who is being invited to collaborate.
|
2492
|
+
# @return [Types::Receiver]
|
2493
|
+
#
|
2494
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/Invitation AWS API Documentation
|
2495
|
+
#
|
2496
|
+
class Invitation < Struct.new(
|
2497
|
+
:message,
|
2498
|
+
:payload,
|
2499
|
+
:receiver)
|
2500
|
+
SENSITIVE = []
|
2501
|
+
include Aws::Structure
|
2502
|
+
end
|
2503
|
+
|
1501
2504
|
# Defines a filter to retrieve opportunities based on the last modified
|
1502
2505
|
# date. This filter is useful for tracking changes or updates to
|
1503
2506
|
# opportunities over time.
|
@@ -1723,6 +2726,40 @@ module Aws::PartnerCentralSelling
|
|
1723
2726
|
include Aws::Structure
|
1724
2727
|
end
|
1725
2728
|
|
2729
|
+
# Provides the lifecycle view of an opportunity resource shared through
|
2730
|
+
# a snapshot.
|
2731
|
+
#
|
2732
|
+
# @!attribute [rw] next_steps
|
2733
|
+
# Describes the next steps for the opportunity shared through a
|
2734
|
+
# snapshot.
|
2735
|
+
# @return [String]
|
2736
|
+
#
|
2737
|
+
# @!attribute [rw] review_status
|
2738
|
+
# Defines the approval status of the opportunity shared through a
|
2739
|
+
# snapshot.
|
2740
|
+
# @return [String]
|
2741
|
+
#
|
2742
|
+
# @!attribute [rw] stage
|
2743
|
+
# Defines the current stage of the opportunity shared through a
|
2744
|
+
# snapshot.
|
2745
|
+
# @return [String]
|
2746
|
+
#
|
2747
|
+
# @!attribute [rw] target_close_date
|
2748
|
+
# The projected launch date of the opportunity shared through a
|
2749
|
+
# snapshot.
|
2750
|
+
# @return [String]
|
2751
|
+
#
|
2752
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/LifeCycleForView AWS API Documentation
|
2753
|
+
#
|
2754
|
+
class LifeCycleForView < Struct.new(
|
2755
|
+
:next_steps,
|
2756
|
+
:review_status,
|
2757
|
+
:stage,
|
2758
|
+
:target_close_date)
|
2759
|
+
SENSITIVE = [:next_steps]
|
2760
|
+
include Aws::Structure
|
2761
|
+
end
|
2762
|
+
|
1726
2763
|
# An object that contains a `LifeCycle` object's subset of fields.
|
1727
2764
|
#
|
1728
2765
|
# @!attribute [rw] closed_lost_reason
|
@@ -1865,12 +2902,320 @@ module Aws::PartnerCentralSelling
|
|
1865
2902
|
include Aws::Structure
|
1866
2903
|
end
|
1867
2904
|
|
2905
|
+
# Specifies a subset of fields associated with tasks related to
|
2906
|
+
# accepting an engagement invitation.
|
2907
|
+
#
|
2908
|
+
# @!attribute [rw] engagement_invitation_id
|
2909
|
+
# The unique identifier of the engagement invitation that was
|
2910
|
+
# accepted.
|
2911
|
+
# @return [String]
|
2912
|
+
#
|
2913
|
+
# @!attribute [rw] message
|
2914
|
+
# Detailed message describing the failure and possible recovery steps.
|
2915
|
+
# @return [String]
|
2916
|
+
#
|
2917
|
+
# @!attribute [rw] opportunity_id
|
2918
|
+
# Unique identifier of opportunity that was created.
|
2919
|
+
# @return [String]
|
2920
|
+
#
|
2921
|
+
# @!attribute [rw] reason_code
|
2922
|
+
# A code pointing to the specific reason for the failure.
|
2923
|
+
# @return [String]
|
2924
|
+
#
|
2925
|
+
# @!attribute [rw] resource_snapshot_job_id
|
2926
|
+
# Unique identifier of the resource snapshot job that was created.
|
2927
|
+
# @return [String]
|
2928
|
+
#
|
2929
|
+
# @!attribute [rw] start_time
|
2930
|
+
# Task start timestamp.
|
2931
|
+
# @return [Time]
|
2932
|
+
#
|
2933
|
+
# @!attribute [rw] task_arn
|
2934
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the task.
|
2935
|
+
# @return [String]
|
2936
|
+
#
|
2937
|
+
# @!attribute [rw] task_id
|
2938
|
+
# Unique identifier of the task.
|
2939
|
+
# @return [String]
|
2940
|
+
#
|
2941
|
+
# @!attribute [rw] task_status
|
2942
|
+
# Status of the task.
|
2943
|
+
# @return [String]
|
2944
|
+
#
|
2945
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTaskSummary AWS API Documentation
|
2946
|
+
#
|
2947
|
+
class ListEngagementByAcceptingInvitationTaskSummary < Struct.new(
|
2948
|
+
:engagement_invitation_id,
|
2949
|
+
:message,
|
2950
|
+
:opportunity_id,
|
2951
|
+
:reason_code,
|
2952
|
+
:resource_snapshot_job_id,
|
2953
|
+
:start_time,
|
2954
|
+
:task_arn,
|
2955
|
+
:task_id,
|
2956
|
+
:task_status)
|
2957
|
+
SENSITIVE = []
|
2958
|
+
include Aws::Structure
|
2959
|
+
end
|
2960
|
+
|
2961
|
+
# @!attribute [rw] catalog
|
2962
|
+
# Specifies the catalog related to the request. Valid values are:
|
2963
|
+
#
|
2964
|
+
# * AWS: Retrieves the request from the production AWS environment.
|
2965
|
+
#
|
2966
|
+
# * Sandbox: Retrieves the request from a sandbox environment used for
|
2967
|
+
# testing or development purposes.
|
2968
|
+
# @return [String]
|
2969
|
+
#
|
2970
|
+
# @!attribute [rw] engagement_invitation_identifier
|
2971
|
+
# Filters tasks by the identifiers of the engagement invitations they
|
2972
|
+
# are processing.
|
2973
|
+
# @return [Array<String>]
|
2974
|
+
#
|
2975
|
+
# @!attribute [rw] max_results
|
2976
|
+
# Use this parameter to control the number of items returned in each
|
2977
|
+
# request, which can be useful for performance tuning and managing
|
2978
|
+
# large result sets.
|
2979
|
+
# @return [Integer]
|
2980
|
+
#
|
2981
|
+
# @!attribute [rw] next_token
|
2982
|
+
# Use this parameter for pagination when the result set spans multiple
|
2983
|
+
# pages. This value is obtained from the NextToken field in the
|
2984
|
+
# response of a previous call to this API.
|
2985
|
+
# @return [String]
|
2986
|
+
#
|
2987
|
+
# @!attribute [rw] opportunity_identifier
|
2988
|
+
# Filters tasks by the identifiers of the opportunities they created
|
2989
|
+
# or are associated with.
|
2990
|
+
# @return [Array<String>]
|
2991
|
+
#
|
2992
|
+
# @!attribute [rw] sort
|
2993
|
+
# Specifies the sorting criteria for the returned results. This allows
|
2994
|
+
# you to order the tasks based on specific attributes.
|
2995
|
+
# @return [Types::ListTasksSortBase]
|
2996
|
+
#
|
2997
|
+
# @!attribute [rw] task_identifier
|
2998
|
+
# Filters tasks by their unique identifiers. Use this when you want to
|
2999
|
+
# retrieve information about specific tasks.
|
3000
|
+
# @return [Array<String>]
|
3001
|
+
#
|
3002
|
+
# @!attribute [rw] task_status
|
3003
|
+
# Filters the tasks based on their current status. This allows you to
|
3004
|
+
# focus on tasks in specific states.
|
3005
|
+
# @return [Array<String>]
|
3006
|
+
#
|
3007
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTasksRequest AWS API Documentation
|
3008
|
+
#
|
3009
|
+
class ListEngagementByAcceptingInvitationTasksRequest < Struct.new(
|
3010
|
+
:catalog,
|
3011
|
+
:engagement_invitation_identifier,
|
3012
|
+
:max_results,
|
3013
|
+
:next_token,
|
3014
|
+
:opportunity_identifier,
|
3015
|
+
:sort,
|
3016
|
+
:task_identifier,
|
3017
|
+
:task_status)
|
3018
|
+
SENSITIVE = []
|
3019
|
+
include Aws::Structure
|
3020
|
+
end
|
3021
|
+
|
3022
|
+
# @!attribute [rw] next_token
|
3023
|
+
# A token used for pagination to retrieve the next page of results.If
|
3024
|
+
# there are more results available, this field will contain a token
|
3025
|
+
# that can be used in a subsequent API call to retrieve the next page.
|
3026
|
+
# If there are no more results, this field will be null or an empty
|
3027
|
+
# string.
|
3028
|
+
# @return [String]
|
3029
|
+
#
|
3030
|
+
# @!attribute [rw] task_summaries
|
3031
|
+
# An array of `EngagementByAcceptingInvitationTaskSummary` objects,
|
3032
|
+
# each representing a task that matches the specified filters. The
|
3033
|
+
# array may be empty if no tasks match the criteria.
|
3034
|
+
# @return [Array<Types::ListEngagementByAcceptingInvitationTaskSummary>]
|
3035
|
+
#
|
3036
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTasksResponse AWS API Documentation
|
3037
|
+
#
|
3038
|
+
class ListEngagementByAcceptingInvitationTasksResponse < Struct.new(
|
3039
|
+
:next_token,
|
3040
|
+
:task_summaries)
|
3041
|
+
SENSITIVE = []
|
3042
|
+
include Aws::Structure
|
3043
|
+
end
|
3044
|
+
|
3045
|
+
# Provides a summary of a task related to creating an engagement from an
|
3046
|
+
# opportunity. This structure contains key information about the task's
|
3047
|
+
# status, associated identifiers, and any failure details.
|
3048
|
+
#
|
3049
|
+
# @!attribute [rw] engagement_id
|
3050
|
+
# The unique identifier of the engagement created as a result of the
|
3051
|
+
# task. This field is populated when the task is completed
|
3052
|
+
# successfully.
|
3053
|
+
# @return [String]
|
3054
|
+
#
|
3055
|
+
# @!attribute [rw] engagement_invitation_id
|
3056
|
+
# The unique identifier of the Engagement Invitation.
|
3057
|
+
# @return [String]
|
3058
|
+
#
|
3059
|
+
# @!attribute [rw] message
|
3060
|
+
# A detailed message providing additional information about the task,
|
3061
|
+
# especially useful in case of failures. This field may contain error
|
3062
|
+
# details or other relevant information about the task's execution
|
3063
|
+
# @return [String]
|
3064
|
+
#
|
3065
|
+
# @!attribute [rw] opportunity_id
|
3066
|
+
# The unique identifier of the original Opportunity from which the
|
3067
|
+
# Engagement is being created. This field helps track the source of
|
3068
|
+
# the Engagement creation task.
|
3069
|
+
# @return [String]
|
3070
|
+
#
|
3071
|
+
# @!attribute [rw] reason_code
|
3072
|
+
# A code indicating the specific reason for a task failure. This field
|
3073
|
+
# is populated when the task status is FAILED and provides a
|
3074
|
+
# categorized reason for the failure.
|
3075
|
+
# @return [String]
|
3076
|
+
#
|
3077
|
+
# @!attribute [rw] resource_snapshot_job_id
|
3078
|
+
# The identifier of the resource snapshot job associated with this
|
3079
|
+
# task, if a snapshot was created as part of the Engagement creation
|
3080
|
+
# process.
|
3081
|
+
# @return [String]
|
3082
|
+
#
|
3083
|
+
# @!attribute [rw] start_time
|
3084
|
+
# The timestamp indicating when the task was initiated, in RFC 3339
|
3085
|
+
# 5.6 date-time format.
|
3086
|
+
# @return [Time]
|
3087
|
+
#
|
3088
|
+
# @!attribute [rw] task_arn
|
3089
|
+
# The Amazon Resource Name (ARN) uniquely identifying this task within
|
3090
|
+
# AWS. This ARN can be used for referencing the task in other AWS
|
3091
|
+
# services or APIs.
|
3092
|
+
# @return [String]
|
3093
|
+
#
|
3094
|
+
# @!attribute [rw] task_id
|
3095
|
+
# A unique identifier for a specific task.
|
3096
|
+
# @return [String]
|
3097
|
+
#
|
3098
|
+
# @!attribute [rw] task_status
|
3099
|
+
# The current status of the task.
|
3100
|
+
# @return [String]
|
3101
|
+
#
|
3102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTaskSummary AWS API Documentation
|
3103
|
+
#
|
3104
|
+
class ListEngagementFromOpportunityTaskSummary < Struct.new(
|
3105
|
+
:engagement_id,
|
3106
|
+
:engagement_invitation_id,
|
3107
|
+
:message,
|
3108
|
+
:opportunity_id,
|
3109
|
+
:reason_code,
|
3110
|
+
:resource_snapshot_job_id,
|
3111
|
+
:start_time,
|
3112
|
+
:task_arn,
|
3113
|
+
:task_id,
|
3114
|
+
:task_status)
|
3115
|
+
SENSITIVE = []
|
3116
|
+
include Aws::Structure
|
3117
|
+
end
|
3118
|
+
|
3119
|
+
# @!attribute [rw] catalog
|
3120
|
+
# Specifies the catalog related to the request. Valid values are:
|
3121
|
+
#
|
3122
|
+
# * AWS: Retrieves the request from the production AWS environment.
|
3123
|
+
#
|
3124
|
+
# * Sandbox: Retrieves the request from a sandbox environment used for
|
3125
|
+
# testing or development purposes.
|
3126
|
+
# @return [String]
|
3127
|
+
#
|
3128
|
+
# @!attribute [rw] engagement_identifier
|
3129
|
+
# Filters tasks by the identifiers of the engagements they created or
|
3130
|
+
# are associated with.
|
3131
|
+
# @return [Array<String>]
|
3132
|
+
#
|
3133
|
+
# @!attribute [rw] max_results
|
3134
|
+
# Specifies the maximum number of results to return in a single page
|
3135
|
+
# of the response.Use this parameter to control the number of items
|
3136
|
+
# returned in each request, which can be useful for performance tuning
|
3137
|
+
# and managing large result sets.
|
3138
|
+
# @return [Integer]
|
3139
|
+
#
|
3140
|
+
# @!attribute [rw] next_token
|
3141
|
+
# The token for requesting the next page of results. This value is
|
3142
|
+
# obtained from the NextToken field in the response of a previous call
|
3143
|
+
# to this API. Use this parameter for pagination when the result set
|
3144
|
+
# spans multiple pages.
|
3145
|
+
# @return [String]
|
3146
|
+
#
|
3147
|
+
# @!attribute [rw] opportunity_identifier
|
3148
|
+
# The identifier of the original opportunity associated with this
|
3149
|
+
# task.
|
3150
|
+
# @return [Array<String>]
|
3151
|
+
#
|
3152
|
+
# @!attribute [rw] sort
|
3153
|
+
# Specifies the sorting criteria for the returned results. This allows
|
3154
|
+
# you to order the tasks based on specific attributes.
|
3155
|
+
# @return [Types::ListTasksSortBase]
|
3156
|
+
#
|
3157
|
+
# @!attribute [rw] task_identifier
|
3158
|
+
# Filters tasks by their unique identifiers. Use this when you want to
|
3159
|
+
# retrieve information about specific tasks.
|
3160
|
+
# @return [Array<String>]
|
3161
|
+
#
|
3162
|
+
# @!attribute [rw] task_status
|
3163
|
+
# Filters the tasks based on their current status. This allows you to
|
3164
|
+
# focus on tasks in specific states.
|
3165
|
+
# @return [Array<String>]
|
3166
|
+
#
|
3167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTasksRequest AWS API Documentation
|
3168
|
+
#
|
3169
|
+
class ListEngagementFromOpportunityTasksRequest < Struct.new(
|
3170
|
+
:catalog,
|
3171
|
+
:engagement_identifier,
|
3172
|
+
:max_results,
|
3173
|
+
:next_token,
|
3174
|
+
:opportunity_identifier,
|
3175
|
+
:sort,
|
3176
|
+
:task_identifier,
|
3177
|
+
:task_status)
|
3178
|
+
SENSITIVE = []
|
3179
|
+
include Aws::Structure
|
3180
|
+
end
|
3181
|
+
|
3182
|
+
# @!attribute [rw] next_token
|
3183
|
+
# A token used for pagination to retrieve the next page of results. If
|
3184
|
+
# there are more results available, this field will contain a token
|
3185
|
+
# that can be used in a subsequent API call to retrieve the next page.
|
3186
|
+
# If there are no more results, this field will be null or an empty
|
3187
|
+
# string.
|
3188
|
+
# @return [String]
|
3189
|
+
#
|
3190
|
+
# @!attribute [rw] task_summaries
|
3191
|
+
# TaskSummaries An array of TaskSummary objects containing details
|
3192
|
+
# about each task.
|
3193
|
+
# @return [Array<Types::ListEngagementFromOpportunityTaskSummary>]
|
3194
|
+
#
|
3195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTasksResponse AWS API Documentation
|
3196
|
+
#
|
3197
|
+
class ListEngagementFromOpportunityTasksResponse < Struct.new(
|
3198
|
+
:next_token,
|
3199
|
+
:task_summaries)
|
3200
|
+
SENSITIVE = []
|
3201
|
+
include Aws::Structure
|
3202
|
+
end
|
3203
|
+
|
1868
3204
|
# @!attribute [rw] catalog
|
1869
3205
|
# Specifies the catalog from which to list the engagement invitations.
|
1870
3206
|
# Use `AWS` for production invitations or `Sandbox` for testing
|
1871
3207
|
# environments.
|
1872
3208
|
# @return [String]
|
1873
3209
|
#
|
3210
|
+
# @!attribute [rw] engagement_identifier
|
3211
|
+
# Retrieves a list of engagement invitation summaries based on
|
3212
|
+
# specified filters. The ListEngagementInvitations operation allows
|
3213
|
+
# you to view all invitations that you have sent or received. You must
|
3214
|
+
# specify the ParticipantType to filter invitations where you are
|
3215
|
+
# either the SENDER or the RECEIVER. Invitations will automatically
|
3216
|
+
# expire if not accepted within 15 days.
|
3217
|
+
# @return [Array<String>]
|
3218
|
+
#
|
1874
3219
|
# @!attribute [rw] max_results
|
1875
3220
|
# Specifies the maximum number of engagement invitations to return in
|
1876
3221
|
# the response. If more results are available, a pagination token will
|
@@ -1894,22 +3239,33 @@ module Aws::PartnerCentralSelling
|
|
1894
3239
|
# on acceptance or rejection of the invitation.
|
1895
3240
|
# @return [Array<String>]
|
1896
3241
|
#
|
3242
|
+
# @!attribute [rw] sender_aws_account_id
|
3243
|
+
# List of sender AWS account IDs to filter the invitations.
|
3244
|
+
# @return [Array<String>]
|
3245
|
+
#
|
1897
3246
|
# @!attribute [rw] sort
|
1898
3247
|
# Specifies the sorting options for listing engagement invitations.
|
1899
3248
|
# Invitations can be sorted by fields such as `InvitationDate` or
|
1900
3249
|
# `Status` to help partners view results in their preferred order.
|
1901
3250
|
# @return [Types::OpportunityEngagementInvitationSort]
|
1902
3251
|
#
|
3252
|
+
# @!attribute [rw] status
|
3253
|
+
# Status values to filter the invitations.
|
3254
|
+
# @return [Array<String>]
|
3255
|
+
#
|
1903
3256
|
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementInvitationsRequest AWS API Documentation
|
1904
3257
|
#
|
1905
3258
|
class ListEngagementInvitationsRequest < Struct.new(
|
1906
3259
|
:catalog,
|
3260
|
+
:engagement_identifier,
|
1907
3261
|
:max_results,
|
1908
3262
|
:next_token,
|
1909
3263
|
:participant_type,
|
1910
3264
|
:payload_type,
|
1911
|
-
:
|
1912
|
-
|
3265
|
+
:sender_aws_account_id,
|
3266
|
+
:sort,
|
3267
|
+
:status)
|
3268
|
+
SENSITIVE = [:sender_aws_account_id]
|
1913
3269
|
include Aws::Structure
|
1914
3270
|
end
|
1915
3271
|
|
@@ -1934,6 +3290,194 @@ module Aws::PartnerCentralSelling
|
|
1934
3290
|
include Aws::Structure
|
1935
3291
|
end
|
1936
3292
|
|
3293
|
+
# @!attribute [rw] catalog
|
3294
|
+
# The catalog related to the request.
|
3295
|
+
# @return [String]
|
3296
|
+
#
|
3297
|
+
# @!attribute [rw] identifier
|
3298
|
+
# Identifier of the Engagement record to retrieve members from.
|
3299
|
+
# @return [String]
|
3300
|
+
#
|
3301
|
+
# @!attribute [rw] max_results
|
3302
|
+
# The maximum number of results to return in a single call.
|
3303
|
+
# @return [Integer]
|
3304
|
+
#
|
3305
|
+
# @!attribute [rw] next_token
|
3306
|
+
# The token for the next set of results.
|
3307
|
+
# @return [String]
|
3308
|
+
#
|
3309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementMembersRequest AWS API Documentation
|
3310
|
+
#
|
3311
|
+
class ListEngagementMembersRequest < Struct.new(
|
3312
|
+
:catalog,
|
3313
|
+
:identifier,
|
3314
|
+
:max_results,
|
3315
|
+
:next_token)
|
3316
|
+
SENSITIVE = []
|
3317
|
+
include Aws::Structure
|
3318
|
+
end
|
3319
|
+
|
3320
|
+
# @!attribute [rw] engagement_member_list
|
3321
|
+
# Provides a list of engagement members.
|
3322
|
+
# @return [Array<Types::EngagementMember>]
|
3323
|
+
#
|
3324
|
+
# @!attribute [rw] next_token
|
3325
|
+
# A pagination token used to retrieve the next set of results. If
|
3326
|
+
# there are more results available than can be returned in a single
|
3327
|
+
# response, this token will be present. Use this token in a subsequent
|
3328
|
+
# request to retrieve the next page of results. If there are no more
|
3329
|
+
# results, this value will be null.
|
3330
|
+
# @return [String]
|
3331
|
+
#
|
3332
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementMembersResponse AWS API Documentation
|
3333
|
+
#
|
3334
|
+
class ListEngagementMembersResponse < Struct.new(
|
3335
|
+
:engagement_member_list,
|
3336
|
+
:next_token)
|
3337
|
+
SENSITIVE = []
|
3338
|
+
include Aws::Structure
|
3339
|
+
end
|
3340
|
+
|
3341
|
+
# @!attribute [rw] catalog
|
3342
|
+
# Specifies the catalog in which to search for engagement-resource
|
3343
|
+
# associations. Valid Values: "AWS" or "Sandbox"
|
3344
|
+
#
|
3345
|
+
# * `AWS` for production environments.
|
3346
|
+
#
|
3347
|
+
# * `Sandbox` for testing and development purposes.
|
3348
|
+
# @return [String]
|
3349
|
+
#
|
3350
|
+
# @!attribute [rw] created_by
|
3351
|
+
# Filters the response to include only snapshots of resources owned by
|
3352
|
+
# the specified AWS account ID. Use this when you want to find
|
3353
|
+
# associations related to resources owned by a particular account.
|
3354
|
+
# @return [String]
|
3355
|
+
#
|
3356
|
+
# @!attribute [rw] engagement_identifier
|
3357
|
+
# Filters the results to include only associations related to the
|
3358
|
+
# specified engagement. Use this when you want to find all resources
|
3359
|
+
# associated with a specific engagement.
|
3360
|
+
# @return [String]
|
3361
|
+
#
|
3362
|
+
# @!attribute [rw] max_results
|
3363
|
+
# Limits the number of results returned in a single call. Use this to
|
3364
|
+
# control the number of results returned, especially useful for
|
3365
|
+
# pagination.
|
3366
|
+
# @return [Integer]
|
3367
|
+
#
|
3368
|
+
# @!attribute [rw] next_token
|
3369
|
+
# A token used for pagination of results. Include this token in
|
3370
|
+
# subsequent requests to retrieve the next set of results.
|
3371
|
+
# @return [String]
|
3372
|
+
#
|
3373
|
+
# @!attribute [rw] resource_identifier
|
3374
|
+
# Filters the results to include only associations with the specified
|
3375
|
+
# resource. Varies depending on the resource type. Use this when you
|
3376
|
+
# want to find all engagements associated with a specific resource.
|
3377
|
+
# @return [String]
|
3378
|
+
#
|
3379
|
+
# @!attribute [rw] resource_type
|
3380
|
+
# Filters the results to include only associations with resources of
|
3381
|
+
# the specified type.
|
3382
|
+
# @return [String]
|
3383
|
+
#
|
3384
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementResourceAssociationsRequest AWS API Documentation
|
3385
|
+
#
|
3386
|
+
class ListEngagementResourceAssociationsRequest < Struct.new(
|
3387
|
+
:catalog,
|
3388
|
+
:created_by,
|
3389
|
+
:engagement_identifier,
|
3390
|
+
:max_results,
|
3391
|
+
:next_token,
|
3392
|
+
:resource_identifier,
|
3393
|
+
:resource_type)
|
3394
|
+
SENSITIVE = [:created_by]
|
3395
|
+
include Aws::Structure
|
3396
|
+
end
|
3397
|
+
|
3398
|
+
# @!attribute [rw] engagement_resource_association_summaries
|
3399
|
+
# A list of engagement-resource association summaries.
|
3400
|
+
# @return [Array<Types::EngagementResourceAssociationSummary>]
|
3401
|
+
#
|
3402
|
+
# @!attribute [rw] next_token
|
3403
|
+
# A token to retrieve the next set of results. Use this token in a
|
3404
|
+
# subsequent request to retrieve additional results if the response
|
3405
|
+
# was truncated.
|
3406
|
+
# @return [String]
|
3407
|
+
#
|
3408
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementResourceAssociationsResponse AWS API Documentation
|
3409
|
+
#
|
3410
|
+
class ListEngagementResourceAssociationsResponse < Struct.new(
|
3411
|
+
:engagement_resource_association_summaries,
|
3412
|
+
:next_token)
|
3413
|
+
SENSITIVE = []
|
3414
|
+
include Aws::Structure
|
3415
|
+
end
|
3416
|
+
|
3417
|
+
# @!attribute [rw] catalog
|
3418
|
+
# Specifies the catalog related to the request.
|
3419
|
+
# @return [String]
|
3420
|
+
#
|
3421
|
+
# @!attribute [rw] created_by
|
3422
|
+
# A list of AWS account IDs. When specified, the response includes
|
3423
|
+
# engagements created by these accounts. This filter is useful for
|
3424
|
+
# finding engagements created by specific team members.
|
3425
|
+
# @return [Array<String>]
|
3426
|
+
#
|
3427
|
+
# @!attribute [rw] engagement_identifier
|
3428
|
+
# An array of strings representing engagement identifiers to retrieve.
|
3429
|
+
# @return [Array<String>]
|
3430
|
+
#
|
3431
|
+
# @!attribute [rw] exclude_created_by
|
3432
|
+
# An array of strings representing AWS Account IDs. Use this to
|
3433
|
+
# exclude engagements created by specific users.
|
3434
|
+
# @return [Array<String>]
|
3435
|
+
#
|
3436
|
+
# @!attribute [rw] max_results
|
3437
|
+
# The maximum number of results to return in a single call.
|
3438
|
+
# @return [Integer]
|
3439
|
+
#
|
3440
|
+
# @!attribute [rw] next_token
|
3441
|
+
# The token for the next set of results. This value is returned from a
|
3442
|
+
# previous call.
|
3443
|
+
# @return [String]
|
3444
|
+
#
|
3445
|
+
# @!attribute [rw] sort
|
3446
|
+
# An object that specifies the sort order of the results.
|
3447
|
+
# @return [Types::EngagementSort]
|
3448
|
+
#
|
3449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementsRequest AWS API Documentation
|
3450
|
+
#
|
3451
|
+
class ListEngagementsRequest < Struct.new(
|
3452
|
+
:catalog,
|
3453
|
+
:created_by,
|
3454
|
+
:engagement_identifier,
|
3455
|
+
:exclude_created_by,
|
3456
|
+
:max_results,
|
3457
|
+
:next_token,
|
3458
|
+
:sort)
|
3459
|
+
SENSITIVE = [:created_by, :exclude_created_by]
|
3460
|
+
include Aws::Structure
|
3461
|
+
end
|
3462
|
+
|
3463
|
+
# @!attribute [rw] engagement_summary_list
|
3464
|
+
# An array of engagement summary objects.
|
3465
|
+
# @return [Array<Types::EngagementSummary>]
|
3466
|
+
#
|
3467
|
+
# @!attribute [rw] next_token
|
3468
|
+
# The token to retrieve the next set of results. This field will be
|
3469
|
+
# null if there are no more results.
|
3470
|
+
# @return [String]
|
3471
|
+
#
|
3472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListEngagementsResponse AWS API Documentation
|
3473
|
+
#
|
3474
|
+
class ListEngagementsResponse < Struct.new(
|
3475
|
+
:engagement_summary_list,
|
3476
|
+
:next_token)
|
3477
|
+
SENSITIVE = []
|
3478
|
+
include Aws::Structure
|
3479
|
+
end
|
3480
|
+
|
1937
3481
|
# @!attribute [rw] catalog
|
1938
3482
|
# Specifies the catalog associated with the request. This field takes
|
1939
3483
|
# a string value from a predefined list: `AWS` or `Sandbox`. The
|
@@ -2032,6 +3576,133 @@ module Aws::PartnerCentralSelling
|
|
2032
3576
|
include Aws::Structure
|
2033
3577
|
end
|
2034
3578
|
|
3579
|
+
# @!attribute [rw] catalog
|
3580
|
+
# Specifies the catalog related to the request.
|
3581
|
+
# @return [String]
|
3582
|
+
#
|
3583
|
+
# @!attribute [rw] engagement_identifier
|
3584
|
+
# The identifier of the engagement to filter the response.
|
3585
|
+
# @return [String]
|
3586
|
+
#
|
3587
|
+
# @!attribute [rw] max_results
|
3588
|
+
# The maximum number of results to return in a single call. If
|
3589
|
+
# omitted, defaults to 50.
|
3590
|
+
# @return [Integer]
|
3591
|
+
#
|
3592
|
+
# @!attribute [rw] next_token
|
3593
|
+
# The token for the next set of results.
|
3594
|
+
# @return [String]
|
3595
|
+
#
|
3596
|
+
# @!attribute [rw] sort
|
3597
|
+
# Configures the sorting of the response. If omitted, results are
|
3598
|
+
# sorted by `CreatedDate` in descending order.
|
3599
|
+
# @return [Types::SortObject]
|
3600
|
+
#
|
3601
|
+
# @!attribute [rw] status
|
3602
|
+
# The status of the jobs to filter the response.
|
3603
|
+
# @return [String]
|
3604
|
+
#
|
3605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListResourceSnapshotJobsRequest AWS API Documentation
|
3606
|
+
#
|
3607
|
+
class ListResourceSnapshotJobsRequest < Struct.new(
|
3608
|
+
:catalog,
|
3609
|
+
:engagement_identifier,
|
3610
|
+
:max_results,
|
3611
|
+
:next_token,
|
3612
|
+
:sort,
|
3613
|
+
:status)
|
3614
|
+
SENSITIVE = []
|
3615
|
+
include Aws::Structure
|
3616
|
+
end
|
3617
|
+
|
3618
|
+
# @!attribute [rw] next_token
|
3619
|
+
# The token to retrieve the next set of results. If there are no
|
3620
|
+
# additional results, this value is null.
|
3621
|
+
# @return [String]
|
3622
|
+
#
|
3623
|
+
# @!attribute [rw] resource_snapshot_job_summaries
|
3624
|
+
# An array of resource snapshot job summary objects.
|
3625
|
+
# @return [Array<Types::ResourceSnapshotJobSummary>]
|
3626
|
+
#
|
3627
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListResourceSnapshotJobsResponse AWS API Documentation
|
3628
|
+
#
|
3629
|
+
class ListResourceSnapshotJobsResponse < Struct.new(
|
3630
|
+
:next_token,
|
3631
|
+
:resource_snapshot_job_summaries)
|
3632
|
+
SENSITIVE = []
|
3633
|
+
include Aws::Structure
|
3634
|
+
end
|
3635
|
+
|
3636
|
+
# @!attribute [rw] catalog
|
3637
|
+
# Specifies the catalog related to the request.
|
3638
|
+
# @return [String]
|
3639
|
+
#
|
3640
|
+
# @!attribute [rw] created_by
|
3641
|
+
# Filters the response to include only snapshots of resources owned by
|
3642
|
+
# the specified AWS account.
|
3643
|
+
# @return [String]
|
3644
|
+
#
|
3645
|
+
# @!attribute [rw] engagement_identifier
|
3646
|
+
# The unique identifier of the engagement associated with the
|
3647
|
+
# snapshots.
|
3648
|
+
# @return [String]
|
3649
|
+
#
|
3650
|
+
# @!attribute [rw] max_results
|
3651
|
+
# The maximum number of results to return in a single call.
|
3652
|
+
# @return [Integer]
|
3653
|
+
#
|
3654
|
+
# @!attribute [rw] next_token
|
3655
|
+
# The token for the next set of results.
|
3656
|
+
# @return [String]
|
3657
|
+
#
|
3658
|
+
# @!attribute [rw] resource_identifier
|
3659
|
+
# Filters the response to include only snapshots of the specified
|
3660
|
+
# resource.
|
3661
|
+
# @return [String]
|
3662
|
+
#
|
3663
|
+
# @!attribute [rw] resource_snapshot_template_identifier
|
3664
|
+
# Filters the response to include only snapshots created using the
|
3665
|
+
# specified template.
|
3666
|
+
# @return [String]
|
3667
|
+
#
|
3668
|
+
# @!attribute [rw] resource_type
|
3669
|
+
# Filters the response to include only snapshots of the specified
|
3670
|
+
# resource type.
|
3671
|
+
# @return [String]
|
3672
|
+
#
|
3673
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListResourceSnapshotsRequest AWS API Documentation
|
3674
|
+
#
|
3675
|
+
class ListResourceSnapshotsRequest < Struct.new(
|
3676
|
+
:catalog,
|
3677
|
+
:created_by,
|
3678
|
+
:engagement_identifier,
|
3679
|
+
:max_results,
|
3680
|
+
:next_token,
|
3681
|
+
:resource_identifier,
|
3682
|
+
:resource_snapshot_template_identifier,
|
3683
|
+
:resource_type)
|
3684
|
+
SENSITIVE = [:created_by]
|
3685
|
+
include Aws::Structure
|
3686
|
+
end
|
3687
|
+
|
3688
|
+
# @!attribute [rw] next_token
|
3689
|
+
# The token to retrieve the next set of results. If there are no
|
3690
|
+
# additional results, this value is null.
|
3691
|
+
# @return [String]
|
3692
|
+
#
|
3693
|
+
# @!attribute [rw] resource_snapshot_summaries
|
3694
|
+
# An array of resource snapshot summary objects.
|
3695
|
+
# @return [Array<Types::ResourceSnapshotSummary>]
|
3696
|
+
#
|
3697
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListResourceSnapshotsResponse AWS API Documentation
|
3698
|
+
#
|
3699
|
+
class ListResourceSnapshotsResponse < Struct.new(
|
3700
|
+
:next_token,
|
3701
|
+
:resource_snapshot_summaries)
|
3702
|
+
SENSITIVE = []
|
3703
|
+
include Aws::Structure
|
3704
|
+
end
|
3705
|
+
|
2035
3706
|
# @!attribute [rw] catalog
|
2036
3707
|
# Specifies the catalog associated with the request. This field takes
|
2037
3708
|
# a string value from a predefined list: `AWS` or `Sandbox`. The
|
@@ -2111,6 +3782,52 @@ module Aws::PartnerCentralSelling
|
|
2111
3782
|
include Aws::Structure
|
2112
3783
|
end
|
2113
3784
|
|
3785
|
+
# @!attribute [rw] resource_arn
|
3786
|
+
# The Amazon Resource Name (ARN) of the resource for which you want to
|
3787
|
+
# retrieve tags.
|
3788
|
+
# @return [String]
|
3789
|
+
#
|
3790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListTagsForResourceRequest AWS API Documentation
|
3791
|
+
#
|
3792
|
+
class ListTagsForResourceRequest < Struct.new(
|
3793
|
+
:resource_arn)
|
3794
|
+
SENSITIVE = []
|
3795
|
+
include Aws::Structure
|
3796
|
+
end
|
3797
|
+
|
3798
|
+
# @!attribute [rw] tags
|
3799
|
+
# A map of the key-value pairs for the tag or tags assigned to the
|
3800
|
+
# specified resource.
|
3801
|
+
# @return [Array<Types::Tag>]
|
3802
|
+
#
|
3803
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListTagsForResourceResponse AWS API Documentation
|
3804
|
+
#
|
3805
|
+
class ListTagsForResourceResponse < Struct.new(
|
3806
|
+
:tags)
|
3807
|
+
SENSITIVE = []
|
3808
|
+
include Aws::Structure
|
3809
|
+
end
|
3810
|
+
|
3811
|
+
# Defines the sorting parameters for listing tasks. This structure
|
3812
|
+
# allows for specifying the field to sort by and the order of sorting.
|
3813
|
+
#
|
3814
|
+
# @!attribute [rw] sort_by
|
3815
|
+
# Specifies the field by which the task list should be sorted.
|
3816
|
+
# @return [String]
|
3817
|
+
#
|
3818
|
+
# @!attribute [rw] sort_order
|
3819
|
+
# Determines the order in which the sorted results are presented.
|
3820
|
+
# @return [String]
|
3821
|
+
#
|
3822
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListTasksSortBase AWS API Documentation
|
3823
|
+
#
|
3824
|
+
class ListTasksSortBase < Struct.new(
|
3825
|
+
:sort_by,
|
3826
|
+
:sort_order)
|
3827
|
+
SENSITIVE = []
|
3828
|
+
include Aws::Structure
|
3829
|
+
end
|
3830
|
+
|
2114
3831
|
# An object that contains marketing details for the `Opportunity`.
|
2115
3832
|
#
|
2116
3833
|
# @!attribute [rw] aws_funding_used
|
@@ -2294,6 +4011,12 @@ module Aws::PartnerCentralSelling
|
|
2294
4011
|
|
2295
4012
|
# An object that contains an `Opportunity`'s subset of fields.
|
2296
4013
|
#
|
4014
|
+
# @!attribute [rw] arn
|
4015
|
+
# The Amazon Resource Name (ARN) for the opportunity. This globally
|
4016
|
+
# unique identifier can be used for IAM policies and cross-service
|
4017
|
+
# references.
|
4018
|
+
# @return [String]
|
4019
|
+
#
|
2297
4020
|
# @!attribute [rw] catalog
|
2298
4021
|
# Specifies the catalog associated with the opportunity, either `AWS`
|
2299
4022
|
# or `Sandbox`. This indicates the environment in which the
|
@@ -2339,30 +4062,85 @@ module Aws::PartnerCentralSelling
|
|
2339
4062
|
# current customer.
|
2340
4063
|
# @return [String]
|
2341
4064
|
#
|
2342
|
-
# @!attribute [rw] partner_opportunity_identifier
|
2343
|
-
# Specifies the `Opportunity`'s unique identifier in the partner's
|
2344
|
-
# CRM system. This value is essential to track and reconcile because
|
2345
|
-
# it's included in the outbound payload sent back to the partner. It
|
2346
|
-
# allows partners to link an opportunity to their CRM.
|
4065
|
+
# @!attribute [rw] partner_opportunity_identifier
|
4066
|
+
# Specifies the `Opportunity`'s unique identifier in the partner's
|
4067
|
+
# CRM system. This value is essential to track and reconcile because
|
4068
|
+
# it's included in the outbound payload sent back to the partner. It
|
4069
|
+
# allows partners to link an opportunity to their CRM.
|
4070
|
+
# @return [String]
|
4071
|
+
#
|
4072
|
+
# @!attribute [rw] project
|
4073
|
+
# An object that contains the `Opportunity`'s project details
|
4074
|
+
# summary.
|
4075
|
+
# @return [Types::ProjectSummary]
|
4076
|
+
#
|
4077
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/OpportunitySummary AWS API Documentation
|
4078
|
+
#
|
4079
|
+
class OpportunitySummary < Struct.new(
|
4080
|
+
:arn,
|
4081
|
+
:catalog,
|
4082
|
+
:created_date,
|
4083
|
+
:customer,
|
4084
|
+
:id,
|
4085
|
+
:last_modified_date,
|
4086
|
+
:life_cycle,
|
4087
|
+
:opportunity_type,
|
4088
|
+
:partner_opportunity_identifier,
|
4089
|
+
:project)
|
4090
|
+
SENSITIVE = []
|
4091
|
+
include Aws::Structure
|
4092
|
+
end
|
4093
|
+
|
4094
|
+
# Provides a comprehensive view of an opportunity summary, including
|
4095
|
+
# lifecycle information, team details, opportunity type, primary needs
|
4096
|
+
# from AWS, and associated project information.
|
4097
|
+
#
|
4098
|
+
# @!attribute [rw] customer
|
4099
|
+
# An object that contains the customer's `Account` and `Contact`.
|
4100
|
+
# @return [Types::Customer]
|
4101
|
+
#
|
4102
|
+
# @!attribute [rw] lifecycle
|
4103
|
+
# Contains information about the opportunity's lifecycle, including
|
4104
|
+
# its current stage, status, and important dates such as creation and
|
4105
|
+
# last modification times.
|
4106
|
+
# @return [Types::LifeCycleForView]
|
4107
|
+
#
|
4108
|
+
# @!attribute [rw] opportunity_team
|
4109
|
+
# Represents the internal team handling the opportunity. Specify the
|
4110
|
+
# members involved in collaborating on an opportunity within the
|
4111
|
+
# partner's organization.
|
4112
|
+
# @return [Array<Types::Contact>]
|
4113
|
+
#
|
4114
|
+
# @!attribute [rw] opportunity_type
|
4115
|
+
# Specifies the opportunity type.
|
2347
4116
|
# @return [String]
|
2348
4117
|
#
|
4118
|
+
# @!attribute [rw] primary_needs_from_aws
|
4119
|
+
# Identifies the type of support the partner needs from AWS.
|
4120
|
+
# @return [Array<String>]
|
4121
|
+
#
|
2349
4122
|
# @!attribute [rw] project
|
2350
|
-
#
|
2351
|
-
#
|
2352
|
-
#
|
4123
|
+
# Contains summary information about the project associated with the
|
4124
|
+
# opportunity, including project name, description, timeline, and
|
4125
|
+
# other relevant details.
|
4126
|
+
# @return [Types::ProjectView]
|
2353
4127
|
#
|
2354
|
-
#
|
4128
|
+
# @!attribute [rw] related_entity_identifiers
|
4129
|
+
# This field provides the associations' information for other
|
4130
|
+
# entities with the opportunity. These entities include identifiers
|
4131
|
+
# for `AWSProducts`, `Partner Solutions`, and `AWSMarketplaceOffers`.
|
4132
|
+
# @return [Types::RelatedEntityIdentifiers]
|
2355
4133
|
#
|
2356
|
-
|
2357
|
-
|
2358
|
-
|
4134
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/OpportunitySummaryView AWS API Documentation
|
4135
|
+
#
|
4136
|
+
class OpportunitySummaryView < Struct.new(
|
2359
4137
|
:customer,
|
2360
|
-
:
|
2361
|
-
:
|
2362
|
-
:life_cycle,
|
4138
|
+
:lifecycle,
|
4139
|
+
:opportunity_team,
|
2363
4140
|
:opportunity_type,
|
2364
|
-
:
|
2365
|
-
:project
|
4141
|
+
:primary_needs_from_aws,
|
4142
|
+
:project,
|
4143
|
+
:related_entity_identifiers)
|
2366
4144
|
SENSITIVE = []
|
2367
4145
|
include Aws::Structure
|
2368
4146
|
end
|
@@ -2372,6 +4150,8 @@ module Aws::PartnerCentralSelling
|
|
2372
4150
|
# and is used by partners to evaluate whether to accept or reject the
|
2373
4151
|
# engagement.
|
2374
4152
|
#
|
4153
|
+
# @note Payload is a union - when making an API calls you must set exactly one of the members.
|
4154
|
+
#
|
2375
4155
|
# @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
4156
|
#
|
2377
4157
|
# @!attribute [rw] opportunity_invitation
|
@@ -2668,10 +4448,97 @@ module Aws::PartnerCentralSelling
|
|
2668
4448
|
include Aws::Structure
|
2669
4449
|
end
|
2670
4450
|
|
4451
|
+
# Provides the project view of an opportunity resource shared through a
|
4452
|
+
# snapshot.
|
4453
|
+
#
|
4454
|
+
# @!attribute [rw] customer_use_case
|
4455
|
+
# Specifies the proposed solution focus or type of workload for the
|
4456
|
+
# project.
|
4457
|
+
# @return [String]
|
4458
|
+
#
|
4459
|
+
# @!attribute [rw] delivery_models
|
4460
|
+
# Describes the deployment or consumption model for the partner
|
4461
|
+
# solution or offering. This field indicates how the project's
|
4462
|
+
# solution will be delivered or implemented for the customer.
|
4463
|
+
# @return [Array<String>]
|
4464
|
+
#
|
4465
|
+
# @!attribute [rw] expected_customer_spend
|
4466
|
+
# Provides information about the anticipated customer spend related to
|
4467
|
+
# this project. This may include details such as amount, frequency,
|
4468
|
+
# and currency of expected expenditure.
|
4469
|
+
# @return [Array<Types::ExpectedCustomerSpend>]
|
4470
|
+
#
|
4471
|
+
# @!attribute [rw] other_solution_description
|
4472
|
+
# Offers a description of other solutions if the standard solutions do
|
4473
|
+
# not adequately cover the project's scope.
|
4474
|
+
# @return [String]
|
4475
|
+
#
|
4476
|
+
# @!attribute [rw] sales_activities
|
4477
|
+
# Lists the pre-sales activities that have occurred with the
|
4478
|
+
# end-customer related to the opportunity. This field is conditionally
|
4479
|
+
# mandatory when the project is qualified for Co-Sell and helps drive
|
4480
|
+
# assignment priority on the AWS side. It provides insight into the
|
4481
|
+
# engagement level with the customer.
|
4482
|
+
# @return [Array<String>]
|
4483
|
+
#
|
4484
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ProjectView AWS API Documentation
|
4485
|
+
#
|
4486
|
+
class ProjectView < Struct.new(
|
4487
|
+
:customer_use_case,
|
4488
|
+
:delivery_models,
|
4489
|
+
:expected_customer_spend,
|
4490
|
+
:other_solution_description,
|
4491
|
+
:sales_activities)
|
4492
|
+
SENSITIVE = [:other_solution_description]
|
4493
|
+
include Aws::Structure
|
4494
|
+
end
|
4495
|
+
|
4496
|
+
# @!attribute [rw] catalog
|
4497
|
+
# Specifies the catalog in which the settings will be updated.
|
4498
|
+
# Acceptable values include `AWS` for production and `Sandbox` for
|
4499
|
+
# testing environments.
|
4500
|
+
# @return [String]
|
4501
|
+
#
|
4502
|
+
# @!attribute [rw] resource_snapshot_job_role_identifier
|
4503
|
+
# Specifies the ARN of the IAM Role used for resource snapshot job
|
4504
|
+
# executions.
|
4505
|
+
# @return [String]
|
4506
|
+
#
|
4507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/PutSellingSystemSettingsRequest AWS API Documentation
|
4508
|
+
#
|
4509
|
+
class PutSellingSystemSettingsRequest < Struct.new(
|
4510
|
+
:catalog,
|
4511
|
+
:resource_snapshot_job_role_identifier)
|
4512
|
+
SENSITIVE = []
|
4513
|
+
include Aws::Structure
|
4514
|
+
end
|
4515
|
+
|
4516
|
+
# @!attribute [rw] catalog
|
4517
|
+
# Specifies the catalog in which the settings are defined. Acceptable
|
4518
|
+
# values include `AWS` for production and `Sandbox` for testing
|
4519
|
+
# environments.
|
4520
|
+
# @return [String]
|
4521
|
+
#
|
4522
|
+
# @!attribute [rw] resource_snapshot_job_role_arn
|
4523
|
+
# Specifies the ARN of the IAM Role used for resource snapshot job
|
4524
|
+
# executions.
|
4525
|
+
# @return [String]
|
4526
|
+
#
|
4527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/PutSellingSystemSettingsResponse AWS API Documentation
|
4528
|
+
#
|
4529
|
+
class PutSellingSystemSettingsResponse < Struct.new(
|
4530
|
+
:catalog,
|
4531
|
+
:resource_snapshot_job_role_arn)
|
4532
|
+
SENSITIVE = []
|
4533
|
+
include Aws::Structure
|
4534
|
+
end
|
4535
|
+
|
2671
4536
|
# Represents the entity that received the Engagement Invitation,
|
2672
4537
|
# including account and company details. This field is essential for
|
2673
4538
|
# tracking the partner who is being invited to collaborate.
|
2674
4539
|
#
|
4540
|
+
# @note Receiver is a union - when making an API calls you must set exactly one of the members.
|
4541
|
+
#
|
2675
4542
|
# @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
4543
|
#
|
2677
4544
|
# @!attribute [rw] account
|
@@ -2814,6 +4681,114 @@ module Aws::PartnerCentralSelling
|
|
2814
4681
|
include Aws::Structure
|
2815
4682
|
end
|
2816
4683
|
|
4684
|
+
# An object that contains a `Resource Snapshot Job`'s subset of fields.
|
4685
|
+
#
|
4686
|
+
# @!attribute [rw] arn
|
4687
|
+
# The Amazon Resource Name (ARN) for the resource snapshot job.
|
4688
|
+
# @return [String]
|
4689
|
+
#
|
4690
|
+
# @!attribute [rw] engagement_id
|
4691
|
+
# The unique identifier of the Engagement.
|
4692
|
+
# @return [String]
|
4693
|
+
#
|
4694
|
+
# @!attribute [rw] id
|
4695
|
+
# The unique identifier for the resource snapshot job within the AWS
|
4696
|
+
# Partner Central system. This ID is used for direct references to the
|
4697
|
+
# job within the service.
|
4698
|
+
# @return [String]
|
4699
|
+
#
|
4700
|
+
# @!attribute [rw] status
|
4701
|
+
# The current status of the snapshot job.
|
4702
|
+
#
|
4703
|
+
# Valid values:
|
4704
|
+
#
|
4705
|
+
# * STOPPED: The job is not currently running.
|
4706
|
+
#
|
4707
|
+
# * RUNNING: The job is actively executing.
|
4708
|
+
# @return [String]
|
4709
|
+
#
|
4710
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ResourceSnapshotJobSummary AWS API Documentation
|
4711
|
+
#
|
4712
|
+
class ResourceSnapshotJobSummary < Struct.new(
|
4713
|
+
:arn,
|
4714
|
+
:engagement_id,
|
4715
|
+
:id,
|
4716
|
+
:status)
|
4717
|
+
SENSITIVE = []
|
4718
|
+
include Aws::Structure
|
4719
|
+
end
|
4720
|
+
|
4721
|
+
# Represents the payload of a resource snapshot. This structure is
|
4722
|
+
# designed to accommodate different types of resource snapshots,
|
4723
|
+
# currently supporting opportunity summaries.
|
4724
|
+
#
|
4725
|
+
# @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.
|
4726
|
+
#
|
4727
|
+
# @!attribute [rw] opportunity_summary
|
4728
|
+
# An object that contains an `opportunity`'s subset of fields.
|
4729
|
+
# @return [Types::OpportunitySummaryView]
|
4730
|
+
#
|
4731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ResourceSnapshotPayload AWS API Documentation
|
4732
|
+
#
|
4733
|
+
class ResourceSnapshotPayload < Struct.new(
|
4734
|
+
:opportunity_summary,
|
4735
|
+
:unknown)
|
4736
|
+
SENSITIVE = []
|
4737
|
+
include Aws::Structure
|
4738
|
+
include Aws::Structure::Union
|
4739
|
+
|
4740
|
+
class OpportunitySummary < ResourceSnapshotPayload; end
|
4741
|
+
class Unknown < ResourceSnapshotPayload; end
|
4742
|
+
end
|
4743
|
+
|
4744
|
+
# Provides a concise summary of a resource snapshot, including its
|
4745
|
+
# unique identifier and version information. This structure is used to
|
4746
|
+
# quickly reference and identify specific versions of resource
|
4747
|
+
# snapshots.
|
4748
|
+
#
|
4749
|
+
# @!attribute [rw] arn
|
4750
|
+
# The Amazon Resource Name (ARN) of the snapshot. This globally unique
|
4751
|
+
# identifier can be used for cross-service references and in IAM
|
4752
|
+
# policies.
|
4753
|
+
# @return [String]
|
4754
|
+
#
|
4755
|
+
# @!attribute [rw] created_by
|
4756
|
+
# The AWS account ID of the entity that owns the resource from which
|
4757
|
+
# the snapshot was created.
|
4758
|
+
# @return [String]
|
4759
|
+
#
|
4760
|
+
# @!attribute [rw] resource_id
|
4761
|
+
# The identifier of the specific resource snapshotted. The format
|
4762
|
+
# might vary depending on the ResourceType.
|
4763
|
+
# @return [String]
|
4764
|
+
#
|
4765
|
+
# @!attribute [rw] resource_snapshot_template_name
|
4766
|
+
# The name of the template used to create the snapshot.
|
4767
|
+
# @return [String]
|
4768
|
+
#
|
4769
|
+
# @!attribute [rw] resource_type
|
4770
|
+
# The type of resource snapshotted.
|
4771
|
+
# @return [String]
|
4772
|
+
#
|
4773
|
+
# @!attribute [rw] revision
|
4774
|
+
# The revision number of the snapshot. This integer value is
|
4775
|
+
# incremented each time the snapshot is updated, allowing for version
|
4776
|
+
# tracking of the resource snapshot.
|
4777
|
+
# @return [Integer]
|
4778
|
+
#
|
4779
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ResourceSnapshotSummary AWS API Documentation
|
4780
|
+
#
|
4781
|
+
class ResourceSnapshotSummary < Struct.new(
|
4782
|
+
:arn,
|
4783
|
+
:created_by,
|
4784
|
+
:resource_id,
|
4785
|
+
:resource_snapshot_template_name,
|
4786
|
+
:resource_type,
|
4787
|
+
:revision)
|
4788
|
+
SENSITIVE = [:created_by]
|
4789
|
+
include Aws::Structure
|
4790
|
+
end
|
4791
|
+
|
2817
4792
|
# An object that contains the details of the sender-provided contact
|
2818
4793
|
# person for the `EngagementInvitation`.
|
2819
4794
|
#
|
@@ -2915,6 +4890,11 @@ module Aws::PartnerCentralSelling
|
|
2915
4890
|
# Specifies minimal information for the solution offered to solve the
|
2916
4891
|
# customer's business problem.
|
2917
4892
|
#
|
4893
|
+
# @!attribute [rw] arn
|
4894
|
+
# The SolutionBase structure provides essential information about a
|
4895
|
+
# solution.
|
4896
|
+
# @return [String]
|
4897
|
+
#
|
2918
4898
|
# @!attribute [rw] catalog
|
2919
4899
|
# Specifies the catalog in which the solution is hosted, either `AWS`
|
2920
4900
|
# or `Sandbox`. This helps partners differentiate between live
|
@@ -2955,6 +4935,7 @@ module Aws::PartnerCentralSelling
|
|
2955
4935
|
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/SolutionBase AWS API Documentation
|
2956
4936
|
#
|
2957
4937
|
class SolutionBase < Struct.new(
|
4938
|
+
:arn,
|
2958
4939
|
:catalog,
|
2959
4940
|
:category,
|
2960
4941
|
:created_date,
|
@@ -2987,6 +4968,27 @@ module Aws::PartnerCentralSelling
|
|
2987
4968
|
include Aws::Structure
|
2988
4969
|
end
|
2989
4970
|
|
4971
|
+
# Defines the sorting parameters for listing resource snapshot jobs.
|
4972
|
+
# This structure allows you to specify the field to sort by and the
|
4973
|
+
# order of sorting.
|
4974
|
+
#
|
4975
|
+
# @!attribute [rw] sort_by
|
4976
|
+
# Specifies the field by which to sort the resource snapshot jobs.
|
4977
|
+
# @return [String]
|
4978
|
+
#
|
4979
|
+
# @!attribute [rw] sort_order
|
4980
|
+
# Determines the order in which the sorted results are presented.
|
4981
|
+
# @return [String]
|
4982
|
+
#
|
4983
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/SortObject AWS API Documentation
|
4984
|
+
#
|
4985
|
+
class SortObject < Struct.new(
|
4986
|
+
:sort_by,
|
4987
|
+
:sort_order)
|
4988
|
+
SENSITIVE = []
|
4989
|
+
include Aws::Structure
|
4990
|
+
end
|
4991
|
+
|
2990
4992
|
# @!attribute [rw] catalog
|
2991
4993
|
# Specifies the catalog related to the task. Use `AWS` for production
|
2992
4994
|
# engagements and `Sandbox` for testing scenarios.
|
@@ -3007,12 +5009,17 @@ module Aws::PartnerCentralSelling
|
|
3007
5009
|
# correct engagement is processed.
|
3008
5010
|
# @return [String]
|
3009
5011
|
#
|
5012
|
+
# @!attribute [rw] tags
|
5013
|
+
# A list of objects specifying each tag name and value.
|
5014
|
+
# @return [Array<Types::Tag>]
|
5015
|
+
#
|
3010
5016
|
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/StartEngagementByAcceptingInvitationTaskRequest AWS API Documentation
|
3011
5017
|
#
|
3012
5018
|
class StartEngagementByAcceptingInvitationTaskRequest < Struct.new(
|
3013
5019
|
:catalog,
|
3014
5020
|
:client_token,
|
3015
|
-
:identifier
|
5021
|
+
:identifier,
|
5022
|
+
:tags)
|
3016
5023
|
SENSITIVE = []
|
3017
5024
|
include Aws::Structure
|
3018
5025
|
end
|
@@ -3036,6 +5043,11 @@ module Aws::PartnerCentralSelling
|
|
3036
5043
|
# Indicates the reason for task failure using an enumerated code.
|
3037
5044
|
# @return [String]
|
3038
5045
|
#
|
5046
|
+
# @!attribute [rw] resource_snapshot_job_id
|
5047
|
+
# The identifier of the Resource Snapshot Job created as part of this
|
5048
|
+
# task.
|
5049
|
+
# @return [String]
|
5050
|
+
#
|
3039
5051
|
# @!attribute [rw] start_time
|
3040
5052
|
# The timestamp indicating when the task was initiated. The format
|
3041
5053
|
# follows RFC 3339 section 5.6.
|
@@ -3062,6 +5074,7 @@ module Aws::PartnerCentralSelling
|
|
3062
5074
|
:message,
|
3063
5075
|
:opportunity_id,
|
3064
5076
|
:reason_code,
|
5077
|
+
:resource_snapshot_job_id,
|
3065
5078
|
:start_time,
|
3066
5079
|
:task_arn,
|
3067
5080
|
:task_id,
|
@@ -3097,17 +5110,32 @@ module Aws::PartnerCentralSelling
|
|
3097
5110
|
# to the correct opportunity.
|
3098
5111
|
# @return [String]
|
3099
5112
|
#
|
5113
|
+
# @!attribute [rw] tags
|
5114
|
+
# A list of objects specifying each tag name and value.
|
5115
|
+
# @return [Array<Types::Tag>]
|
5116
|
+
#
|
3100
5117
|
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/StartEngagementFromOpportunityTaskRequest AWS API Documentation
|
3101
5118
|
#
|
3102
5119
|
class StartEngagementFromOpportunityTaskRequest < Struct.new(
|
3103
5120
|
:aws_submission,
|
3104
5121
|
:catalog,
|
3105
5122
|
:client_token,
|
3106
|
-
:identifier
|
5123
|
+
:identifier,
|
5124
|
+
:tags)
|
3107
5125
|
SENSITIVE = []
|
3108
5126
|
include Aws::Structure
|
3109
5127
|
end
|
3110
5128
|
|
5129
|
+
# @!attribute [rw] engagement_id
|
5130
|
+
# The identifier of the newly created Engagement. Only populated if
|
5131
|
+
# TaskStatus is COMPLETE.
|
5132
|
+
# @return [String]
|
5133
|
+
#
|
5134
|
+
# @!attribute [rw] engagement_invitation_id
|
5135
|
+
# The identifier of the new Engagement invitation. Only populated if
|
5136
|
+
# TaskStatus is COMPLETE.
|
5137
|
+
# @return [String]
|
5138
|
+
#
|
3111
5139
|
# @!attribute [rw] message
|
3112
5140
|
# If the task fails, this field contains a detailed message describing
|
3113
5141
|
# the failure and possible recovery steps.
|
@@ -3123,6 +5151,12 @@ module Aws::PartnerCentralSelling
|
|
3123
5151
|
# Indicates the reason for task failure using an enumerated code.
|
3124
5152
|
# @return [String]
|
3125
5153
|
#
|
5154
|
+
# @!attribute [rw] resource_snapshot_job_id
|
5155
|
+
# The identifier of the resource snapshot job created to add the
|
5156
|
+
# opportunity resource snapshot to the Engagement. Only populated if
|
5157
|
+
# TaskStatus is COMPLETE
|
5158
|
+
# @return [String]
|
5159
|
+
#
|
3126
5160
|
# @!attribute [rw] start_time
|
3127
5161
|
# The timestamp indicating when the task was initiated. The format
|
3128
5162
|
# follows RFC 3339 section 5.6.
|
@@ -3147,9 +5181,12 @@ module Aws::PartnerCentralSelling
|
|
3147
5181
|
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/StartEngagementFromOpportunityTaskResponse AWS API Documentation
|
3148
5182
|
#
|
3149
5183
|
class StartEngagementFromOpportunityTaskResponse < Struct.new(
|
5184
|
+
:engagement_id,
|
5185
|
+
:engagement_invitation_id,
|
3150
5186
|
:message,
|
3151
5187
|
:opportunity_id,
|
3152
5188
|
:reason_code,
|
5189
|
+
:resource_snapshot_job_id,
|
3153
5190
|
:start_time,
|
3154
5191
|
:task_arn,
|
3155
5192
|
:task_id,
|
@@ -3158,6 +5195,138 @@ module Aws::PartnerCentralSelling
|
|
3158
5195
|
include Aws::Structure
|
3159
5196
|
end
|
3160
5197
|
|
5198
|
+
# @!attribute [rw] catalog
|
5199
|
+
# Specifies the catalog related to the request. Valid values are:
|
5200
|
+
#
|
5201
|
+
# * AWS: Starts the request from the production AWS environment.
|
5202
|
+
#
|
5203
|
+
# * Sandbox: Starts the request from a sandbox environment used for
|
5204
|
+
# testing or development purposes.
|
5205
|
+
# @return [String]
|
5206
|
+
#
|
5207
|
+
# @!attribute [rw] resource_snapshot_job_identifier
|
5208
|
+
# The identifier of the resource snapshot job to start.
|
5209
|
+
# @return [String]
|
5210
|
+
#
|
5211
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/StartResourceSnapshotJobRequest AWS API Documentation
|
5212
|
+
#
|
5213
|
+
class StartResourceSnapshotJobRequest < Struct.new(
|
5214
|
+
:catalog,
|
5215
|
+
:resource_snapshot_job_identifier)
|
5216
|
+
SENSITIVE = []
|
5217
|
+
include Aws::Structure
|
5218
|
+
end
|
5219
|
+
|
5220
|
+
# @!attribute [rw] catalog
|
5221
|
+
# Specifies the catalog related to the request. Valid values are:
|
5222
|
+
#
|
5223
|
+
# * AWS: Stops the request from the production AWS environment.
|
5224
|
+
#
|
5225
|
+
# * Sandbox: Stops the request from a sandbox environment used for
|
5226
|
+
# testing or development purposes.
|
5227
|
+
# @return [String]
|
5228
|
+
#
|
5229
|
+
# @!attribute [rw] resource_snapshot_job_identifier
|
5230
|
+
# The identifier of the job to stop.
|
5231
|
+
# @return [String]
|
5232
|
+
#
|
5233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/StopResourceSnapshotJobRequest AWS API Documentation
|
5234
|
+
#
|
5235
|
+
class StopResourceSnapshotJobRequest < Struct.new(
|
5236
|
+
:catalog,
|
5237
|
+
:resource_snapshot_job_identifier)
|
5238
|
+
SENSITIVE = []
|
5239
|
+
include Aws::Structure
|
5240
|
+
end
|
5241
|
+
|
5242
|
+
# @!attribute [rw] catalog
|
5243
|
+
# Specifies the catalog related to the request. Valid values are:
|
5244
|
+
#
|
5245
|
+
# * AWS: Submits the opportunity request from the production AWS
|
5246
|
+
# environment.
|
5247
|
+
#
|
5248
|
+
# * Sandbox: Submits the opportunity request from a sandbox
|
5249
|
+
# environment used for testing or development purposes.
|
5250
|
+
# @return [String]
|
5251
|
+
#
|
5252
|
+
# @!attribute [rw] identifier
|
5253
|
+
# The identifier of the Opportunity previously created by partner and
|
5254
|
+
# needs to be submitted.
|
5255
|
+
# @return [String]
|
5256
|
+
#
|
5257
|
+
# @!attribute [rw] involvement_type
|
5258
|
+
# Specifies the level of AWS sellers' involvement on the opportunity.
|
5259
|
+
# Valid values:
|
5260
|
+
#
|
5261
|
+
# * `Co-sell`: Indicates the user wants to co-sell with AWS. Share the
|
5262
|
+
# opportunity with AWS to receive deal assistance and support.
|
5263
|
+
#
|
5264
|
+
# * `For Visibility Only`: Indicates that the user does not need
|
5265
|
+
# support from AWS Sales Rep. Share this opportunity with AWS for
|
5266
|
+
# visibility only, you will not receive deal assistance and support.
|
5267
|
+
# @return [String]
|
5268
|
+
#
|
5269
|
+
# @!attribute [rw] visibility
|
5270
|
+
# Determines whether to restrict visibility of the opportunity from
|
5271
|
+
# AWS sales. Default value is Full. Valid values:
|
5272
|
+
#
|
5273
|
+
# * `Full`: The opportunity is fully visible to AWS sales.
|
5274
|
+
#
|
5275
|
+
# * `Limited`: The opportunity has restricted visibility to AWS sales.
|
5276
|
+
# @return [String]
|
5277
|
+
#
|
5278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/SubmitOpportunityRequest AWS API Documentation
|
5279
|
+
#
|
5280
|
+
class SubmitOpportunityRequest < Struct.new(
|
5281
|
+
:catalog,
|
5282
|
+
:identifier,
|
5283
|
+
:involvement_type,
|
5284
|
+
:visibility)
|
5285
|
+
SENSITIVE = []
|
5286
|
+
include Aws::Structure
|
5287
|
+
end
|
5288
|
+
|
5289
|
+
# The key-value pair assigned to a specified resource.
|
5290
|
+
#
|
5291
|
+
# @!attribute [rw] key
|
5292
|
+
# The key in the tag.
|
5293
|
+
# @return [String]
|
5294
|
+
#
|
5295
|
+
# @!attribute [rw] value
|
5296
|
+
# The value in the tag.
|
5297
|
+
# @return [String]
|
5298
|
+
#
|
5299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/Tag AWS API Documentation
|
5300
|
+
#
|
5301
|
+
class Tag < Struct.new(
|
5302
|
+
:key,
|
5303
|
+
:value)
|
5304
|
+
SENSITIVE = []
|
5305
|
+
include Aws::Structure
|
5306
|
+
end
|
5307
|
+
|
5308
|
+
# @!attribute [rw] resource_arn
|
5309
|
+
# The Amazon Resource Name (ARN) of the resource that you want to tag.
|
5310
|
+
# @return [String]
|
5311
|
+
#
|
5312
|
+
# @!attribute [rw] tags
|
5313
|
+
# A map of the key-value pairs of the tag or tags to assign to the
|
5314
|
+
# resource.
|
5315
|
+
# @return [Array<Types::Tag>]
|
5316
|
+
#
|
5317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/TagResourceRequest AWS API Documentation
|
5318
|
+
#
|
5319
|
+
class TagResourceRequest < Struct.new(
|
5320
|
+
:resource_arn,
|
5321
|
+
:tags)
|
5322
|
+
SENSITIVE = []
|
5323
|
+
include Aws::Structure
|
5324
|
+
end
|
5325
|
+
|
5326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/TagResourceResponse AWS API Documentation
|
5327
|
+
#
|
5328
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
5329
|
+
|
3161
5330
|
# This error occurs when there are too many requests sent. Review the
|
3162
5331
|
# provided quotas and adapt your usage to avoid throttling.
|
3163
5332
|
#
|
@@ -3179,6 +5348,29 @@ module Aws::PartnerCentralSelling
|
|
3179
5348
|
include Aws::Structure
|
3180
5349
|
end
|
3181
5350
|
|
5351
|
+
# @!attribute [rw] resource_arn
|
5352
|
+
# The Amazon Resource Name (ARN) of the resource that you want to
|
5353
|
+
# untag.
|
5354
|
+
# @return [String]
|
5355
|
+
#
|
5356
|
+
# @!attribute [rw] tag_keys
|
5357
|
+
# The keys of the key-value pairs for the tag or tags you want to
|
5358
|
+
# remove from the specified resource.
|
5359
|
+
# @return [Array<String>]
|
5360
|
+
#
|
5361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/UntagResourceRequest AWS API Documentation
|
5362
|
+
#
|
5363
|
+
class UntagResourceRequest < Struct.new(
|
5364
|
+
:resource_arn,
|
5365
|
+
:tag_keys)
|
5366
|
+
SENSITIVE = []
|
5367
|
+
include Aws::Structure
|
5368
|
+
end
|
5369
|
+
|
5370
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/UntagResourceResponse AWS API Documentation
|
5371
|
+
#
|
5372
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
5373
|
+
|
3182
5374
|
# @!attribute [rw] catalog
|
3183
5375
|
# Specifies the catalog associated with the request. This field takes
|
3184
5376
|
# a string value from a predefined list: `AWS` or `Sandbox`. The
|
@@ -3280,13 +5472,6 @@ module Aws::PartnerCentralSelling
|
|
3280
5472
|
# * Cosell—Support for Public Tender/RFx: Opportunity related to the
|
3281
5473
|
# public sector where the partner needs RFx support from Amazon Web
|
3282
5474
|
# Services.
|
3283
|
-
#
|
3284
|
-
# * Do Not Need Support from AWS Sales Rep: Indicates that a partner
|
3285
|
-
# doesn't need support from an Amazon Web Services Sales
|
3286
|
-
# representative. The opportunity is managed solely by the partner.
|
3287
|
-
# It's possible to request coselling support on these opportunities
|
3288
|
-
# at any stage during their lifecycle. Also known as,
|
3289
|
-
# for-visibility-only (FVO) opportunity.
|
3290
5475
|
# @return [Array<String>]
|
3291
5476
|
#
|
3292
5477
|
# @!attribute [rw] project
|