aws-sdk-partnercentralselling 1.19.0 → 1.20.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 +9 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-partnercentralselling/client.rb +554 -20
- data/lib/aws-sdk-partnercentralselling/client_api.rb +289 -13
- data/lib/aws-sdk-partnercentralselling/errors.rb +5 -0
- data/lib/aws-sdk-partnercentralselling/types.rb +963 -14
- data/lib/aws-sdk-partnercentralselling.rb +1 -1
- data/sig/client.rbs +245 -8
- data/sig/errors.rbs +1 -0
- data/sig/types.rbs +208 -15
- metadata +1 -1
|
@@ -42,10 +42,15 @@ module Aws::PartnerCentralSelling
|
|
|
42
42
|
# @!attribute [rw] message
|
|
43
43
|
# @return [String]
|
|
44
44
|
#
|
|
45
|
+
# @!attribute [rw] reason
|
|
46
|
+
# The reason why access was denied for the requested operation.
|
|
47
|
+
# @return [String]
|
|
48
|
+
#
|
|
45
49
|
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/AccessDeniedException AWS API Documentation
|
|
46
50
|
#
|
|
47
51
|
class AccessDeniedException < Struct.new(
|
|
48
|
-
:message
|
|
52
|
+
:message,
|
|
53
|
+
:reason)
|
|
49
54
|
SENSITIVE = []
|
|
50
55
|
include Aws::Structure
|
|
51
56
|
end
|
|
@@ -331,6 +336,13 @@ module Aws::PartnerCentralSelling
|
|
|
331
336
|
# by referencing the associated email address.
|
|
332
337
|
# @return [String]
|
|
333
338
|
#
|
|
339
|
+
# @!attribute [rw] phone
|
|
340
|
+
# Specifies the contact phone number of the assignee responsible for
|
|
341
|
+
# the opportunity or engagement. This field enables direct
|
|
342
|
+
# communication for time-sensitive matters and facilitates
|
|
343
|
+
# coordination between AWS and partner teams.
|
|
344
|
+
# @return [String]
|
|
345
|
+
#
|
|
334
346
|
# @!attribute [rw] business_title
|
|
335
347
|
# Specifies the business title of the assignee managing the
|
|
336
348
|
# opportunity. This helps clarify the individual's role and
|
|
@@ -344,8 +356,9 @@ module Aws::PartnerCentralSelling
|
|
|
344
356
|
:email,
|
|
345
357
|
:first_name,
|
|
346
358
|
:last_name,
|
|
359
|
+
:phone,
|
|
347
360
|
:business_title)
|
|
348
|
-
SENSITIVE = [:email, :first_name, :last_name, :business_title]
|
|
361
|
+
SENSITIVE = [:email, :first_name, :last_name, :phone, :business_title]
|
|
349
362
|
include Aws::Structure
|
|
350
363
|
end
|
|
351
364
|
|
|
@@ -642,6 +655,94 @@ module Aws::PartnerCentralSelling
|
|
|
642
655
|
include Aws::Structure
|
|
643
656
|
end
|
|
644
657
|
|
|
658
|
+
# @!attribute [rw] catalog
|
|
659
|
+
# Specifies the catalog associated with the engagement context
|
|
660
|
+
# request. This field takes a string value from a predefined list:
|
|
661
|
+
# `AWS` or `Sandbox`. The catalog determines which environment the
|
|
662
|
+
# engagement context is created in. Use `AWS` to create contexts in
|
|
663
|
+
# the production environment, and `Sandbox` for testing in secure,
|
|
664
|
+
# isolated environments.
|
|
665
|
+
# @return [String]
|
|
666
|
+
#
|
|
667
|
+
# @!attribute [rw] engagement_identifier
|
|
668
|
+
# The unique identifier of the `Engagement` for which the context is
|
|
669
|
+
# being created. This parameter ensures the context is associated with
|
|
670
|
+
# the correct engagement and provides the necessary linkage between
|
|
671
|
+
# the engagement and its contextual information.
|
|
672
|
+
# @return [String]
|
|
673
|
+
#
|
|
674
|
+
# @!attribute [rw] client_token
|
|
675
|
+
# A unique, case-sensitive identifier provided by the client to ensure
|
|
676
|
+
# that the request is handled exactly once. This token helps prevent
|
|
677
|
+
# duplicate context creations and must not exceed sixty-four
|
|
678
|
+
# alphanumeric characters. Use a UUID or other unique string to ensure
|
|
679
|
+
# idempotency.
|
|
680
|
+
#
|
|
681
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
682
|
+
# not need to pass this option.
|
|
683
|
+
# @return [String]
|
|
684
|
+
#
|
|
685
|
+
# @!attribute [rw] type
|
|
686
|
+
# Specifies the type of context being created for the engagement. This
|
|
687
|
+
# field determines the structure and content of the context payload.
|
|
688
|
+
# Valid values include `CustomerProject` for customer project-related
|
|
689
|
+
# contexts. The type field ensures that the context is properly
|
|
690
|
+
# categorized and processed according to its intended purpose.
|
|
691
|
+
# @return [String]
|
|
692
|
+
#
|
|
693
|
+
# @!attribute [rw] payload
|
|
694
|
+
# Represents the payload of an Engagement context. The structure of
|
|
695
|
+
# this payload varies based on the context type specified in the
|
|
696
|
+
# EngagementContextDetails.
|
|
697
|
+
# @return [Types::EngagementContextPayload]
|
|
698
|
+
#
|
|
699
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CreateEngagementContextRequest AWS API Documentation
|
|
700
|
+
#
|
|
701
|
+
class CreateEngagementContextRequest < Struct.new(
|
|
702
|
+
:catalog,
|
|
703
|
+
:engagement_identifier,
|
|
704
|
+
:client_token,
|
|
705
|
+
:type,
|
|
706
|
+
:payload)
|
|
707
|
+
SENSITIVE = []
|
|
708
|
+
include Aws::Structure
|
|
709
|
+
end
|
|
710
|
+
|
|
711
|
+
# @!attribute [rw] engagement_id
|
|
712
|
+
# The unique identifier of the engagement to which the context was
|
|
713
|
+
# added. This ID confirms the successful association of the context
|
|
714
|
+
# with the specified engagement.
|
|
715
|
+
# @return [String]
|
|
716
|
+
#
|
|
717
|
+
# @!attribute [rw] engagement_arn
|
|
718
|
+
# The Amazon Resource Name (ARN) of the engagement to which the
|
|
719
|
+
# context was added. This globally unique identifier can be used for
|
|
720
|
+
# cross-service references and IAM policies.
|
|
721
|
+
# @return [String]
|
|
722
|
+
#
|
|
723
|
+
# @!attribute [rw] engagement_last_modified_at
|
|
724
|
+
# The timestamp indicating when the engagement was last modified as a
|
|
725
|
+
# result of adding the context, in ISO 8601 format (UTC). Example:
|
|
726
|
+
# "2023-05-01T20:37:46Z".
|
|
727
|
+
# @return [Time]
|
|
728
|
+
#
|
|
729
|
+
# @!attribute [rw] context_id
|
|
730
|
+
# The unique identifier assigned to the newly created engagement
|
|
731
|
+
# context. This ID can be used to reference the specific context
|
|
732
|
+
# within the engagement for future operations.
|
|
733
|
+
# @return [String]
|
|
734
|
+
#
|
|
735
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CreateEngagementContextResponse AWS API Documentation
|
|
736
|
+
#
|
|
737
|
+
class CreateEngagementContextResponse < Struct.new(
|
|
738
|
+
:engagement_id,
|
|
739
|
+
:engagement_arn,
|
|
740
|
+
:engagement_last_modified_at,
|
|
741
|
+
:context_id)
|
|
742
|
+
SENSITIVE = []
|
|
743
|
+
include Aws::Structure
|
|
744
|
+
end
|
|
745
|
+
|
|
645
746
|
# @!attribute [rw] catalog
|
|
646
747
|
# Specifies the catalog related to the engagement. Accepted values are
|
|
647
748
|
# `AWS` and `Sandbox`, which determine the environment in which the
|
|
@@ -765,11 +866,18 @@ module Aws::PartnerCentralSelling
|
|
|
765
866
|
# The Amazon Resource Name (ARN) that identifies the engagement.
|
|
766
867
|
# @return [String]
|
|
767
868
|
#
|
|
869
|
+
# @!attribute [rw] modified_at
|
|
870
|
+
# The timestamp indicating when the engagement was last modified, in
|
|
871
|
+
# ISO 8601 format (UTC). For newly created engagements, this value
|
|
872
|
+
# matches the creation timestamp. Example: "2023-05-01T20:37:46Z".
|
|
873
|
+
# @return [Time]
|
|
874
|
+
#
|
|
768
875
|
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/CreateEngagementResponse AWS API Documentation
|
|
769
876
|
#
|
|
770
877
|
class CreateEngagementResponse < Struct.new(
|
|
771
878
|
:id,
|
|
772
|
-
:arn
|
|
879
|
+
:arn,
|
|
880
|
+
:modified_at)
|
|
773
881
|
SENSITIVE = []
|
|
774
882
|
include Aws::Structure
|
|
775
883
|
end
|
|
@@ -1266,6 +1374,11 @@ module Aws::PartnerCentralSelling
|
|
|
1266
1374
|
# structure allows for specifying the type of context and its associated
|
|
1267
1375
|
# payload.
|
|
1268
1376
|
#
|
|
1377
|
+
# @!attribute [rw] id
|
|
1378
|
+
# The unique identifier of the engagement context. This ID is used to
|
|
1379
|
+
# reference and manage the specific context within the engagement.
|
|
1380
|
+
# @return [String]
|
|
1381
|
+
#
|
|
1269
1382
|
# @!attribute [rw] type
|
|
1270
1383
|
# Specifies the type of Engagement context. Valid values are
|
|
1271
1384
|
# "CustomerProject" or "Document", indicating whether the context
|
|
@@ -1280,6 +1393,7 @@ module Aws::PartnerCentralSelling
|
|
|
1280
1393
|
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementContextDetails AWS API Documentation
|
|
1281
1394
|
#
|
|
1282
1395
|
class EngagementContextDetails < Struct.new(
|
|
1396
|
+
:id,
|
|
1283
1397
|
:type,
|
|
1284
1398
|
:payload)
|
|
1285
1399
|
SENSITIVE = []
|
|
@@ -1300,16 +1414,24 @@ module Aws::PartnerCentralSelling
|
|
|
1300
1414
|
# the Type in EngagementContextDetails is set to "CustomerProject".
|
|
1301
1415
|
# @return [Types::CustomerProjectsContext]
|
|
1302
1416
|
#
|
|
1417
|
+
# @!attribute [rw] lead
|
|
1418
|
+
# Contains detailed information about a lead when the context type is
|
|
1419
|
+
# "Lead". This field is present only when the Type in
|
|
1420
|
+
# EngagementContextDetails is set to "Lead".
|
|
1421
|
+
# @return [Types::LeadContext]
|
|
1422
|
+
#
|
|
1303
1423
|
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementContextPayload AWS API Documentation
|
|
1304
1424
|
#
|
|
1305
1425
|
class EngagementContextPayload < Struct.new(
|
|
1306
1426
|
:customer_project,
|
|
1427
|
+
:lead,
|
|
1307
1428
|
:unknown)
|
|
1308
1429
|
SENSITIVE = []
|
|
1309
1430
|
include Aws::Structure
|
|
1310
1431
|
include Aws::Structure::Union
|
|
1311
1432
|
|
|
1312
1433
|
class CustomerProject < EngagementContextPayload; end
|
|
1434
|
+
class Lead < EngagementContextPayload; end
|
|
1313
1435
|
class Unknown < EngagementContextPayload; end
|
|
1314
1436
|
end
|
|
1315
1437
|
|
|
@@ -1628,6 +1750,23 @@ module Aws::PartnerCentralSelling
|
|
|
1628
1750
|
# The number of members in the Engagement.
|
|
1629
1751
|
# @return [Integer]
|
|
1630
1752
|
#
|
|
1753
|
+
# @!attribute [rw] modified_at
|
|
1754
|
+
# The timestamp indicating when the engagement was last modified, in
|
|
1755
|
+
# ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z".
|
|
1756
|
+
# @return [Time]
|
|
1757
|
+
#
|
|
1758
|
+
# @!attribute [rw] modified_by
|
|
1759
|
+
# The AWS account ID of the user who last modified the engagement.
|
|
1760
|
+
# This field helps track who made the most recent changes to the
|
|
1761
|
+
# engagement.
|
|
1762
|
+
# @return [String]
|
|
1763
|
+
#
|
|
1764
|
+
# @!attribute [rw] context_types
|
|
1765
|
+
# An array of context types associated with the engagement, such as
|
|
1766
|
+
# "CustomerProject" or "Lead". This provides a quick overview of
|
|
1767
|
+
# the types of contexts included in the engagement.
|
|
1768
|
+
# @return [Array<String>]
|
|
1769
|
+
#
|
|
1631
1770
|
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/EngagementSummary AWS API Documentation
|
|
1632
1771
|
#
|
|
1633
1772
|
class EngagementSummary < Struct.new(
|
|
@@ -1636,8 +1775,11 @@ module Aws::PartnerCentralSelling
|
|
|
1636
1775
|
:title,
|
|
1637
1776
|
:created_at,
|
|
1638
1777
|
:created_by,
|
|
1639
|
-
:member_count
|
|
1640
|
-
|
|
1778
|
+
:member_count,
|
|
1779
|
+
:modified_at,
|
|
1780
|
+
:modified_by,
|
|
1781
|
+
:context_types)
|
|
1782
|
+
SENSITIVE = [:created_by, :modified_by]
|
|
1641
1783
|
include Aws::Structure
|
|
1642
1784
|
end
|
|
1643
1785
|
|
|
@@ -1710,12 +1852,6 @@ module Aws::PartnerCentralSelling
|
|
|
1710
1852
|
include Aws::Structure
|
|
1711
1853
|
end
|
|
1712
1854
|
|
|
1713
|
-
# @!attribute [rw] catalog
|
|
1714
|
-
# Specifies the catalog in which the AWS Opportunity exists. This is
|
|
1715
|
-
# the environment (e.g., `AWS` or `Sandbox`) where the opportunity is
|
|
1716
|
-
# being managed.
|
|
1717
|
-
# @return [String]
|
|
1718
|
-
#
|
|
1719
1855
|
# @!attribute [rw] related_opportunity_id
|
|
1720
1856
|
# Provides the unique identifier of the related partner opportunity,
|
|
1721
1857
|
# allowing partners to link the AWS Opportunity to their corresponding
|
|
@@ -1785,10 +1921,15 @@ module Aws::PartnerCentralSelling
|
|
|
1785
1921
|
# understanding the broader context of the opportunity.
|
|
1786
1922
|
# @return [Types::AwsOpportunityProject]
|
|
1787
1923
|
#
|
|
1924
|
+
# @!attribute [rw] catalog
|
|
1925
|
+
# Specifies the catalog in which the AWS Opportunity exists. This is
|
|
1926
|
+
# the environment (e.g., `AWS` or `Sandbox`) where the opportunity is
|
|
1927
|
+
# being managed.
|
|
1928
|
+
# @return [String]
|
|
1929
|
+
#
|
|
1788
1930
|
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/GetAwsOpportunitySummaryResponse AWS API Documentation
|
|
1789
1931
|
#
|
|
1790
1932
|
class GetAwsOpportunitySummaryResponse < Struct.new(
|
|
1791
|
-
:catalog,
|
|
1792
1933
|
:related_opportunity_id,
|
|
1793
1934
|
:origin,
|
|
1794
1935
|
:involvement_type,
|
|
@@ -1799,7 +1940,8 @@ module Aws::PartnerCentralSelling
|
|
|
1799
1940
|
:involvement_type_change_reason,
|
|
1800
1941
|
:related_entity_ids,
|
|
1801
1942
|
:customer,
|
|
1802
|
-
:project
|
|
1943
|
+
:project,
|
|
1944
|
+
:catalog)
|
|
1803
1945
|
SENSITIVE = []
|
|
1804
1946
|
include Aws::Structure
|
|
1805
1947
|
end
|
|
@@ -1993,6 +2135,18 @@ module Aws::PartnerCentralSelling
|
|
|
1993
2135
|
# their roles or permissions within the Engagement.
|
|
1994
2136
|
# @return [Integer]
|
|
1995
2137
|
#
|
|
2138
|
+
# @!attribute [rw] modified_at
|
|
2139
|
+
# The timestamp indicating when the engagement was last modified, in
|
|
2140
|
+
# ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z". This helps
|
|
2141
|
+
# track the most recent changes to the engagement.
|
|
2142
|
+
# @return [Time]
|
|
2143
|
+
#
|
|
2144
|
+
# @!attribute [rw] modified_by
|
|
2145
|
+
# The AWS account ID of the user who last modified the engagement.
|
|
2146
|
+
# This field helps track who made the most recent changes to the
|
|
2147
|
+
# engagement.
|
|
2148
|
+
# @return [String]
|
|
2149
|
+
#
|
|
1996
2150
|
# @!attribute [rw] contexts
|
|
1997
2151
|
# A list of context objects associated with the engagement. Each
|
|
1998
2152
|
# context provides additional information related to the Engagement,
|
|
@@ -2009,8 +2163,10 @@ module Aws::PartnerCentralSelling
|
|
|
2009
2163
|
:created_at,
|
|
2010
2164
|
:created_by,
|
|
2011
2165
|
:member_count,
|
|
2166
|
+
:modified_at,
|
|
2167
|
+
:modified_by,
|
|
2012
2168
|
:contexts)
|
|
2013
|
-
SENSITIVE = [:created_by]
|
|
2169
|
+
SENSITIVE = [:created_by, :modified_by]
|
|
2014
2170
|
include Aws::Structure
|
|
2015
2171
|
end
|
|
2016
2172
|
|
|
@@ -2532,6 +2688,331 @@ module Aws::PartnerCentralSelling
|
|
|
2532
2688
|
include Aws::Structure
|
|
2533
2689
|
end
|
|
2534
2690
|
|
|
2691
|
+
# An object that contains a lead contact's details associated with the
|
|
2692
|
+
# engagement. This provides contact information for individuals involved
|
|
2693
|
+
# in lead-related activities.
|
|
2694
|
+
#
|
|
2695
|
+
# @!attribute [rw] business_title
|
|
2696
|
+
# The lead contact's business title or job role associated with the
|
|
2697
|
+
# engagement.
|
|
2698
|
+
# @return [String]
|
|
2699
|
+
#
|
|
2700
|
+
# @!attribute [rw] email
|
|
2701
|
+
# The lead contact's email address associated with the engagement.
|
|
2702
|
+
# @return [String]
|
|
2703
|
+
#
|
|
2704
|
+
# @!attribute [rw] first_name
|
|
2705
|
+
# The lead contact's first name associated with the engagement.
|
|
2706
|
+
# @return [String]
|
|
2707
|
+
#
|
|
2708
|
+
# @!attribute [rw] last_name
|
|
2709
|
+
# The lead contact's last name associated with the engagement.
|
|
2710
|
+
# @return [String]
|
|
2711
|
+
#
|
|
2712
|
+
# @!attribute [rw] phone
|
|
2713
|
+
# The lead contact's phone number associated with the engagement.
|
|
2714
|
+
# @return [String]
|
|
2715
|
+
#
|
|
2716
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/LeadContact AWS API Documentation
|
|
2717
|
+
#
|
|
2718
|
+
class LeadContact < Struct.new(
|
|
2719
|
+
:business_title,
|
|
2720
|
+
:email,
|
|
2721
|
+
:first_name,
|
|
2722
|
+
:last_name,
|
|
2723
|
+
:phone)
|
|
2724
|
+
SENSITIVE = [:business_title, :email, :first_name, :last_name, :phone]
|
|
2725
|
+
include Aws::Structure
|
|
2726
|
+
end
|
|
2727
|
+
|
|
2728
|
+
# Provides comprehensive details about a lead associated with an
|
|
2729
|
+
# engagement. This structure contains information about lead
|
|
2730
|
+
# qualification status, customer details, and interaction history to
|
|
2731
|
+
# facilitate lead management and tracking within the engagement.
|
|
2732
|
+
#
|
|
2733
|
+
# @!attribute [rw] qualification_status
|
|
2734
|
+
# Indicates the current qualification status of the lead, such as
|
|
2735
|
+
# whether it has been qualified, disqualified, or is still under
|
|
2736
|
+
# evaluation. This helps track the lead's progression through the
|
|
2737
|
+
# qualification process.
|
|
2738
|
+
# @return [String]
|
|
2739
|
+
#
|
|
2740
|
+
# @!attribute [rw] customer
|
|
2741
|
+
# Contains detailed information about the customer associated with the
|
|
2742
|
+
# lead, including company information, contact details, and other
|
|
2743
|
+
# relevant customer data.
|
|
2744
|
+
# @return [Types::LeadCustomer]
|
|
2745
|
+
#
|
|
2746
|
+
# @!attribute [rw] interactions
|
|
2747
|
+
# An array of interactions that have occurred with the lead, providing
|
|
2748
|
+
# a history of communications, meetings, and other engagement
|
|
2749
|
+
# activities related to the lead.
|
|
2750
|
+
# @return [Array<Types::LeadInteraction>]
|
|
2751
|
+
#
|
|
2752
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/LeadContext AWS API Documentation
|
|
2753
|
+
#
|
|
2754
|
+
class LeadContext < Struct.new(
|
|
2755
|
+
:qualification_status,
|
|
2756
|
+
:customer,
|
|
2757
|
+
:interactions)
|
|
2758
|
+
SENSITIVE = []
|
|
2759
|
+
include Aws::Structure
|
|
2760
|
+
end
|
|
2761
|
+
|
|
2762
|
+
# Contains detailed information about the customer associated with the
|
|
2763
|
+
# lead, including company details, industry classification, and AWS
|
|
2764
|
+
# maturity level. This information helps qualify and categorize the lead
|
|
2765
|
+
# for appropriate engagement strategies.
|
|
2766
|
+
#
|
|
2767
|
+
# @!attribute [rw] industry
|
|
2768
|
+
# Specifies the industry sector to which the lead customer's company
|
|
2769
|
+
# belongs. This categorization helps in understanding the customer's
|
|
2770
|
+
# business context and tailoring appropriate solutions.
|
|
2771
|
+
# @return [String]
|
|
2772
|
+
#
|
|
2773
|
+
# @!attribute [rw] company_name
|
|
2774
|
+
# The name of the lead customer's company. This field is essential
|
|
2775
|
+
# for identifying and tracking the customer organization associated
|
|
2776
|
+
# with the lead.
|
|
2777
|
+
# @return [String]
|
|
2778
|
+
#
|
|
2779
|
+
# @!attribute [rw] website_url
|
|
2780
|
+
# The website URL of the lead customer's company. This provides
|
|
2781
|
+
# additional context about the customer organization and helps verify
|
|
2782
|
+
# company legitimacy and size.
|
|
2783
|
+
# @return [String]
|
|
2784
|
+
#
|
|
2785
|
+
# @!attribute [rw] address
|
|
2786
|
+
# An object that contains an `Address` object's subset of fields.
|
|
2787
|
+
# @return [Types::AddressSummary]
|
|
2788
|
+
#
|
|
2789
|
+
# @!attribute [rw] aws_maturity
|
|
2790
|
+
# Indicates the customer's level of experience and adoption with AWS
|
|
2791
|
+
# services. This assessment helps determine the appropriate engagement
|
|
2792
|
+
# approach and solution complexity.
|
|
2793
|
+
# @return [String]
|
|
2794
|
+
#
|
|
2795
|
+
# @!attribute [rw] market_segment
|
|
2796
|
+
# Specifies the market segment classification of the lead customer,
|
|
2797
|
+
# such as enterprise, mid-market, or small business. This segmentation
|
|
2798
|
+
# helps in targeting appropriate solutions and engagement strategies.
|
|
2799
|
+
# @return [String]
|
|
2800
|
+
#
|
|
2801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/LeadCustomer AWS API Documentation
|
|
2802
|
+
#
|
|
2803
|
+
class LeadCustomer < Struct.new(
|
|
2804
|
+
:industry,
|
|
2805
|
+
:company_name,
|
|
2806
|
+
:website_url,
|
|
2807
|
+
:address,
|
|
2808
|
+
:aws_maturity,
|
|
2809
|
+
:market_segment)
|
|
2810
|
+
SENSITIVE = [:company_name, :website_url]
|
|
2811
|
+
include Aws::Structure
|
|
2812
|
+
end
|
|
2813
|
+
|
|
2814
|
+
# Represents a specific interaction or touchpoint with a lead customer.
|
|
2815
|
+
# This structure captures details about communications, meetings, or
|
|
2816
|
+
# other engagement activities that help track the lead's progression
|
|
2817
|
+
# and engagement history.
|
|
2818
|
+
#
|
|
2819
|
+
# @!attribute [rw] source_type
|
|
2820
|
+
# Specifies the type of source that generated the lead interaction,
|
|
2821
|
+
# such as "Event", "Website", "Referral", or "Campaign". This
|
|
2822
|
+
# categorization helps track lead generation effectiveness across
|
|
2823
|
+
# different channels.
|
|
2824
|
+
# @return [String]
|
|
2825
|
+
#
|
|
2826
|
+
# @!attribute [rw] source_id
|
|
2827
|
+
# The unique identifier of the specific source that generated the lead
|
|
2828
|
+
# interaction. This ID provides traceability back to the original lead
|
|
2829
|
+
# generation activity.
|
|
2830
|
+
# @return [String]
|
|
2831
|
+
#
|
|
2832
|
+
# @!attribute [rw] source_name
|
|
2833
|
+
# The descriptive name of the source that generated the lead
|
|
2834
|
+
# interaction, providing a human-readable identifier for the lead
|
|
2835
|
+
# generation channel or activity.
|
|
2836
|
+
# @return [String]
|
|
2837
|
+
#
|
|
2838
|
+
# @!attribute [rw] usecase
|
|
2839
|
+
# Describes the specific use case or business scenario discussed
|
|
2840
|
+
# during the lead interaction. This helps categorize the customer's
|
|
2841
|
+
# interests and potential solutions.
|
|
2842
|
+
# @return [String]
|
|
2843
|
+
#
|
|
2844
|
+
# @!attribute [rw] interaction_date
|
|
2845
|
+
# The date and time when the lead interaction occurred, in ISO 8601
|
|
2846
|
+
# format (UTC). This timestamp helps track the chronology of lead
|
|
2847
|
+
# engagement activities.
|
|
2848
|
+
# @return [Time]
|
|
2849
|
+
#
|
|
2850
|
+
# @!attribute [rw] customer_action
|
|
2851
|
+
# Describes the action taken by the customer during or as a result of
|
|
2852
|
+
# the interaction, such as requesting information, scheduling a
|
|
2853
|
+
# meeting, or expressing interest in a solution.
|
|
2854
|
+
# @return [String]
|
|
2855
|
+
#
|
|
2856
|
+
# @!attribute [rw] business_problem
|
|
2857
|
+
# Describes the business problem or challenge that the customer
|
|
2858
|
+
# discussed during the interaction. This information helps qualify the
|
|
2859
|
+
# lead and identify appropriate solutions.
|
|
2860
|
+
# @return [String]
|
|
2861
|
+
#
|
|
2862
|
+
# @!attribute [rw] contact
|
|
2863
|
+
# Contains contact information for the customer representative
|
|
2864
|
+
# involved in the lead interaction, including their name, title, and
|
|
2865
|
+
# contact details.
|
|
2866
|
+
# @return [Types::LeadContact]
|
|
2867
|
+
#
|
|
2868
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/LeadInteraction AWS API Documentation
|
|
2869
|
+
#
|
|
2870
|
+
class LeadInteraction < Struct.new(
|
|
2871
|
+
:source_type,
|
|
2872
|
+
:source_id,
|
|
2873
|
+
:source_name,
|
|
2874
|
+
:usecase,
|
|
2875
|
+
:interaction_date,
|
|
2876
|
+
:customer_action,
|
|
2877
|
+
:business_problem,
|
|
2878
|
+
:contact)
|
|
2879
|
+
SENSITIVE = [:business_problem]
|
|
2880
|
+
include Aws::Structure
|
|
2881
|
+
end
|
|
2882
|
+
|
|
2883
|
+
# Contains customer information included in a lead invitation payload.
|
|
2884
|
+
# This structure provides essential details about the customer to help
|
|
2885
|
+
# partners evaluate the lead opportunity and determine their interest in
|
|
2886
|
+
# engagement.
|
|
2887
|
+
#
|
|
2888
|
+
# @!attribute [rw] industry
|
|
2889
|
+
# Specifies the industry sector of the customer company associated
|
|
2890
|
+
# with the lead invitation. This categorization helps partners
|
|
2891
|
+
# understand the customer's business context and assess solution fit.
|
|
2892
|
+
# @return [String]
|
|
2893
|
+
#
|
|
2894
|
+
# @!attribute [rw] company_name
|
|
2895
|
+
# The name of the customer company associated with the lead
|
|
2896
|
+
# invitation. This field identifies the target organization for the
|
|
2897
|
+
# lead engagement opportunity.
|
|
2898
|
+
# @return [String]
|
|
2899
|
+
#
|
|
2900
|
+
# @!attribute [rw] website_url
|
|
2901
|
+
# The website URL of the customer company. This provides additional
|
|
2902
|
+
# context about the customer organization and helps partners verify
|
|
2903
|
+
# company details and assess business size and legitimacy.
|
|
2904
|
+
# @return [String]
|
|
2905
|
+
#
|
|
2906
|
+
# @!attribute [rw] country_code
|
|
2907
|
+
# The country code indicating the geographic location of the customer
|
|
2908
|
+
# company. This information helps partners understand regional
|
|
2909
|
+
# requirements and assess their ability to serve the customer
|
|
2910
|
+
# effectively.
|
|
2911
|
+
# @return [String]
|
|
2912
|
+
#
|
|
2913
|
+
# @!attribute [rw] aws_maturity
|
|
2914
|
+
# Indicates the customer's level of experience and adoption with AWS
|
|
2915
|
+
# services. This assessment helps partners understand the customer's
|
|
2916
|
+
# cloud maturity and tailor their engagement approach accordingly.
|
|
2917
|
+
# @return [String]
|
|
2918
|
+
#
|
|
2919
|
+
# @!attribute [rw] market_segment
|
|
2920
|
+
# Specifies the market segment classification of the customer, such as
|
|
2921
|
+
# enterprise, mid-market, or small business. This segmentation helps
|
|
2922
|
+
# partners determine the appropriate solution complexity and
|
|
2923
|
+
# engagement strategy.
|
|
2924
|
+
# @return [String]
|
|
2925
|
+
#
|
|
2926
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/LeadInvitationCustomer AWS API Documentation
|
|
2927
|
+
#
|
|
2928
|
+
class LeadInvitationCustomer < Struct.new(
|
|
2929
|
+
:industry,
|
|
2930
|
+
:company_name,
|
|
2931
|
+
:website_url,
|
|
2932
|
+
:country_code,
|
|
2933
|
+
:aws_maturity,
|
|
2934
|
+
:market_segment)
|
|
2935
|
+
SENSITIVE = [:company_name, :website_url, :country_code]
|
|
2936
|
+
include Aws::Structure
|
|
2937
|
+
end
|
|
2938
|
+
|
|
2939
|
+
# Represents interaction details included in a lead invitation payload.
|
|
2940
|
+
# This structure provides context about how the lead was generated and
|
|
2941
|
+
# the customer's engagement history to help partners assess the
|
|
2942
|
+
# opportunity quality.
|
|
2943
|
+
#
|
|
2944
|
+
# @!attribute [rw] source_type
|
|
2945
|
+
# Specifies the type of source that generated the lead interaction,
|
|
2946
|
+
# such as "Event", "Website", or "Campaign". This helps partners
|
|
2947
|
+
# understand the lead generation channel and assess lead quality based
|
|
2948
|
+
# on the source type.
|
|
2949
|
+
# @return [String]
|
|
2950
|
+
#
|
|
2951
|
+
# @!attribute [rw] source_id
|
|
2952
|
+
# The unique identifier of the specific source that generated the lead
|
|
2953
|
+
# interaction. This provides traceability to the original lead
|
|
2954
|
+
# generation activity for reference and follow-up purposes.
|
|
2955
|
+
# @return [String]
|
|
2956
|
+
#
|
|
2957
|
+
# @!attribute [rw] source_name
|
|
2958
|
+
# The descriptive name of the source that generated the lead
|
|
2959
|
+
# interaction. This human-readable identifier helps partners
|
|
2960
|
+
# understand the specific lead generation channel or campaign that
|
|
2961
|
+
# created the opportunity.
|
|
2962
|
+
# @return [String]
|
|
2963
|
+
#
|
|
2964
|
+
# @!attribute [rw] usecase
|
|
2965
|
+
# Describes the specific use case or business scenario associated with
|
|
2966
|
+
# the lead interaction. This information helps partners understand the
|
|
2967
|
+
# customer's interests and potential solution requirements.
|
|
2968
|
+
# @return [String]
|
|
2969
|
+
#
|
|
2970
|
+
# @!attribute [rw] contact_business_title
|
|
2971
|
+
# The business title or job role of the customer contact involved in
|
|
2972
|
+
# the lead interaction. This helps partners identify the
|
|
2973
|
+
# decision-making level and engagement approach for the lead.
|
|
2974
|
+
# @return [String]
|
|
2975
|
+
#
|
|
2976
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/LeadInvitationInteraction AWS API Documentation
|
|
2977
|
+
#
|
|
2978
|
+
class LeadInvitationInteraction < Struct.new(
|
|
2979
|
+
:source_type,
|
|
2980
|
+
:source_id,
|
|
2981
|
+
:source_name,
|
|
2982
|
+
:usecase,
|
|
2983
|
+
:contact_business_title)
|
|
2984
|
+
SENSITIVE = [:contact_business_title]
|
|
2985
|
+
include Aws::Structure
|
|
2986
|
+
end
|
|
2987
|
+
|
|
2988
|
+
# Represents the data payload of an engagement invitation for a lead
|
|
2989
|
+
# opportunity. This contains detailed information about the customer and
|
|
2990
|
+
# interaction history that partners use to evaluate whether to accept
|
|
2991
|
+
# the lead engagement invitation.
|
|
2992
|
+
#
|
|
2993
|
+
# @!attribute [rw] customer
|
|
2994
|
+
# Contains information about the customer associated with the lead
|
|
2995
|
+
# invitation. This data helps partners understand the customer's
|
|
2996
|
+
# profile, industry, and business context to assess the lead
|
|
2997
|
+
# opportunity.
|
|
2998
|
+
# @return [Types::LeadInvitationCustomer]
|
|
2999
|
+
#
|
|
3000
|
+
# @!attribute [rw] interaction
|
|
3001
|
+
# Describes the interaction details associated with the lead,
|
|
3002
|
+
# including the source of the lead generation and customer engagement
|
|
3003
|
+
# information. This context helps partners evaluate the lead quality
|
|
3004
|
+
# and engagement approach.
|
|
3005
|
+
# @return [Types::LeadInvitationInteraction]
|
|
3006
|
+
#
|
|
3007
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/LeadInvitationPayload AWS API Documentation
|
|
3008
|
+
#
|
|
3009
|
+
class LeadInvitationPayload < Struct.new(
|
|
3010
|
+
:customer,
|
|
3011
|
+
:interaction)
|
|
3012
|
+
SENSITIVE = []
|
|
3013
|
+
include Aws::Structure
|
|
3014
|
+
end
|
|
3015
|
+
|
|
2535
3016
|
# An object that contains the `Opportunity` lifecycle's details.
|
|
2536
3017
|
#
|
|
2537
3018
|
# @!attribute [rw] stage
|
|
@@ -3438,6 +3919,20 @@ module Aws::PartnerCentralSelling
|
|
|
3438
3919
|
# exclude engagements created by specific users.
|
|
3439
3920
|
# @return [Array<String>]
|
|
3440
3921
|
#
|
|
3922
|
+
# @!attribute [rw] context_types
|
|
3923
|
+
# Filters engagements to include only those containing the specified
|
|
3924
|
+
# context types, such as "CustomerProject" or "Lead". Use this to
|
|
3925
|
+
# find engagements that have specific types of contextual information
|
|
3926
|
+
# associated with them.
|
|
3927
|
+
# @return [Array<String>]
|
|
3928
|
+
#
|
|
3929
|
+
# @!attribute [rw] exclude_context_types
|
|
3930
|
+
# Filters engagements to exclude those containing the specified
|
|
3931
|
+
# context types. Use this to find engagements that do not have certain
|
|
3932
|
+
# types of contextual information, helping to narrow results based on
|
|
3933
|
+
# context exclusion criteria.
|
|
3934
|
+
# @return [Array<String>]
|
|
3935
|
+
#
|
|
3441
3936
|
# @!attribute [rw] sort
|
|
3442
3937
|
# Specifies the sorting parameters for listing Engagements.
|
|
3443
3938
|
# @return [Types::EngagementSort]
|
|
@@ -3461,6 +3956,8 @@ module Aws::PartnerCentralSelling
|
|
|
3461
3956
|
:catalog,
|
|
3462
3957
|
:created_by,
|
|
3463
3958
|
:exclude_created_by,
|
|
3959
|
+
:context_types,
|
|
3960
|
+
:exclude_context_types,
|
|
3464
3961
|
:sort,
|
|
3465
3962
|
:max_results,
|
|
3466
3963
|
:next_token,
|
|
@@ -3585,6 +4082,183 @@ module Aws::PartnerCentralSelling
|
|
|
3585
4082
|
include Aws::Structure
|
|
3586
4083
|
end
|
|
3587
4084
|
|
|
4085
|
+
# Provides a summary of a task related to creating an opportunity from
|
|
4086
|
+
# an engagement. This structure contains key information about the
|
|
4087
|
+
# task's status, associated identifiers, and any failure details for
|
|
4088
|
+
# opportunity creation processes.
|
|
4089
|
+
#
|
|
4090
|
+
# @!attribute [rw] task_id
|
|
4091
|
+
# The unique identifier of the task for creating an opportunity from
|
|
4092
|
+
# an engagement.
|
|
4093
|
+
# @return [String]
|
|
4094
|
+
#
|
|
4095
|
+
# @!attribute [rw] task_arn
|
|
4096
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the task
|
|
4097
|
+
# within AWS. This ARN can be used for referencing the task in other
|
|
4098
|
+
# AWS services or APIs.
|
|
4099
|
+
# @return [String]
|
|
4100
|
+
#
|
|
4101
|
+
# @!attribute [rw] start_time
|
|
4102
|
+
# The timestamp indicating when the task was initiated, in RFC 3339
|
|
4103
|
+
# format.
|
|
4104
|
+
# @return [Time]
|
|
4105
|
+
#
|
|
4106
|
+
# @!attribute [rw] task_status
|
|
4107
|
+
# The current status of the task. Valid values are COMPLETE,
|
|
4108
|
+
# INPROGRESS, or FAILED.
|
|
4109
|
+
# @return [String]
|
|
4110
|
+
#
|
|
4111
|
+
# @!attribute [rw] message
|
|
4112
|
+
# A detailed message providing additional information about the task,
|
|
4113
|
+
# especially useful in case of failures. This field may contain error
|
|
4114
|
+
# details or other relevant information about the task's execution.
|
|
4115
|
+
# @return [String]
|
|
4116
|
+
#
|
|
4117
|
+
# @!attribute [rw] reason_code
|
|
4118
|
+
# A code indicating the specific reason for a task failure. This field
|
|
4119
|
+
# is populated when the task status is FAILED and provides a
|
|
4120
|
+
# categorized reason for the failure.
|
|
4121
|
+
# @return [String]
|
|
4122
|
+
#
|
|
4123
|
+
# @!attribute [rw] opportunity_id
|
|
4124
|
+
# The unique identifier of the opportunity created as a result of the
|
|
4125
|
+
# task. This field is populated when the task is completed
|
|
4126
|
+
# successfully.
|
|
4127
|
+
# @return [String]
|
|
4128
|
+
#
|
|
4129
|
+
# @!attribute [rw] resource_snapshot_job_id
|
|
4130
|
+
# The identifier of the resource snapshot job associated with this
|
|
4131
|
+
# task, if a snapshot was created as part of the opportunity creation
|
|
4132
|
+
# process.
|
|
4133
|
+
# @return [String]
|
|
4134
|
+
#
|
|
4135
|
+
# @!attribute [rw] engagement_id
|
|
4136
|
+
# The unique identifier of the engagement from which the opportunity
|
|
4137
|
+
# is being created. This field helps track the source of the
|
|
4138
|
+
# opportunity creation task.
|
|
4139
|
+
# @return [String]
|
|
4140
|
+
#
|
|
4141
|
+
# @!attribute [rw] context_id
|
|
4142
|
+
# The unique identifier of the engagement context associated with the
|
|
4143
|
+
# opportunity creation task. This links the task to specific
|
|
4144
|
+
# contextual information within the engagement.
|
|
4145
|
+
# @return [String]
|
|
4146
|
+
#
|
|
4147
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListOpportunityFromEngagementTaskSummary AWS API Documentation
|
|
4148
|
+
#
|
|
4149
|
+
class ListOpportunityFromEngagementTaskSummary < Struct.new(
|
|
4150
|
+
:task_id,
|
|
4151
|
+
:task_arn,
|
|
4152
|
+
:start_time,
|
|
4153
|
+
:task_status,
|
|
4154
|
+
:message,
|
|
4155
|
+
:reason_code,
|
|
4156
|
+
:opportunity_id,
|
|
4157
|
+
:resource_snapshot_job_id,
|
|
4158
|
+
:engagement_id,
|
|
4159
|
+
:context_id)
|
|
4160
|
+
SENSITIVE = []
|
|
4161
|
+
include Aws::Structure
|
|
4162
|
+
end
|
|
4163
|
+
|
|
4164
|
+
# @!attribute [rw] max_results
|
|
4165
|
+
# Specifies the maximum number of results to return in a single page
|
|
4166
|
+
# of the response. Use this parameter to control the number of items
|
|
4167
|
+
# returned in each request, which can be useful for performance tuning
|
|
4168
|
+
# and managing large result sets.
|
|
4169
|
+
# @return [Integer]
|
|
4170
|
+
#
|
|
4171
|
+
# @!attribute [rw] next_token
|
|
4172
|
+
# The token for requesting the next page of results. This value is
|
|
4173
|
+
# obtained from the NextToken field in the response of a previous call
|
|
4174
|
+
# to this API. Use this parameter for pagination when the result set
|
|
4175
|
+
# spans multiple pages.
|
|
4176
|
+
# @return [String]
|
|
4177
|
+
#
|
|
4178
|
+
# @!attribute [rw] sort
|
|
4179
|
+
# Defines the sorting parameters for listing tasks. This structure
|
|
4180
|
+
# allows for specifying the field to sort by and the order of sorting.
|
|
4181
|
+
# @return [Types::ListTasksSortBase]
|
|
4182
|
+
#
|
|
4183
|
+
# @!attribute [rw] catalog
|
|
4184
|
+
# Specifies the catalog related to the request. Valid values are `AWS`
|
|
4185
|
+
# for production environments and `Sandbox` for testing or development
|
|
4186
|
+
# purposes. The catalog determines which environment the task data is
|
|
4187
|
+
# retrieved from.
|
|
4188
|
+
# @return [String]
|
|
4189
|
+
#
|
|
4190
|
+
# @!attribute [rw] task_status
|
|
4191
|
+
# Filters the tasks based on their current status. This allows you to
|
|
4192
|
+
# focus on tasks in specific states. Valid values are `COMPLETE` for
|
|
4193
|
+
# tasks that have finished successfully, `INPROGRESS` for tasks that
|
|
4194
|
+
# are currently running, and `FAILED` for tasks that have encountered
|
|
4195
|
+
# an error and failed to complete.
|
|
4196
|
+
# @return [Array<String>]
|
|
4197
|
+
#
|
|
4198
|
+
# @!attribute [rw] task_identifier
|
|
4199
|
+
# Filters tasks by their unique identifiers. Use this when you want to
|
|
4200
|
+
# retrieve information about specific tasks. Provide the task ID to
|
|
4201
|
+
# get details about a particular opportunity creation task.
|
|
4202
|
+
# @return [Array<String>]
|
|
4203
|
+
#
|
|
4204
|
+
# @!attribute [rw] opportunity_identifier
|
|
4205
|
+
# Filters tasks by the identifiers of the opportunities they created
|
|
4206
|
+
# or are associated with. Use this to find tasks related to specific
|
|
4207
|
+
# opportunity creation processes.
|
|
4208
|
+
# @return [Array<String>]
|
|
4209
|
+
#
|
|
4210
|
+
# @!attribute [rw] engagement_identifier
|
|
4211
|
+
# Filters tasks by the identifiers of the engagements from which
|
|
4212
|
+
# opportunities are being created. Use this to find all opportunity
|
|
4213
|
+
# creation tasks associated with a specific engagement.
|
|
4214
|
+
# @return [Array<String>]
|
|
4215
|
+
#
|
|
4216
|
+
# @!attribute [rw] context_identifier
|
|
4217
|
+
# Filters tasks by the identifiers of the engagement contexts
|
|
4218
|
+
# associated with the opportunity creation. Use this to find tasks
|
|
4219
|
+
# related to specific contextual information within engagements that
|
|
4220
|
+
# are being converted to opportunities.
|
|
4221
|
+
# @return [Array<String>]
|
|
4222
|
+
#
|
|
4223
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListOpportunityFromEngagementTasksRequest AWS API Documentation
|
|
4224
|
+
#
|
|
4225
|
+
class ListOpportunityFromEngagementTasksRequest < Struct.new(
|
|
4226
|
+
:max_results,
|
|
4227
|
+
:next_token,
|
|
4228
|
+
:sort,
|
|
4229
|
+
:catalog,
|
|
4230
|
+
:task_status,
|
|
4231
|
+
:task_identifier,
|
|
4232
|
+
:opportunity_identifier,
|
|
4233
|
+
:engagement_identifier,
|
|
4234
|
+
:context_identifier)
|
|
4235
|
+
SENSITIVE = []
|
|
4236
|
+
include Aws::Structure
|
|
4237
|
+
end
|
|
4238
|
+
|
|
4239
|
+
# @!attribute [rw] task_summaries
|
|
4240
|
+
# An array of `ListOpportunityFromEngagementTaskSummary` objects, each
|
|
4241
|
+
# representing a task that matches the specified filters. The array
|
|
4242
|
+
# may be empty if no tasks match the criteria.
|
|
4243
|
+
# @return [Array<Types::ListOpportunityFromEngagementTaskSummary>]
|
|
4244
|
+
#
|
|
4245
|
+
# @!attribute [rw] next_token
|
|
4246
|
+
# A token used for pagination to retrieve the next page of results. If
|
|
4247
|
+
# there are more results available, this field will contain a token
|
|
4248
|
+
# that can be used in a subsequent API call to retrieve the next page.
|
|
4249
|
+
# If there are no more results, this field will be null or an empty
|
|
4250
|
+
# string.
|
|
4251
|
+
# @return [String]
|
|
4252
|
+
#
|
|
4253
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/ListOpportunityFromEngagementTasksResponse AWS API Documentation
|
|
4254
|
+
#
|
|
4255
|
+
class ListOpportunityFromEngagementTasksResponse < Struct.new(
|
|
4256
|
+
:task_summaries,
|
|
4257
|
+
:next_token)
|
|
4258
|
+
SENSITIVE = []
|
|
4259
|
+
include Aws::Structure
|
|
4260
|
+
end
|
|
4261
|
+
|
|
3588
4262
|
# @!attribute [rw] catalog
|
|
3589
4263
|
# Specifies the catalog related to the request.
|
|
3590
4264
|
# @return [String]
|
|
@@ -4170,16 +4844,25 @@ module Aws::PartnerCentralSelling
|
|
|
4170
4844
|
# from AWS.
|
|
4171
4845
|
# @return [Types::OpportunityInvitationPayload]
|
|
4172
4846
|
#
|
|
4847
|
+
# @!attribute [rw] lead_invitation
|
|
4848
|
+
# Specifies the details of the lead invitation within the Engagement
|
|
4849
|
+
# Invitation payload. This data helps partners understand the lead
|
|
4850
|
+
# context, customer information, and interaction history for the lead
|
|
4851
|
+
# opportunity from AWS.
|
|
4852
|
+
# @return [Types::LeadInvitationPayload]
|
|
4853
|
+
#
|
|
4173
4854
|
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/Payload AWS API Documentation
|
|
4174
4855
|
#
|
|
4175
4856
|
class Payload < Struct.new(
|
|
4176
4857
|
:opportunity_invitation,
|
|
4858
|
+
:lead_invitation,
|
|
4177
4859
|
:unknown)
|
|
4178
4860
|
SENSITIVE = []
|
|
4179
4861
|
include Aws::Structure
|
|
4180
4862
|
include Aws::Structure::Union
|
|
4181
4863
|
|
|
4182
4864
|
class OpportunityInvitation < Payload; end
|
|
4865
|
+
class LeadInvitation < Payload; end
|
|
4183
4866
|
class Unknown < Payload; end
|
|
4184
4867
|
end
|
|
4185
4868
|
|
|
@@ -4629,6 +5312,14 @@ module Aws::PartnerCentralSelling
|
|
|
4629
5312
|
# [1]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_ListEntities.html
|
|
4630
5313
|
# @return [Array<String>]
|
|
4631
5314
|
#
|
|
5315
|
+
# @!attribute [rw] aws_marketplace_offer_sets
|
|
5316
|
+
# Enables the association of AWS Marketplace offer sets with the
|
|
5317
|
+
# `Opportunity`. Offer sets allow grouping multiple related
|
|
5318
|
+
# marketplace offers together for comprehensive solution packaging.
|
|
5319
|
+
# Each value is an Amazon Resource Name (ARN) in this format:
|
|
5320
|
+
# `arn:aws:aws-marketplace:us-east-1:999999999999:AWSMarketplace/OfferSet/offerset-sampleOfferSet32`.
|
|
5321
|
+
# @return [Array<String>]
|
|
5322
|
+
#
|
|
4632
5323
|
# @!attribute [rw] solutions
|
|
4633
5324
|
# Enables partner solutions or offerings' association with an
|
|
4634
5325
|
# opportunity. To associate a solution, provide the solution's unique
|
|
@@ -4665,6 +5356,7 @@ module Aws::PartnerCentralSelling
|
|
|
4665
5356
|
#
|
|
4666
5357
|
class RelatedEntityIdentifiers < Struct.new(
|
|
4667
5358
|
:aws_marketplace_offers,
|
|
5359
|
+
:aws_marketplace_offer_sets,
|
|
4668
5360
|
:solutions,
|
|
4669
5361
|
:aws_products)
|
|
4670
5362
|
SENSITIVE = []
|
|
@@ -5204,6 +5896,115 @@ module Aws::PartnerCentralSelling
|
|
|
5204
5896
|
include Aws::Structure
|
|
5205
5897
|
end
|
|
5206
5898
|
|
|
5899
|
+
# @!attribute [rw] catalog
|
|
5900
|
+
# Specifies the catalog in which the opportunity creation task is
|
|
5901
|
+
# executed. Acceptable values include `AWS` for production and
|
|
5902
|
+
# `Sandbox` for testing environments.
|
|
5903
|
+
# @return [String]
|
|
5904
|
+
#
|
|
5905
|
+
# @!attribute [rw] client_token
|
|
5906
|
+
# A unique token provided by the client to help ensure the idempotency
|
|
5907
|
+
# of the request. It helps prevent the same task from being performed
|
|
5908
|
+
# multiple times.
|
|
5909
|
+
#
|
|
5910
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
5911
|
+
# not need to pass this option.
|
|
5912
|
+
# @return [String]
|
|
5913
|
+
#
|
|
5914
|
+
# @!attribute [rw] identifier
|
|
5915
|
+
# The unique identifier of the engagement from which the opportunity
|
|
5916
|
+
# creation task is to be initiated. This helps ensure that the task is
|
|
5917
|
+
# applied to the correct engagement.
|
|
5918
|
+
# @return [String]
|
|
5919
|
+
#
|
|
5920
|
+
# @!attribute [rw] context_identifier
|
|
5921
|
+
# The unique identifier of the engagement context from which to create
|
|
5922
|
+
# the opportunity. This specifies the specific contextual information
|
|
5923
|
+
# within the engagement that will be used for opportunity creation.
|
|
5924
|
+
# @return [String]
|
|
5925
|
+
#
|
|
5926
|
+
# @!attribute [rw] tags
|
|
5927
|
+
# A map of the key-value pairs of the tag or tags to assign.
|
|
5928
|
+
# @return [Array<Types::Tag>]
|
|
5929
|
+
#
|
|
5930
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/StartOpportunityFromEngagementTaskRequest AWS API Documentation
|
|
5931
|
+
#
|
|
5932
|
+
class StartOpportunityFromEngagementTaskRequest < Struct.new(
|
|
5933
|
+
:catalog,
|
|
5934
|
+
:client_token,
|
|
5935
|
+
:identifier,
|
|
5936
|
+
:context_identifier,
|
|
5937
|
+
:tags)
|
|
5938
|
+
SENSITIVE = []
|
|
5939
|
+
include Aws::Structure
|
|
5940
|
+
end
|
|
5941
|
+
|
|
5942
|
+
# @!attribute [rw] task_id
|
|
5943
|
+
# The unique identifier of the task, used to track the task's
|
|
5944
|
+
# progress.
|
|
5945
|
+
# @return [String]
|
|
5946
|
+
#
|
|
5947
|
+
# @!attribute [rw] task_arn
|
|
5948
|
+
# The Amazon Resource Name (ARN) of the task, used for tracking and
|
|
5949
|
+
# managing the task within AWS.
|
|
5950
|
+
# @return [String]
|
|
5951
|
+
#
|
|
5952
|
+
# @!attribute [rw] start_time
|
|
5953
|
+
# The timestamp indicating when the task was initiated. The format
|
|
5954
|
+
# follows RFC 3339 section 5.6.
|
|
5955
|
+
# @return [Time]
|
|
5956
|
+
#
|
|
5957
|
+
# @!attribute [rw] task_status
|
|
5958
|
+
# Indicates the current status of the task.
|
|
5959
|
+
# @return [String]
|
|
5960
|
+
#
|
|
5961
|
+
# @!attribute [rw] message
|
|
5962
|
+
# If the task fails, this field contains a detailed message describing
|
|
5963
|
+
# the failure and possible recovery steps.
|
|
5964
|
+
# @return [String]
|
|
5965
|
+
#
|
|
5966
|
+
# @!attribute [rw] reason_code
|
|
5967
|
+
# Indicates the reason for task failure using an enumerated code.
|
|
5968
|
+
# @return [String]
|
|
5969
|
+
#
|
|
5970
|
+
# @!attribute [rw] opportunity_id
|
|
5971
|
+
# The unique identifier of the opportunity created as a result of the
|
|
5972
|
+
# task. This field is populated when the task is completed
|
|
5973
|
+
# successfully.
|
|
5974
|
+
# @return [String]
|
|
5975
|
+
#
|
|
5976
|
+
# @!attribute [rw] resource_snapshot_job_id
|
|
5977
|
+
# The identifier of the resource snapshot job created as part of the
|
|
5978
|
+
# opportunity creation process.
|
|
5979
|
+
# @return [String]
|
|
5980
|
+
#
|
|
5981
|
+
# @!attribute [rw] engagement_id
|
|
5982
|
+
# The unique identifier of the engagement from which the opportunity
|
|
5983
|
+
# was created.
|
|
5984
|
+
# @return [String]
|
|
5985
|
+
#
|
|
5986
|
+
# @!attribute [rw] context_id
|
|
5987
|
+
# The unique identifier of the engagement context used to create the
|
|
5988
|
+
# opportunity.
|
|
5989
|
+
# @return [String]
|
|
5990
|
+
#
|
|
5991
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/StartOpportunityFromEngagementTaskResponse AWS API Documentation
|
|
5992
|
+
#
|
|
5993
|
+
class StartOpportunityFromEngagementTaskResponse < Struct.new(
|
|
5994
|
+
:task_id,
|
|
5995
|
+
:task_arn,
|
|
5996
|
+
:start_time,
|
|
5997
|
+
:task_status,
|
|
5998
|
+
:message,
|
|
5999
|
+
:reason_code,
|
|
6000
|
+
:opportunity_id,
|
|
6001
|
+
:resource_snapshot_job_id,
|
|
6002
|
+
:engagement_id,
|
|
6003
|
+
:context_id)
|
|
6004
|
+
SENSITIVE = []
|
|
6005
|
+
include Aws::Structure
|
|
6006
|
+
end
|
|
6007
|
+
|
|
5207
6008
|
# @!attribute [rw] catalog
|
|
5208
6009
|
# Specifies the catalog related to the request. Valid values are:
|
|
5209
6010
|
#
|
|
@@ -5379,6 +6180,149 @@ module Aws::PartnerCentralSelling
|
|
|
5379
6180
|
#
|
|
5380
6181
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
|
5381
6182
|
|
|
6183
|
+
# Represents the updated payload of an engagement context. The structure
|
|
6184
|
+
# of this payload varies based on the context type being updated.
|
|
6185
|
+
#
|
|
6186
|
+
# @note UpdateEngagementContextPayload is a union - when making an API calls you must set exactly one of the members.
|
|
6187
|
+
#
|
|
6188
|
+
# @!attribute [rw] lead
|
|
6189
|
+
# Contains updated information about a lead when the context type is
|
|
6190
|
+
# "Lead". This field is present only when updating a lead context
|
|
6191
|
+
# within the engagement.
|
|
6192
|
+
# @return [Types::UpdateLeadContext]
|
|
6193
|
+
#
|
|
6194
|
+
# @!attribute [rw] customer_project
|
|
6195
|
+
# The CustomerProjects structure in Engagements offers a flexible
|
|
6196
|
+
# framework for managing customer-project relationships. It supports
|
|
6197
|
+
# multiple customers per Engagement and multiple projects per
|
|
6198
|
+
# customer, while also allowing for customers without projects and
|
|
6199
|
+
# projects without specific customers.
|
|
6200
|
+
#
|
|
6201
|
+
# All Engagement members have full visibility of customers and their
|
|
6202
|
+
# associated projects, enabling the capture of relevant context even
|
|
6203
|
+
# when project details are not fully defined. This structure also
|
|
6204
|
+
# facilitates targeted invitations, allowing partners to focus on
|
|
6205
|
+
# specific customers and their business problems when sending
|
|
6206
|
+
# Engagement invitations.
|
|
6207
|
+
# @return [Types::CustomerProjectsContext]
|
|
6208
|
+
#
|
|
6209
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/UpdateEngagementContextPayload AWS API Documentation
|
|
6210
|
+
#
|
|
6211
|
+
class UpdateEngagementContextPayload < Struct.new(
|
|
6212
|
+
:lead,
|
|
6213
|
+
:customer_project,
|
|
6214
|
+
:unknown)
|
|
6215
|
+
SENSITIVE = []
|
|
6216
|
+
include Aws::Structure
|
|
6217
|
+
include Aws::Structure::Union
|
|
6218
|
+
|
|
6219
|
+
class Lead < UpdateEngagementContextPayload; end
|
|
6220
|
+
class CustomerProject < UpdateEngagementContextPayload; end
|
|
6221
|
+
class Unknown < UpdateEngagementContextPayload; end
|
|
6222
|
+
end
|
|
6223
|
+
|
|
6224
|
+
# @!attribute [rw] catalog
|
|
6225
|
+
# Specifies the catalog associated with the engagement context update
|
|
6226
|
+
# request. This field takes a string value from a predefined list:
|
|
6227
|
+
# `AWS` or `Sandbox`. The catalog determines which environment the
|
|
6228
|
+
# engagement context is updated in.
|
|
6229
|
+
# @return [String]
|
|
6230
|
+
#
|
|
6231
|
+
# @!attribute [rw] engagement_identifier
|
|
6232
|
+
# The unique identifier of the `Engagement` containing the context to
|
|
6233
|
+
# be updated. This parameter ensures the context update is applied to
|
|
6234
|
+
# the correct engagement.
|
|
6235
|
+
# @return [String]
|
|
6236
|
+
#
|
|
6237
|
+
# @!attribute [rw] context_identifier
|
|
6238
|
+
# The unique identifier of the specific engagement context to be
|
|
6239
|
+
# updated. This ensures that the correct context within the engagement
|
|
6240
|
+
# is modified.
|
|
6241
|
+
# @return [String]
|
|
6242
|
+
#
|
|
6243
|
+
# @!attribute [rw] engagement_last_modified_at
|
|
6244
|
+
# The timestamp when the engagement was last modified, used for
|
|
6245
|
+
# optimistic concurrency control. This helps prevent conflicts when
|
|
6246
|
+
# multiple users attempt to update the same engagement simultaneously.
|
|
6247
|
+
# @return [Time]
|
|
6248
|
+
#
|
|
6249
|
+
# @!attribute [rw] type
|
|
6250
|
+
# Specifies the type of context being updated within the engagement.
|
|
6251
|
+
# This field determines the structure and content of the context
|
|
6252
|
+
# payload being modified.
|
|
6253
|
+
# @return [String]
|
|
6254
|
+
#
|
|
6255
|
+
# @!attribute [rw] payload
|
|
6256
|
+
# Contains the updated contextual information for the engagement. The
|
|
6257
|
+
# structure of this payload varies based on the context type specified
|
|
6258
|
+
# in the Type field.
|
|
6259
|
+
# @return [Types::UpdateEngagementContextPayload]
|
|
6260
|
+
#
|
|
6261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/UpdateEngagementContextRequest AWS API Documentation
|
|
6262
|
+
#
|
|
6263
|
+
class UpdateEngagementContextRequest < Struct.new(
|
|
6264
|
+
:catalog,
|
|
6265
|
+
:engagement_identifier,
|
|
6266
|
+
:context_identifier,
|
|
6267
|
+
:engagement_last_modified_at,
|
|
6268
|
+
:type,
|
|
6269
|
+
:payload)
|
|
6270
|
+
SENSITIVE = []
|
|
6271
|
+
include Aws::Structure
|
|
6272
|
+
end
|
|
6273
|
+
|
|
6274
|
+
# @!attribute [rw] engagement_id
|
|
6275
|
+
# The unique identifier of the engagement that was updated.
|
|
6276
|
+
# @return [String]
|
|
6277
|
+
#
|
|
6278
|
+
# @!attribute [rw] engagement_arn
|
|
6279
|
+
# The Amazon Resource Name (ARN) of the updated engagement.
|
|
6280
|
+
# @return [String]
|
|
6281
|
+
#
|
|
6282
|
+
# @!attribute [rw] engagement_last_modified_at
|
|
6283
|
+
# The timestamp when the engagement context was last modified.
|
|
6284
|
+
# @return [Time]
|
|
6285
|
+
#
|
|
6286
|
+
# @!attribute [rw] context_id
|
|
6287
|
+
# The unique identifier of the engagement context that was updated.
|
|
6288
|
+
# @return [String]
|
|
6289
|
+
#
|
|
6290
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/UpdateEngagementContextResponse AWS API Documentation
|
|
6291
|
+
#
|
|
6292
|
+
class UpdateEngagementContextResponse < Struct.new(
|
|
6293
|
+
:engagement_id,
|
|
6294
|
+
:engagement_arn,
|
|
6295
|
+
:engagement_last_modified_at,
|
|
6296
|
+
:context_id)
|
|
6297
|
+
SENSITIVE = []
|
|
6298
|
+
include Aws::Structure
|
|
6299
|
+
end
|
|
6300
|
+
|
|
6301
|
+
# Updates the context information for a lead with qualification status,
|
|
6302
|
+
# customer details, and interaction data.
|
|
6303
|
+
#
|
|
6304
|
+
# @!attribute [rw] qualification_status
|
|
6305
|
+
# The updated qualification status of the lead.
|
|
6306
|
+
# @return [String]
|
|
6307
|
+
#
|
|
6308
|
+
# @!attribute [rw] customer
|
|
6309
|
+
# Updated customer information associated with the lead.
|
|
6310
|
+
# @return [Types::LeadCustomer]
|
|
6311
|
+
#
|
|
6312
|
+
# @!attribute [rw] interaction
|
|
6313
|
+
# Updated interaction details for the lead context.
|
|
6314
|
+
# @return [Types::LeadInteraction]
|
|
6315
|
+
#
|
|
6316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-selling-2022-07-26/UpdateLeadContext AWS API Documentation
|
|
6317
|
+
#
|
|
6318
|
+
class UpdateLeadContext < Struct.new(
|
|
6319
|
+
:qualification_status,
|
|
6320
|
+
:customer,
|
|
6321
|
+
:interaction)
|
|
6322
|
+
SENSITIVE = []
|
|
6323
|
+
include Aws::Structure
|
|
6324
|
+
end
|
|
6325
|
+
|
|
5382
6326
|
# @!attribute [rw] catalog
|
|
5383
6327
|
# Specifies the catalog associated with the request. This field takes
|
|
5384
6328
|
# a string value from a predefined list: `AWS` or `Sandbox`. The
|
|
@@ -5594,6 +6538,11 @@ module Aws::PartnerCentralSelling
|
|
|
5594
6538
|
#
|
|
5595
6539
|
# Fix: Reduce the number of values to match the expected limit.
|
|
5596
6540
|
#
|
|
6541
|
+
# * *NOT\_ENOUGH\_VALUES:* There are not enough values in a field that
|
|
6542
|
+
# expects more entries.
|
|
6543
|
+
#
|
|
6544
|
+
# Fix: Increase the number of values to match the expected threshold.
|
|
6545
|
+
#
|
|
5597
6546
|
# * *ACTION\_NOT\_PERMITTED:* The action isn't permitted due to current
|
|
5598
6547
|
# state or permissions.
|
|
5599
6548
|
#
|