2026/11/19 - Partner Central Selling API - 18 new 10 updated api methods
Changes Adds the Leads APIs (SearchEngagements, ListEngagementGroups), customer account APIs with statistics and bulk jobs, SearchOpportunities, opportunity bulk jobs, account planning invitations, co-sell motion reason on AWS opportunity summaries, and channel recommendations on lead insights.
Use GetCustomerAccountBulkJob to retrieve the status and record counts of a bulk job.
See also: AWS API Documentation
Request Syntax
client.get_customer_account_bulk_job(
Catalog='string',
Identifier='string'
)
string
[REQUIRED]
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
string
[REQUIRED]
Specifies the ARN or the identifier of the bulk job.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string',
'Status': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
'FileName': 'string',
'TotalRecords': 123,
'ProcessedRecords': 123,
'SuccessCount': 123,
'FailureCount': 123,
'DeletedCount': 123,
'FailureReason': 'string',
'CreatedAt': datetime(2015, 1, 1),
'CompletedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Information about get customer account bulk job response.
Arn (string) --
The Amazon Resource Name (ARN) of the bulk job.
Id (string) --
The unique identifier of the bulk job.
Status (string) --
The current status of the bulk job.
FileName (string) --
The name of the file that the job processes.
TotalRecords (integer) --
The total number of records in the file. The value is 0 until the job reads the file.
ProcessedRecords (integer) --
The number of records that the job has finished processing.
SuccessCount (integer) --
The number of records that the job processed successfully.
FailureCount (integer) --
The number of records that failed.
DeletedCount (integer) --
The number of accounts imported by this job that have since been deleted. This counter only increases, so the accounts still present equal SuccessCount minus DeletedCount.
FailureReason (string) --
The reason that the job failed. Present only when the job status is FAILED.
CreatedAt (datetime) --
The date and time when the bulk job was created.
CompletedAt (datetime) --
The date and time when the job finished. Absent while the job is running.
Use GetCustomerAccount to retrieve the details of a customer account, including the customer information that you provided, the enrichment status, and the enrichment information that AWS provides when the status is ENRICHED.
See also: AWS API Documentation
Request Syntax
client.get_customer_account(
Catalog='string',
Identifier='string'
)
string
[REQUIRED]
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
string
[REQUIRED]
Specifies the ARN or the identifier of the customer account.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string',
'Catalog': 'string',
'EnrichmentStatus': 'PENDING'|'ENRICHED'|'NO_MATCH_FOUND'|'ACTION_REQUIRED',
'PartnerAccountIdentifier': 'string',
'CreatedDate': datetime(2015, 1, 1),
'LastModifiedDate': datetime(2015, 1, 1),
'Issues': [
{
'Severity': 'string',
'Code': 'string',
'Message': 'string'
},
],
'AwsEnrichment': {
'Customer': {
'AccountName': 'string',
'Industry': 'string',
'SubIndustry': 'string',
'Sector': 'string',
'Segment': 'string',
'CompanySize': 'string',
'Region': 'string',
'SubRegion': 'string',
'Geo': 'string',
'Country': 'string',
'CustomerAccountPlanningQualification': 'string',
'EligiblePrograms': [
'string',
]
},
'Insights': {
'MarketplaceEngagementScore': 'string',
'SolutionCategory': 'string',
'SolutionScore': 'string',
'SolutionSubCategory': 'string'
}
},
'ReasonCode': 'DUPLICATE_CUSTOMER_MATCH'|'PROCESSING_ERROR',
'Message': 'string',
'ExistingCustomerAccountArn': 'string',
'Account': {
'CompanyName': 'string',
'WebsiteUrl': 'string',
'Duns': 'string',
'Address': {
'City': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'StreetAddress': 'string'
},
'Industry': 'string',
'OtherIndustry': 'string',
'Domain': 'string',
'ParentCompanyName': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Information about get customer account response.
Arn (string) --
The Amazon Resource Name (ARN) of the customer account.
Id (string) --
The unique identifier of the customer account.
Catalog (string) --
The catalog that the customer account belongs to.
EnrichmentStatus (string) --
The enrichment status of the customer account.
PartnerAccountIdentifier (string) --
Your own identifier for the customer account, if you provided one.
CreatedDate (datetime) --
The date and time when the customer account was created.
LastModifiedDate (datetime) --
The date and time when the customer account was last modified.
Issues (list) --
The issues found with the customer account. Present only when there is at least one issue.
(dict) --
An issue found with a customer account. It includes the severity, a machine-readable code, and a description.
Severity (string) --
The severity of the issue.
Code (string) --
A code that identifies the type of issue.
Message (string) --
A description of the issue.
AwsEnrichment (dict) --
Enrichment information that AWS provides about the customer. Present only when EnrichmentStatus is ENRICHED.
Customer (dict) --
Information about the customer that AWS provides.
AccountName (string) --
The name of the customer, as recorded by AWS.
Industry (string) --
The industry of the customer, as classified by AWS.
SubIndustry (string) --
The sub-industry of the customer, as classified by AWS.
Sector (string) --
The sector of the customer, as classified by AWS.
Segment (string) --
The market segment of the customer, as classified by AWS.
CompanySize (string) --
The size of the customer company.
Region (string) --
The region of the customer, as classified by AWS.
SubRegion (string) --
The sub-region of the customer, as classified by AWS.
Geo (string) --
The geographic area of the customer, as classified by AWS.
Country (string) --
The country of the customer.
CustomerAccountPlanningQualification (string) --
Indicates whether the customer qualifies for account planning with AWS.
EligiblePrograms (list) --
The AWS programs that the customer is eligible for.
(string) --
Insights (dict) --
Insights that AWS computes for the customer.
MarketplaceEngagementScore (string) --
The level of engagement of the customer with AWS Marketplace. Valid values are High, Medium, and Low.
SolutionCategory (string) --
The category of the solution that AWS recommends for the customer.
SolutionScore (string) --
The likelihood that the customer adopts the recommended solution. Valid values are High, Medium, and Low.
SolutionSubCategory (string) --
The sub-category of the solution that AWS recommends for the customer.
ReasonCode (string) --
The reason that the customer account needs your action. Present only when EnrichmentStatus is ACTION_REQUIRED.
Message (string) --
A description of the problem and the steps that you can take to resolve it.
ExistingCustomerAccountArn (string) --
The ARN of the customer account that already maps this customer. Present only when ReasonCode is DUPLICATE_CUSTOMER_MATCH.
Account (dict) --
The details of the customer that you provided.
CompanyName (string) --
The name of the customer company.
WebsiteUrl (string) --
The website URL of the customer company.
Duns (string) --
The Data Universal Numbering System (DUNS) number of the customer company.
Address (dict) --
The address of the customer company.
City (string) --
Specifies the end Customer's city associated with the Opportunity.
PostalCode (string) --
Specifies the end Customer's postal code associated with the Opportunity.
StateOrRegion (string) --
Specifies the end Customer's state or region associated with the Opportunity.
Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP
CountryCode (string) --
Specifies the end Customer's country associated with the Opportunity.
StreetAddress (string) --
Specifies the end Customer's street address associated with the Opportunity.
Industry (string) --
The industry of the customer company.
OtherIndustry (string) --
A description of the industry, used when the industry is Other.
Domain (string) --
The internet domain of the customer company, such as example.com.
ParentCompanyName (string) --
The name of the parent company of the customer company, if any.
Tags (list) --
The tags on the customer account. This member is absent if the tags can't be retrieved, which is different from an account that has no tags.
(dict) --
The key-value pair assigned to a specified resource.
Key (string) --
The key in the tag.
Value (string) --
The value in the tag.
Use ListCustomerAccountBulkJobs to list the bulk jobs in the specified catalog. You can filter the results by job identifier or status.
Results are paginated. Use NextToken to retrieve additional results.
See also: AWS API Documentation
Request Syntax
client.list_customer_account_bulk_jobs(
Catalog='string',
Filter={
'Identifier': 'string',
'Status': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'
},
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
dict
Specifies criteria to filter the bulk jobs, such as the job identifier or status.
Identifier (string) --
Filters the results to the bulk job with the specified ARN or identifier.
Status (string) --
Filters the results to bulk jobs with the specified status.
integer
Specifies the maximum number of results to return in a single call. Use this value together with NextToken to control pagination.
string
Specifies the token for the next page of results. Use the NextToken value from a previous response to retrieve the next page.
dict
Response Syntax
{
'items': [
{
'Arn': 'string',
'Id': 'string',
'Status': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
'FileName': 'string',
'TotalRecords': 123,
'ProcessedRecords': 123,
'SuccessCount': 123,
'FailureCount': 123,
'DeletedCount': 123,
'FailureReason': 'string',
'CreatedAt': datetime(2015, 1, 1),
'CompletedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Information about list customer account bulk jobs response.
items (list) --
The bulk jobs that match the request.
(dict) --
A bulk job in the results of ListCustomerAccountBulkJobs. It includes the job status, the file name, and the record counts.
Arn (string) --
The Amazon Resource Name (ARN) of the bulk job.
Id (string) --
The unique identifier of the bulk job.
Status (string) --
The current status of the bulk job.
FileName (string) --
The name of the file that the job processes.
TotalRecords (integer) --
The total number of records in the file. The value is 0 until the job reads the file.
ProcessedRecords (integer) --
The number of records that the job has finished processing.
SuccessCount (integer) --
The number of records that the job processed successfully.
FailureCount (integer) --
The number of records that failed.
DeletedCount (integer) --
The number of accounts imported by this job that have since been deleted. This counter only increases, so the accounts still present equal SuccessCount minus DeletedCount.
FailureReason (string) --
The reason that the job failed. Present only when the job status is FAILED.
CreatedAt (datetime) --
The date and time when the bulk job was created.
CompletedAt (datetime) --
The date and time when the job finished. Absent while the job is running.
NextToken (string) --
The token to retrieve the next page of results. This value is absent when there are no more results.
Gets the status of the failed-records report for a finished opportunity bulk job and, when the report is ready, a temporary URL to download it.
A report is available only after the job is COMPLETED or FAILED. The URL expires after 15 minutes, and the report expires after about 7 days.
See also: AWS API Documentation
Request Syntax
client.get_opportunity_bulk_job_report_url(
Catalog='string',
JobId='string',
ReportFormat='CSV',
ReportType='FAILED_RECORDS'|'ALL_RECORDS'
)
string
[REQUIRED]
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
string
[REQUIRED]
Specifies the identifier of the bulk job.
string
[REQUIRED]
Specifies the format of the report. The only supported value is CSV.
string
Specifies which records the report covers. If you omit this field, the report covers the records that failed. ALL_RECORDS isn't supported yet, and a request for it fails with a ValidationException.
dict
Response Syntax
{
'ReportStatus': 'NOT_STARTED'|'IN_PROGRESS'|'AVAILABLE'|'FAILED'|'EXPIRED',
'ReportType': 'FAILED_RECORDS'|'ALL_RECORDS',
'ReportFormat': 'CSV',
'Url': 'string',
'ExpiresAt': datetime(2015, 1, 1),
'FailureReason': 'string'
}
Response Structure
(dict) --
The status of the report and, when it is ready, the URL to download it.
ReportStatus (string) --
The status of the report. The Url is returned only when the status is AVAILABLE.
ReportType (string) --
The records that the report covers.
ReportFormat (string) --
The format of the report.
Url (string) --
A temporary URL for downloading the report. Present only when ReportStatus is AVAILABLE.
ExpiresAt (datetime) --
The date and time, in UTC, when the URL expires. Present only when ReportStatus is AVAILABLE.
FailureReason (string) --
The reason that Partner Central couldn't generate the report. Present only when ReportStatus is FAILED.
Lists the opportunity bulk jobs in the specified catalog, newest first. You can filter the results by job identifier or status.
Results are paginated. Use NextToken to retrieve additional results.
See also: AWS API Documentation
Request Syntax
client.list_opportunity_bulk_jobs(
Catalog='string',
MaxResults=123,
NextToken='string',
JobId='string',
Status='SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'
)
string
[REQUIRED]
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
integer
Specifies the maximum number of results to return in a single call.
Default: 20
string
A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.
string
Filters the results to the bulk job with this identifier.
string
Filters the results to bulk jobs with this status.
dict
Response Syntax
{
'OpportunityBulkJobSummaries': [
{
'JobId': 'string',
'Status': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
'TotalRecords': 123,
'ProcessedRecords': 123,
'SuccessCount': 123,
'FailureCount': 123,
'CreatedAt': datetime(2015, 1, 1),
'StartedAt': datetime(2015, 1, 1),
'CompletedAt': datetime(2015, 1, 1),
'FailureReason': 'string',
'FileName': 'string',
'OperationType': 'BULK_CREATE'|'BULK_UPDATE'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The opportunity bulk jobs that match the request.
OpportunityBulkJobSummaries (list) --
The bulk jobs that match the request, newest first.
(dict) --
The status, record counts, and input file name of an opportunity bulk job.
JobId (string) --
The unique identifier of the bulk job.
Status (string) --
The current status of the bulk job.
TotalRecords (integer) --
The total number of records in the input file.
ProcessedRecords (integer) --
The number of records that Partner Central has processed so far.
SuccessCount (integer) --
The number of records that succeeded.
FailureCount (integer) --
The number of records that failed.
CreatedAt (datetime) --
The date and time, in UTC, when you created the bulk job.
StartedAt (datetime) --
The date and time, in UTC, when the bulk job started processing records.
CompletedAt (datetime) --
The date and time, in UTC, when the bulk job finished.
FailureReason (string) --
The reason that the bulk job failed. Present only when Status is FAILED.
FileName (string) --
The name of the input file that started the bulk job. Use it to identify the job by its file.
OperationType (string) --
Indicates whether the bulk job creates or updates opportunities, based on the template of the input file. Partner Central doesn't set this field until it reads the file.
NextToken (string) --
A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.
Use GetCustomerAccountStatistics to count your customer accounts and group them by fields such as industry, geography, or enrichment status. You can use the same filters as SearchCustomerAccounts.
See also: AWS API Documentation
Request Syntax
client.get_customer_account_statistics(
Catalog='string',
Filter={
'AndAllFilters': [
{'... recursive ...'},
],
'OrAllFilters': [
{'... recursive ...'},
],
'NotFilter': {'... recursive ...'},
'EqualsTo': {
'Key': 'ENRICHMENT_STATUS'|'COMPANY_NAME'|'AWS_INDUSTRY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'IMPORT_ID'|'CREATED_DATE'|'LAST_MODIFIED_DATE'|'GEO'|'COUNTRY'|'SEGMENT'|'SOLUTION_CATEGORY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'SOLUTION_SCORE',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'ContainsAny': {
'Key': 'ENRICHMENT_STATUS'|'COMPANY_NAME'|'AWS_INDUSTRY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'IMPORT_ID'|'CREATED_DATE'|'LAST_MODIFIED_DATE'|'GEO'|'COUNTRY'|'SEGMENT'|'SOLUTION_CATEGORY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'SOLUTION_SCORE',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'ContainsAll': {
'Key': 'ENRICHMENT_STATUS'|'COMPANY_NAME'|'AWS_INDUSTRY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'IMPORT_ID'|'CREATED_DATE'|'LAST_MODIFIED_DATE'|'GEO'|'COUNTRY'|'SEGMENT'|'SOLUTION_CATEGORY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'SOLUTION_SCORE',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'GreaterThan': {
'Key': 'ENRICHMENT_STATUS'|'COMPANY_NAME'|'AWS_INDUSTRY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'IMPORT_ID'|'CREATED_DATE'|'LAST_MODIFIED_DATE'|'GEO'|'COUNTRY'|'SEGMENT'|'SOLUTION_CATEGORY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'SOLUTION_SCORE',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'GreaterThanOrEquals': {
'Key': 'ENRICHMENT_STATUS'|'COMPANY_NAME'|'AWS_INDUSTRY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'IMPORT_ID'|'CREATED_DATE'|'LAST_MODIFIED_DATE'|'GEO'|'COUNTRY'|'SEGMENT'|'SOLUTION_CATEGORY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'SOLUTION_SCORE',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'LessThan': {
'Key': 'ENRICHMENT_STATUS'|'COMPANY_NAME'|'AWS_INDUSTRY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'IMPORT_ID'|'CREATED_DATE'|'LAST_MODIFIED_DATE'|'GEO'|'COUNTRY'|'SEGMENT'|'SOLUTION_CATEGORY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'SOLUTION_SCORE',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'LessThanOrEquals': {
'Key': 'ENRICHMENT_STATUS'|'COMPANY_NAME'|'AWS_INDUSTRY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'IMPORT_ID'|'CREATED_DATE'|'LAST_MODIFIED_DATE'|'GEO'|'COUNTRY'|'SEGMENT'|'SOLUTION_CATEGORY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'SOLUTION_SCORE',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
}
},
Aggregations=[
{
'GroupBy': [
'ENRICHMENT_STATUS'|'AWS_INDUSTRY'|'SEGMENT'|'REGION'|'SOLUTION_CATEGORY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'GEO'|'COUNTRY'|'SOLUTION_SCORE',
]
},
],
IncludeMissing=True|False
)
string
[REQUIRED]
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
dict
Specifies a filter tree that narrows the customer accounts. Each node either combines child filters or compares a single field to a value. If you omit this field, the statistics cover all of your customer accounts.
AndAllFilters (list) --
A list of child filters joined with a logical AND. The node matches only when every child filter matches.
(dict) --
A filter node. Specify exactly one member. AndAllFilters, OrAllFilters, and NotFilter combine child filters. The other members compare a single field to a value. Each combinator list can contain up to 10 filters.
OrAllFilters (list) --
A list of child filters joined with a logical OR. The node matches when at least one child filter matches.
(dict) --
A filter node. Specify exactly one member. AndAllFilters, OrAllFilters, and NotFilter combine child filters. The other members compare a single field to a value. Each combinator list can contain up to 10 filters.
NotFilter (dict) --
A single child filter that is negated. The node matches when the child filter doesn't match.
EqualsTo (dict) --
A condition that matches when the field equals the supplied StringValue.
Key (string) -- [REQUIRED]
The field that the condition applies to.
Value (dict) -- [REQUIRED]
The value that the condition compares the field against.
StringValue (string) --
A single string value, used by EqualsTo.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
LongValue (integer) --
Reserved for future use.
DateValue (datetime) --
A date and time value, used by the range comparisons on date fields.
ContainsAny (dict) --
A condition that matches when the field matches any of the values in the supplied StringListValue.
Key (string) -- [REQUIRED]
The field that the condition applies to.
Value (dict) -- [REQUIRED]
The value that the condition compares the field against.
StringValue (string) --
A single string value, used by EqualsTo.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
LongValue (integer) --
Reserved for future use.
DateValue (datetime) --
A date and time value, used by the range comparisons on date fields.
ContainsAll (dict) --
A condition that matches when the field contains every value in the supplied StringListValue. Supported on fields that hold more than one value.
Key (string) -- [REQUIRED]
The field that the condition applies to.
Value (dict) -- [REQUIRED]
The value that the condition compares the field against.
StringValue (string) --
A single string value, used by EqualsTo.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
LongValue (integer) --
Reserved for future use.
DateValue (datetime) --
A date and time value, used by the range comparisons on date fields.
GreaterThan (dict) --
A condition that matches when the date field is later than the supplied DateValue.
Key (string) -- [REQUIRED]
The field that the condition applies to.
Value (dict) -- [REQUIRED]
The value that the condition compares the field against.
StringValue (string) --
A single string value, used by EqualsTo.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
LongValue (integer) --
Reserved for future use.
DateValue (datetime) --
A date and time value, used by the range comparisons on date fields.
GreaterThanOrEquals (dict) --
A condition that matches when the date field is the same as or later than the supplied DateValue.
Key (string) -- [REQUIRED]
The field that the condition applies to.
Value (dict) -- [REQUIRED]
The value that the condition compares the field against.
StringValue (string) --
A single string value, used by EqualsTo.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
LongValue (integer) --
Reserved for future use.
DateValue (datetime) --
A date and time value, used by the range comparisons on date fields.
LessThan (dict) --
A condition that matches when the date field is earlier than the supplied DateValue.
Key (string) -- [REQUIRED]
The field that the condition applies to.
Value (dict) -- [REQUIRED]
The value that the condition compares the field against.
StringValue (string) --
A single string value, used by EqualsTo.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
LongValue (integer) --
Reserved for future use.
DateValue (datetime) --
A date and time value, used by the range comparisons on date fields.
LessThanOrEquals (dict) --
A condition that matches when the date field is the same as or earlier than the supplied DateValue.
Key (string) -- [REQUIRED]
The field that the condition applies to.
Value (dict) -- [REQUIRED]
The value that the condition compares the field against.
StringValue (string) --
A single string value, used by EqualsTo.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
LongValue (integer) --
Reserved for future use.
DateValue (datetime) --
A date and time value, used by the range comparisons on date fields.
list
Specifies how to group the customer accounts. Each aggregation returns the number of accounts for each value of a field.
(dict) --
Groups customer accounts by the values of a field.
GroupBy (list) -- [REQUIRED]
The field to group the customer accounts by. Specify one field.
(string) --
The fields that you can group customer accounts by in GetCustomerAccountStatistics.
boolean
Specifies whether to include a group for customer accounts that have no value for the grouped field.
dict
Response Syntax
{
'TotalCount': 123,
'Aggregations': [
{
'GroupBy': [
'ENRICHMENT_STATUS'|'AWS_INDUSTRY'|'SEGMENT'|'REGION'|'SOLUTION_CATEGORY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'GEO'|'COUNTRY'|'SOLUTION_SCORE',
],
'Buckets': [
{
'Values': [
'string',
],
'Count': 123
},
],
'OtherCount': 123
},
]
}
Response Structure
(dict) --
Information about get customer account statistics response.
TotalCount (integer) --
The total number of customer accounts that match the filter.
Aggregations (list) --
The results of the aggregations, in the order that you requested them.
(dict) --
The result of an aggregation. It includes the grouped field, the number of customer accounts for each value, and the number of accounts with other values.
GroupBy (list) --
The field that the customer accounts are grouped by.
(string) --
The fields that you can group customer accounts by in GetCustomerAccountStatistics.
Buckets (list) --
The groups of customer accounts, one for each value of the field, with the number of accounts in each group.
(dict) --
One group in an aggregation result. It includes the field values that define the group and the number of customer accounts in it.
Values (list) --
The field value that defines this group.
(string) --
Count (integer) --
The number of customer accounts in this group.
OtherCount (integer) --
The number of customer accounts that have a value not included in Buckets.
Lists the outcome of each record in an opportunity bulk job. You can filter the results by record status.
Results are paginated. Use NextToken to retrieve additional results.
See also: AWS API Documentation
Request Syntax
client.list_opportunity_bulk_job_results(
Catalog='string',
MaxResults=123,
NextToken='string',
JobId='string',
Status='SUCCEEDED'|'FAILED'
)
string
[REQUIRED]
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
integer
Specifies the maximum number of results to return in a single call.
Default: 20
string
A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.
string
[REQUIRED]
Specifies the identifier of the bulk job.
string
Filters the results to records with this status.
dict
Response Syntax
{
'Results': [
{
'RequestId': 'string',
'Status': 'SUCCEEDED'|'FAILED',
'ResourceIdentifier': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The results of an opportunity bulk job.
Results (list) --
The outcome of each record in the bulk job.
(dict) --
The outcome of processing a single record within a bulk job. It identifies the record and, when the record didn't succeed, carries an error code and message.
RequestId (string) --
The identifier of the record in the bulk job file.
Status (string) --
The outcome of processing the record.
ResourceIdentifier (string) --
This value is the identifier of the resource that Partner Central created or updated for the record. A failed record includes this value when Partner Central created the resource before the failure.
ErrorCode (string) --
A code that identifies why the record failed. Present only when the record failed.
ErrorMessage (string) --
A description of why the record failed. Present only when the record failed.
NextToken (string) --
A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.
Use UpdateCustomerAccount to replace the customer information on an existing customer account. AWS matches the account again with the updated information.
To prevent concurrent changes from overwriting each other, specify the LastModifiedDate value that you last read for the account. If the account changed since then, the request fails with a ConflictException.
See also: AWS API Documentation
Request Syntax
client.update_customer_account(
Catalog='string',
Identifier='string',
Account={
'CompanyName': 'string',
'WebsiteUrl': 'string',
'Duns': 'string',
'Address': {
'City': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'StreetAddress': 'string'
},
'Industry': 'string',
'OtherIndustry': 'string',
'Domain': 'string',
'ParentCompanyName': 'string'
},
PartnerAccountIdentifier='string',
LastModifiedDate=datetime(2015, 1, 1)
)
string
[REQUIRED]
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
string
[REQUIRED]
Specifies the ARN or the identifier of the customer account.
dict
[REQUIRED]
Specifies the complete, updated details of the customer. These details replace the existing details on the customer account.
CompanyName (string) -- [REQUIRED]
The name of the customer company.
WebsiteUrl (string) --
The website URL of the customer company.
Duns (string) --
The Data Universal Numbering System (DUNS) number of the customer company.
Address (dict) --
The address of the customer company.
City (string) --
Specifies the end Customer's city associated with the Opportunity.
PostalCode (string) --
Specifies the end Customer's postal code associated with the Opportunity.
StateOrRegion (string) --
Specifies the end Customer's state or region associated with the Opportunity.
Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP
CountryCode (string) --
Specifies the end Customer's country associated with the Opportunity.
StreetAddress (string) --
Specifies the end Customer's street address associated with the Opportunity.
Industry (string) --
The industry of the customer company.
OtherIndustry (string) --
A description of the industry, used when the industry is Other.
Domain (string) --
The internet domain of the customer company, such as example.com.
ParentCompanyName (string) --
The name of the parent company of the customer company, if any.
string
Specifies your own identifier for the customer account, such as the account ID in your CRM system. Use it to correlate the customer account with your records.
datetime
[REQUIRED]
Specifies the LastModifiedDate of the customer account as you last read it. If it doesn't match the current value, the request fails with a ConflictException.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string',
'Status': 'PENDING'|'ENRICHED'|'NO_MATCH_FOUND'|'ACTION_REQUIRED',
'Catalog': 'string',
'PartnerAccountIdentifier': 'string',
'CreatedDate': datetime(2015, 1, 1),
'LastModifiedDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Information about update customer account response.
Arn (string) --
The Amazon Resource Name (ARN) of the customer account.
Id (string) --
The unique identifier of the customer account.
Status (string) --
The enrichment status of the customer account.
Catalog (string) --
The catalog that the customer account belongs to.
PartnerAccountIdentifier (string) --
Your own identifier for the customer account, if you provided one.
CreatedDate (datetime) --
The date and time when the customer account was created.
LastModifiedDate (datetime) --
The date and time when the customer account was last modified.
Use SearchCustomerAccounts to find customer accounts in the specified catalog. You can filter the results by fields such as enrichment status, industry, geography, and creation date, and sort them by company name, date, or score.
Results are paginated. Use NextToken to retrieve additional results.
See also: AWS API Documentation
Request Syntax
client.search_customer_accounts(
Catalog='string',
Filter={
'AndAllFilters': [
{'... recursive ...'},
],
'OrAllFilters': [
{'... recursive ...'},
],
'NotFilter': {'... recursive ...'},
'EqualsTo': {
'Key': 'ENRICHMENT_STATUS'|'COMPANY_NAME'|'AWS_INDUSTRY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'IMPORT_ID'|'CREATED_DATE'|'LAST_MODIFIED_DATE'|'GEO'|'COUNTRY'|'SEGMENT'|'SOLUTION_CATEGORY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'SOLUTION_SCORE',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'ContainsAny': {
'Key': 'ENRICHMENT_STATUS'|'COMPANY_NAME'|'AWS_INDUSTRY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'IMPORT_ID'|'CREATED_DATE'|'LAST_MODIFIED_DATE'|'GEO'|'COUNTRY'|'SEGMENT'|'SOLUTION_CATEGORY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'SOLUTION_SCORE',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'ContainsAll': {
'Key': 'ENRICHMENT_STATUS'|'COMPANY_NAME'|'AWS_INDUSTRY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'IMPORT_ID'|'CREATED_DATE'|'LAST_MODIFIED_DATE'|'GEO'|'COUNTRY'|'SEGMENT'|'SOLUTION_CATEGORY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'SOLUTION_SCORE',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'GreaterThan': {
'Key': 'ENRICHMENT_STATUS'|'COMPANY_NAME'|'AWS_INDUSTRY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'IMPORT_ID'|'CREATED_DATE'|'LAST_MODIFIED_DATE'|'GEO'|'COUNTRY'|'SEGMENT'|'SOLUTION_CATEGORY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'SOLUTION_SCORE',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'GreaterThanOrEquals': {
'Key': 'ENRICHMENT_STATUS'|'COMPANY_NAME'|'AWS_INDUSTRY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'IMPORT_ID'|'CREATED_DATE'|'LAST_MODIFIED_DATE'|'GEO'|'COUNTRY'|'SEGMENT'|'SOLUTION_CATEGORY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'SOLUTION_SCORE',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'LessThan': {
'Key': 'ENRICHMENT_STATUS'|'COMPANY_NAME'|'AWS_INDUSTRY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'IMPORT_ID'|'CREATED_DATE'|'LAST_MODIFIED_DATE'|'GEO'|'COUNTRY'|'SEGMENT'|'SOLUTION_CATEGORY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'SOLUTION_SCORE',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'LessThanOrEquals': {
'Key': 'ENRICHMENT_STATUS'|'COMPANY_NAME'|'AWS_INDUSTRY'|'ACCOUNT_PLANNING_QUALIFICATION'|'PROGRAM_ELIGIBILITY'|'IMPORT_ID'|'CREATED_DATE'|'LAST_MODIFIED_DATE'|'GEO'|'COUNTRY'|'SEGMENT'|'SOLUTION_CATEGORY'|'MARKETPLACE_ENGAGEMENT_SCORE'|'SOLUTION_SCORE',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
}
},
Sort={
'SortBy': 'COMPANY_NAME'|'CREATED_DATE'|'LAST_MODIFIED_DATE'|'MARKETPLACE_ENGAGEMENT_SCORE'|'SOLUTION_SCORE',
'SortOrder': 'ASCENDING'|'DESCENDING'
},
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
dict
Specifies a filter tree that narrows the customer accounts. Each node either combines child filters or compares a single field to a value.
AndAllFilters (list) --
A list of child filters joined with a logical AND. The node matches only when every child filter matches.
(dict) --
A filter node. Specify exactly one member. AndAllFilters, OrAllFilters, and NotFilter combine child filters. The other members compare a single field to a value. Each combinator list can contain up to 10 filters.
OrAllFilters (list) --
A list of child filters joined with a logical OR. The node matches when at least one child filter matches.
(dict) --
A filter node. Specify exactly one member. AndAllFilters, OrAllFilters, and NotFilter combine child filters. The other members compare a single field to a value. Each combinator list can contain up to 10 filters.
NotFilter (dict) --
A single child filter that is negated. The node matches when the child filter doesn't match.
EqualsTo (dict) --
A condition that matches when the field equals the supplied StringValue.
Key (string) -- [REQUIRED]
The field that the condition applies to.
Value (dict) -- [REQUIRED]
The value that the condition compares the field against.
StringValue (string) --
A single string value, used by EqualsTo.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
LongValue (integer) --
Reserved for future use.
DateValue (datetime) --
A date and time value, used by the range comparisons on date fields.
ContainsAny (dict) --
A condition that matches when the field matches any of the values in the supplied StringListValue.
Key (string) -- [REQUIRED]
The field that the condition applies to.
Value (dict) -- [REQUIRED]
The value that the condition compares the field against.
StringValue (string) --
A single string value, used by EqualsTo.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
LongValue (integer) --
Reserved for future use.
DateValue (datetime) --
A date and time value, used by the range comparisons on date fields.
ContainsAll (dict) --
A condition that matches when the field contains every value in the supplied StringListValue. Supported on fields that hold more than one value.
Key (string) -- [REQUIRED]
The field that the condition applies to.
Value (dict) -- [REQUIRED]
The value that the condition compares the field against.
StringValue (string) --
A single string value, used by EqualsTo.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
LongValue (integer) --
Reserved for future use.
DateValue (datetime) --
A date and time value, used by the range comparisons on date fields.
GreaterThan (dict) --
A condition that matches when the date field is later than the supplied DateValue.
Key (string) -- [REQUIRED]
The field that the condition applies to.
Value (dict) -- [REQUIRED]
The value that the condition compares the field against.
StringValue (string) --
A single string value, used by EqualsTo.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
LongValue (integer) --
Reserved for future use.
DateValue (datetime) --
A date and time value, used by the range comparisons on date fields.
GreaterThanOrEquals (dict) --
A condition that matches when the date field is the same as or later than the supplied DateValue.
Key (string) -- [REQUIRED]
The field that the condition applies to.
Value (dict) -- [REQUIRED]
The value that the condition compares the field against.
StringValue (string) --
A single string value, used by EqualsTo.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
LongValue (integer) --
Reserved for future use.
DateValue (datetime) --
A date and time value, used by the range comparisons on date fields.
LessThan (dict) --
A condition that matches when the date field is earlier than the supplied DateValue.
Key (string) -- [REQUIRED]
The field that the condition applies to.
Value (dict) -- [REQUIRED]
The value that the condition compares the field against.
StringValue (string) --
A single string value, used by EqualsTo.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
LongValue (integer) --
Reserved for future use.
DateValue (datetime) --
A date and time value, used by the range comparisons on date fields.
LessThanOrEquals (dict) --
A condition that matches when the date field is the same as or earlier than the supplied DateValue.
Key (string) -- [REQUIRED]
The field that the condition applies to.
Value (dict) -- [REQUIRED]
The value that the condition compares the field against.
StringValue (string) --
A single string value, used by EqualsTo.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
LongValue (integer) --
Reserved for future use.
DateValue (datetime) --
A date and time value, used by the range comparisons on date fields.
dict
Specifies the field and direction used to sort the results.
SortBy (string) -- [REQUIRED]
The field to sort the results by.
SortOrder (string) -- [REQUIRED]
The direction of the sort, either ascending or descending.
integer
Specifies the maximum number of results to return in a single call. Use this value together with NextToken to control pagination.
string
Specifies the token for the next page of results. Use the NextToken value from a previous response to retrieve the next page.
dict
Response Syntax
{
'CustomerAccountSummaries': [
{
'Arn': 'string',
'Id': 'string',
'Catalog': 'string',
'EnrichmentStatus': 'PENDING'|'ENRICHED'|'NO_MATCH_FOUND'|'ACTION_REQUIRED',
'PartnerAccountIdentifier': 'string',
'CreatedDate': datetime(2015, 1, 1),
'LastModifiedDate': datetime(2015, 1, 1),
'CustomerAccount': {
'CompanyName': 'string'
},
'AwsEnrichment': {
'Customer': {
'Industry': 'string',
'AccountPlanningQualification': 'string',
'EligiblePrograms': [
'string',
],
'Geo': 'string',
'Country': 'string',
'Segment': 'string'
},
'Insights': {
'MarketplaceEngagementScore': 'string',
'SolutionCategory': 'string',
'SolutionScore': 'string'
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Information about search customer accounts response.
CustomerAccountSummaries (list) --
The customer accounts that match the request.
(dict) --
A customer account in the results of SearchCustomerAccounts. It carries a reduced set of fields compared to the full account that is returned by GetCustomerAccount.
Arn (string) --
The Amazon Resource Name (ARN) of the customer account.
Id (string) --
The unique identifier of the customer account.
Catalog (string) --
The catalog that the customer account belongs to.
EnrichmentStatus (string) --
The enrichment status of the customer account.
PartnerAccountIdentifier (string) --
Your own identifier for the customer account, if you provided one.
CreatedDate (datetime) --
The date and time when the customer account was created.
LastModifiedDate (datetime) --
The date and time when the customer account was last modified.
CustomerAccount (dict) --
A summary of the details of the customer that you provided.
CompanyName (string) --
The name of the customer company.
AwsEnrichment (dict) --
A summary of the enrichment information that AWS provides about the customer. Present only when EnrichmentStatus is ENRICHED.
Customer (dict) --
Information about the customer that AWS provides.
Industry (string) --
The industry of the customer, as classified by AWS.
AccountPlanningQualification (string) --
Indicates whether the customer qualifies for account planning with AWS.
EligiblePrograms (list) --
The AWS programs that the customer is eligible for.
(string) --
Geo (string) --
The geographic area of the customer, as classified by AWS.
Country (string) --
The country of the customer.
Segment (string) --
The market segment of the customer, as classified by AWS.
Insights (dict) --
Insights that AWS computes for the customer.
MarketplaceEngagementScore (string) --
The level of engagement of the customer with AWS Marketplace. Valid values are High, Medium, and Low.
SolutionCategory (string) --
The category of the solution that AWS recommends for the customer.
SolutionScore (string) --
The likelihood that the customer adopts the recommended solution. Valid values are High, Medium, and Low.
NextToken (string) --
The token to retrieve the next page of results. This value is absent when there are no more results.
Use DeleteCustomerAccount to delete a customer account. This operation is idempotent. Deleting a customer account that was already deleted succeeds.
See also: AWS API Documentation
Request Syntax
client.delete_customer_account(
Catalog='string',
Identifier='string'
)
string
[REQUIRED]
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
string
[REQUIRED]
Specifies the ARN or the identifier of the customer account.
dict
Response Syntax
{}
Response Structure
(dict) --
Information about delete customer account response.
Use GetCustomerAccountBulkJobReportUrl to get a temporary URL for downloading the report of a bulk job, such as the list of records that failed. A report is available only after the job is COMPLETED or FAILED. For a job that is still running, the request fails with a ConflictException.
The report is generated on request. If ReportStatus is not AVAILABLE, call the operation again later.
See also: AWS API Documentation
Request Syntax
client.get_customer_account_bulk_job_report_url(
Catalog='string',
Identifier='string',
ReportType='FAILED_RECORDS'|'ALL_RECORDS'
)
string
[REQUIRED]
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
string
[REQUIRED]
Specifies the ARN or the identifier of the bulk job.
string
Specifies which records the report covers. If you omit this field, the report covers the records that failed.
dict
Response Syntax
{
'ReportStatus': 'NOT_STARTED'|'IN_PROGRESS'|'AVAILABLE'|'FAILED'|'EXPIRED',
'ReportType': 'FAILED_RECORDS'|'ALL_RECORDS',
'Url': 'string',
'ExpiresAt': datetime(2015, 1, 1),
'FailureReason': 'string'
}
Response Structure
(dict) --
Information about get customer account bulk job report url response.
ReportStatus (string) --
The status of the report. The Url is returned only when the status is AVAILABLE.
ReportType (string) --
The records that the report covers.
Url (string) --
A temporary URL for downloading the report. Present only when ReportStatus is AVAILABLE.
ExpiresAt (datetime) --
The date and time when the URL expires. Present only when ReportStatus is AVAILABLE.
FailureReason (string) --
The reason that the report couldn't be generated. Present only when ReportStatus is FAILED.
The SearchOpportunities operation in the AWS Partner Central Selling API searches and filters the opportunities available to you in AWS Partner Central.
You can optionally provide a free-text Keyword, a structured Filter tree, and Sort options. The operation returns a curated summary view of each matching opportunity. If you supply both Keyword and Filter, the operation combines them with a logical AND, so each one narrows the result set.
Results are paginated. Use the NextToken parameter to retrieve additional pages of results.
See also: AWS API Documentation
Request Syntax
client.search_opportunities(
Catalog='string',
MaxResults=123,
NextToken='string',
Keyword='string',
Filter={
'AndAllFilters': [
{'... recursive ...'},
],
'OrAllFilters': [
{'... recursive ...'},
],
'NotFilter': {'... recursive ...'},
'EqualsTo': {
'Key': 'OpportunityId'|'Stage'|'ReviewStatus'|'CustomerCompanyName'|'LastModifiedDate'|'TargetCloseDate'|'CreatedDate'|'CountryCode'|'PartnerProjectTitle'|'OpportunityType'|'PartnerOpportunityIdentifier'|'Industry'|'AwsAccountId'|'ApnPrograms'|'Origin'|'Tags'|'NextStep'|'OfferId'|'OfferSetId'|'AwsMarketplaceSolution'|'CosellMotion'|'OpportunityOwner'|'EstimatedMrr'|'EngagementScore',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DoubleValue': 123.0,
'DateValue': datetime(2015, 1, 1)
}
},
'ContainsAny': {
'Key': 'OpportunityId'|'Stage'|'ReviewStatus'|'CustomerCompanyName'|'LastModifiedDate'|'TargetCloseDate'|'CreatedDate'|'CountryCode'|'PartnerProjectTitle'|'OpportunityType'|'PartnerOpportunityIdentifier'|'Industry'|'AwsAccountId'|'ApnPrograms'|'Origin'|'Tags'|'NextStep'|'OfferId'|'OfferSetId'|'AwsMarketplaceSolution'|'CosellMotion'|'OpportunityOwner'|'EstimatedMrr'|'EngagementScore',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DoubleValue': 123.0,
'DateValue': datetime(2015, 1, 1)
}
},
'ContainsAll': {
'Key': 'OpportunityId'|'Stage'|'ReviewStatus'|'CustomerCompanyName'|'LastModifiedDate'|'TargetCloseDate'|'CreatedDate'|'CountryCode'|'PartnerProjectTitle'|'OpportunityType'|'PartnerOpportunityIdentifier'|'Industry'|'AwsAccountId'|'ApnPrograms'|'Origin'|'Tags'|'NextStep'|'OfferId'|'OfferSetId'|'AwsMarketplaceSolution'|'CosellMotion'|'OpportunityOwner'|'EstimatedMrr'|'EngagementScore',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DoubleValue': 123.0,
'DateValue': datetime(2015, 1, 1)
}
},
'GreaterThan': {
'Key': 'OpportunityId'|'Stage'|'ReviewStatus'|'CustomerCompanyName'|'LastModifiedDate'|'TargetCloseDate'|'CreatedDate'|'CountryCode'|'PartnerProjectTitle'|'OpportunityType'|'PartnerOpportunityIdentifier'|'Industry'|'AwsAccountId'|'ApnPrograms'|'Origin'|'Tags'|'NextStep'|'OfferId'|'OfferSetId'|'AwsMarketplaceSolution'|'CosellMotion'|'OpportunityOwner'|'EstimatedMrr'|'EngagementScore',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DoubleValue': 123.0,
'DateValue': datetime(2015, 1, 1)
}
},
'GreaterThanOrEquals': {
'Key': 'OpportunityId'|'Stage'|'ReviewStatus'|'CustomerCompanyName'|'LastModifiedDate'|'TargetCloseDate'|'CreatedDate'|'CountryCode'|'PartnerProjectTitle'|'OpportunityType'|'PartnerOpportunityIdentifier'|'Industry'|'AwsAccountId'|'ApnPrograms'|'Origin'|'Tags'|'NextStep'|'OfferId'|'OfferSetId'|'AwsMarketplaceSolution'|'CosellMotion'|'OpportunityOwner'|'EstimatedMrr'|'EngagementScore',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DoubleValue': 123.0,
'DateValue': datetime(2015, 1, 1)
}
},
'LessThan': {
'Key': 'OpportunityId'|'Stage'|'ReviewStatus'|'CustomerCompanyName'|'LastModifiedDate'|'TargetCloseDate'|'CreatedDate'|'CountryCode'|'PartnerProjectTitle'|'OpportunityType'|'PartnerOpportunityIdentifier'|'Industry'|'AwsAccountId'|'ApnPrograms'|'Origin'|'Tags'|'NextStep'|'OfferId'|'OfferSetId'|'AwsMarketplaceSolution'|'CosellMotion'|'OpportunityOwner'|'EstimatedMrr'|'EngagementScore',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DoubleValue': 123.0,
'DateValue': datetime(2015, 1, 1)
}
},
'LessThanOrEquals': {
'Key': 'OpportunityId'|'Stage'|'ReviewStatus'|'CustomerCompanyName'|'LastModifiedDate'|'TargetCloseDate'|'CreatedDate'|'CountryCode'|'PartnerProjectTitle'|'OpportunityType'|'PartnerOpportunityIdentifier'|'Industry'|'AwsAccountId'|'ApnPrograms'|'Origin'|'Tags'|'NextStep'|'OfferId'|'OfferSetId'|'AwsMarketplaceSolution'|'CosellMotion'|'OpportunityOwner'|'EstimatedMrr'|'EngagementScore',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DoubleValue': 123.0,
'DateValue': datetime(2015, 1, 1)
}
}
},
Sort={
'SortBy': 'OpportunityId'|'Stage'|'ReviewStatus'|'CustomerCompanyName'|'LastModifiedDate'|'TargetCloseDate'|'CreatedDate'|'CountryCode'|'PartnerProjectTitle'|'OpportunityType'|'PartnerOpportunityIdentifier'|'Industry'|'AwsAccountId'|'Origin'|'NextStep'|'CosellMotion'|'OpportunityOwner'|'EngagementScore'|'EstimatedMrr'|'Tags'|'OfferId'|'OfferSetId'|'ApnPrograms',
'SortOrder': 'ASCENDING'|'DESCENDING'
}
)
string
[REQUIRED]
Specifies the catalog in which you run the search. Use AWS to search production opportunities, or use Sandbox to search opportunities in a testing environment.
integer
The maximum number of results to return in a single call. Use this value to control pagination together with NextToken. If you omit this parameter, the service applies a default page size and returns the remaining results on subsequent pages.
string
A pagination token returned by a previous call. Pass it in a subsequent call to retrieve the next page of results. Omit it on the first call.
string
An optional free-text query string matched against opportunity fields. When provided together with Filter, both narrow the result set.
dict
A recursive, structured filter tree. Each node is either a boolean combinator ( AndAllFilters, OrAllFilters, or NotFilter) or a leaf predicate (a single comparison such as EqualsTo). When provided together with Keyword, both narrow the result set.
AndAllFilters (list) --
A list of sub-filters that are joined with a logical AND. The node matches only when every sub-filter matches.
(dict) --
A recursive filter node. Exactly one member must be set. The boolean combinators nest sub-filters: AndAllFilters joins its children with AND, OrAllFilters matches when at least one child matches, and NotFilter negates its single child. The remaining members are leaf conditions over a single field. Nesting is bounded (depth up to 3, each combinator list up to 10 entries, and up to 20 leaf conditions per tree). If a request exceeds these limits, the service returns a ValidationException.
OrAllFilters (list) --
A list of sub-filters that are joined with a logical OR. The node matches when at least one sub-filter matches.
(dict) --
A recursive filter node. Exactly one member must be set. The boolean combinators nest sub-filters: AndAllFilters joins its children with AND, OrAllFilters matches when at least one child matches, and NotFilter negates its single child. The remaining members are leaf conditions over a single field. Nesting is bounded (depth up to 3, each combinator list up to 10 entries, and up to 20 leaf conditions per tree). If a request exceeds these limits, the service returns a ValidationException.
NotFilter (dict) --
A single sub-filter that is negated. The node matches when the sub-filter does not match.
EqualsTo (dict) --
A leaf condition that matches when the field equals the supplied value.
Key (string) -- [REQUIRED]
The opportunity field that the condition applies to.
Value (dict) -- [REQUIRED]
The typed value the condition compares against. Specify one of the following:
A single string value – used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
A list of string values – used by ContainsAny or ContainsAll to match against multiple values.
An integral numeric value – used by the range comparisons on integral numeric fields.
A fractional numeric value – used by the range comparisons on numeric amount fields such as EstimatedMrr.
A date-time value in RFC 3339 format – used by the range comparisons on date fields.
StringValue (string) --
A single string value. Used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
StringListValue (list) --
A list of string values. Used by ContainsAny or ContainsAll to match against multiple values.
(string) --
A text value that a search filter compares against.
LongValue (integer) --
An integral numeric value, used by the range comparisons on integral numeric fields.
DoubleValue (float) --
A fractional numeric value, used by the range comparisons on numeric amount fields such as EstimatedMrr.
DateValue (datetime) --
A date-time value in RFC 3339 format, used by the range comparisons on date fields.
ContainsAny (dict) --
A leaf condition that matches when the field contains any of the supplied values as a case-insensitive substring. On a multi-valued field, the condition matches when any element contains the substring.
Key (string) -- [REQUIRED]
The opportunity field that the condition applies to.
Value (dict) -- [REQUIRED]
The typed value the condition compares against. Specify one of the following:
A single string value – used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
A list of string values – used by ContainsAny or ContainsAll to match against multiple values.
An integral numeric value – used by the range comparisons on integral numeric fields.
A fractional numeric value – used by the range comparisons on numeric amount fields such as EstimatedMrr.
A date-time value in RFC 3339 format – used by the range comparisons on date fields.
StringValue (string) --
A single string value. Used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
StringListValue (list) --
A list of string values. Used by ContainsAny or ContainsAll to match against multiple values.
(string) --
A text value that a search filter compares against.
LongValue (integer) --
An integral numeric value, used by the range comparisons on integral numeric fields.
DoubleValue (float) --
A fractional numeric value, used by the range comparisons on numeric amount fields such as EstimatedMrr.
DateValue (datetime) --
A date-time value in RFC 3339 format, used by the range comparisons on date fields.
ContainsAll (dict) --
A leaf condition that matches when the field holds every supplied value. On a multi-valued field, every listed value must be present.
Key (string) -- [REQUIRED]
The opportunity field that the condition applies to.
Value (dict) -- [REQUIRED]
The typed value the condition compares against. Specify one of the following:
A single string value – used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
A list of string values – used by ContainsAny or ContainsAll to match against multiple values.
An integral numeric value – used by the range comparisons on integral numeric fields.
A fractional numeric value – used by the range comparisons on numeric amount fields such as EstimatedMrr.
A date-time value in RFC 3339 format – used by the range comparisons on date fields.
StringValue (string) --
A single string value. Used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
StringListValue (list) --
A list of string values. Used by ContainsAny or ContainsAll to match against multiple values.
(string) --
A text value that a search filter compares against.
LongValue (integer) --
An integral numeric value, used by the range comparisons on integral numeric fields.
DoubleValue (float) --
A fractional numeric value, used by the range comparisons on numeric amount fields such as EstimatedMrr.
DateValue (datetime) --
A date-time value in RFC 3339 format, used by the range comparisons on date fields.
GreaterThan (dict) --
A leaf condition that matches when the field is greater than the supplied value. Supported on ordered fields only (date or numeric).
Key (string) -- [REQUIRED]
The opportunity field that the condition applies to.
Value (dict) -- [REQUIRED]
The typed value the condition compares against. Specify one of the following:
A single string value – used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
A list of string values – used by ContainsAny or ContainsAll to match against multiple values.
An integral numeric value – used by the range comparisons on integral numeric fields.
A fractional numeric value – used by the range comparisons on numeric amount fields such as EstimatedMrr.
A date-time value in RFC 3339 format – used by the range comparisons on date fields.
StringValue (string) --
A single string value. Used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
StringListValue (list) --
A list of string values. Used by ContainsAny or ContainsAll to match against multiple values.
(string) --
A text value that a search filter compares against.
LongValue (integer) --
An integral numeric value, used by the range comparisons on integral numeric fields.
DoubleValue (float) --
A fractional numeric value, used by the range comparisons on numeric amount fields such as EstimatedMrr.
DateValue (datetime) --
A date-time value in RFC 3339 format, used by the range comparisons on date fields.
GreaterThanOrEquals (dict) --
A leaf condition that matches when the field is greater than or equal to the supplied value. Supported on ordered fields only (date or numeric).
Key (string) -- [REQUIRED]
The opportunity field that the condition applies to.
Value (dict) -- [REQUIRED]
The typed value the condition compares against. Specify one of the following:
A single string value – used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
A list of string values – used by ContainsAny or ContainsAll to match against multiple values.
An integral numeric value – used by the range comparisons on integral numeric fields.
A fractional numeric value – used by the range comparisons on numeric amount fields such as EstimatedMrr.
A date-time value in RFC 3339 format – used by the range comparisons on date fields.
StringValue (string) --
A single string value. Used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
StringListValue (list) --
A list of string values. Used by ContainsAny or ContainsAll to match against multiple values.
(string) --
A text value that a search filter compares against.
LongValue (integer) --
An integral numeric value, used by the range comparisons on integral numeric fields.
DoubleValue (float) --
A fractional numeric value, used by the range comparisons on numeric amount fields such as EstimatedMrr.
DateValue (datetime) --
A date-time value in RFC 3339 format, used by the range comparisons on date fields.
LessThan (dict) --
A leaf condition that matches when the field is less than the supplied value. Supported on ordered fields only (date or numeric).
Key (string) -- [REQUIRED]
The opportunity field that the condition applies to.
Value (dict) -- [REQUIRED]
The typed value the condition compares against. Specify one of the following:
A single string value – used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
A list of string values – used by ContainsAny or ContainsAll to match against multiple values.
An integral numeric value – used by the range comparisons on integral numeric fields.
A fractional numeric value – used by the range comparisons on numeric amount fields such as EstimatedMrr.
A date-time value in RFC 3339 format – used by the range comparisons on date fields.
StringValue (string) --
A single string value. Used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
StringListValue (list) --
A list of string values. Used by ContainsAny or ContainsAll to match against multiple values.
(string) --
A text value that a search filter compares against.
LongValue (integer) --
An integral numeric value, used by the range comparisons on integral numeric fields.
DoubleValue (float) --
A fractional numeric value, used by the range comparisons on numeric amount fields such as EstimatedMrr.
DateValue (datetime) --
A date-time value in RFC 3339 format, used by the range comparisons on date fields.
LessThanOrEquals (dict) --
A leaf condition that matches when the field is less than or equal to the supplied value. Supported on ordered fields only (date or numeric).
Key (string) -- [REQUIRED]
The opportunity field that the condition applies to.
Value (dict) -- [REQUIRED]
The typed value the condition compares against. Specify one of the following:
A single string value – used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
A list of string values – used by ContainsAny or ContainsAll to match against multiple values.
An integral numeric value – used by the range comparisons on integral numeric fields.
A fractional numeric value – used by the range comparisons on numeric amount fields such as EstimatedMrr.
A date-time value in RFC 3339 format – used by the range comparisons on date fields.
StringValue (string) --
A single string value. Used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
StringListValue (list) --
A list of string values. Used by ContainsAny or ContainsAll to match against multiple values.
(string) --
A text value that a search filter compares against.
LongValue (integer) --
An integral numeric value, used by the range comparisons on integral numeric fields.
DoubleValue (float) --
A fractional numeric value, used by the range comparisons on numeric amount fields such as EstimatedMrr.
DateValue (datetime) --
A date-time value in RFC 3339 format, used by the range comparisons on date fields.
dict
Specifies the field and direction used to sort the search results.
SortBy (string) -- [REQUIRED]
The field to sort the results by.
SortOrder (string) -- [REQUIRED]
The direction of the sort, either ascending or descending.
dict
Response Syntax
{
'OpportunitySearchSummaries': [
{
'Id': 'string',
'LastModifiedDate': datetime(2015, 1, 1),
'CreatedDate': datetime(2015, 1, 1),
'OpportunityType': 'Net New Business'|'Flat Renewal'|'Expansion',
'PartnerOpportunityIdentifier': 'string',
'LifeCycle': {
'ReviewStatus': 'Pending Submission'|'Submitted'|'In review'|'Approved'|'Rejected'|'Action Required',
'Stage': 'Prospect'|'Qualified'|'Technical Validation'|'Business Validation'|'Committed'|'Launched'|'Closed Lost',
'NextSteps': 'string',
'TargetCloseDate': 'string'
},
'Customer': {
'Account': {
'CompanyName': 'string',
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'AwsAccountId': 'string',
'Address': {
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
}
}
},
'Project': {
'Title': 'string',
'ApnPrograms': [
'string',
],
'ExpectedCustomerSpend': [
{
'Amount': 'string',
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'RelatedEntityIdentifiers': {
'AwsMarketplaceOffers': [
'string',
],
'AwsMarketplaceOfferSets': [
'string',
],
'AwsMarketplaceSolutions': [
'string',
],
'Solutions': [
'string',
]
},
'OpportunityTeam': [
{
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string'
},
],
'AwsOpportunitySummary': {
'Origin': 'AWS Referral'|'Partner Referral',
'CosellMotion': 'string',
'Insights': {
'EngagementScore': 'High'|'Medium'|'Low',
'OpportunityQuality': {
'Score': 123
}
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the response that the SearchOpportunities action returns.
OpportunitySearchSummaries (list) --
An array of curated summary views, one for each opportunity that matches the request criteria.
(dict) --
A curated summary view of an opportunity returned by a search. It holds the fields needed to render a search result row, take action, and run follow-up filters.
Id (string) --
The read-only, system-generated unique identifier of the opportunity.
LastModifiedDate (datetime) --
The date and time when the opportunity was last modified, in UTC.
CreatedDate (datetime) --
The date and time when the opportunity was created, in UTC.
OpportunityType (string) --
Specifies whether the opportunity is a new business opportunity, a renewal, or an expansion.
PartnerOpportunityIdentifier (string) --
The unique identifier of the opportunity in your customer relationship management (CRM) system. This value lets you link the opportunity to your CRM.
LifeCycle (dict) --
A curated lifecycle view: review status, stage, next steps, and target close date.
ReviewStatus (string) --
The approval status of the opportunity.
Stage (string) --
The stage of the opportunity.
NextSteps (string) --
The next steps for the opportunity. Mandatory for co-sell opportunities.
TargetCloseDate (string) --
The projected launch date of the opportunity, in ISO 8601 (YYYY-MM-DD) format.
Customer (dict) --
A curated customer view: company name, industry, AWS account, and country.
Account (dict) --
The end customer account details for the opportunity.
CompanyName (string) --
The name of the end customer company on the opportunity.
Industry (string) --
The industry of the end customer on the opportunity.
AwsAccountId (string) --
The end customer company's AWS account ID, if known or available.
Address (dict) --
The end customer address details for the opportunity.
CountryCode (string) --
The country of the end customer, in ISO 3166 alpha-2 format.
Project (dict) --
A curated project view: title, AWS Partner Network (APN) programs, and expected customer spend.
Title (string) --
The partner opportunity name.
ApnPrograms (list) --
The AWS Partner Network (APN) programs associated with the opportunity's products or services.
(string) --
ExpectedCustomerSpend (list) --
The estimated AWS monthly recurring revenue (MRR): amount and currency only.
(dict) --
A curated expected-spend entry: amount and currency only. Frequency and target company are omitted from search results.
Amount (string) --
The estimated monthly recurring revenue amount.
CurrencyCode (string) --
The currency of the estimated amount, in ISO 4217 format.
Tags (list) --
The tags associated with the opportunity, returned as key-value pairs.
(dict) --
The key-value pair assigned to a specified resource.
Key (string) --
The key in the tag.
Value (string) --
The value in the tag.
RelatedEntityIdentifiers (dict) --
Curated related-entity identifiers surfaced in search: AWS Marketplace offers, offer sets, and solutions.
AwsMarketplaceOffers (list) --
The AWS Marketplace offers associated with this opportunity.
(string) --
The Amazon Resource Name (ARN) that identifies an AWS Marketplace offer.
AwsMarketplaceOfferSets (list) --
The AWS Marketplace offer sets associated with this opportunity.
(string) --
The Amazon Resource Name (ARN) that identifies an AWS Marketplace offer set.
AwsMarketplaceSolutions (list) --
The AWS Marketplace solutions associated with this opportunity.
(string) --
The Amazon Resource Name (ARN) that identifies an AWS Marketplace solution.
Solutions (list) --
The proposed solutions to address the customer's business problem.
(string) --
The identifier of a partner solution. An identifier starts with S- followed by up to 19 digits.
OpportunityTeam (list) --
The opportunity owner and team members. Search results include only each member's name and business title, and exclude contact email and phone.
(dict) --
An opportunity team member surfaced in search: name and business title only, with no contact details.
FirstName (string) --
The team member's first name.
LastName (string) --
The team member's last name.
BusinessTitle (string) --
The team member's business title.
AwsOpportunitySummary (dict) --
The AWS-side view of this opportunity. Absent when no AWS opportunity summary record exists yet.
Origin (string) --
Specifies whether the opportunity originated from AWS or from the partner.
CosellMotion (string) --
The engagement classification for this opportunity. Read-only.
Insights (dict) --
Curated insights returned in search results: the engagement score and quality score.
EngagementScore (string) --
The level of engagement with the opportunity. The value is High, Medium, or Low.
OpportunityQuality (dict) --
The opportunity quality score. Null when the opportunity has not yet been scored.
Score (integer) --
A deal quality score (0-100) assigned to the opportunity.
NextToken (string) --
A pagination token for retrieving the next set of results. Pass this token in a subsequent call to get the next page. The response includes this token only when additional result pages are available.
Use CreateCustomerAccount to map a customer account from your records to an AWS customer. Provide details about the customer, such as the company name and website. AWS then matches the account to a customer and adds enrichment information about it.
Matching runs asynchronously. The response returns the new customer account with a status of PENDING. Use GetCustomerAccount to check the result and read the enrichment information.
See also: AWS API Documentation
Request Syntax
client.create_customer_account(
Catalog='string',
Account={
'CompanyName': 'string',
'WebsiteUrl': 'string',
'Duns': 'string',
'Address': {
'City': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'StreetAddress': 'string'
},
'Industry': 'string',
'OtherIndustry': 'string',
'Domain': 'string',
'ParentCompanyName': 'string'
},
PartnerAccountIdentifier='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
dict
[REQUIRED]
Specifies the details of the customer, such as the company name, website, and address. AWS uses these details to match the account to a customer.
CompanyName (string) -- [REQUIRED]
The name of the customer company.
WebsiteUrl (string) --
The website URL of the customer company.
Duns (string) --
The Data Universal Numbering System (DUNS) number of the customer company.
Address (dict) --
The address of the customer company.
City (string) --
Specifies the end Customer's city associated with the Opportunity.
PostalCode (string) --
Specifies the end Customer's postal code associated with the Opportunity.
StateOrRegion (string) --
Specifies the end Customer's state or region associated with the Opportunity.
Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP
CountryCode (string) --
Specifies the end Customer's country associated with the Opportunity.
StreetAddress (string) --
Specifies the end Customer's street address associated with the Opportunity.
Industry (string) --
The industry of the customer company.
OtherIndustry (string) --
A description of the industry, used when the industry is Other.
Domain (string) --
The internet domain of the customer company, such as example.com.
ParentCompanyName (string) --
The name of the parent company of the customer company, if any.
string
Specifies your own identifier for the customer account, such as the account ID in your CRM system. Use it to correlate the customer account with your records.
list
Specifies the tags to add to the customer account. Each tag is a key-value pair.
(dict) --
The key-value pair assigned to a specified resource.
Key (string) -- [REQUIRED]
The key in the tag.
Value (string) -- [REQUIRED]
The value in the tag.
string
Specifies a unique, case-sensitive identifier that you provide to make the request idempotent. If you retry a request with the same token, the operation returns the result of the original request instead of creating another customer account.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string',
'Status': 'PENDING'|'ENRICHED'|'NO_MATCH_FOUND'|'ACTION_REQUIRED',
'Catalog': 'string',
'PartnerAccountIdentifier': 'string',
'CreatedDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Information about create customer account response.
Arn (string) --
The Amazon Resource Name (ARN) of the customer account.
Id (string) --
The unique identifier of the customer account.
Status (string) --
The enrichment status of the new customer account. A new account starts as PENDING.
Catalog (string) --
The catalog that the customer account belongs to.
PartnerAccountIdentifier (string) --
Your own identifier for the customer account, if you provided one.
CreatedDate (datetime) --
The date and time when the customer account was created.
Use ListCustomerAccountBulkJobResults to list the outcome of each record in a bulk job. You can filter the results to records that succeeded or failed. A job that failed before it processed any records returns an empty list.
Results are paginated. Use NextToken to retrieve additional results.
See also: AWS API Documentation
Request Syntax
client.list_customer_account_bulk_job_results(
Catalog='string',
Identifier='string',
Status='SUCCEEDED'|'FAILED',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
string
[REQUIRED]
Specifies the ARN or the identifier of the bulk job.
string
Filters the results to records with the specified outcome. If you omit this field, records with all outcomes are returned.
integer
Specifies the maximum number of results to return in a single call. Use this value together with NextToken to control pagination.
string
Specifies the token for the next page of results. Use the NextToken value from a previous response to retrieve the next page.
dict
Response Syntax
{
'Results': [
{
'RequestId': 'string',
'Status': 'SUCCEEDED'|'FAILED',
'ResourceIdentifier': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Information about list customer account bulk job results response.
Results (list) --
The outcome of each record in the bulk job.
(dict) --
The outcome of processing a single record within a bulk job. It identifies the record and, when the record didn't succeed, carries an error code and message.
RequestId (string) --
The identifier of the record in the bulk job file.
Status (string) --
The outcome of processing the record.
ResourceIdentifier (string) --
This value is the identifier of the resource that Partner Central created or updated for the record. A failed record includes this value when Partner Central created the resource before the failure.
ErrorCode (string) --
A code that identifies why the record failed. Present only when the record failed.
ErrorMessage (string) --
A description of why the record failed. Present only when the record failed.
NextToken (string) --
The token to retrieve the next page of results. This value is absent when there are no more results.
The StartOpportunityBulkJob operation creates or updates many opportunities in AWS Partner Central (Partner Central) from a single CSV file. The column headers in the file determine whether the job creates or updates opportunities.
Returns a JobId for the job. Use ListOpportunityBulkJobs to track the job, ListOpportunityBulkJobResults to review each record, and GetOpportunityBulkJobReportUrl to download a report of the failed records.
See also: AWS API Documentation
Request Syntax
client.start_opportunity_bulk_job(
Catalog='string',
ClientToken='string',
FileURI='string',
FileFormat='CSV'
)
string
[REQUIRED]
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
string
[REQUIRED]
A unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time. If this token matches a previous request with the same parameters, the operation returns the JobId of the original job. If you reuse the token with different parameters, the request fails with a ConflictException.
This field is autopopulated if not provided.
string
[REQUIRED]
Specifies the location of the CSV file that contains the opportunities to create or update. Use one of the following:
An s3:// URI of a file that you uploaded to Partner Central for your account. You can add only the versionId query parameter.
An https:// presigned Amazon S3 URL
The file must be a plain-text CSV file no larger than 100 MB.
string
[REQUIRED]
Specifies the format of the input file. The only supported value is CSV.
dict
Response Syntax
{
'JobId': 'string'
}
Response Structure
(dict) --
The response to a request to start an opportunity bulk job.
JobId (string) --
The unique identifier of the bulk job. Use it with the other opportunity bulk job operations.
Searches the engagements in AWS Partner Central that match your criteria, such as customer industry or geography. You can combine a free-text Keyword, a structured Filter tree, an engagement group ( GroupId), and Sort options, and each search criterion that you specify narrows the results. Results are paginated, so use NextToken to retrieve additional results.
See also: AWS API Documentation
Request Syntax
client.search_engagements(
Catalog='string',
Keyword='string',
Filter={
'AndAllFilters': [
{'... recursive ...'},
],
'OrAllFilters': [
{'... recursive ...'},
],
'NotFilter': {'... recursive ...'},
'EqualsTo': {
'Key': 'EngagementId'|'Title'|'PartnerId'|'CreatedAt'|'LastModifiedAt'|'MemberCount'|'ProspectingCustomerGeo'|'ProspectingCustomerRegion'|'ProspectingCustomerIndustry'|'ProspectingCustomerSegment'|'ProspectingCustomerCountry'|'ProspectingCustomerCompanySize'|'ProspectingInsightsMarketplaceEngagementScore'|'ProspectingInsightsSolutionCategory'|'ProspectingInsightsSolutionSubCategory'|'LeadQualificationStatus'|'LeadReadinessScore'|'LeadCustomerIndustry'|'LeadCustomerCountryCode'|'LeadCustomerAwsMaturity'|'LeadCustomerMarketSegment'|'LeadInteractionsSourceType'|'LeadCustomerCompanyName'|'LeadInteractionsContactFirstName'|'LeadInteractionsContactLastName'|'LeadInteractionsUsecase'|'LeadInteractionsSourceName'|'LeadInteractionsContactBusinessTitle'|'ContextType',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'ContainsAny': {
'Key': 'EngagementId'|'Title'|'PartnerId'|'CreatedAt'|'LastModifiedAt'|'MemberCount'|'ProspectingCustomerGeo'|'ProspectingCustomerRegion'|'ProspectingCustomerIndustry'|'ProspectingCustomerSegment'|'ProspectingCustomerCountry'|'ProspectingCustomerCompanySize'|'ProspectingInsightsMarketplaceEngagementScore'|'ProspectingInsightsSolutionCategory'|'ProspectingInsightsSolutionSubCategory'|'LeadQualificationStatus'|'LeadReadinessScore'|'LeadCustomerIndustry'|'LeadCustomerCountryCode'|'LeadCustomerAwsMaturity'|'LeadCustomerMarketSegment'|'LeadInteractionsSourceType'|'LeadCustomerCompanyName'|'LeadInteractionsContactFirstName'|'LeadInteractionsContactLastName'|'LeadInteractionsUsecase'|'LeadInteractionsSourceName'|'LeadInteractionsContactBusinessTitle'|'ContextType',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'ContainsAll': {
'Key': 'EngagementId'|'Title'|'PartnerId'|'CreatedAt'|'LastModifiedAt'|'MemberCount'|'ProspectingCustomerGeo'|'ProspectingCustomerRegion'|'ProspectingCustomerIndustry'|'ProspectingCustomerSegment'|'ProspectingCustomerCountry'|'ProspectingCustomerCompanySize'|'ProspectingInsightsMarketplaceEngagementScore'|'ProspectingInsightsSolutionCategory'|'ProspectingInsightsSolutionSubCategory'|'LeadQualificationStatus'|'LeadReadinessScore'|'LeadCustomerIndustry'|'LeadCustomerCountryCode'|'LeadCustomerAwsMaturity'|'LeadCustomerMarketSegment'|'LeadInteractionsSourceType'|'LeadCustomerCompanyName'|'LeadInteractionsContactFirstName'|'LeadInteractionsContactLastName'|'LeadInteractionsUsecase'|'LeadInteractionsSourceName'|'LeadInteractionsContactBusinessTitle'|'ContextType',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'GreaterThan': {
'Key': 'EngagementId'|'Title'|'PartnerId'|'CreatedAt'|'LastModifiedAt'|'MemberCount'|'ProspectingCustomerGeo'|'ProspectingCustomerRegion'|'ProspectingCustomerIndustry'|'ProspectingCustomerSegment'|'ProspectingCustomerCountry'|'ProspectingCustomerCompanySize'|'ProspectingInsightsMarketplaceEngagementScore'|'ProspectingInsightsSolutionCategory'|'ProspectingInsightsSolutionSubCategory'|'LeadQualificationStatus'|'LeadReadinessScore'|'LeadCustomerIndustry'|'LeadCustomerCountryCode'|'LeadCustomerAwsMaturity'|'LeadCustomerMarketSegment'|'LeadInteractionsSourceType'|'LeadCustomerCompanyName'|'LeadInteractionsContactFirstName'|'LeadInteractionsContactLastName'|'LeadInteractionsUsecase'|'LeadInteractionsSourceName'|'LeadInteractionsContactBusinessTitle'|'ContextType',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'GreaterThanOrEquals': {
'Key': 'EngagementId'|'Title'|'PartnerId'|'CreatedAt'|'LastModifiedAt'|'MemberCount'|'ProspectingCustomerGeo'|'ProspectingCustomerRegion'|'ProspectingCustomerIndustry'|'ProspectingCustomerSegment'|'ProspectingCustomerCountry'|'ProspectingCustomerCompanySize'|'ProspectingInsightsMarketplaceEngagementScore'|'ProspectingInsightsSolutionCategory'|'ProspectingInsightsSolutionSubCategory'|'LeadQualificationStatus'|'LeadReadinessScore'|'LeadCustomerIndustry'|'LeadCustomerCountryCode'|'LeadCustomerAwsMaturity'|'LeadCustomerMarketSegment'|'LeadInteractionsSourceType'|'LeadCustomerCompanyName'|'LeadInteractionsContactFirstName'|'LeadInteractionsContactLastName'|'LeadInteractionsUsecase'|'LeadInteractionsSourceName'|'LeadInteractionsContactBusinessTitle'|'ContextType',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'LessThan': {
'Key': 'EngagementId'|'Title'|'PartnerId'|'CreatedAt'|'LastModifiedAt'|'MemberCount'|'ProspectingCustomerGeo'|'ProspectingCustomerRegion'|'ProspectingCustomerIndustry'|'ProspectingCustomerSegment'|'ProspectingCustomerCountry'|'ProspectingCustomerCompanySize'|'ProspectingInsightsMarketplaceEngagementScore'|'ProspectingInsightsSolutionCategory'|'ProspectingInsightsSolutionSubCategory'|'LeadQualificationStatus'|'LeadReadinessScore'|'LeadCustomerIndustry'|'LeadCustomerCountryCode'|'LeadCustomerAwsMaturity'|'LeadCustomerMarketSegment'|'LeadInteractionsSourceType'|'LeadCustomerCompanyName'|'LeadInteractionsContactFirstName'|'LeadInteractionsContactLastName'|'LeadInteractionsUsecase'|'LeadInteractionsSourceName'|'LeadInteractionsContactBusinessTitle'|'ContextType',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
},
'LessThanOrEquals': {
'Key': 'EngagementId'|'Title'|'PartnerId'|'CreatedAt'|'LastModifiedAt'|'MemberCount'|'ProspectingCustomerGeo'|'ProspectingCustomerRegion'|'ProspectingCustomerIndustry'|'ProspectingCustomerSegment'|'ProspectingCustomerCountry'|'ProspectingCustomerCompanySize'|'ProspectingInsightsMarketplaceEngagementScore'|'ProspectingInsightsSolutionCategory'|'ProspectingInsightsSolutionSubCategory'|'LeadQualificationStatus'|'LeadReadinessScore'|'LeadCustomerIndustry'|'LeadCustomerCountryCode'|'LeadCustomerAwsMaturity'|'LeadCustomerMarketSegment'|'LeadInteractionsSourceType'|'LeadCustomerCompanyName'|'LeadInteractionsContactFirstName'|'LeadInteractionsContactLastName'|'LeadInteractionsUsecase'|'LeadInteractionsSourceName'|'LeadInteractionsContactBusinessTitle'|'ContextType',
'Value': {
'StringValue': 'string',
'StringListValue': [
'string',
],
'LongValue': 123,
'DateValue': datetime(2015, 1, 1)
}
}
},
GroupId='string',
Sort={
'SortBy': 'EngagementId'|'Title'|'PartnerId'|'CreatedAt'|'LastModifiedAt'|'MemberCount'|'ProspectingCustomerGeo'|'ProspectingCustomerRegion'|'ProspectingCustomerIndustry'|'ProspectingCustomerSegment'|'ProspectingCustomerCountry'|'ProspectingCustomerCompanySize'|'ProspectingInsightsMarketplaceEngagementScore'|'ProspectingInsightsSolutionCategory'|'ProspectingInsightsSolutionSubCategory'|'LeadQualificationStatus'|'LeadReadinessScore'|'LeadCustomerIndustry'|'LeadCustomerCountryCode'|'LeadCustomerAwsMaturity'|'LeadCustomerMarketSegment'|'LeadCustomerCompanyName'|'LeadInteractionsContactFirstName'|'LeadInteractionsContactLastName'|'LeadInteractionsUsecase'|'LeadInteractionsContactBusinessTitle',
'SortOrder': 'ASCENDING'|'DESCENDING'
},
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
Specifies the catalog to search. The following values are valid:
AWS: Production.
Sandbox: Testing environments.
string
An optional free-text query string matched against the engagement title, description, customer company name, and member company names. When provided together with Filter or GroupId, each one narrows the result set.
dict
A recursive, structured filter tree. Each node is either a boolean combinator ( AndAllFilters, OrAllFilters, or NotFilter) or a leaf predicate (a single comparison such as EqualsTo). When provided together with Keyword or GroupId, each one narrows the result set.
AndAllFilters (list) --
A list of sub-filters that are joined with a logical AND. The node matches only when every sub-filter matches.
(dict) --
A recursive filter node. Exactly one member must be set. The boolean combinators nest sub-filters: AndAllFilters joins its children with AND, OrAllFilters matches when at least one child matches, and NotFilter negates its single child. The remaining members are leaf conditions over a single field. Nesting is limited to a depth of 3, and each combinator list can contain up to 10 entries.
OrAllFilters (list) --
A list of sub-filters that are joined with a logical OR. The node matches when at least one sub-filter matches.
(dict) --
A recursive filter node. Exactly one member must be set. The boolean combinators nest sub-filters: AndAllFilters joins its children with AND, OrAllFilters matches when at least one child matches, and NotFilter negates its single child. The remaining members are leaf conditions over a single field. Nesting is limited to a depth of 3, and each combinator list can contain up to 10 entries.
NotFilter (dict) --
A single sub-filter that is negated. The node matches when the sub-filter does not match.
EqualsTo (dict) --
A leaf condition that matches when the field equals the supplied StringValue.
Key (string) -- [REQUIRED]
The engagement field that the condition applies to.
Value (dict) -- [REQUIRED]
The typed value the condition compares against.
StringValue (string) --
A single string value, used by EqualsTo, ContainsAny, and ContainsAll.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
A string value used in a filter condition.
LongValue (integer) --
An integral numeric value, used by the range comparisons on numeric fields.
DateValue (datetime) --
A date-time value in RFC 3339 format, used by the range comparisons on date fields.
ContainsAny (dict) --
A leaf condition that matches when the field contains any of the supplied values as a case-insensitive substring. Specify a single StringValue or a StringListValue. For a field that holds one value for each lead interaction, the condition matches when any of those values contains a supplied value. Supported on string fields only.
Key (string) -- [REQUIRED]
The engagement field that the condition applies to.
Value (dict) -- [REQUIRED]
The typed value the condition compares against.
StringValue (string) --
A single string value, used by EqualsTo, ContainsAny, and ContainsAll.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
A string value used in a filter condition.
LongValue (integer) --
An integral numeric value, used by the range comparisons on numeric fields.
DateValue (datetime) --
A date-time value in RFC 3339 format, used by the range comparisons on date fields.
ContainsAll (dict) --
A leaf condition that matches when the field holds every supplied value exactly. Specify a single StringValue or a StringListValue. For a field that holds one value for each lead interaction, each supplied value must be present on at least one interaction. For a single-valued field, a list of more than one value returns no results. Supported on string fields only.
Key (string) -- [REQUIRED]
The engagement field that the condition applies to.
Value (dict) -- [REQUIRED]
The typed value the condition compares against.
StringValue (string) --
A single string value, used by EqualsTo, ContainsAny, and ContainsAll.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
A string value used in a filter condition.
LongValue (integer) --
An integral numeric value, used by the range comparisons on numeric fields.
DateValue (datetime) --
A date-time value in RFC 3339 format, used by the range comparisons on date fields.
GreaterThan (dict) --
A leaf condition that matches when the field is greater than the supplied value. This condition is supported only on ordered fields, such as date and numeric fields.
Key (string) -- [REQUIRED]
The engagement field that the condition applies to.
Value (dict) -- [REQUIRED]
The typed value the condition compares against.
StringValue (string) --
A single string value, used by EqualsTo, ContainsAny, and ContainsAll.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
A string value used in a filter condition.
LongValue (integer) --
An integral numeric value, used by the range comparisons on numeric fields.
DateValue (datetime) --
A date-time value in RFC 3339 format, used by the range comparisons on date fields.
GreaterThanOrEquals (dict) --
A leaf condition that matches when the field is greater than or equal to the supplied value. This condition is supported only on ordered fields, such as date and numeric fields.
Key (string) -- [REQUIRED]
The engagement field that the condition applies to.
Value (dict) -- [REQUIRED]
The typed value the condition compares against.
StringValue (string) --
A single string value, used by EqualsTo, ContainsAny, and ContainsAll.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
A string value used in a filter condition.
LongValue (integer) --
An integral numeric value, used by the range comparisons on numeric fields.
DateValue (datetime) --
A date-time value in RFC 3339 format, used by the range comparisons on date fields.
LessThan (dict) --
A leaf condition that matches when the field is less than the supplied value. This condition is supported only on ordered fields, such as date and numeric fields.
Key (string) -- [REQUIRED]
The engagement field that the condition applies to.
Value (dict) -- [REQUIRED]
The typed value the condition compares against.
StringValue (string) --
A single string value, used by EqualsTo, ContainsAny, and ContainsAll.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
A string value used in a filter condition.
LongValue (integer) --
An integral numeric value, used by the range comparisons on numeric fields.
DateValue (datetime) --
A date-time value in RFC 3339 format, used by the range comparisons on date fields.
LessThanOrEquals (dict) --
A leaf condition that matches when the field is less than or equal to the supplied value. This condition is supported only on ordered fields, such as date and numeric fields.
Key (string) -- [REQUIRED]
The engagement field that the condition applies to.
Value (dict) -- [REQUIRED]
The typed value the condition compares against.
StringValue (string) --
A single string value, used by EqualsTo, ContainsAny, and ContainsAll.
StringListValue (list) --
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
(string) --
A string value used in a filter condition.
LongValue (integer) --
An integral numeric value, used by the range comparisons on numeric fields.
DateValue (datetime) --
A date-time value in RFC 3339 format, used by the range comparisons on date fields.
string
The identifier of an engagement group that ListEngagementGroups returns. When you specify a group, the operation returns only the engagements that match the criteria that define the group. The group must be active and available to you in the specified catalog. Otherwise, the request fails with a ValidationException.
dict
Specifies the field and direction used to sort the search results. If you omit this field, results are sorted by creation time, newest first.
SortBy (string) -- [REQUIRED]
The field to sort the results by.
SortOrder (string) -- [REQUIRED]
The direction of the sort, either ascending or descending.
integer
Specifies the maximum number of results to return in a single call. If you omit this value, the operation returns up to 20 results. Use this value to control pagination together with NextToken.
string
A pagination token returned by a previous call. Pass it in a subsequent call to retrieve the next page of results. Omit it on the first call.
dict
Response Syntax
{
'EngagementSearchSummaries': [
{
'Id': 'string',
'Arn': 'string',
'Title': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'CreatedBy': 'string',
'MemberCount': 123,
'ModifiedAt': datetime(2015, 1, 1),
'ModifiedBy': 'string',
'Contexts': [
{
'Id': 'string',
'Type': 'CustomerProject'|'Lead'|'ProspectingResult'|'CustomerAccount',
'Payload': {
'CustomerProject': {
'Customer': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'Project': {
'Title': 'string',
'BusinessProblem': 'string',
'TargetCompletionDate': 'string'
}
},
'Lead': {
'Insights': {
'LeadReadinessScore': 'string',
'ChannelRecommendation': {
'RecommendedChannel': 'string',
'BestOutreachWindows': [
{
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'StartTimeUtc': 'string',
'EndTimeUtc': 'string'
},
]
}
},
'QualificationStatus': 'string',
'Customer': {
'Industry': 'string',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'Address': {
'City': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'CountryCode': 'string'
},
'AwsMaturity': 'string',
'MarketSegment': 'string'
},
'Interactions': [
{
'SourceType': 'string',
'SourceId': 'string',
'SourceName': 'string',
'Usecase': 'string',
'InteractionDate': datetime(2015, 1, 1),
'CustomerAction': 'string',
'BusinessProblem': 'string',
'Contact': {
'BusinessTitle': 'string',
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'Phone': 'string'
}
},
]
},
'ProspectingResult': {
'Aws': {
'Customer': {
'AccountName': 'string',
'Geo': 'string',
'Region': 'string',
'SubRegion': 'string',
'Country': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'SubIndustry': 'string',
'Segment': 'string',
'CompanySize': 'string',
'EligiblePrograms': [
'string',
],
'PublicProfileSummary': 'string'
},
'Insights': {
'MarketplaceEngagementScore': 'string',
'SolutionScore': 'string',
'SolutionCategory': 'string',
'SolutionSubCategory': 'string'
},
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TaskId': 'string',
'TaskArn': 'string',
'TaskName': 'string'
}
},
'CustomerAccount': {
'AccountIdentifier': 'string',
'Customer': {
'Industry': 'string',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
}
}
}
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The response from the SearchEngagements operation.
EngagementSearchSummaries (list) --
An array of summaries, one for each engagement that matches the request criteria.
(dict) --
A summary of an engagement returned by SearchEngagements. It contains the same engagement fields as the GetEngagement response.
Id (string) --
The unique resource identifier of the engagement.
Arn (string) --
The Amazon Resource Name (ARN) of the engagement.
Title (string) --
The title of the engagement.
Description (string) --
A description of the engagement.
CreatedAt (datetime) --
The date and time when the engagement was created, in ISO 8601 format, in Coordinated Universal Time (UTC).
CreatedBy (string) --
The AWS account ID of the user who created the engagement.
MemberCount (integer) --
The number of members in the engagement.
ModifiedAt (datetime) --
The date and time when the engagement was last modified, in ISO 8601 format, in Coordinated Universal Time (UTC).
ModifiedBy (string) --
The AWS account ID of the user who last modified the engagement.
Contexts (list) --
The contexts associated with the engagement, such as prospecting results, lead details, and customer project details.
(dict) --
Provides detailed context information for an Engagement. This structure allows for specifying the type of context and its associated payload.
Id (string) --
The unique identifier of the engagement context. This ID is used to reference and manage the specific context within the engagement.
Type (string) --
Specifies the type of Engagement context. Valid values are "CustomerProject" or "Document", indicating whether the context relates to a customer project or a document respectively.
Payload (dict) --
Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.
CustomerProject (dict) --
Contains detailed information about a customer project when the context type is "CustomerProject". This field is present only when the Type in EngagementContextDetails is set to "CustomerProject".
Customer (dict) --
Contains details about the customer that the customer project belongs to.
Industry (string) --
Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.
CompanyName (string) --
Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.
WebsiteUrl (string) --
Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.
CountryCode (string) --
Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.
Project (dict) --
Information about the customer project associated with the Engagement.
Title (string) --
The title of the project.
BusinessProblem (string) --
A description of the business problem the project aims to solve.
TargetCompletionDate (string) --
The target completion date for the customer's project.
Lead (dict) --
Contains detailed information about a lead when the context type is "Lead". This field is present only when the Type in EngagementContextDetails is set to "Lead".
Insights (dict) --
Insights that AI generates and associates with the lead. These insights provide automated analysis such as lead readiness scoring to help partners assess the lead quality.
LeadReadinessScore (string) --
A score that indicates the lead's readiness for engagement. Valid values are Low, Medium, and High. Use this score to prioritize leads based on their likelihood of conversion.
ChannelRecommendation (dict) --
The outreach channel most commonly recommended for leads that share this lead's country, geography, region, and company segment. It includes the days and the Coordinated Universal Time (UTC) hours when that channel is best used. This is guidance for the group of similar leads. It doesn't describe this lead's own contact history. Present only when a recommendation is available for the lead.
RecommendedChannel (string) --
The recommended outreach channel for the group of similar leads. Valid values are EMAIL and CALL.
BestOutreachWindows (list) --
The recommended day-specific outreach windows for the recommended channel, expressed in Coordinated Universal Time (UTC). Each window applies to one day, and more than one window can fall on the same day. This field is optional and appears only when window guidance is available.
(dict) --
A single recommended outreach window for one day, expressed in Coordinated Universal Time (UTC).
Day (string) --
The day of the week that this outreach window applies to. Valid values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY.
StartTimeUtc (string) --
The inclusive start of the outreach window, in Coordinated Universal Time (UTC), in 24-hour HH:mm format.
EndTimeUtc (string) --
The exclusive end of the outreach window, in Coordinated Universal Time (UTC), in 24-hour HH:mm format.
QualificationStatus (string) --
Indicates the current qualification status of the lead, such as whether it has been qualified, disqualified, or is still under evaluation. This helps track the lead's progression through the qualification process.
Customer (dict) --
Contains detailed information about the customer associated with the lead, including company information, contact details, and other relevant customer data.
Industry (string) --
Specifies the industry sector to which the lead customer's company belongs. This categorization helps in understanding the customer's business context and tailoring appropriate solutions.
CompanyName (string) --
The name of the lead customer's company. This field is essential for identifying and tracking the customer organization associated with the lead.
WebsiteUrl (string) --
The website URL of the lead customer's company. This provides additional context about the customer organization and helps verify company legitimacy and size.
Address (dict) --
The address information for the lead customer.
City (string) --
The city of the lead customer's address.
PostalCode (string) --
The postal code of the lead customer's address.
StateOrRegion (string) --
The state or region of the lead customer's address.
CountryCode (string) --
The country code of the lead customer's address.
AwsMaturity (string) --
Indicates the customer's level of experience and adoption with AWS services. This assessment helps determine the appropriate engagement approach and solution complexity.
MarketSegment (string) --
Specifies the market segment classification of the lead customer, such as enterprise, mid-market, or small business. This segmentation helps in targeting appropriate solutions and engagement strategies.
Interactions (list) --
An array of interactions that have occurred with the lead, providing a history of communications, meetings, and other engagement activities related to the lead.
(dict) --
Represents a specific interaction or touchpoint with a lead customer. This structure captures details about communications, meetings, or other engagement activities that help track the lead's progression and engagement history.
SourceType (string) --
Specifies the type of source that generated the lead interaction, such as "Event", "Website", "Referral", or "Campaign". This categorization helps track lead generation effectiveness across different channels.
SourceId (string) --
The unique identifier of the specific source that generated the lead interaction. This ID provides traceability back to the original lead generation activity.
SourceName (string) --
The descriptive name of the source that generated the lead interaction, providing a human-readable identifier for the lead generation channel or activity.
Usecase (string) --
Describes the specific use case or business scenario discussed during the lead interaction. This helps categorize the customer's interests and potential solutions.
InteractionDate (datetime) --
The date and time when the lead interaction occurred, in ISO 8601 format (UTC). This timestamp helps track the chronology of lead engagement activities.
CustomerAction (string) --
Describes the action taken by the customer during or as a result of the interaction, such as requesting information, scheduling a meeting, or expressing interest in a solution.
BusinessProblem (string) --
Describes the business problem or challenge that the customer discussed during the interaction. This information helps qualify the lead and identify appropriate solutions.
Contact (dict) --
Contains contact information for the customer representative involved in the lead interaction, including their name, title, and contact details.
BusinessTitle (string) --
The lead contact's business title or job role associated with the engagement.
Email (string) --
The lead contact's email address associated with the engagement.
FirstName (string) --
The lead contact's first name associated with the engagement.
LastName (string) --
The lead contact's last name associated with the engagement.
Phone (string) --
The lead contact's phone number associated with the engagement.
ProspectingResult (dict) --
Contains prospecting result data with enriched insights. The system generates these insights when a partner runs an autonomous prospecting job on leads. This field appears only when the context type is "ProspectingResult".
Aws (dict) --
Prospecting data and insights that AWS provides during the prospecting job. This includes customer details, task information, and scoring that AI generates.
Customer (dict) --
Contains details about the prospected customer account, including geographic, industry, and segment classifications.
AccountName (string) --
The name of the prospected customer account.
Geo (string) --
The geographic region classification of the prospected customer account.
Region (string) --
The specific region of the prospected customer account.
SubRegion (string) --
The subregion classification of the prospected customer account.
Country (string) --
The country code of the prospected customer account.
Industry (string) --
The industry classification of the prospected customer account.
SubIndustry (string) --
The sub-industry classification of the prospected customer account. This provides more granular categorization within the primary industry.
Segment (string) --
The market segment classification of the prospected customer account.
CompanySize (string) --
The company size classification of the prospected customer account.
EligiblePrograms (list) --
A list of AWS Greenfield programs that the prospected customer is eligible for. Use this list to identify relevant go-to-market opportunities.
(string) --
PublicProfileSummary (string) --
A summary of publicly available information about the prospected customer. The system uses this summary to generate customer insights and inform engagement strategies.
Insights (dict) --
Insights that AI generates from the prospecting analysis. These insights include engagement scores and solution fit assessments for the prospected customer.
MarketplaceEngagementScore (string) --
A score that indicates the prospected customer's level of engagement with AWS Marketplace. Valid values are High, Medium, and Low.
SolutionScore (string) --
A score that indicates how well the partner's solution fits the prospected customer's needs.
SolutionCategory (string) --
The primary solution category classification for the prospected customer. This indicates the type of solution that best addresses their needs.
SolutionSubCategory (string) --
The solution sub-category classification for the prospected customer. This provides more granular categorization of the recommended solution type.
StartTime (datetime) --
The timestamp when the prospecting result context was created. The format is ISO 8601 (UTC).
EndTime (datetime) --
The timestamp when the prospecting task completed processing. The format is ISO 8601 (UTC).
TaskId (string) --
The unique identifier of the prospecting task that generates this result.
TaskArn (string) --
The Amazon Resource Name (ARN) of the prospecting task. Use this ARN to track and manage the task within AWS.
TaskName (string) --
The name that the user provides for the prospecting task that generates this result.
CustomerAccount (dict) --
The customer account context for account planning. This field appears only when the context type is CustomerAccount.
AccountIdentifier (string) --
The identifier of the customer account that the engagement concerns, as an Amazon Resource Name (ARN) or a customer account identifier.
Customer (dict) --
A snapshot of the customer company's identity for the account. On read, the service populates this from the account identifier.
Industry (string) --
The industry classification of the customer company.
CompanyName (string) --
The name of the customer company.
WebsiteUrl (string) --
The website URL of the customer company.
CountryCode (string) --
The country of the customer company, as an ISO 3166-1 alpha-2 country code.
NextToken (string) --
A pagination token used to retrieve the next set of results in subsequent calls. The response includes this token only when additional result pages are available.
Use StartCustomerAccountBulkJob to create many customer accounts from a single file. The job starts processing as soon as it is created.
Use GetCustomerAccountBulkJob to track progress, ListCustomerAccountBulkJobResults to review the outcome of each record, and GetCustomerAccountBulkJobReportUrl to download a report when the job finishes.
See also: AWS API Documentation
Request Syntax
client.start_customer_account_bulk_job(
Catalog='string',
ClientToken='string',
FileUri='string'
)
string
[REQUIRED]
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
string
[REQUIRED]
Specifies a unique, case-sensitive identifier that you provide to make the request idempotent. If you retry a request with the same token, the operation returns the original job instead of starting another one.
This field is autopopulated if not provided.
string
[REQUIRED]
Specifies the location of the file that contains the customer accounts to create.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string',
'Status': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
'CreatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Information about start customer account bulk job response.
Arn (string) --
The Amazon Resource Name (ARN) of the bulk job.
Id (string) --
The unique identifier of the bulk job.
Status (string) --
The current status of the bulk job.
CreatedAt (datetime) --
The date and time when the bulk job was created.
Lists the active, fully curated AWS Partner Central engagement groups that are available to you in the specified catalog. An engagement group is a curated set of engagements that share common characteristics, such as customer geography, industry, or solution category. To retrieve the engagements in a group, pass the group Id to SearchEngagements as GroupId, and use NextToken to retrieve additional pages of groups.
See also: AWS API Documentation
Request Syntax
client.list_engagement_groups(
Catalog='string',
ReadinessLevel='SalesReady'|'MarketingReady'|'LowPotential',
Sort={
'SortBy': 'Count'|'UpdatedAt',
'SortOrder': 'ASCENDING'|'DESCENDING'
},
EngagementGroupIdentifiers=[
'string',
],
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
Specifies the catalog in which to list engagement groups. The following values are valid:
AWS: Production.
Sandbox: Testing environments.
string
Filters the results to engagement groups with the specified readiness level. If you omit this field, the operation returns groups of all readiness levels.
dict
Specifies the field and direction used to sort the results. You can sort by Count or UpdatedAt. If you omit this field, the operation returns groups in recommended order.
SortBy (string) -- [REQUIRED]
The field to sort the results by.
SortOrder (string) -- [REQUIRED]
The direction of the sort, either ascending or descending.
list
Filters the results to the specified engagement groups. Each entry can be an engagement group identifier or an engagement group ARN. You can specify 1 to 10 entries. Identifiers that don't match an active group available to you are ignored.
(string) --
Specifies an engagement group. You can specify either of the following:
An engagement group identifier.
An engagement group ARN.
integer
Specifies the maximum number of results to return in a single call. If you omit this value, the operation returns up to 20 results. Use this value to control pagination together with NextToken.
string
A pagination token returned by a previous call. Pass it in a subsequent call to retrieve the next page of results. Omit it on the first call.
dict
Response Syntax
{
'EngagementGroupSummaries': [
{
'Id': 'string',
'Arn': 'string',
'Catalog': 'string',
'Name': 'string',
'Description': 'string',
'Count': 123,
'ReadinessLevel': 'SalesReady'|'MarketingReady'|'LowPotential',
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The response from the ListEngagementGroups operation.
EngagementGroupSummaries (list) --
An array of engagement groups that are available to you in the specified catalog. The array is empty when no groups are available.
(dict) --
A summary of an engagement group: a curated set of engagements that share common characteristics.
Id (string) --
The unique identifier of the engagement group. Pass this value to SearchEngagements as GroupId.
Arn (string) --
The Amazon Resource Name (ARN) of the engagement group.
Catalog (string) --
The catalog that the engagement group belongs to.
Name (string) --
The name of the engagement group.
Description (string) --
A description of the engagements that the group targets.
Count (integer) --
The number of engagements in the group that are available to you.
ReadinessLevel (string) --
The readiness level of the engagement group, which indicates the recommended call to action for its leads.
UpdatedAt (datetime) --
The date and time when the engagement group was last updated, in ISO 8601 format, in Coordinated Universal Time (UTC).
NextToken (string) --
A pagination token used to retrieve the next set of results in subsequent calls. The response includes this token only when additional result pages are available.
{'Contexts': {'Payload': {'CustomerAccount': {'AccountIdentifier': 'string',
'Customer': {'CompanyName': 'string',
'CountryCode': 'US '
'| '
'AF '
'| '
'AX '
'| '
'AL '
'| '
'DZ '
'| '
'AS '
'| '
'AD '
'| '
'AO '
'| '
'AI '
'| '
'AQ '
'| '
'AG '
'| '
'AR '
'| '
'AM '
'| '
'AW '
'| '
'AU '
'| '
'AT '
'| '
'AZ '
'| '
'BS '
'| '
'BH '
'| '
'BD '
'| '
'BB '
'| '
'BY '
'| '
'BE '
'| '
'BZ '
'| '
'BJ '
'| '
'BM '
'| '
'BT '
'| '
'BO '
'| '
'BQ '
'| '
'BA '
'| '
'BW '
'| '
'BV '
'| '
'BR '
'| '
'IO '
'| '
'BN '
'| '
'BG '
'| '
'BF '
'| '
'BI '
'| '
'KH '
'| '
'CM '
'| '
'CA '
'| '
'CV '
'| '
'KY '
'| '
'CF '
'| '
'TD '
'| '
'CL '
'| '
'CN '
'| '
'CX '
'| '
'CC '
'| '
'CO '
'| '
'KM '
'| '
'CG '
'| '
'CK '
'| '
'CR '
'| '
'CI '
'| '
'HR '
'| '
'CU '
'| '
'CW '
'| '
'CY '
'| '
'CZ '
'| '
'CD '
'| '
'DK '
'| '
'DJ '
'| '
'DM '
'| '
'DO '
'| '
'EC '
'| '
'EG '
'| '
'SV '
'| '
'GQ '
'| '
'ER '
'| '
'EE '
'| '
'ET '
'| '
'FK '
'| '
'FO '
'| '
'FJ '
'| '
'FI '
'| '
'FR '
'| '
'GF '
'| '
'PF '
'| '
'TF '
'| '
'GA '
'| '
'GM '
'| '
'GE '
'| '
'DE '
'| '
'GH '
'| '
'GI '
'| '
'GR '
'| '
'GL '
'| '
'GD '
'| '
'GP '
'| '
'GU '
'| '
'GT '
'| '
'GG '
'| '
'GN '
'| '
'GW '
'| '
'GY '
'| '
'HT '
'| '
'HM '
'| '
'VA '
'| '
'HN '
'| '
'HK '
'| '
'HU '
'| '
'IS '
'| '
'IN '
'| '
'ID '
'| '
'IR '
'| '
'IQ '
'| '
'IE '
'| '
'IM '
'| '
'IL '
'| '
'IT '
'| '
'JM '
'| '
'JP '
'| '
'JE '
'| '
'JO '
'| '
'KZ '
'| '
'KE '
'| '
'KI '
'| '
'KR '
'| '
'KW '
'| '
'KG '
'| '
'LA '
'| '
'LV '
'| '
'LB '
'| '
'LS '
'| '
'LR '
'| '
'LY '
'| '
'LI '
'| '
'LT '
'| '
'LU '
'| '
'MO '
'| '
'MK '
'| '
'MG '
'| '
'MW '
'| '
'MY '
'| '
'MV '
'| '
'ML '
'| '
'MT '
'| '
'MH '
'| '
'MQ '
'| '
'MR '
'| '
'MU '
'| '
'YT '
'| '
'MX '
'| '
'FM '
'| '
'MD '
'| '
'MC '
'| '
'MN '
'| '
'ME '
'| '
'MS '
'| '
'MA '
'| '
'MZ '
'| '
'MM '
'| '
'NA '
'| '
'NR '
'| '
'NP '
'| '
'NL '
'| '
'AN '
'| '
'NC '
'| '
'NZ '
'| '
'NI '
'| '
'NE '
'| '
'NG '
'| '
'NU '
'| '
'NF '
'| '
'MP '
'| '
'NO '
'| '
'OM '
'| '
'PK '
'| '
'PW '
'| '
'PS '
'| '
'PA '
'| '
'PG '
'| '
'PY '
'| '
'PE '
'| '
'PH '
'| '
'PN '
'| '
'PL '
'| '
'PT '
'| '
'PR '
'| '
'QA '
'| '
'RE '
'| '
'RO '
'| '
'RU '
'| '
'RW '
'| '
'BL '
'| '
'SH '
'| '
'KN '
'| '
'LC '
'| '
'MF '
'| '
'PM '
'| '
'VC '
'| '
'WS '
'| '
'SM '
'| '
'ST '
'| '
'SA '
'| '
'SN '
'| '
'RS '
'| '
'SC '
'| '
'SL '
'| '
'SG '
'| '
'SX '
'| '
'SK '
'| '
'SI '
'| '
'SB '
'| '
'SO '
'| '
'ZA '
'| '
'GS '
'| '
'SS '
'| '
'ES '
'| '
'LK '
'| '
'SD '
'| '
'SR '
'| '
'SJ '
'| '
'SZ '
'| '
'SE '
'| '
'CH '
'| '
'SY '
'| '
'TW '
'| '
'TJ '
'| '
'TZ '
'| '
'TH '
'| '
'TL '
'| '
'TG '
'| '
'TK '
'| '
'TO '
'| '
'TT '
'| '
'TN '
'| '
'TR '
'| '
'TM '
'| '
'TC '
'| '
'TV '
'| '
'UG '
'| '
'UA '
'| '
'AE '
'| '
'GB '
'| '
'UM '
'| '
'UY '
'| '
'UZ '
'| '
'VU '
'| '
'VE '
'| '
'VN '
'| '
'VG '
'| '
'VI '
'| '
'WF '
'| '
'EH '
'| '
'YE '
'| '
'ZM '
'| '
'ZW',
'Industry': 'string',
'WebsiteUrl': 'string'}},
'Lead': {'Insights': {'ChannelRecommendation': {'BestOutreachWindows': [{'Day': 'MONDAY '
'| '
'TUESDAY '
'| '
'WEDNESDAY '
'| '
'THURSDAY '
'| '
'FRIDAY '
'| '
'SATURDAY '
'| '
'SUNDAY',
'EndTimeUtc': 'string',
'StartTimeUtc': 'string'}],
'RecommendedChannel': 'string'}}}},
'Type': {'CustomerAccount'}}}
The CreateEngagement action allows you to create an Engagement, which serves as a collaborative space between different parties such as AWS Partners and AWS Sellers. This action automatically adds the caller's AWS account as an active member of the newly created Engagement.
See also: AWS API Documentation
Request Syntax
client.create_engagement(
Catalog='string',
ClientToken='string',
Title='string',
Description='string',
Contexts=[
{
'Id': 'string',
'Type': 'CustomerProject'|'Lead'|'ProspectingResult'|'CustomerAccount',
'Payload': {
'CustomerProject': {
'Customer': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'Project': {
'Title': 'string',
'BusinessProblem': 'string',
'TargetCompletionDate': 'string'
}
},
'Lead': {
'Insights': {
'LeadReadinessScore': 'string',
'ChannelRecommendation': {
'RecommendedChannel': 'string',
'BestOutreachWindows': [
{
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'StartTimeUtc': 'string',
'EndTimeUtc': 'string'
},
]
}
},
'QualificationStatus': 'string',
'Customer': {
'Industry': 'string',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'Address': {
'City': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'CountryCode': 'string'
},
'AwsMaturity': 'string',
'MarketSegment': 'string'
},
'Interactions': [
{
'SourceType': 'string',
'SourceId': 'string',
'SourceName': 'string',
'Usecase': 'string',
'InteractionDate': datetime(2015, 1, 1),
'CustomerAction': 'string',
'BusinessProblem': 'string',
'Contact': {
'BusinessTitle': 'string',
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'Phone': 'string'
}
},
]
},
'ProspectingResult': {
'Aws': {
'Customer': {
'AccountName': 'string',
'Geo': 'string',
'Region': 'string',
'SubRegion': 'string',
'Country': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'SubIndustry': 'string',
'Segment': 'string',
'CompanySize': 'string',
'EligiblePrograms': [
'string',
],
'PublicProfileSummary': 'string'
},
'Insights': {
'MarketplaceEngagementScore': 'string',
'SolutionScore': 'string',
'SolutionCategory': 'string',
'SolutionSubCategory': 'string'
},
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TaskId': 'string',
'TaskArn': 'string',
'TaskName': 'string'
}
},
'CustomerAccount': {
'AccountIdentifier': 'string',
'Customer': {
'Industry': 'string',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
}
}
}
},
]
)
string
[REQUIRED]
The CreateEngagementRequest$Catalog parameter specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.
string
[REQUIRED]
The CreateEngagementRequest$ClientToken parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. The value must not exceed sixty-four alphanumeric characters.
This field is autopopulated if not provided.
string
Specifies the title of the Engagement.
string
Provides a description of the Engagement.
list
The Contexts field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a Type field indicating the context type, which must be CustomerProject in this version, and a Payload field containing the CustomerProject details. The CustomerProject object is composed of two main components: Customer and Project. The Customer object includes information such as CompanyName, WebsiteUrl, Industry, and CountryCode, providing essential details about the customer. The Project object contains Title, BusinessProblem, and TargetCompletionDate, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.
(dict) --
Provides detailed context information for an Engagement. This structure allows for specifying the type of context and its associated payload.
Id (string) --
The unique identifier of the engagement context. This ID is used to reference and manage the specific context within the engagement.
Type (string) -- [REQUIRED]
Specifies the type of Engagement context. Valid values are "CustomerProject" or "Document", indicating whether the context relates to a customer project or a document respectively.
Payload (dict) --
Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.
CustomerProject (dict) --
Contains detailed information about a customer project when the context type is "CustomerProject". This field is present only when the Type in EngagementContextDetails is set to "CustomerProject".
Customer (dict) --
Contains details about the customer that the customer project belongs to.
Industry (string) -- [REQUIRED]
Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.
CompanyName (string) -- [REQUIRED]
Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.
WebsiteUrl (string) -- [REQUIRED]
Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.
CountryCode (string) -- [REQUIRED]
Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.
Project (dict) --
Information about the customer project associated with the Engagement.
Title (string) -- [REQUIRED]
The title of the project.
BusinessProblem (string) -- [REQUIRED]
A description of the business problem the project aims to solve.
TargetCompletionDate (string) -- [REQUIRED]
The target completion date for the customer's project.
Lead (dict) --
Contains detailed information about a lead when the context type is "Lead". This field is present only when the Type in EngagementContextDetails is set to "Lead".
Insights (dict) --
Insights that AI generates and associates with the lead. These insights provide automated analysis such as lead readiness scoring to help partners assess the lead quality.
LeadReadinessScore (string) --
A score that indicates the lead's readiness for engagement. Valid values are Low, Medium, and High. Use this score to prioritize leads based on their likelihood of conversion.
ChannelRecommendation (dict) --
The outreach channel most commonly recommended for leads that share this lead's country, geography, region, and company segment. It includes the days and the Coordinated Universal Time (UTC) hours when that channel is best used. This is guidance for the group of similar leads. It doesn't describe this lead's own contact history. Present only when a recommendation is available for the lead.
RecommendedChannel (string) -- [REQUIRED]
The recommended outreach channel for the group of similar leads. Valid values are EMAIL and CALL.
BestOutreachWindows (list) --
The recommended day-specific outreach windows for the recommended channel, expressed in Coordinated Universal Time (UTC). Each window applies to one day, and more than one window can fall on the same day. This field is optional and appears only when window guidance is available.
(dict) --
A single recommended outreach window for one day, expressed in Coordinated Universal Time (UTC).
Day (string) -- [REQUIRED]
The day of the week that this outreach window applies to. Valid values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY.
StartTimeUtc (string) -- [REQUIRED]
The inclusive start of the outreach window, in Coordinated Universal Time (UTC), in 24-hour HH:mm format.
EndTimeUtc (string) -- [REQUIRED]
The exclusive end of the outreach window, in Coordinated Universal Time (UTC), in 24-hour HH:mm format.
QualificationStatus (string) --
Indicates the current qualification status of the lead, such as whether it has been qualified, disqualified, or is still under evaluation. This helps track the lead's progression through the qualification process.
Customer (dict) -- [REQUIRED]
Contains detailed information about the customer associated with the lead, including company information, contact details, and other relevant customer data.
Industry (string) --
Specifies the industry sector to which the lead customer's company belongs. This categorization helps in understanding the customer's business context and tailoring appropriate solutions.
CompanyName (string) -- [REQUIRED]
The name of the lead customer's company. This field is essential for identifying and tracking the customer organization associated with the lead.
WebsiteUrl (string) --
The website URL of the lead customer's company. This provides additional context about the customer organization and helps verify company legitimacy and size.
Address (dict) --
The address information for the lead customer.
City (string) --
The city of the lead customer's address.
PostalCode (string) --
The postal code of the lead customer's address.
StateOrRegion (string) --
The state or region of the lead customer's address.
CountryCode (string) --
The country code of the lead customer's address.
AwsMaturity (string) --
Indicates the customer's level of experience and adoption with AWS services. This assessment helps determine the appropriate engagement approach and solution complexity.
MarketSegment (string) --
Specifies the market segment classification of the lead customer, such as enterprise, mid-market, or small business. This segmentation helps in targeting appropriate solutions and engagement strategies.
Interactions (list) -- [REQUIRED]
An array of interactions that have occurred with the lead, providing a history of communications, meetings, and other engagement activities related to the lead.
(dict) --
Represents a specific interaction or touchpoint with a lead customer. This structure captures details about communications, meetings, or other engagement activities that help track the lead's progression and engagement history.
SourceType (string) --
Specifies the type of source that generated the lead interaction, such as "Event", "Website", "Referral", or "Campaign". This categorization helps track lead generation effectiveness across different channels.
SourceId (string) --
The unique identifier of the specific source that generated the lead interaction. This ID provides traceability back to the original lead generation activity.
SourceName (string) --
The descriptive name of the source that generated the lead interaction, providing a human-readable identifier for the lead generation channel or activity.
Usecase (string) --
Describes the specific use case or business scenario discussed during the lead interaction. This helps categorize the customer's interests and potential solutions.
InteractionDate (datetime) --
The date and time when the lead interaction occurred, in ISO 8601 format (UTC). This timestamp helps track the chronology of lead engagement activities.
CustomerAction (string) --
Describes the action taken by the customer during or as a result of the interaction, such as requesting information, scheduling a meeting, or expressing interest in a solution.
BusinessProblem (string) --
Describes the business problem or challenge that the customer discussed during the interaction. This information helps qualify the lead and identify appropriate solutions.
Contact (dict) -- [REQUIRED]
Contains contact information for the customer representative involved in the lead interaction, including their name, title, and contact details.
BusinessTitle (string) -- [REQUIRED]
The lead contact's business title or job role associated with the engagement.
Email (string) -- [REQUIRED]
The lead contact's email address associated with the engagement.
FirstName (string) -- [REQUIRED]
The lead contact's first name associated with the engagement.
LastName (string) -- [REQUIRED]
The lead contact's last name associated with the engagement.
Phone (string) --
The lead contact's phone number associated with the engagement.
ProspectingResult (dict) --
Contains prospecting result data with enriched insights. The system generates these insights when a partner runs an autonomous prospecting job on leads. This field appears only when the context type is "ProspectingResult".
Aws (dict) --
Prospecting data and insights that AWS provides during the prospecting job. This includes customer details, task information, and scoring that AI generates.
Customer (dict) --
Contains details about the prospected customer account, including geographic, industry, and segment classifications.
AccountName (string) --
The name of the prospected customer account.
Geo (string) --
The geographic region classification of the prospected customer account.
Region (string) --
The specific region of the prospected customer account.
SubRegion (string) --
The subregion classification of the prospected customer account.
Country (string) --
The country code of the prospected customer account.
Industry (string) --
The industry classification of the prospected customer account.
SubIndustry (string) --
The sub-industry classification of the prospected customer account. This provides more granular categorization within the primary industry.
Segment (string) --
The market segment classification of the prospected customer account.
CompanySize (string) --
The company size classification of the prospected customer account.
EligiblePrograms (list) --
A list of AWS Greenfield programs that the prospected customer is eligible for. Use this list to identify relevant go-to-market opportunities.
(string) --
PublicProfileSummary (string) --
A summary of publicly available information about the prospected customer. The system uses this summary to generate customer insights and inform engagement strategies.
Insights (dict) --
Insights that AI generates from the prospecting analysis. These insights include engagement scores and solution fit assessments for the prospected customer.
MarketplaceEngagementScore (string) --
A score that indicates the prospected customer's level of engagement with AWS Marketplace. Valid values are High, Medium, and Low.
SolutionScore (string) --
A score that indicates how well the partner's solution fits the prospected customer's needs.
SolutionCategory (string) --
The primary solution category classification for the prospected customer. This indicates the type of solution that best addresses their needs.
SolutionSubCategory (string) --
The solution sub-category classification for the prospected customer. This provides more granular categorization of the recommended solution type.
StartTime (datetime) --
The timestamp when the prospecting result context was created. The format is ISO 8601 (UTC).
EndTime (datetime) --
The timestamp when the prospecting task completed processing. The format is ISO 8601 (UTC).
TaskId (string) --
The unique identifier of the prospecting task that generates this result.
TaskArn (string) --
The Amazon Resource Name (ARN) of the prospecting task. Use this ARN to track and manage the task within AWS.
TaskName (string) --
The name that the user provides for the prospecting task that generates this result.
CustomerAccount (dict) --
The customer account context for account planning. This field appears only when the context type is CustomerAccount.
AccountIdentifier (string) --
The identifier of the customer account that the engagement concerns, as an Amazon Resource Name (ARN) or a customer account identifier.
Customer (dict) --
A snapshot of the customer company's identity for the account. On read, the service populates this from the account identifier.
Industry (string) --
The industry classification of the customer company.
CompanyName (string) -- [REQUIRED]
The name of the customer company.
WebsiteUrl (string) --
The website URL of the customer company.
CountryCode (string) --
The country of the customer company, as an ISO 3166-1 alpha-2 country code.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'ModifiedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Contains the response that the CreateEngagement action returns.
Id (string) --
Unique identifier assigned to the newly created engagement.
Arn (string) --
The Amazon Resource Name (ARN) that identifies the engagement.
ModifiedAt (datetime) --
The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). For newly created engagements, this value matches the creation timestamp. Example: "2023-05-01T20:37:46Z".
{'Payload': {'CustomerAccount': {'AccountIdentifier': 'string',
'Customer': {'CompanyName': 'string',
'CountryCode': 'US | AF | AX | '
'AL | DZ | AS | '
'AD | AO | AI | '
'AQ | AG | AR | '
'AM | AW | AU | '
'AT | AZ | BS | '
'BH | BD | BB | '
'BY | BE | BZ | '
'BJ | BM | BT | '
'BO | BQ | BA | '
'BW | BV | BR | '
'IO | BN | BG | '
'BF | BI | KH | '
'CM | CA | CV | '
'KY | CF | TD | '
'CL | CN | CX | '
'CC | CO | KM | '
'CG | CK | CR | '
'CI | HR | CU | '
'CW | CY | CZ | '
'CD | DK | DJ | '
'DM | DO | EC | '
'EG | SV | GQ | '
'ER | EE | ET | '
'FK | FO | FJ | '
'FI | FR | GF | '
'PF | TF | GA | '
'GM | GE | DE | '
'GH | GI | GR | '
'GL | GD | GP | '
'GU | GT | GG | '
'GN | GW | GY | '
'HT | HM | VA | '
'HN | HK | HU | '
'IS | IN | ID | '
'IR | IQ | IE | '
'IM | IL | IT | '
'JM | JP | JE | '
'JO | KZ | KE | '
'KI | KR | KW | '
'KG | LA | LV | '
'LB | LS | LR | '
'LY | LI | LT | '
'LU | MO | MK | '
'MG | MW | MY | '
'MV | ML | MT | '
'MH | MQ | MR | '
'MU | YT | MX | '
'FM | MD | MC | '
'MN | ME | MS | '
'MA | MZ | MM | '
'NA | NR | NP | '
'NL | AN | NC | '
'NZ | NI | NE | '
'NG | NU | NF | '
'MP | NO | OM | '
'PK | PW | PS | '
'PA | PG | PY | '
'PE | PH | PN | '
'PL | PT | PR | '
'QA | RE | RO | '
'RU | RW | BL | '
'SH | KN | LC | '
'MF | PM | VC | '
'WS | SM | ST | '
'SA | SN | RS | '
'SC | SL | SG | '
'SX | SK | SI | '
'SB | SO | ZA | '
'GS | SS | ES | '
'LK | SD | SR | '
'SJ | SZ | SE | '
'CH | SY | TW | '
'TJ | TZ | TH | '
'TL | TG | TK | '
'TO | TT | TN | '
'TR | TM | TC | '
'TV | UG | UA | '
'AE | GB | UM | '
'UY | UZ | VU | '
'VE | VN | VG | '
'VI | WF | EH | '
'YE | ZM | ZW',
'Industry': 'string',
'WebsiteUrl': 'string'}},
'Lead': {'Insights': {'ChannelRecommendation': {'BestOutreachWindows': [{'Day': 'MONDAY '
'| '
'TUESDAY '
'| '
'WEDNESDAY '
'| '
'THURSDAY '
'| '
'FRIDAY '
'| '
'SATURDAY '
'| '
'SUNDAY',
'EndTimeUtc': 'string',
'StartTimeUtc': 'string'}],
'RecommendedChannel': 'string'}}}},
'Type': {'CustomerAccount'}}
Creates a new context within an existing engagement. This action allows you to add contextual information such as customer projects or documents to an engagement, providing additional details that help facilitate collaboration between engagement members.
See also: AWS API Documentation
Request Syntax
client.create_engagement_context(
Catalog='string',
EngagementIdentifier='string',
ClientToken='string',
Type='CustomerProject'|'Lead'|'ProspectingResult'|'CustomerAccount',
Payload={
'CustomerProject': {
'Customer': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'Project': {
'Title': 'string',
'BusinessProblem': 'string',
'TargetCompletionDate': 'string'
}
},
'Lead': {
'Insights': {
'LeadReadinessScore': 'string',
'ChannelRecommendation': {
'RecommendedChannel': 'string',
'BestOutreachWindows': [
{
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'StartTimeUtc': 'string',
'EndTimeUtc': 'string'
},
]
}
},
'QualificationStatus': 'string',
'Customer': {
'Industry': 'string',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'Address': {
'City': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'CountryCode': 'string'
},
'AwsMaturity': 'string',
'MarketSegment': 'string'
},
'Interactions': [
{
'SourceType': 'string',
'SourceId': 'string',
'SourceName': 'string',
'Usecase': 'string',
'InteractionDate': datetime(2015, 1, 1),
'CustomerAction': 'string',
'BusinessProblem': 'string',
'Contact': {
'BusinessTitle': 'string',
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'Phone': 'string'
}
},
]
},
'ProspectingResult': {
'Aws': {
'Customer': {
'AccountName': 'string',
'Geo': 'string',
'Region': 'string',
'SubRegion': 'string',
'Country': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'SubIndustry': 'string',
'Segment': 'string',
'CompanySize': 'string',
'EligiblePrograms': [
'string',
],
'PublicProfileSummary': 'string'
},
'Insights': {
'MarketplaceEngagementScore': 'string',
'SolutionScore': 'string',
'SolutionCategory': 'string',
'SolutionSubCategory': 'string'
},
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TaskId': 'string',
'TaskArn': 'string',
'TaskName': 'string'
}
},
'CustomerAccount': {
'AccountIdentifier': 'string',
'Customer': {
'Industry': 'string',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
}
}
}
)
string
[REQUIRED]
Specifies the catalog associated with the engagement context request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is created in. Use AWS to create contexts in the production environment, and Sandbox for testing in secure, isolated environments.
string
[REQUIRED]
The unique identifier of the Engagement for which the context is being created. This parameter ensures the context is associated with the correct engagement and provides the necessary linkage between the engagement and its contextual information.
string
[REQUIRED]
A unique, case-sensitive identifier provided by the client to ensure that the request is handled exactly once. This token helps prevent duplicate context creations and must not exceed sixty-four alphanumeric characters. Use a UUID or other unique string to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
Specifies the type of context being created for the engagement. This field determines the structure and content of the context payload. Valid values include CustomerProject for customer project-related contexts. The type field ensures that the context is properly categorized and processed according to its intended purpose.
dict
[REQUIRED]
Contains the contextual information to add to the engagement. The structure of this payload depends on the context type in the Type field.
CustomerProject (dict) --
Contains detailed information about a customer project when the context type is "CustomerProject". This field is present only when the Type in EngagementContextDetails is set to "CustomerProject".
Customer (dict) --
Contains details about the customer that the customer project belongs to.
Industry (string) -- [REQUIRED]
Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.
CompanyName (string) -- [REQUIRED]
Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.
WebsiteUrl (string) -- [REQUIRED]
Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.
CountryCode (string) -- [REQUIRED]
Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.
Project (dict) --
Information about the customer project associated with the Engagement.
Title (string) -- [REQUIRED]
The title of the project.
BusinessProblem (string) -- [REQUIRED]
A description of the business problem the project aims to solve.
TargetCompletionDate (string) -- [REQUIRED]
The target completion date for the customer's project.
Lead (dict) --
Contains detailed information about a lead when the context type is "Lead". This field is present only when the Type in EngagementContextDetails is set to "Lead".
Insights (dict) --
Insights that AI generates and associates with the lead. These insights provide automated analysis such as lead readiness scoring to help partners assess the lead quality.
LeadReadinessScore (string) --
A score that indicates the lead's readiness for engagement. Valid values are Low, Medium, and High. Use this score to prioritize leads based on their likelihood of conversion.
ChannelRecommendation (dict) --
The outreach channel most commonly recommended for leads that share this lead's country, geography, region, and company segment. It includes the days and the Coordinated Universal Time (UTC) hours when that channel is best used. This is guidance for the group of similar leads. It doesn't describe this lead's own contact history. Present only when a recommendation is available for the lead.
RecommendedChannel (string) -- [REQUIRED]
The recommended outreach channel for the group of similar leads. Valid values are EMAIL and CALL.
BestOutreachWindows (list) --
The recommended day-specific outreach windows for the recommended channel, expressed in Coordinated Universal Time (UTC). Each window applies to one day, and more than one window can fall on the same day. This field is optional and appears only when window guidance is available.
(dict) --
A single recommended outreach window for one day, expressed in Coordinated Universal Time (UTC).
Day (string) -- [REQUIRED]
The day of the week that this outreach window applies to. Valid values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY.
StartTimeUtc (string) -- [REQUIRED]
The inclusive start of the outreach window, in Coordinated Universal Time (UTC), in 24-hour HH:mm format.
EndTimeUtc (string) -- [REQUIRED]
The exclusive end of the outreach window, in Coordinated Universal Time (UTC), in 24-hour HH:mm format.
QualificationStatus (string) --
Indicates the current qualification status of the lead, such as whether it has been qualified, disqualified, or is still under evaluation. This helps track the lead's progression through the qualification process.
Customer (dict) -- [REQUIRED]
Contains detailed information about the customer associated with the lead, including company information, contact details, and other relevant customer data.
Industry (string) --
Specifies the industry sector to which the lead customer's company belongs. This categorization helps in understanding the customer's business context and tailoring appropriate solutions.
CompanyName (string) -- [REQUIRED]
The name of the lead customer's company. This field is essential for identifying and tracking the customer organization associated with the lead.
WebsiteUrl (string) --
The website URL of the lead customer's company. This provides additional context about the customer organization and helps verify company legitimacy and size.
Address (dict) --
The address information for the lead customer.
City (string) --
The city of the lead customer's address.
PostalCode (string) --
The postal code of the lead customer's address.
StateOrRegion (string) --
The state or region of the lead customer's address.
CountryCode (string) --
The country code of the lead customer's address.
AwsMaturity (string) --
Indicates the customer's level of experience and adoption with AWS services. This assessment helps determine the appropriate engagement approach and solution complexity.
MarketSegment (string) --
Specifies the market segment classification of the lead customer, such as enterprise, mid-market, or small business. This segmentation helps in targeting appropriate solutions and engagement strategies.
Interactions (list) -- [REQUIRED]
An array of interactions that have occurred with the lead, providing a history of communications, meetings, and other engagement activities related to the lead.
(dict) --
Represents a specific interaction or touchpoint with a lead customer. This structure captures details about communications, meetings, or other engagement activities that help track the lead's progression and engagement history.
SourceType (string) --
Specifies the type of source that generated the lead interaction, such as "Event", "Website", "Referral", or "Campaign". This categorization helps track lead generation effectiveness across different channels.
SourceId (string) --
The unique identifier of the specific source that generated the lead interaction. This ID provides traceability back to the original lead generation activity.
SourceName (string) --
The descriptive name of the source that generated the lead interaction, providing a human-readable identifier for the lead generation channel or activity.
Usecase (string) --
Describes the specific use case or business scenario discussed during the lead interaction. This helps categorize the customer's interests and potential solutions.
InteractionDate (datetime) --
The date and time when the lead interaction occurred, in ISO 8601 format (UTC). This timestamp helps track the chronology of lead engagement activities.
CustomerAction (string) --
Describes the action taken by the customer during or as a result of the interaction, such as requesting information, scheduling a meeting, or expressing interest in a solution.
BusinessProblem (string) --
Describes the business problem or challenge that the customer discussed during the interaction. This information helps qualify the lead and identify appropriate solutions.
Contact (dict) -- [REQUIRED]
Contains contact information for the customer representative involved in the lead interaction, including their name, title, and contact details.
BusinessTitle (string) -- [REQUIRED]
The lead contact's business title or job role associated with the engagement.
Email (string) -- [REQUIRED]
The lead contact's email address associated with the engagement.
FirstName (string) -- [REQUIRED]
The lead contact's first name associated with the engagement.
LastName (string) -- [REQUIRED]
The lead contact's last name associated with the engagement.
Phone (string) --
The lead contact's phone number associated with the engagement.
ProspectingResult (dict) --
Contains prospecting result data with enriched insights. The system generates these insights when a partner runs an autonomous prospecting job on leads. This field appears only when the context type is "ProspectingResult".
Aws (dict) --
Prospecting data and insights that AWS provides during the prospecting job. This includes customer details, task information, and scoring that AI generates.
Customer (dict) --
Contains details about the prospected customer account, including geographic, industry, and segment classifications.
AccountName (string) --
The name of the prospected customer account.
Geo (string) --
The geographic region classification of the prospected customer account.
Region (string) --
The specific region of the prospected customer account.
SubRegion (string) --
The subregion classification of the prospected customer account.
Country (string) --
The country code of the prospected customer account.
Industry (string) --
The industry classification of the prospected customer account.
SubIndustry (string) --
The sub-industry classification of the prospected customer account. This provides more granular categorization within the primary industry.
Segment (string) --
The market segment classification of the prospected customer account.
CompanySize (string) --
The company size classification of the prospected customer account.
EligiblePrograms (list) --
A list of AWS Greenfield programs that the prospected customer is eligible for. Use this list to identify relevant go-to-market opportunities.
(string) --
PublicProfileSummary (string) --
A summary of publicly available information about the prospected customer. The system uses this summary to generate customer insights and inform engagement strategies.
Insights (dict) --
Insights that AI generates from the prospecting analysis. These insights include engagement scores and solution fit assessments for the prospected customer.
MarketplaceEngagementScore (string) --
A score that indicates the prospected customer's level of engagement with AWS Marketplace. Valid values are High, Medium, and Low.
SolutionScore (string) --
A score that indicates how well the partner's solution fits the prospected customer's needs.
SolutionCategory (string) --
The primary solution category classification for the prospected customer. This indicates the type of solution that best addresses their needs.
SolutionSubCategory (string) --
The solution sub-category classification for the prospected customer. This provides more granular categorization of the recommended solution type.
StartTime (datetime) --
The timestamp when the prospecting result context was created. The format is ISO 8601 (UTC).
EndTime (datetime) --
The timestamp when the prospecting task completed processing. The format is ISO 8601 (UTC).
TaskId (string) --
The unique identifier of the prospecting task that generates this result.
TaskArn (string) --
The Amazon Resource Name (ARN) of the prospecting task. Use this ARN to track and manage the task within AWS.
TaskName (string) --
The name that the user provides for the prospecting task that generates this result.
CustomerAccount (dict) --
The customer account context for account planning. This field appears only when the context type is CustomerAccount.
AccountIdentifier (string) --
The identifier of the customer account that the engagement concerns, as an Amazon Resource Name (ARN) or a customer account identifier.
Customer (dict) --
A snapshot of the customer company's identity for the account. On read, the service populates this from the account identifier.
Industry (string) --
The industry classification of the customer company.
CompanyName (string) -- [REQUIRED]
The name of the customer company.
WebsiteUrl (string) --
The website URL of the customer company.
CountryCode (string) --
The country of the customer company, as an ISO 3166-1 alpha-2 country code.
dict
Response Syntax
{
'EngagementId': 'string',
'EngagementArn': 'string',
'EngagementLastModifiedAt': datetime(2015, 1, 1),
'ContextId': 'string'
}
Response Structure
(dict) --
Contains the response that the CreateEngagementContext action returns.
EngagementId (string) --
The unique identifier of the engagement to which the context was added. This ID confirms the successful association of the context with the specified engagement.
EngagementArn (string) --
The Amazon Resource Name (ARN) of the engagement to which the context was added. This globally unique identifier can be used for cross-service references and IAM policies.
EngagementLastModifiedAt (datetime) --
The timestamp indicating when the engagement was last modified as a result of adding the context, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z".
ContextId (string) --
The unique identifier assigned to the newly created engagement context. This ID can be used to reference the specific context within the engagement for future operations.
{'Invitation': {'Payload': {'AccountPlanningInvitation': {'AccountIdentifier': 'string',
'Customer': {'CompanyName': 'string',
'CountryCode': 'US '
'| '
'AF '
'| '
'AX '
'| '
'AL '
'| '
'DZ '
'| '
'AS '
'| '
'AD '
'| '
'AO '
'| '
'AI '
'| '
'AQ '
'| '
'AG '
'| '
'AR '
'| '
'AM '
'| '
'AW '
'| '
'AU '
'| '
'AT '
'| '
'AZ '
'| '
'BS '
'| '
'BH '
'| '
'BD '
'| '
'BB '
'| '
'BY '
'| '
'BE '
'| '
'BZ '
'| '
'BJ '
'| '
'BM '
'| '
'BT '
'| '
'BO '
'| '
'BQ '
'| '
'BA '
'| '
'BW '
'| '
'BV '
'| '
'BR '
'| '
'IO '
'| '
'BN '
'| '
'BG '
'| '
'BF '
'| '
'BI '
'| '
'KH '
'| '
'CM '
'| '
'CA '
'| '
'CV '
'| '
'KY '
'| '
'CF '
'| '
'TD '
'| '
'CL '
'| '
'CN '
'| '
'CX '
'| '
'CC '
'| '
'CO '
'| '
'KM '
'| '
'CG '
'| '
'CK '
'| '
'CR '
'| '
'CI '
'| '
'HR '
'| '
'CU '
'| '
'CW '
'| '
'CY '
'| '
'CZ '
'| '
'CD '
'| '
'DK '
'| '
'DJ '
'| '
'DM '
'| '
'DO '
'| '
'EC '
'| '
'EG '
'| '
'SV '
'| '
'GQ '
'| '
'ER '
'| '
'EE '
'| '
'ET '
'| '
'FK '
'| '
'FO '
'| '
'FJ '
'| '
'FI '
'| '
'FR '
'| '
'GF '
'| '
'PF '
'| '
'TF '
'| '
'GA '
'| '
'GM '
'| '
'GE '
'| '
'DE '
'| '
'GH '
'| '
'GI '
'| '
'GR '
'| '
'GL '
'| '
'GD '
'| '
'GP '
'| '
'GU '
'| '
'GT '
'| '
'GG '
'| '
'GN '
'| '
'GW '
'| '
'GY '
'| '
'HT '
'| '
'HM '
'| '
'VA '
'| '
'HN '
'| '
'HK '
'| '
'HU '
'| '
'IS '
'| '
'IN '
'| '
'ID '
'| '
'IR '
'| '
'IQ '
'| '
'IE '
'| '
'IM '
'| '
'IL '
'| '
'IT '
'| '
'JM '
'| '
'JP '
'| '
'JE '
'| '
'JO '
'| '
'KZ '
'| '
'KE '
'| '
'KI '
'| '
'KR '
'| '
'KW '
'| '
'KG '
'| '
'LA '
'| '
'LV '
'| '
'LB '
'| '
'LS '
'| '
'LR '
'| '
'LY '
'| '
'LI '
'| '
'LT '
'| '
'LU '
'| '
'MO '
'| '
'MK '
'| '
'MG '
'| '
'MW '
'| '
'MY '
'| '
'MV '
'| '
'ML '
'| '
'MT '
'| '
'MH '
'| '
'MQ '
'| '
'MR '
'| '
'MU '
'| '
'YT '
'| '
'MX '
'| '
'FM '
'| '
'MD '
'| '
'MC '
'| '
'MN '
'| '
'ME '
'| '
'MS '
'| '
'MA '
'| '
'MZ '
'| '
'MM '
'| '
'NA '
'| '
'NR '
'| '
'NP '
'| '
'NL '
'| '
'AN '
'| '
'NC '
'| '
'NZ '
'| '
'NI '
'| '
'NE '
'| '
'NG '
'| '
'NU '
'| '
'NF '
'| '
'MP '
'| '
'NO '
'| '
'OM '
'| '
'PK '
'| '
'PW '
'| '
'PS '
'| '
'PA '
'| '
'PG '
'| '
'PY '
'| '
'PE '
'| '
'PH '
'| '
'PN '
'| '
'PL '
'| '
'PT '
'| '
'PR '
'| '
'QA '
'| '
'RE '
'| '
'RO '
'| '
'RU '
'| '
'RW '
'| '
'BL '
'| '
'SH '
'| '
'KN '
'| '
'LC '
'| '
'MF '
'| '
'PM '
'| '
'VC '
'| '
'WS '
'| '
'SM '
'| '
'ST '
'| '
'SA '
'| '
'SN '
'| '
'RS '
'| '
'SC '
'| '
'SL '
'| '
'SG '
'| '
'SX '
'| '
'SK '
'| '
'SI '
'| '
'SB '
'| '
'SO '
'| '
'ZA '
'| '
'GS '
'| '
'SS '
'| '
'ES '
'| '
'LK '
'| '
'SD '
'| '
'SR '
'| '
'SJ '
'| '
'SZ '
'| '
'SE '
'| '
'CH '
'| '
'SY '
'| '
'TW '
'| '
'TJ '
'| '
'TZ '
'| '
'TH '
'| '
'TL '
'| '
'TG '
'| '
'TK '
'| '
'TO '
'| '
'TT '
'| '
'TN '
'| '
'TR '
'| '
'TM '
'| '
'TC '
'| '
'TV '
'| '
'UG '
'| '
'UA '
'| '
'AE '
'| '
'GB '
'| '
'UM '
'| '
'UY '
'| '
'UZ '
'| '
'VU '
'| '
'VE '
'| '
'VN '
'| '
'VG '
'| '
'VI '
'| '
'WF '
'| '
'EH '
'| '
'YE '
'| '
'ZM '
'| '
'ZW',
'Industry': 'string',
'WebsiteUrl': 'string'},
'PreferredContact': {'Timezone': 'string',
'Window': 'MORNING '
'| '
'AFTERNOON '
'| '
'EVENING'},
'SenderContacts': [{'BusinessTitle': 'string',
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'Phone': 'string'}]},
'OpportunityInvitation': {'OpportunityType': 'Net '
'New '
'Business '
'| '
'Flat '
'Renewal '
'| '
'Expansion'}}}}
This action creates an invitation from a sender to a single receiver to join an engagement.
See also: AWS API Documentation
Request Syntax
client.create_engagement_invitation(
Catalog='string',
ClientToken='string',
EngagementIdentifier='string',
Invitation={
'Message': 'string',
'Receiver': {
'Account': {
'Alias': 'string',
'AwsAccountId': 'string'
}
},
'Payload': {
'OpportunityInvitation': {
'SenderContacts': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
],
'ReceiverResponsibilities': [
'Distributor'|'Reseller'|'Hardware Partner'|'Managed Service Provider'|'Software Partner'|'Services Partner'|'Training Partner'|'Co-Sell Facilitator'|'Facilitator',
],
'Customer': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'Project': {
'BusinessProblem': 'string',
'Title': 'string',
'TargetCompletionDate': 'string',
'ExpectedCustomerSpend': [
{
'Amount': 'string',
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TargetCompany': 'string',
'EstimationUrl': 'string'
},
]
},
'OpportunityType': 'Net New Business'|'Flat Renewal'|'Expansion'
},
'LeadInvitation': {
'Customer': {
'Industry': 'string',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'string',
'AwsMaturity': 'string',
'MarketSegment': 'string'
},
'Interaction': {
'SourceType': 'string',
'SourceId': 'string',
'SourceName': 'string',
'Usecase': 'string',
'ContactBusinessTitle': 'string'
}
},
'AccountPlanningInvitation': {
'AccountIdentifier': 'string',
'Customer': {
'Industry': 'string',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'SenderContacts': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
],
'PreferredContact': {
'Window': 'MORNING'|'AFTERNOON'|'EVENING',
'Timezone': 'string'
}
}
}
}
)
string
[REQUIRED]
Specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.
string
[REQUIRED]
Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the Engagement associated with the invitation. This parameter ensures the invitation is created within the correct Engagement context.
dict
[REQUIRED]
The Invitation object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can be the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details, or LeadInvitation, which includes structures for customer information and interaction details.
Message (string) -- [REQUIRED]
A message accompanying the invitation.
Receiver (dict) -- [REQUIRED]
Specifies the partner that receives the invitation.
Account (dict) --
Specifies the AWS account of the partner who received the Engagement Invitation. This field is used to track the invitation recipient within the AWS ecosystem.
Alias (string) --
Represents the alias of the partner account receiving the Engagement Invitation, making it easier to identify and track the recipient in reports or logs.
AwsAccountId (string) -- [REQUIRED]
Indicates the AWS account ID of the partner who received the Engagement Invitation. This is a unique identifier for managing engagements with specific AWS accounts.
Payload (dict) -- [REQUIRED]
Contains the details that the invitation carries, such as the opportunity or the account planning details that the partner receives.
OpportunityInvitation (dict) --
Specifies the details of the opportunity invitation within the Engagement Invitation payload. This data helps partners understand the context, scope, and expected involvement for the opportunity from AWS.
SenderContacts (list) --
Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are opportunity stakeholders.
(dict) --
An object that contains the details of the sender-provided contact person for the EngagementInvitation.
Email (string) -- [REQUIRED]
The sender-provided contact's email address associated with the EngagementInvitation.
FirstName (string) --
The sender-provided contact's last name associated with the EngagementInvitation.
LastName (string) --
The sender-provided contact's first name associated with the EngagementInvitation.
BusinessTitle (string) --
The sender-provided contact's title (job title or role) associated with the EngagementInvitation.
Phone (string) --
The sender-provided contact's phone number associated with the EngagementInvitation.
ReceiverResponsibilities (list) -- [REQUIRED]
Outlines the responsibilities or expectations of the receiver in the context of the invitation.
(string) --
A responsibility that the receiver of an engagement invitation has in the engagement.
Customer (dict) -- [REQUIRED]
Contains information about the customer related to the opportunity in the Engagement Invitation. This data helps partners understand the customer’s profile and requirements.
Industry (string) -- [REQUIRED]
Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.
CompanyName (string) -- [REQUIRED]
Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.
WebsiteUrl (string) -- [REQUIRED]
Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.
CountryCode (string) -- [REQUIRED]
Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.
Project (dict) -- [REQUIRED]
Describes the project details associated with the opportunity, including the customer’s needs and the scope of work expected to be performed.
BusinessProblem (string) -- [REQUIRED]
Describes the business problem that the project aims to solve. This information is crucial for understanding the project’s goals and objectives.
Title (string) -- [REQUIRED]
Specifies the title of the project. This title helps partners quickly identify and understand the focus of the project.
TargetCompletionDate (string) -- [REQUIRED]
Specifies the estimated date of project completion. This field helps track the project timeline and manage expectations.
ExpectedCustomerSpend (list) -- [REQUIRED]
Contains revenue estimates for the partner related to the project. This field provides an idea of the financial potential of the opportunity for the partner.
(dict) --
Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.
Amount (string) --
Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.
CurrencyCode (string) -- [REQUIRED]
Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets. Accepted values are USD (US Dollars) and EUR (Euros). If the AWS Partition is aws-eusc (AWS European Sovereign Cloud), the currency code must be EUR.
Frequency (string) -- [REQUIRED]
Indicates how frequently the customer is expected to spend the projected amount. Use Monthly for recurring monthly spend (required for TargetCompany: "AWS" entries). Use None for one-time deal value entries (required for TargetCompany: "Self" entries when providing Total Contract Value).
TargetCompany (string) -- [REQUIRED]
Specifies the entity associated with this spend entry. Use AWS for the system’s AWS Monthly Recurring Revenue (MRR) estimate. Use Self for the partner’s own deal value entry when providing Total Contract Value (TCV) for automatic MRR conversion. When ExpectedContractDuration is present on the Project, only AWS and Self are accepted. When ExpectedContractDuration is not present, only AWS is accepted and any other value will be automatically set to AWS.
EstimationUrl (string) --
A URL providing additional information or context about the spend estimation.
OpportunityType (string) --
The type of the opportunity being shared. The sender of the invitation sets it. Valid values:
Net New Business: A new business opportunity with a potential customer that's not previously engaged with your solutions or services.
Flat Renewal: An opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.
Expansion: An opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.
LeadInvitation (dict) --
Specifies the details of the lead invitation within the Engagement Invitation payload. This data helps partners understand the lead context, customer information, and interaction history for the lead opportunity from AWS.
Customer (dict) -- [REQUIRED]
Contains information about the customer associated with the lead invitation. This data helps partners understand the customer's profile, industry, and business context to assess the lead opportunity.
Industry (string) --
Specifies the industry sector of the customer company associated with the lead invitation. This categorization helps partners understand the customer's business context and assess solution fit.
CompanyName (string) -- [REQUIRED]
The name of the customer company associated with the lead invitation. This field identifies the target organization for the lead engagement opportunity.
WebsiteUrl (string) --
The website URL of the customer company. This provides additional context about the customer organization and helps partners verify company details and assess business size and legitimacy.
CountryCode (string) --
The country code indicating the geographic location of the customer company. This information helps partners understand regional requirements and assess their ability to serve the customer effectively.
AwsMaturity (string) --
Indicates the customer's level of experience and adoption with AWS services. This assessment helps partners understand the customer's cloud maturity and tailor their engagement approach accordingly.
MarketSegment (string) --
Specifies the market segment classification of the customer, such as enterprise, mid-market, or small business. This segmentation helps partners determine the appropriate solution complexity and engagement strategy.
Interaction (dict) -- [REQUIRED]
Describes the interaction details associated with the lead, including the source of the lead generation and customer engagement information. This context helps partners evaluate the lead quality and engagement approach.
SourceType (string) --
Specifies the type of source that generated the lead interaction, such as "Event", "Website", or "Campaign". This helps partners understand the lead generation channel and assess lead quality based on the source type.
SourceId (string) --
The unique identifier of the specific source that generated the lead interaction. This provides traceability to the original lead generation activity for reference and follow-up purposes.
SourceName (string) --
The descriptive name of the source that generated the lead interaction. This human-readable identifier helps partners understand the specific lead generation channel or campaign that created the opportunity.
Usecase (string) --
Describes the specific use case or business scenario associated with the lead interaction. This information helps partners understand the customer's interests and potential solution requirements.
ContactBusinessTitle (string) -- [REQUIRED]
The business title or job role of the customer contact involved in the lead interaction. This helps partners identify the decision-making level and engagement approach for the lead.
AccountPlanningInvitation (dict) --
The content of an account-planning invitation. This field is present when the invitation is for account planning.
AccountIdentifier (string) --
The identifier of the customer account that the plan concerns, as an Amazon Resource Name (ARN) or a customer account identifier.
Customer (dict) --
A caller-supplied snapshot of the customer company's identity, so that the receiver can tell which account the plan concerns even when the account isn't yet mapped to an AWS account.
Industry (string) --
The industry classification of the customer company.
CompanyName (string) -- [REQUIRED]
The name of the customer company.
WebsiteUrl (string) --
The website URL of the customer company.
CountryCode (string) --
The country of the customer company, as an ISO 3166-1 alpha-2 country code.
SenderContacts (list) --
The sender's contact information for this account plan.
(dict) --
An object that contains the details of the sender-provided contact person for the EngagementInvitation.
Email (string) -- [REQUIRED]
The sender-provided contact's email address associated with the EngagementInvitation.
FirstName (string) --
The sender-provided contact's last name associated with the EngagementInvitation.
LastName (string) --
The sender-provided contact's first name associated with the EngagementInvitation.
BusinessTitle (string) --
The sender-provided contact's title (job title or role) associated with the EngagementInvitation.
Phone (string) --
The sender-provided contact's phone number associated with the EngagementInvitation.
PreferredContact (dict) --
When the sender prefers to be contacted about this account plan. This information is advisory.
Window (string) --
The preferred time-of-day band for contact.
Timezone (string) --
The IANA time zone name that the window is expressed in, for example America/Chicago.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string'
}
Response Structure
(dict) --
Contains the response that the CreateEngagementInvitation action returns.
Id (string) --
Unique identifier assigned to the newly created engagement invitation.
Arn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the engagement invitation.
{'CosellMotionReason': 'string'}
Retrieves a summary of an AWS Opportunity. This summary includes high-level details about the opportunity sourced from AWS, such as lifecycle information, customer details, and involvement type. It is useful for tracking updates on the AWS opportunity corresponding to an opportunity in the partner's account.
See also: AWS API Documentation
Request Syntax
client.get_aws_opportunity_summary(
Catalog='string',
RelatedOpportunityIdentifier='string'
)
string
[REQUIRED]
Specifies the catalog in which the AWS Opportunity is located. Accepted values include AWS for production opportunities or Sandbox for testing purposes. The catalog determines which environment the opportunity data is pulled from.
string
[REQUIRED]
The unique identifier for the related partner opportunity. Use this field to correlate an AWS opportunity with its corresponding partner opportunity.
dict
Response Syntax
{
'RelatedOpportunityId': 'string',
'Origin': 'AWS Referral'|'Partner Referral',
'InvolvementType': 'For Visibility Only'|'Co-Sell',
'Visibility': 'Full'|'Limited',
'LifeCycle': {
'TargetCloseDate': 'string',
'ClosedLostReason': 'Administrative'|'Business Associate Agreement'|'Company Acquired/Dissolved'|'Competitive Offering'|'Customer Data Requirement'|'Customer Deficiency'|'Customer Experience'|'Delay / Cancellation of Project'|'Duplicate'|'Duplicate Opportunity'|'Executive Blocker'|'Failed Vetting'|'Feature Limitation'|'Financial/Commercial'|'Insufficient Amazon Value'|'Insufficient AWS Value'|'International Constraints'|'Legal / Tax / Regulatory'|'Legal Terms and Conditions'|'Lost to Competitor'|'Lost to Competitor - Google'|'Lost to Competitor - Microsoft'|'Lost to Competitor - Other'|'Lost to Competitor - Rackspace'|'Lost to Competitor - SoftLayer'|'Lost to Competitor - VMWare'|'No Customer Reference'|'No Integration Resources'|'No Opportunity'|'No Perceived Value of MP'|'No Response'|'Not Committed to AWS'|'No Update'|'On Premises Deployment'|'Other'|'Other (Details in Description)'|'Partner Gap'|'Past Due'|'People/Relationship/Governance'|'Platform Technology Limitation'|'Preference for Competitor'|'Price'|'Product/Technology'|'Product Not on AWS'|'Security / Compliance'|'Self-Service'|'Technical Limitations'|'Term Sheet Impasse',
'Stage': 'Not Started'|'In Progress'|'Prospect'|'Engaged'|'Identified'|'Qualify'|'Research'|'Seller Engaged'|'Evaluating'|'Seller Registered'|'Term Sheet Negotiation'|'Contract Negotiation'|'Onboarding'|'Building Integration'|'Qualified'|'On-hold'|'Technical Validation'|'Business Validation'|'Committed'|'Launched'|'Deferred to Partner'|'Closed Lost'|'Completed'|'Closed Incomplete',
'NextSteps': 'string',
'NextStepsHistory': [
{
'Value': 'string',
'Time': datetime(2015, 1, 1)
},
]
},
'OpportunityTeam': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'AWSSalesRep'|'AWSAccountOwner'|'WWPSPDM'|'PDM'|'PSM'|'ISVSM'|'Signatory'
},
],
'Insights': {
'NextBestActions': 'string',
'EngagementScore': 'High'|'Medium'|'Low',
'AwsProductsSpendInsightsBySource': {
'Partner': {
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TotalAmount': 'string',
'TotalOptimizedAmount': 'string',
'TotalPotentialSavingsAmount': 'string',
'TotalAmountByCategory': {
'string': 'string'
},
'AwsProducts': [
{
'ProductCode': 'string',
'ServiceCode': 'string',
'Categories': [
'string',
],
'Amount': 'string',
'OptimizedAmount': 'string',
'PotentialSavingsAmount': 'string',
'Optimizations': [
{
'Description': 'string',
'SavingsAmount': 'string'
},
]
},
]
},
'AWS': {
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TotalAmount': 'string',
'TotalOptimizedAmount': 'string',
'TotalPotentialSavingsAmount': 'string',
'TotalAmountByCategory': {
'string': 'string'
},
'AwsProducts': [
{
'ProductCode': 'string',
'ServiceCode': 'string',
'Categories': [
'string',
],
'Amount': 'string',
'OptimizedAmount': 'string',
'PotentialSavingsAmount': 'string',
'Optimizations': [
{
'Description': 'string',
'SavingsAmount': 'string'
},
]
},
]
}
},
'OpportunityQuality': {
'Score': 123,
'Trend': 'string'
},
'Recommendations': [
{
'Type': 'string',
'Details': 'string',
'Attributes': {
'string': 'string'
}
},
]
},
'InvolvementTypeChangeReason': 'Expansion Opportunity'|'Change in Deal Information'|'Customer Requested'|'Technical Complexity'|'Risk Mitigation',
'RelatedEntityIds': {
'AwsProducts': [
'string',
],
'Solutions': [
'string',
],
'AwsMarketplaceSolutions': [
'string',
],
'AwsMarketplaceProducts': [
'string',
]
},
'Customer': {
'Contacts': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
]
},
'Project': {
'ExpectedCustomerSpend': [
{
'Amount': 'string',
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TargetCompany': 'string',
'EstimationUrl': 'string'
},
],
'AwsPartition': 'aws-eusc'
},
'CosellMotion': 'string',
'CosellMotionReason': 'string',
'SoftwareRevenue': {
'Value': {
'Amount': 'string',
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL'
},
'Discount': 'string',
'EffectiveDate': 'string',
'ExpirationDate': 'string'
},
'Catalog': 'string'
}
Response Structure
(dict) --
Contains the response that the GetAwsOpportunitySummary action returns.
RelatedOpportunityId (string) --
Provides the unique identifier of the related partner opportunity, allowing partners to link the AWS Opportunity to their corresponding opportunity in their CRM system.
Origin (string) --
Specifies whether the AWS Opportunity originated from AWS or the partner. This helps distinguish between opportunities that were sourced by AWS and those referred by the partner.
InvolvementType (string) --
Specifies the type of involvement AWS has in the opportunity, such as direct cosell or advisory support. This field helps partners understand the role AWS plays in advancing the opportunity.
Visibility (string) --
Defines the visibility level for the AWS Opportunity. Use Full visibility for most cases, while Limited visibility is reserved for special programs or sensitive opportunities.
LifeCycle (dict) --
Contains lifecycle information for the AWS Opportunity, including review status, stage, and target close date. This field is crucial for partners to monitor the progression of the opportunity.
TargetCloseDate (string) --
Indicates the expected date by which the opportunity is projected to close. This field helps in planning resources and timelines for both the partner and AWS.
ClosedLostReason (string) --
Indicates the reason why an opportunity was marked as Closed Lost. This helps in understanding the context behind the lost opportunity and aids in refining future strategies.
Stage (string) --
Represents the current stage of the opportunity in its lifecycle, such as Qualification, Validation, or Closed Won. This helps in understanding the opportunity's progress.
NextSteps (string) --
Specifies the immediate next steps required to progress the opportunity. These steps are based on AWS guidance and the current stage of the opportunity.
NextStepsHistory (list) --
Provides a historical log of previous next steps that were taken to move the opportunity forward. This helps in tracking the decision-making process and identifying any delays or obstacles encountered.
(dict) --
Tracks the history of next steps associated with the opportunity. This field captures the actions planned for the future and their timeline.
Value (string) --
Represents the details of the next step recorded, such as follow-up actions or decisions made. This field helps in tracking progress and ensuring alignment with project goals.
Time (datetime) --
Indicates the date and time when a particular next step was recorded or planned. This helps in managing the timeline for the opportunity.
OpportunityTeam (list) --
Details the AWS opportunity team, including members involved. This information helps partners know who from AWS is engaged and what their role is.
(dict) --
Represents an Amazon Web Services team member for the engagement. This structure includes details such as name, email, and business title.
Email (string) --
Provides the Amazon Web Services team member's email address.
FirstName (string) --
Provides the Amazon Web Services team member's first name.
LastName (string) --
Provides the Amazon Web Services team member's last name.
BusinessTitle (string) --
Specifies the Amazon Web Services team member's business title and indicates their organizational role.
Insights (dict) --
Provides insights into the AWS Opportunity, including engagement score and recommended actions that AWS suggests for the partner.
NextBestActions (string) --
Provides recommendations from AWS on the next best actions to take in order to move the opportunity forward and increase the likelihood of success.
EngagementScore (string) --
Represents a score assigned by AWS to indicate the level of engagement and potential success for the opportunity. This score helps partners prioritize their efforts.
AwsProductsSpendInsightsBySource (dict) --
Source-separated spend insights that provide independent analysis for AWS recommendations and partner estimates.
Partner (dict) --
Partner-sourced insights derived from Pricing Calculator URLs.
CurrencyCode (string) --
ISO 4217 currency code. Supported values are USD and EUR. Returns EUR when the opportunity is in the aws-eusc (AWS European Sovereign Cloud) partition.
Frequency (string) --
Time period for spend amounts.
TotalAmount (string) --
Total estimated spend for this source before optimizations.
TotalOptimizedAmount (string) --
Total estimated spend after applying recommended optimizations.
TotalPotentialSavingsAmount (string) --
Quantified savings achievable through implementing optimizations.
TotalAmountByCategory (dict) --
Spend amounts mapped to AWS programs and modernization pathways.
(string) --
The name of the AWS program or modernization pathway that the spend amount maps to.
(string) --
The spend amount that maps to the AWS program or modernization pathway.
AwsProducts (list) --
Product-level details including costs and optimization recommendations.
(dict) --
List of AWS services with program eligibility indicators (MAP, modernization pathways), cost estimates, and optimization recommendations.
ProductCode (string) --
AWS Partner Central product identifier used for opportunity association.
ServiceCode (string) --
Pricing Calculator service code.
Categories (list) --
List of program and pathway categories this product is eligible for.
(string) --
Amount (string) --
Baseline service cost before optimizations.
OptimizedAmount (string) --
Service cost after applying optimizations.
PotentialSavingsAmount (string) --
Service-specific cost reduction through optimizations.
Optimizations (list) --
List of specific optimization recommendations for this product.
(dict) --
Specific optimization strategies partners can implement to reduce costs.
Description (string) --
Human-readable explanation of the optimization strategy.
SavingsAmount (string) --
Quantified cost savings achievable by implementing this optimization.
AWS (dict) --
AI-generated insights including recommended products from AWS.
CurrencyCode (string) --
ISO 4217 currency code. Supported values are USD and EUR. Returns EUR when the opportunity is in the aws-eusc (AWS European Sovereign Cloud) partition.
Frequency (string) --
Time period for spend amounts.
TotalAmount (string) --
Total estimated spend for this source before optimizations.
TotalOptimizedAmount (string) --
Total estimated spend after applying recommended optimizations.
TotalPotentialSavingsAmount (string) --
Quantified savings achievable through implementing optimizations.
TotalAmountByCategory (dict) --
Spend amounts mapped to AWS programs and modernization pathways.
(string) --
The name of the AWS program or modernization pathway that the spend amount maps to.
(string) --
The spend amount that maps to the AWS program or modernization pathway.
AwsProducts (list) --
Product-level details including costs and optimization recommendations.
(dict) --
List of AWS services with program eligibility indicators (MAP, modernization pathways), cost estimates, and optimization recommendations.
ProductCode (string) --
AWS Partner Central product identifier used for opportunity association.
ServiceCode (string) --
Pricing Calculator service code.
Categories (list) --
List of program and pathway categories this product is eligible for.
(string) --
Amount (string) --
Baseline service cost before optimizations.
OptimizedAmount (string) --
Service cost after applying optimizations.
PotentialSavingsAmount (string) --
Service-specific cost reduction through optimizations.
Optimizations (list) --
List of specific optimization recommendations for this product.
(dict) --
Specific optimization strategies partners can implement to reduce costs.
Description (string) --
Human-readable explanation of the optimization strategy.
SavingsAmount (string) --
Quantified cost savings achievable by implementing this optimization.
OpportunityQuality (dict) --
Opportunity quality assessment. Null if not yet scored.
Score (integer) --
Deal quality score assigned to the opportunity. Values range from 0 to 100.
Trend (string) --
Direction of score change since last scoring iteration. Known values: Improving, Declining, No Change.
Recommendations (list) --
List of recommendations from various agent-driven sources.
(dict) --
A recommendation from an agent-driven source.
Type (string) --
The recommendation source type. Known values: OpportunityQuality, SolutionRecommendation, SpecialistRecommendation.
Details (string) --
Human-readable recommendation text from this source.
Attributes (dict) --
Source-specific metadata as key-value pairs.
(string) --
The name of the attribute.
(string) --
The value of the attribute.
InvolvementTypeChangeReason (string) --
Provides a reason for any changes in the involvement type of AWS in the opportunity. This field is used to track why the level of AWS engagement has changed from For Visibility Only to Co-sell offering transparency into the partnership dynamics.
RelatedEntityIds (dict) --
Lists related entity identifiers, such as AWS products or partner solutions, associated with the AWS Opportunity. These identifiers provide additional context and help partners understand which AWS services are involved.
AwsProducts (list) --
Specifies the AWS products associated with the opportunity. This field helps track the specific products that are part of the proposed solution.
(string) --
The identifier of an AWS product.
Solutions (list) --
Specifies the partner solutions related to the opportunity. These solutions represent the partner's offerings that are being positioned as part of the overall AWS opportunity.
(string) --
The identifier of a partner solution. An identifier starts with S- followed by up to 19 digits.
AwsMarketplaceSolutions (list) --
The AWS Marketplace solution ARNs associated with this opportunity.
(string) --
The Amazon Resource Name (ARN) that identifies an AWS Marketplace solution.
AwsMarketplaceProducts (list) --
The AWS Marketplace product ARNs associated with this opportunity.
(string) --
The Amazon Resource Name (ARN) that identifies an AWS Marketplace product.
Customer (dict) --
Provides details about the customer associated with the AWS Opportunity, including account information, industry, and other customer data. These details help partners understand the business context of the opportunity.
Contacts (list) --
Provides a list of customer contacts involved in the opportunity. These contacts may include decision makers, influencers, and other stakeholders within the customer's organization.
(dict) --
An object that contains a Customer Partner's contact details.
Email (string) --
The contact's email address associated with the Opportunity.
FirstName (string) --
The contact's first name associated with the Opportunity.
LastName (string) --
The contact's last name associated with the Opportunity.
BusinessTitle (string) --
The partner contact's title (job title or role) associated with the Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.
Phone (string) --
The contact's phone number associated with the Opportunity.
Project (dict) --
Provides details about the project associated with the AWS Opportunity, including the customer’s business problem, expected outcomes, and project scope. This information is crucial for understanding the broader context of the opportunity.
ExpectedCustomerSpend (list) --
Indicates the expected spending by the customer over the course of the project. This value helps partners and AWS estimate the financial impact of the opportunity. Use the AWS Pricing Calculator to create an estimate of the customer’s total spend. If only annual recurring revenue (ARR) is available, distribute it across 12 months to provide an average monthly value.
(dict) --
Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.
Amount (string) --
Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.
CurrencyCode (string) --
Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets. Accepted values are USD (US Dollars) and EUR (Euros). If the AWS Partition is aws-eusc (AWS European Sovereign Cloud), the currency code must be EUR.
Frequency (string) --
Indicates how frequently the customer is expected to spend the projected amount. Use Monthly for recurring monthly spend (required for TargetCompany: "AWS" entries). Use None for one-time deal value entries (required for TargetCompany: "Self" entries when providing Total Contract Value).
TargetCompany (string) --
Specifies the entity associated with this spend entry. Use AWS for the system’s AWS Monthly Recurring Revenue (MRR) estimate. Use Self for the partner’s own deal value entry when providing Total Contract Value (TCV) for automatic MRR conversion. When ExpectedContractDuration is present on the Project, only AWS and Self are accepted. When ExpectedContractDuration is not present, only AWS is accepted and any other value will be automatically set to AWS.
EstimationUrl (string) --
A URL providing additional information or context about the spend estimation.
AwsPartition (string) --
AWS partition where the opportunity will be deployed. Possible values: aws-eusc for AWS European Sovereign Cloud, null for all other partitions.
CosellMotion (string) --
Engagement classification for this opportunity. Read-only. Null before scoring. Known values: AWS Field-engaged, Agent-engaged, Partner-led.
CosellMotionReason (string) --
The plain-language reason for the current CosellMotion value. Read-only. Null when CosellMotion is null.
SoftwareRevenue (dict) --
Seller-provided PARC deal terms: commitment value, discount, and contract dates.
Value (dict) --
The committed value and currency for the procurement terms.
Amount (string) --
Specifies the payment amount.
CurrencyCode (string) --
Specifies the payment currency. Accepted values are USD (US Dollars) and EUR (Euros). If the AWS Partition is aws-eusc (AWS European Sovereign Cloud), the currency code must be EUR.
Discount (string) --
Discount percentage offered on the software revenue. Percent convention: 15.00 means 15%.
EffectiveDate (string) --
Contract effective (start) date in YYYY-MM-DD format.
ExpirationDate (string) --
Contract expiration (end) date in YYYY-MM-DD format.
Catalog (string) --
Specifies the catalog in which the AWS Opportunity exists. This is the environment (e.g., AWS or Sandbox) where the opportunity is being managed.
{'Contexts': {'Payload': {'CustomerAccount': {'AccountIdentifier': 'string',
'Customer': {'CompanyName': 'string',
'CountryCode': 'US '
'| '
'AF '
'| '
'AX '
'| '
'AL '
'| '
'DZ '
'| '
'AS '
'| '
'AD '
'| '
'AO '
'| '
'AI '
'| '
'AQ '
'| '
'AG '
'| '
'AR '
'| '
'AM '
'| '
'AW '
'| '
'AU '
'| '
'AT '
'| '
'AZ '
'| '
'BS '
'| '
'BH '
'| '
'BD '
'| '
'BB '
'| '
'BY '
'| '
'BE '
'| '
'BZ '
'| '
'BJ '
'| '
'BM '
'| '
'BT '
'| '
'BO '
'| '
'BQ '
'| '
'BA '
'| '
'BW '
'| '
'BV '
'| '
'BR '
'| '
'IO '
'| '
'BN '
'| '
'BG '
'| '
'BF '
'| '
'BI '
'| '
'KH '
'| '
'CM '
'| '
'CA '
'| '
'CV '
'| '
'KY '
'| '
'CF '
'| '
'TD '
'| '
'CL '
'| '
'CN '
'| '
'CX '
'| '
'CC '
'| '
'CO '
'| '
'KM '
'| '
'CG '
'| '
'CK '
'| '
'CR '
'| '
'CI '
'| '
'HR '
'| '
'CU '
'| '
'CW '
'| '
'CY '
'| '
'CZ '
'| '
'CD '
'| '
'DK '
'| '
'DJ '
'| '
'DM '
'| '
'DO '
'| '
'EC '
'| '
'EG '
'| '
'SV '
'| '
'GQ '
'| '
'ER '
'| '
'EE '
'| '
'ET '
'| '
'FK '
'| '
'FO '
'| '
'FJ '
'| '
'FI '
'| '
'FR '
'| '
'GF '
'| '
'PF '
'| '
'TF '
'| '
'GA '
'| '
'GM '
'| '
'GE '
'| '
'DE '
'| '
'GH '
'| '
'GI '
'| '
'GR '
'| '
'GL '
'| '
'GD '
'| '
'GP '
'| '
'GU '
'| '
'GT '
'| '
'GG '
'| '
'GN '
'| '
'GW '
'| '
'GY '
'| '
'HT '
'| '
'HM '
'| '
'VA '
'| '
'HN '
'| '
'HK '
'| '
'HU '
'| '
'IS '
'| '
'IN '
'| '
'ID '
'| '
'IR '
'| '
'IQ '
'| '
'IE '
'| '
'IM '
'| '
'IL '
'| '
'IT '
'| '
'JM '
'| '
'JP '
'| '
'JE '
'| '
'JO '
'| '
'KZ '
'| '
'KE '
'| '
'KI '
'| '
'KR '
'| '
'KW '
'| '
'KG '
'| '
'LA '
'| '
'LV '
'| '
'LB '
'| '
'LS '
'| '
'LR '
'| '
'LY '
'| '
'LI '
'| '
'LT '
'| '
'LU '
'| '
'MO '
'| '
'MK '
'| '
'MG '
'| '
'MW '
'| '
'MY '
'| '
'MV '
'| '
'ML '
'| '
'MT '
'| '
'MH '
'| '
'MQ '
'| '
'MR '
'| '
'MU '
'| '
'YT '
'| '
'MX '
'| '
'FM '
'| '
'MD '
'| '
'MC '
'| '
'MN '
'| '
'ME '
'| '
'MS '
'| '
'MA '
'| '
'MZ '
'| '
'MM '
'| '
'NA '
'| '
'NR '
'| '
'NP '
'| '
'NL '
'| '
'AN '
'| '
'NC '
'| '
'NZ '
'| '
'NI '
'| '
'NE '
'| '
'NG '
'| '
'NU '
'| '
'NF '
'| '
'MP '
'| '
'NO '
'| '
'OM '
'| '
'PK '
'| '
'PW '
'| '
'PS '
'| '
'PA '
'| '
'PG '
'| '
'PY '
'| '
'PE '
'| '
'PH '
'| '
'PN '
'| '
'PL '
'| '
'PT '
'| '
'PR '
'| '
'QA '
'| '
'RE '
'| '
'RO '
'| '
'RU '
'| '
'RW '
'| '
'BL '
'| '
'SH '
'| '
'KN '
'| '
'LC '
'| '
'MF '
'| '
'PM '
'| '
'VC '
'| '
'WS '
'| '
'SM '
'| '
'ST '
'| '
'SA '
'| '
'SN '
'| '
'RS '
'| '
'SC '
'| '
'SL '
'| '
'SG '
'| '
'SX '
'| '
'SK '
'| '
'SI '
'| '
'SB '
'| '
'SO '
'| '
'ZA '
'| '
'GS '
'| '
'SS '
'| '
'ES '
'| '
'LK '
'| '
'SD '
'| '
'SR '
'| '
'SJ '
'| '
'SZ '
'| '
'SE '
'| '
'CH '
'| '
'SY '
'| '
'TW '
'| '
'TJ '
'| '
'TZ '
'| '
'TH '
'| '
'TL '
'| '
'TG '
'| '
'TK '
'| '
'TO '
'| '
'TT '
'| '
'TN '
'| '
'TR '
'| '
'TM '
'| '
'TC '
'| '
'TV '
'| '
'UG '
'| '
'UA '
'| '
'AE '
'| '
'GB '
'| '
'UM '
'| '
'UY '
'| '
'UZ '
'| '
'VU '
'| '
'VE '
'| '
'VN '
'| '
'VG '
'| '
'VI '
'| '
'WF '
'| '
'EH '
'| '
'YE '
'| '
'ZM '
'| '
'ZW',
'Industry': 'string',
'WebsiteUrl': 'string'}},
'Lead': {'Insights': {'ChannelRecommendation': {'BestOutreachWindows': [{'Day': 'MONDAY '
'| '
'TUESDAY '
'| '
'WEDNESDAY '
'| '
'THURSDAY '
'| '
'FRIDAY '
'| '
'SATURDAY '
'| '
'SUNDAY',
'EndTimeUtc': 'string',
'StartTimeUtc': 'string'}],
'RecommendedChannel': 'string'}}}},
'Type': {'CustomerAccount'}}}
Use this action to retrieve the engagement record for a given EngagementIdentifier.
See also: AWS API Documentation
Request Syntax
client.get_engagement(
Catalog='string',
Identifier='string'
)
string
[REQUIRED]
Specifies the catalog related to the engagement request. Valid values are AWS and Sandbox.
string
[REQUIRED]
Specifies the identifier of the Engagement record to retrieve.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'Title': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'CreatedBy': 'string',
'MemberCount': 123,
'ModifiedAt': datetime(2015, 1, 1),
'ModifiedBy': 'string',
'Contexts': [
{
'Id': 'string',
'Type': 'CustomerProject'|'Lead'|'ProspectingResult'|'CustomerAccount',
'Payload': {
'CustomerProject': {
'Customer': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'Project': {
'Title': 'string',
'BusinessProblem': 'string',
'TargetCompletionDate': 'string'
}
},
'Lead': {
'Insights': {
'LeadReadinessScore': 'string',
'ChannelRecommendation': {
'RecommendedChannel': 'string',
'BestOutreachWindows': [
{
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'StartTimeUtc': 'string',
'EndTimeUtc': 'string'
},
]
}
},
'QualificationStatus': 'string',
'Customer': {
'Industry': 'string',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'Address': {
'City': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'CountryCode': 'string'
},
'AwsMaturity': 'string',
'MarketSegment': 'string'
},
'Interactions': [
{
'SourceType': 'string',
'SourceId': 'string',
'SourceName': 'string',
'Usecase': 'string',
'InteractionDate': datetime(2015, 1, 1),
'CustomerAction': 'string',
'BusinessProblem': 'string',
'Contact': {
'BusinessTitle': 'string',
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'Phone': 'string'
}
},
]
},
'ProspectingResult': {
'Aws': {
'Customer': {
'AccountName': 'string',
'Geo': 'string',
'Region': 'string',
'SubRegion': 'string',
'Country': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'SubIndustry': 'string',
'Segment': 'string',
'CompanySize': 'string',
'EligiblePrograms': [
'string',
],
'PublicProfileSummary': 'string'
},
'Insights': {
'MarketplaceEngagementScore': 'string',
'SolutionScore': 'string',
'SolutionCategory': 'string',
'SolutionSubCategory': 'string'
},
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TaskId': 'string',
'TaskArn': 'string',
'TaskName': 'string'
}
},
'CustomerAccount': {
'AccountIdentifier': 'string',
'Customer': {
'Industry': 'string',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
}
}
}
},
]
}
Response Structure
(dict) --
Contains the response that the GetEngagement action returns.
Id (string) --
The unique resource identifier of the engagement retrieved.
Arn (string) --
The Amazon Resource Name (ARN) of the engagement retrieved.
Title (string) --
The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.
Description (string) --
A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.
CreatedAt (datetime) --
The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This timestamp helps track the lifecycle of the Engagement.
CreatedBy (string) --
The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.
MemberCount (integer) --
Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.
ModifiedAt (datetime) --
The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z". This helps track the most recent changes to the engagement.
ModifiedBy (string) --
The AWS account ID of the user who last modified the engagement. This field helps track who made the most recent changes to the engagement.
Contexts (list) --
A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.
(dict) --
Provides detailed context information for an Engagement. This structure allows for specifying the type of context and its associated payload.
Id (string) --
The unique identifier of the engagement context. This ID is used to reference and manage the specific context within the engagement.
Type (string) --
Specifies the type of Engagement context. Valid values are "CustomerProject" or "Document", indicating whether the context relates to a customer project or a document respectively.
Payload (dict) --
Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.
CustomerProject (dict) --
Contains detailed information about a customer project when the context type is "CustomerProject". This field is present only when the Type in EngagementContextDetails is set to "CustomerProject".
Customer (dict) --
Contains details about the customer that the customer project belongs to.
Industry (string) --
Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.
CompanyName (string) --
Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.
WebsiteUrl (string) --
Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.
CountryCode (string) --
Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.
Project (dict) --
Information about the customer project associated with the Engagement.
Title (string) --
The title of the project.
BusinessProblem (string) --
A description of the business problem the project aims to solve.
TargetCompletionDate (string) --
The target completion date for the customer's project.
Lead (dict) --
Contains detailed information about a lead when the context type is "Lead". This field is present only when the Type in EngagementContextDetails is set to "Lead".
Insights (dict) --
Insights that AI generates and associates with the lead. These insights provide automated analysis such as lead readiness scoring to help partners assess the lead quality.
LeadReadinessScore (string) --
A score that indicates the lead's readiness for engagement. Valid values are Low, Medium, and High. Use this score to prioritize leads based on their likelihood of conversion.
ChannelRecommendation (dict) --
The outreach channel most commonly recommended for leads that share this lead's country, geography, region, and company segment. It includes the days and the Coordinated Universal Time (UTC) hours when that channel is best used. This is guidance for the group of similar leads. It doesn't describe this lead's own contact history. Present only when a recommendation is available for the lead.
RecommendedChannel (string) --
The recommended outreach channel for the group of similar leads. Valid values are EMAIL and CALL.
BestOutreachWindows (list) --
The recommended day-specific outreach windows for the recommended channel, expressed in Coordinated Universal Time (UTC). Each window applies to one day, and more than one window can fall on the same day. This field is optional and appears only when window guidance is available.
(dict) --
A single recommended outreach window for one day, expressed in Coordinated Universal Time (UTC).
Day (string) --
The day of the week that this outreach window applies to. Valid values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY.
StartTimeUtc (string) --
The inclusive start of the outreach window, in Coordinated Universal Time (UTC), in 24-hour HH:mm format.
EndTimeUtc (string) --
The exclusive end of the outreach window, in Coordinated Universal Time (UTC), in 24-hour HH:mm format.
QualificationStatus (string) --
Indicates the current qualification status of the lead, such as whether it has been qualified, disqualified, or is still under evaluation. This helps track the lead's progression through the qualification process.
Customer (dict) --
Contains detailed information about the customer associated with the lead, including company information, contact details, and other relevant customer data.
Industry (string) --
Specifies the industry sector to which the lead customer's company belongs. This categorization helps in understanding the customer's business context and tailoring appropriate solutions.
CompanyName (string) --
The name of the lead customer's company. This field is essential for identifying and tracking the customer organization associated with the lead.
WebsiteUrl (string) --
The website URL of the lead customer's company. This provides additional context about the customer organization and helps verify company legitimacy and size.
Address (dict) --
The address information for the lead customer.
City (string) --
The city of the lead customer's address.
PostalCode (string) --
The postal code of the lead customer's address.
StateOrRegion (string) --
The state or region of the lead customer's address.
CountryCode (string) --
The country code of the lead customer's address.
AwsMaturity (string) --
Indicates the customer's level of experience and adoption with AWS services. This assessment helps determine the appropriate engagement approach and solution complexity.
MarketSegment (string) --
Specifies the market segment classification of the lead customer, such as enterprise, mid-market, or small business. This segmentation helps in targeting appropriate solutions and engagement strategies.
Interactions (list) --
An array of interactions that have occurred with the lead, providing a history of communications, meetings, and other engagement activities related to the lead.
(dict) --
Represents a specific interaction or touchpoint with a lead customer. This structure captures details about communications, meetings, or other engagement activities that help track the lead's progression and engagement history.
SourceType (string) --
Specifies the type of source that generated the lead interaction, such as "Event", "Website", "Referral", or "Campaign". This categorization helps track lead generation effectiveness across different channels.
SourceId (string) --
The unique identifier of the specific source that generated the lead interaction. This ID provides traceability back to the original lead generation activity.
SourceName (string) --
The descriptive name of the source that generated the lead interaction, providing a human-readable identifier for the lead generation channel or activity.
Usecase (string) --
Describes the specific use case or business scenario discussed during the lead interaction. This helps categorize the customer's interests and potential solutions.
InteractionDate (datetime) --
The date and time when the lead interaction occurred, in ISO 8601 format (UTC). This timestamp helps track the chronology of lead engagement activities.
CustomerAction (string) --
Describes the action taken by the customer during or as a result of the interaction, such as requesting information, scheduling a meeting, or expressing interest in a solution.
BusinessProblem (string) --
Describes the business problem or challenge that the customer discussed during the interaction. This information helps qualify the lead and identify appropriate solutions.
Contact (dict) --
Contains contact information for the customer representative involved in the lead interaction, including their name, title, and contact details.
BusinessTitle (string) --
The lead contact's business title or job role associated with the engagement.
Email (string) --
The lead contact's email address associated with the engagement.
FirstName (string) --
The lead contact's first name associated with the engagement.
LastName (string) --
The lead contact's last name associated with the engagement.
Phone (string) --
The lead contact's phone number associated with the engagement.
ProspectingResult (dict) --
Contains prospecting result data with enriched insights. The system generates these insights when a partner runs an autonomous prospecting job on leads. This field appears only when the context type is "ProspectingResult".
Aws (dict) --
Prospecting data and insights that AWS provides during the prospecting job. This includes customer details, task information, and scoring that AI generates.
Customer (dict) --
Contains details about the prospected customer account, including geographic, industry, and segment classifications.
AccountName (string) --
The name of the prospected customer account.
Geo (string) --
The geographic region classification of the prospected customer account.
Region (string) --
The specific region of the prospected customer account.
SubRegion (string) --
The subregion classification of the prospected customer account.
Country (string) --
The country code of the prospected customer account.
Industry (string) --
The industry classification of the prospected customer account.
SubIndustry (string) --
The sub-industry classification of the prospected customer account. This provides more granular categorization within the primary industry.
Segment (string) --
The market segment classification of the prospected customer account.
CompanySize (string) --
The company size classification of the prospected customer account.
EligiblePrograms (list) --
A list of AWS Greenfield programs that the prospected customer is eligible for. Use this list to identify relevant go-to-market opportunities.
(string) --
PublicProfileSummary (string) --
A summary of publicly available information about the prospected customer. The system uses this summary to generate customer insights and inform engagement strategies.
Insights (dict) --
Insights that AI generates from the prospecting analysis. These insights include engagement scores and solution fit assessments for the prospected customer.
MarketplaceEngagementScore (string) --
A score that indicates the prospected customer's level of engagement with AWS Marketplace. Valid values are High, Medium, and Low.
SolutionScore (string) --
A score that indicates how well the partner's solution fits the prospected customer's needs.
SolutionCategory (string) --
The primary solution category classification for the prospected customer. This indicates the type of solution that best addresses their needs.
SolutionSubCategory (string) --
The solution sub-category classification for the prospected customer. This provides more granular categorization of the recommended solution type.
StartTime (datetime) --
The timestamp when the prospecting result context was created. The format is ISO 8601 (UTC).
EndTime (datetime) --
The timestamp when the prospecting task completed processing. The format is ISO 8601 (UTC).
TaskId (string) --
The unique identifier of the prospecting task that generates this result.
TaskArn (string) --
The Amazon Resource Name (ARN) of the prospecting task. Use this ARN to track and manage the task within AWS.
TaskName (string) --
The name that the user provides for the prospecting task that generates this result.
CustomerAccount (dict) --
The customer account context for account planning. This field appears only when the context type is CustomerAccount.
AccountIdentifier (string) --
The identifier of the customer account that the engagement concerns, as an Amazon Resource Name (ARN) or a customer account identifier.
Customer (dict) --
A snapshot of the customer company's identity for the account. On read, the service populates this from the account identifier.
Industry (string) --
The industry classification of the customer company.
CompanyName (string) --
The name of the customer company.
WebsiteUrl (string) --
The website URL of the customer company.
CountryCode (string) --
The country of the customer company, as an ISO 3166-1 alpha-2 country code.
{'EnrichmentContext': {'LeadInsights': {'ChannelRecommendation': {'BestOutreachWindows': [{'Day': 'MONDAY '
'| '
'TUESDAY '
'| '
'WEDNESDAY '
'| '
'THURSDAY '
'| '
'FRIDAY '
'| '
'SATURDAY '
'| '
'SUNDAY',
'EndTimeUtc': 'string',
'StartTimeUtc': 'string'}],
'RecommendedChannel': 'string'}}},
'Payload': {'AccountPlanningInvitation': {'AccountIdentifier': 'string',
'Customer': {'CompanyName': 'string',
'CountryCode': 'US | '
'AF | '
'AX | '
'AL | '
'DZ | '
'AS | '
'AD | '
'AO | '
'AI | '
'AQ | '
'AG | '
'AR | '
'AM | '
'AW | '
'AU | '
'AT | '
'AZ | '
'BS | '
'BH | '
'BD | '
'BB | '
'BY | '
'BE | '
'BZ | '
'BJ | '
'BM | '
'BT | '
'BO | '
'BQ | '
'BA | '
'BW | '
'BV | '
'BR | '
'IO | '
'BN | '
'BG | '
'BF | '
'BI | '
'KH | '
'CM | '
'CA | '
'CV | '
'KY | '
'CF | '
'TD | '
'CL | '
'CN | '
'CX | '
'CC | '
'CO | '
'KM | '
'CG | '
'CK | '
'CR | '
'CI | '
'HR | '
'CU | '
'CW | '
'CY | '
'CZ | '
'CD | '
'DK | '
'DJ | '
'DM | '
'DO | '
'EC | '
'EG | '
'SV | '
'GQ | '
'ER | '
'EE | '
'ET | '
'FK | '
'FO | '
'FJ | '
'FI | '
'FR | '
'GF | '
'PF | '
'TF | '
'GA | '
'GM | '
'GE | '
'DE | '
'GH | '
'GI | '
'GR | '
'GL | '
'GD | '
'GP | '
'GU | '
'GT | '
'GG | '
'GN | '
'GW | '
'GY | '
'HT | '
'HM | '
'VA | '
'HN | '
'HK | '
'HU | '
'IS | '
'IN | '
'ID | '
'IR | '
'IQ | '
'IE | '
'IM | '
'IL | '
'IT | '
'JM | '
'JP | '
'JE | '
'JO | '
'KZ | '
'KE | '
'KI | '
'KR | '
'KW | '
'KG | '
'LA | '
'LV | '
'LB | '
'LS | '
'LR | '
'LY | '
'LI | '
'LT | '
'LU | '
'MO | '
'MK | '
'MG | '
'MW | '
'MY | '
'MV | '
'ML | '
'MT | '
'MH | '
'MQ | '
'MR | '
'MU | '
'YT | '
'MX | '
'FM | '
'MD | '
'MC | '
'MN | '
'ME | '
'MS | '
'MA | '
'MZ | '
'MM | '
'NA | '
'NR | '
'NP | '
'NL | '
'AN | '
'NC | '
'NZ | '
'NI | '
'NE | '
'NG | '
'NU | '
'NF | '
'MP | '
'NO | '
'OM | '
'PK | '
'PW | '
'PS | '
'PA | '
'PG | '
'PY | '
'PE | '
'PH | '
'PN | '
'PL | '
'PT | '
'PR | '
'QA | '
'RE | '
'RO | '
'RU | '
'RW | '
'BL | '
'SH | '
'KN | '
'LC | '
'MF | '
'PM | '
'VC | '
'WS | '
'SM | '
'ST | '
'SA | '
'SN | '
'RS | '
'SC | '
'SL | '
'SG | '
'SX | '
'SK | '
'SI | '
'SB | '
'SO | '
'ZA | '
'GS | '
'SS | '
'ES | '
'LK | '
'SD | '
'SR | '
'SJ | '
'SZ | '
'SE | '
'CH | '
'SY | '
'TW | '
'TJ | '
'TZ | '
'TH | '
'TL | '
'TG | '
'TK | '
'TO | '
'TT | '
'TN | '
'TR | '
'TM | '
'TC | '
'TV | '
'UG | '
'UA | '
'AE | '
'GB | '
'UM | '
'UY | '
'UZ | '
'VU | '
'VE | '
'VN | '
'VG | '
'VI | '
'WF | '
'EH | '
'YE | '
'ZM | '
'ZW',
'Industry': 'string',
'WebsiteUrl': 'string'},
'PreferredContact': {'Timezone': 'string',
'Window': 'MORNING '
'| '
'AFTERNOON '
'| '
'EVENING'},
'SenderContacts': [{'BusinessTitle': 'string',
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'Phone': 'string'}]},
'OpportunityInvitation': {'OpportunityType': 'Net New Business | '
'Flat Renewal | '
'Expansion'}},
'PayloadType': {'AccountPlanningInvitation'}}
Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes aspects such as customer, project details, and lifecycle information. To connect an engagement invitation with an opportunity, match the invitation’s Payload.Project.Title with opportunity Project.Title.
See also: AWS API Documentation
Request Syntax
client.get_engagement_invitation(
Catalog='string',
Identifier='string'
)
string
[REQUIRED]
Specifies the catalog associated with the request. The field accepts values from the predefined set: AWS for live operations or Sandbox for testing environments.
string
[REQUIRED]
Specifies the unique identifier for the retrieved engagement invitation.
dict
Response Syntax
{
'Arn': 'string',
'PayloadType': 'OpportunityInvitation'|'LeadInvitation'|'AccountPlanningInvitation',
'Id': 'string',
'EngagementId': 'string',
'EngagementTitle': 'string',
'Status': 'ACCEPTED'|'PENDING'|'REJECTED'|'EXPIRED',
'InvitationDate': datetime(2015, 1, 1),
'ExpirationDate': datetime(2015, 1, 1),
'SenderAwsAccountId': 'string',
'SenderCompanyName': 'string',
'Receiver': {
'Account': {
'Alias': 'string',
'AwsAccountId': 'string'
}
},
'Catalog': 'string',
'RejectionReason': 'string',
'Payload': {
'OpportunityInvitation': {
'SenderContacts': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
],
'ReceiverResponsibilities': [
'Distributor'|'Reseller'|'Hardware Partner'|'Managed Service Provider'|'Software Partner'|'Services Partner'|'Training Partner'|'Co-Sell Facilitator'|'Facilitator',
],
'Customer': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'Project': {
'BusinessProblem': 'string',
'Title': 'string',
'TargetCompletionDate': 'string',
'ExpectedCustomerSpend': [
{
'Amount': 'string',
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TargetCompany': 'string',
'EstimationUrl': 'string'
},
]
},
'OpportunityType': 'Net New Business'|'Flat Renewal'|'Expansion'
},
'LeadInvitation': {
'Customer': {
'Industry': 'string',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'string',
'AwsMaturity': 'string',
'MarketSegment': 'string'
},
'Interaction': {
'SourceType': 'string',
'SourceId': 'string',
'SourceName': 'string',
'Usecase': 'string',
'ContactBusinessTitle': 'string'
}
},
'AccountPlanningInvitation': {
'AccountIdentifier': 'string',
'Customer': {
'Industry': 'string',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'SenderContacts': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
],
'PreferredContact': {
'Window': 'MORNING'|'AFTERNOON'|'EVENING',
'Timezone': 'string'
}
}
},
'InvitationMessage': 'string',
'EngagementDescription': 'string',
'ExistingMembers': [
{
'CompanyName': 'string',
'WebsiteUrl': 'string'
},
],
'EnrichmentContext': {
'ProspectingResultAws': {
'Customer': {
'AccountName': 'string',
'Geo': 'string',
'Region': 'string',
'SubRegion': 'string',
'Country': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'SubIndustry': 'string',
'Segment': 'string',
'CompanySize': 'string',
'EligiblePrograms': [
'string',
],
'PublicProfileSummary': 'string'
},
'Insights': {
'MarketplaceEngagementScore': 'string',
'SolutionScore': 'string',
'SolutionCategory': 'string',
'SolutionSubCategory': 'string'
}
},
'LeadInsights': {
'LeadReadinessScore': 'string',
'ChannelRecommendation': {
'RecommendedChannel': 'string',
'BestOutreachWindows': [
{
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'StartTimeUtc': 'string',
'EndTimeUtc': 'string'
},
]
}
}
}
}
Response Structure
(dict) --
Contains the response that the GetEngagementInvitation action returns.
Arn (string) --
The Amazon Resource Name (ARN) that identifies the engagement invitation.
PayloadType (string) --
The type of payload contained in the engagement invitation, indicating what data or context the payload covers.
Id (string) --
Unique identifier assigned to the engagement invitation being retrieved.
EngagementId (string) --
The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.
EngagementTitle (string) --
The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.
Status (string) --
The current status of the engagement invitation.
InvitationDate (datetime) --
The date when the engagement invitation was sent to the partner.
ExpirationDate (datetime) --
Indicates the date on which the engagement invitation will expire if not accepted by the partner.
SenderAwsAccountId (string) --
Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.
SenderCompanyName (string) --
The name of the AWS organization or team that sent the engagement invitation.
Receiver (dict) --
Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.
Account (dict) --
Specifies the AWS account of the partner who received the Engagement Invitation. This field is used to track the invitation recipient within the AWS ecosystem.
Alias (string) --
Represents the alias of the partner account receiving the Engagement Invitation, making it easier to identify and track the recipient in reports or logs.
AwsAccountId (string) --
Indicates the AWS account ID of the partner who received the Engagement Invitation. This is a unique identifier for managing engagements with specific AWS accounts.
Catalog (string) --
Indicates the catalog from which the engagement invitation details are retrieved. This field helps in identifying the appropriate catalog (e.g., AWS or Sandbox) used in the request.
RejectionReason (string) --
If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.
Payload (dict) --
Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.
OpportunityInvitation (dict) --
Specifies the details of the opportunity invitation within the Engagement Invitation payload. This data helps partners understand the context, scope, and expected involvement for the opportunity from AWS.
SenderContacts (list) --
Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are opportunity stakeholders.
(dict) --
An object that contains the details of the sender-provided contact person for the EngagementInvitation.
Email (string) --
The sender-provided contact's email address associated with the EngagementInvitation.
FirstName (string) --
The sender-provided contact's last name associated with the EngagementInvitation.
LastName (string) --
The sender-provided contact's first name associated with the EngagementInvitation.
BusinessTitle (string) --
The sender-provided contact's title (job title or role) associated with the EngagementInvitation.
Phone (string) --
The sender-provided contact's phone number associated with the EngagementInvitation.
ReceiverResponsibilities (list) --
Outlines the responsibilities or expectations of the receiver in the context of the invitation.
(string) --
A responsibility that the receiver of an engagement invitation has in the engagement.
Customer (dict) --
Contains information about the customer related to the opportunity in the Engagement Invitation. This data helps partners understand the customer’s profile and requirements.
Industry (string) --
Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.
CompanyName (string) --
Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.
WebsiteUrl (string) --
Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.
CountryCode (string) --
Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.
Project (dict) --
Describes the project details associated with the opportunity, including the customer’s needs and the scope of work expected to be performed.
BusinessProblem (string) --
Describes the business problem that the project aims to solve. This information is crucial for understanding the project’s goals and objectives.
Title (string) --
Specifies the title of the project. This title helps partners quickly identify and understand the focus of the project.
TargetCompletionDate (string) --
Specifies the estimated date of project completion. This field helps track the project timeline and manage expectations.
ExpectedCustomerSpend (list) --
Contains revenue estimates for the partner related to the project. This field provides an idea of the financial potential of the opportunity for the partner.
(dict) --
Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.
Amount (string) --
Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.
CurrencyCode (string) --
Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets. Accepted values are USD (US Dollars) and EUR (Euros). If the AWS Partition is aws-eusc (AWS European Sovereign Cloud), the currency code must be EUR.
Frequency (string) --
Indicates how frequently the customer is expected to spend the projected amount. Use Monthly for recurring monthly spend (required for TargetCompany: "AWS" entries). Use None for one-time deal value entries (required for TargetCompany: "Self" entries when providing Total Contract Value).
TargetCompany (string) --
Specifies the entity associated with this spend entry. Use AWS for the system’s AWS Monthly Recurring Revenue (MRR) estimate. Use Self for the partner’s own deal value entry when providing Total Contract Value (TCV) for automatic MRR conversion. When ExpectedContractDuration is present on the Project, only AWS and Self are accepted. When ExpectedContractDuration is not present, only AWS is accepted and any other value will be automatically set to AWS.
EstimationUrl (string) --
A URL providing additional information or context about the spend estimation.
OpportunityType (string) --
The type of the opportunity being shared. The sender of the invitation sets it. Valid values:
Net New Business: A new business opportunity with a potential customer that's not previously engaged with your solutions or services.
Flat Renewal: An opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.
Expansion: An opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.
LeadInvitation (dict) --
Specifies the details of the lead invitation within the Engagement Invitation payload. This data helps partners understand the lead context, customer information, and interaction history for the lead opportunity from AWS.
Customer (dict) --
Contains information about the customer associated with the lead invitation. This data helps partners understand the customer's profile, industry, and business context to assess the lead opportunity.
Industry (string) --
Specifies the industry sector of the customer company associated with the lead invitation. This categorization helps partners understand the customer's business context and assess solution fit.
CompanyName (string) --
The name of the customer company associated with the lead invitation. This field identifies the target organization for the lead engagement opportunity.
WebsiteUrl (string) --
The website URL of the customer company. This provides additional context about the customer organization and helps partners verify company details and assess business size and legitimacy.
CountryCode (string) --
The country code indicating the geographic location of the customer company. This information helps partners understand regional requirements and assess their ability to serve the customer effectively.
AwsMaturity (string) --
Indicates the customer's level of experience and adoption with AWS services. This assessment helps partners understand the customer's cloud maturity and tailor their engagement approach accordingly.
MarketSegment (string) --
Specifies the market segment classification of the customer, such as enterprise, mid-market, or small business. This segmentation helps partners determine the appropriate solution complexity and engagement strategy.
Interaction (dict) --
Describes the interaction details associated with the lead, including the source of the lead generation and customer engagement information. This context helps partners evaluate the lead quality and engagement approach.
SourceType (string) --
Specifies the type of source that generated the lead interaction, such as "Event", "Website", or "Campaign". This helps partners understand the lead generation channel and assess lead quality based on the source type.
SourceId (string) --
The unique identifier of the specific source that generated the lead interaction. This provides traceability to the original lead generation activity for reference and follow-up purposes.
SourceName (string) --
The descriptive name of the source that generated the lead interaction. This human-readable identifier helps partners understand the specific lead generation channel or campaign that created the opportunity.
Usecase (string) --
Describes the specific use case or business scenario associated with the lead interaction. This information helps partners understand the customer's interests and potential solution requirements.
ContactBusinessTitle (string) --
The business title or job role of the customer contact involved in the lead interaction. This helps partners identify the decision-making level and engagement approach for the lead.
AccountPlanningInvitation (dict) --
The content of an account-planning invitation. This field is present when the invitation is for account planning.
AccountIdentifier (string) --
The identifier of the customer account that the plan concerns, as an Amazon Resource Name (ARN) or a customer account identifier.
Customer (dict) --
A caller-supplied snapshot of the customer company's identity, so that the receiver can tell which account the plan concerns even when the account isn't yet mapped to an AWS account.
Industry (string) --
The industry classification of the customer company.
CompanyName (string) --
The name of the customer company.
WebsiteUrl (string) --
The website URL of the customer company.
CountryCode (string) --
The country of the customer company, as an ISO 3166-1 alpha-2 country code.
SenderContacts (list) --
The sender's contact information for this account plan.
(dict) --
An object that contains the details of the sender-provided contact person for the EngagementInvitation.
Email (string) --
The sender-provided contact's email address associated with the EngagementInvitation.
FirstName (string) --
The sender-provided contact's last name associated with the EngagementInvitation.
LastName (string) --
The sender-provided contact's first name associated with the EngagementInvitation.
BusinessTitle (string) --
The sender-provided contact's title (job title or role) associated with the EngagementInvitation.
Phone (string) --
The sender-provided contact's phone number associated with the EngagementInvitation.
PreferredContact (dict) --
When the sender prefers to be contacted about this account plan. This information is advisory.
Window (string) --
The preferred time-of-day band for contact.
Timezone (string) --
The IANA time zone name that the window is expressed in, for example America/Chicago.
InvitationMessage (string) --
The message sent to the invited partner when the invitation was created.
EngagementDescription (string) --
The description of the engagement associated with this invitation.
ExistingMembers (list) --
A list of active members currently part of the Engagement. This array contains a maximum of 10 members, each represented by an object with the following properties.
CompanyName: The name of the member's company.
WebsiteUrl: The website URL of the member's company.
(dict) --
The EngagementMemberSummary provides a snapshot of essential information about participants in an AWS Partner Central Engagement. This compact data structure encapsulates key details of each member, facilitating efficient collaboration and management within the Engagement.
CompanyName (string) --
The official name of the member's company or organization.
WebsiteUrl (string) --
The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier.
EnrichmentContext (dict) --
The enrichment data for the engagement associated with this invitation. You can view propensity scores, program eligibility, and lead readiness assessments before taking action on the invitation.
ProspectingResultAws (dict) --
The customer account data and propensity insights for the prospected account. It includes geographic, industry, and segment classifications, along with engagement and solution scoring.
Customer (dict) --
The prospected customer account details, including geographic classification, industry segmentation, company size, and program eligibility.
AccountName (string) --
The name of the prospected customer account.
Geo (string) --
The geographic region classification of the prospected customer account.
Region (string) --
The specific region of the prospected customer account.
SubRegion (string) --
The subregion classification of the prospected customer account.
Country (string) --
The country code of the prospected customer account.
Industry (string) --
The industry classification of the prospected customer account.
SubIndustry (string) --
The sub-industry classification of the prospected customer account. This provides more granular categorization within the primary industry.
Segment (string) --
The market segment classification of the prospected customer account.
CompanySize (string) --
The company size classification of the prospected customer account.
EligiblePrograms (list) --
A list of AWS Greenfield programs that the prospected customer is eligible for. Use this list to identify relevant go-to-market opportunities.
(string) --
PublicProfileSummary (string) --
A summary of publicly available information about the prospected customer. The system uses this summary to generate customer insights and inform engagement strategies.
Insights (dict) --
The AI-generated insights from the prospecting analysis, including marketplace engagement scoring, solution fit assessments, and solution categorization.
MarketplaceEngagementScore (string) --
A score that indicates the prospected customer's level of engagement with AWS Marketplace. Valid values are High, Medium, and Low.
SolutionScore (string) --
A score that indicates how well the partner's solution fits the prospected customer's needs.
SolutionCategory (string) --
The primary solution category classification for the prospected customer. This indicates the type of solution that best addresses their needs.
SolutionSubCategory (string) --
The solution sub-category classification for the prospected customer. This provides more granular categorization of the recommended solution type.
LeadInsights (dict) --
The AI-generated lead readiness score for this lead. Use this score to assess lead quality and prioritize engagement efforts.
LeadReadinessScore (string) --
A score that indicates the lead's readiness for engagement. Valid values are Low, Medium, and High. Use this score to prioritize leads based on their likelihood of conversion.
ChannelRecommendation (dict) --
The outreach channel most commonly recommended for leads that share this lead's country, geography, region, and company segment. It includes the days and the Coordinated Universal Time (UTC) hours when that channel is best used. This is guidance for the group of similar leads. It doesn't describe this lead's own contact history. Present only when a recommendation is available for the lead.
RecommendedChannel (string) --
The recommended outreach channel for the group of similar leads. Valid values are EMAIL and CALL.
BestOutreachWindows (list) --
The recommended day-specific outreach windows for the recommended channel, expressed in Coordinated Universal Time (UTC). Each window applies to one day, and more than one window can fall on the same day. This field is optional and appears only when window guidance is available.
(dict) --
A single recommended outreach window for one day, expressed in Coordinated Universal Time (UTC).
Day (string) --
The day of the week that this outreach window applies to. Valid values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY.
StartTimeUtc (string) --
The inclusive start of the outreach window, in Coordinated Universal Time (UTC), in 24-hour HH:mm format.
EndTimeUtc (string) --
The exclusive end of the outreach window, in Coordinated Universal Time (UTC), in 24-hour HH:mm format.
{'Payload': {'AwsOpportunitySummaryFullView': {'CosellMotionReason': 'string'}}}
Use this action to retrieve a specific snapshot record.
See also: AWS API Documentation
Request Syntax
client.get_resource_snapshot(
Catalog='string',
EngagementIdentifier='string',
ResourceType='Opportunity',
ResourceIdentifier='string',
ResourceSnapshotTemplateIdentifier='string',
Revision=123
)
string
[REQUIRED]
Specifies the catalog related to the request. Valid values are:
AWS: Retrieves the snapshot from the production AWS environment.
Sandbox: Retrieves the snapshot from a sandbox environment used for testing or development purposes.
string
[REQUIRED]
The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.
string
[REQUIRED]
Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes: Opportunity: For opportunity-related data.
string
[REQUIRED]
The unique identifier of the specific resource that was snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For Opportunity type, it will be an opportunity ID
string
[REQUIRED]
he name of the template that defines the schema for the snapshot. This template determines which subset of the resource data is included in the snapshot and must correspond to an existing and valid template for the specified ResourceType.
integer
Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.
dict
Response Syntax
{
'Catalog': 'string',
'Arn': 'string',
'CreatedBy': 'string',
'CreatedAt': datetime(2015, 1, 1),
'EngagementId': 'string',
'ResourceType': 'Opportunity',
'ResourceId': 'string',
'ResourceSnapshotTemplateName': 'string',
'Revision': 123,
'Payload': {
'OpportunitySummary': {
'OpportunityType': 'Net New Business'|'Flat Renewal'|'Expansion',
'Lifecycle': {
'TargetCloseDate': 'string',
'ReviewStatus': 'Pending Submission'|'Submitted'|'In review'|'Approved'|'Rejected'|'Action Required',
'Stage': 'Prospect'|'Qualified'|'Technical Validation'|'Business Validation'|'Committed'|'Launched'|'Closed Lost',
'NextSteps': 'string'
},
'OpportunityTeam': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
],
'PrimaryNeedsFromAws': [
'Co-Sell - Architectural Validation'|'Co-Sell - Business Presentation'|'Co-Sell - Competitive Information'|'Co-Sell - Pricing Assistance'|'Co-Sell - Technical Consultation'|'Co-Sell - Total Cost of Ownership Evaluation'|'Co-Sell - Deal Support'|'Co-Sell - Support for Public Tender / RFx',
],
'Customer': {
'Account': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'OtherIndustry': 'string',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'AwsAccountId': 'string',
'Address': {
'City': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'StreetAddress': 'string'
},
'Duns': 'string'
},
'Contacts': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
]
},
'Project': {
'DeliveryModels': [
'SaaS or PaaS'|'BYOL or AMI'|'Managed Services'|'Professional Services'|'Resell'|'Other',
],
'ExpectedCustomerSpend': [
{
'Amount': 'string',
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TargetCompany': 'string',
'EstimationUrl': 'string'
},
],
'ExpectedContractDuration': {
'Term': 'Months',
'Value': 'string'
},
'CustomerUseCase': 'string',
'SalesActivities': [
'Initialized discussions with customer'|'Customer has shown interest in solution'|'Conducted POC / Demo'|'In evaluation / planning stage'|'Agreed on solution to Business Problem'|'Completed Action Plan'|'Finalized Deployment Need'|'SOW Signed',
],
'OtherSolutionDescription': 'string'
},
'RelatedEntityIdentifiers': {
'AwsMarketplaceOffers': [
'string',
],
'AwsMarketplaceOfferSets': [
'string',
],
'Solutions': [
'string',
],
'AwsProducts': [
'string',
],
'AwsMarketplaceSolutions': [
'string',
],
'AwsMarketplaceProducts': [
'string',
]
}
},
'AwsOpportunitySummaryFullView': {
'RelatedOpportunityId': 'string',
'Origin': 'AWS Referral'|'Partner Referral',
'InvolvementType': 'For Visibility Only'|'Co-Sell',
'Visibility': 'Full'|'Limited',
'LifeCycle': {
'TargetCloseDate': 'string',
'ClosedLostReason': 'Administrative'|'Business Associate Agreement'|'Company Acquired/Dissolved'|'Competitive Offering'|'Customer Data Requirement'|'Customer Deficiency'|'Customer Experience'|'Delay / Cancellation of Project'|'Duplicate'|'Duplicate Opportunity'|'Executive Blocker'|'Failed Vetting'|'Feature Limitation'|'Financial/Commercial'|'Insufficient Amazon Value'|'Insufficient AWS Value'|'International Constraints'|'Legal / Tax / Regulatory'|'Legal Terms and Conditions'|'Lost to Competitor'|'Lost to Competitor - Google'|'Lost to Competitor - Microsoft'|'Lost to Competitor - Other'|'Lost to Competitor - Rackspace'|'Lost to Competitor - SoftLayer'|'Lost to Competitor - VMWare'|'No Customer Reference'|'No Integration Resources'|'No Opportunity'|'No Perceived Value of MP'|'No Response'|'Not Committed to AWS'|'No Update'|'On Premises Deployment'|'Other'|'Other (Details in Description)'|'Partner Gap'|'Past Due'|'People/Relationship/Governance'|'Platform Technology Limitation'|'Preference for Competitor'|'Price'|'Product/Technology'|'Product Not on AWS'|'Security / Compliance'|'Self-Service'|'Technical Limitations'|'Term Sheet Impasse',
'Stage': 'Not Started'|'In Progress'|'Prospect'|'Engaged'|'Identified'|'Qualify'|'Research'|'Seller Engaged'|'Evaluating'|'Seller Registered'|'Term Sheet Negotiation'|'Contract Negotiation'|'Onboarding'|'Building Integration'|'Qualified'|'On-hold'|'Technical Validation'|'Business Validation'|'Committed'|'Launched'|'Deferred to Partner'|'Closed Lost'|'Completed'|'Closed Incomplete',
'NextSteps': 'string',
'NextStepsHistory': [
{
'Value': 'string',
'Time': datetime(2015, 1, 1)
},
]
},
'OpportunityTeam': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'AWSSalesRep'|'AWSAccountOwner'|'WWPSPDM'|'PDM'|'PSM'|'ISVSM'|'Signatory'
},
],
'Insights': {
'NextBestActions': 'string',
'EngagementScore': 'High'|'Medium'|'Low',
'AwsProductsSpendInsightsBySource': {
'Partner': {
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TotalAmount': 'string',
'TotalOptimizedAmount': 'string',
'TotalPotentialSavingsAmount': 'string',
'TotalAmountByCategory': {
'string': 'string'
},
'AwsProducts': [
{
'ProductCode': 'string',
'ServiceCode': 'string',
'Categories': [
'string',
],
'Amount': 'string',
'OptimizedAmount': 'string',
'PotentialSavingsAmount': 'string',
'Optimizations': [
{
'Description': 'string',
'SavingsAmount': 'string'
},
]
},
]
},
'AWS': {
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TotalAmount': 'string',
'TotalOptimizedAmount': 'string',
'TotalPotentialSavingsAmount': 'string',
'TotalAmountByCategory': {
'string': 'string'
},
'AwsProducts': [
{
'ProductCode': 'string',
'ServiceCode': 'string',
'Categories': [
'string',
],
'Amount': 'string',
'OptimizedAmount': 'string',
'PotentialSavingsAmount': 'string',
'Optimizations': [
{
'Description': 'string',
'SavingsAmount': 'string'
},
]
},
]
}
},
'OpportunityQuality': {
'Score': 123,
'Trend': 'string'
},
'Recommendations': [
{
'Type': 'string',
'Details': 'string',
'Attributes': {
'string': 'string'
}
},
]
},
'InvolvementTypeChangeReason': 'Expansion Opportunity'|'Change in Deal Information'|'Customer Requested'|'Technical Complexity'|'Risk Mitigation',
'RelatedEntityIds': {
'AwsProducts': [
'string',
],
'Solutions': [
'string',
],
'AwsMarketplaceSolutions': [
'string',
],
'AwsMarketplaceProducts': [
'string',
]
},
'Customer': {
'Contacts': [
{
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'BusinessTitle': 'string',
'Phone': 'string'
},
]
},
'Project': {
'ExpectedCustomerSpend': [
{
'Amount': 'string',
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
'Frequency': 'Monthly',
'TargetCompany': 'string',
'EstimationUrl': 'string'
},
],
'AwsPartition': 'aws-eusc'
},
'CosellMotion': 'string',
'CosellMotionReason': 'string',
'SoftwareRevenue': {
'Value': {
'Amount': 'string',
'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL'
},
'Discount': 'string',
'EffectiveDate': 'string',
'ExpirationDate': 'string'
}
}
},
'TargetMemberAccounts': [
'string',
]
}
Response Structure
(dict) --
Contains the response that the GetResourceSnapshot action returns.
Catalog (string) --
The catalog in which the snapshot was created. Matches the Catalog specified in the request.
Arn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the resource snapshot.
CreatedBy (string) --
The AWS account ID of the principal (user or role) who created the snapshot. This helps in tracking the origin of the snapshot.
CreatedAt (datetime) --
The timestamp when the snapshot was created, in ISO 8601 format (e.g., "2023-06-01T14:30:00Z"). This allows for precise tracking of when the snapshot was taken.
EngagementId (string) --
The identifier of the engagement associated with this snapshot. Matches the EngagementIdentifier specified in the request.
ResourceType (string) --
The type of the resource that was snapshotted. Matches the ResourceType specified in the request.
ResourceId (string) --
The identifier of the specific resource that was snapshotted. Matches the ResourceIdentifier specified in the request.
ResourceSnapshotTemplateName (string) --
The name of the view used for this snapshot. This is the same as the template name.
Revision (integer) --
The revision number of this snapshot. This is a positive integer that is sequential and unique within the context of a resource view.
Payload (dict) --
Contains the data of the resource snapshot. The structure of this payload depends on the resource type and the snapshot template.
OpportunitySummary (dict) --
An object that contains an opportunity's subset of fields.
OpportunityType (string) --
Specifies the opportunity type.
Lifecycle (dict) --
Contains information about the opportunity's lifecycle, including its current stage, status, and important dates such as creation and last modification times.
TargetCloseDate (string) --
The projected launch date of the opportunity shared through a snapshot.
ReviewStatus (string) --
Defines the approval status of the opportunity shared through a snapshot.
Stage (string) --
Defines the current stage of the opportunity shared through a snapshot.
NextSteps (string) --
Describes the next steps for the opportunity shared through a snapshot.
OpportunityTeam (list) --
Represents the internal team handling the opportunity. Specify the members involved in collaborating on an opportunity within the partner's organization.
(dict) --
An object that contains a Customer Partner's contact details.
Email (string) --
The contact's email address associated with the Opportunity.
FirstName (string) --
The contact's first name associated with the Opportunity.
LastName (string) --
The contact's last name associated with the Opportunity.
BusinessTitle (string) --
The partner contact's title (job title or role) associated with the Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.
Phone (string) --
The contact's phone number associated with the Opportunity.
PrimaryNeedsFromAws (list) --
Identifies the type of support the partner needs from AWS.
(string) --
A type of help that the partner needs from AWS on an opportunity.
Customer (dict) --
Contains details about the customer that the opportunity belongs to.
Account (dict) --
An object that contains the customer's account details.
Industry (string) --
Specifies the industry the end Customer belongs to that's associated with the Opportunity. It refers to the category or sector where the customer's business operates. This is a required field.
OtherIndustry (string) --
Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other.
CompanyName (string) --
Specifies the end Customer's company name associated with the Opportunity.
WebsiteUrl (string) --
Specifies the end customer's company website URL associated with the Opportunity. This value is crucial to map the customer within the Amazon Web Services CRM system. This field is required in all cases except when the opportunity is related to national security.
AwsAccountId (string) --
Specifies the Customer Amazon Web Services account ID associated with the Opportunity.
Address (dict) --
Specifies the end Customer's address details associated with the Opportunity.
City (string) --
Specifies the end Customer's city associated with the Opportunity.
PostalCode (string) --
Specifies the end Customer's postal code associated with the Opportunity.
StateOrRegion (string) --
Specifies the end Customer's state or region associated with the Opportunity.
Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP
CountryCode (string) --
Specifies the end Customer's country associated with the Opportunity.
StreetAddress (string) --
Specifies the end Customer's street address associated with the Opportunity.
Duns (string) --
Indicates the Customer DUNS number, if available.
Contacts (list) --
Represents the contact details for individuals associated with the customer of the Opportunity. This field captures relevant contacts, including decision-makers, influencers, and technical stakeholders within the customer organization. These contacts are key to progressing the opportunity.
(dict) --
An object that contains a Customer Partner's contact details.
Email (string) --
The contact's email address associated with the Opportunity.
FirstName (string) --
The contact's first name associated with the Opportunity.
LastName (string) --
The contact's last name associated with the Opportunity.
BusinessTitle (string) --
The partner contact's title (job title or role) associated with the Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.
Phone (string) --
The contact's phone number associated with the Opportunity.
Project (dict) --
Contains summary information about the project associated with the opportunity, including project name, description, timeline, and other relevant details.
DeliveryModels (list) --
Describes the deployment or consumption model for the partner solution or offering. This field indicates how the project's solution will be delivered or implemented for the customer.
(string) --
A model that the partner uses to deliver the solution to the customer.
ExpectedCustomerSpend (list) --
Provides information about the anticipated customer spend related to this project. This may include details such as amount, frequency, and currency of expected expenditure.
(dict) --
Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.
Amount (string) --
Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.
CurrencyCode (string) --
Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets. Accepted values are USD (US Dollars) and EUR (Euros). If the AWS Partition is aws-eusc (AWS European Sovereign Cloud), the currency code must be EUR.
Frequency (string) --
Indicates how frequently the customer is expected to spend the projected amount. Use Monthly for recurring monthly spend (required for TargetCompany: "AWS" entries). Use None for one-time deal value entries (required for TargetCompany: "Self" entries when providing Total Contract Value).
TargetCompany (string) --
Specifies the entity associated with this spend entry. Use AWS for the system’s AWS Monthly Recurring Revenue (MRR) estimate. Use Self for the partner’s own deal value entry when providing Total Contract Value (TCV) for automatic MRR conversion. When ExpectedContractDuration is present on the Project, only AWS and Self are accepted. When ExpectedContractDuration is not present, only AWS is accepted and any other value will be automatically set to AWS.
EstimationUrl (string) --
A URL providing additional information or context about the spend estimation.
ExpectedContractDuration (dict) --
Optional. The expected contract duration for this opportunity, representing the anticipated length of the contract in the unit specified by Term.
Term (string) --
The unit of measurement for the contract duration value. Currently accepts only Months.
Value (string) --
A String representation of the contract duration as an integer, expressed in the unit defined by Term. Valid values range from 1 to 144.
CustomerUseCase (string) --
Specifies the proposed solution focus or type of workload for the project.
SalesActivities (list) --
Lists the pre-sales activities that have occurred with the end-customer related to the opportunity. This field is conditionally mandatory when the project is qualified for Co-Sell and helps drive assignment priority on the AWS side. It provides insight into the engagement level with the customer.
(string) --
A sales activity that the partner completed for the opportunity.
OtherSolutionDescription (string) --
Offers a description of other solutions if the standard solutions do not adequately cover the project's scope.
RelatedEntityIdentifiers (dict) --
Lists the identifiers of entities that relate to the opportunity, such as AWS products, partner solutions, and AWS Marketplace offers.
AwsMarketplaceOffers (list) --
Takes one value per opportunity. Each value is an Amazon Resource Name (ARN), in this format: "offers": ["arn:aws:aws-marketplace:us-east-1:999999999999:AWSMarketplace/Offer/offer-sampleOffer32"].
Use the ListEntities action in the Marketplace Catalog APIs for a list of offers in the associated Marketplace seller account.
(string) --
The Amazon Resource Name (ARN) that identifies an AWS Marketplace offer.
AwsMarketplaceOfferSets (list) --
Enables the association of AWS Marketplace offer sets with the Opportunity. Offer sets allow grouping multiple related marketplace offers together for comprehensive solution packaging. Each value is an Amazon Resource Name (ARN) in this format: arn:aws:aws-marketplace:us-east-1:999999999999:AWSMarketplace/OfferSet/offerset-sampleOfferSet32.
(string) --
The Amazon Resource Name (ARN) that identifies an AWS Marketplace offer set.
Solutions (list) --
Enables partner solutions or offerings' association with an opportunity. To associate a solution, provide the solution's unique identifier, which you can obtain with the ListSolutions operation.
If the specific solution identifier is not available, you can use the value Other and provide details about the solution in the otherSolutionOffered field. But when the opportunity reaches the Committed stage or beyond, the Other value cannot be used, and a valid solution identifier must be provided.
By associating the relevant solutions with the opportunity, you can communicate the offerings that are being considered or implemented to address the customer's business problem.
(string) --
The identifier of a partner solution. An identifier starts with S- followed by up to 19 digits.
AwsProducts (list) --
Enables the association of specific Amazon Web Services products with the Opportunity. Partners can indicate the relevant Amazon Web Services products for the Opportunity's solution and align with the customer's needs. Returns multiple values separated by commas. For example, "AWSProducts" : ["AmazonRedshift", "AWSAppFabric", "AWSCleanRooms"].
Use the file with the list of Amazon Web Services products hosted on GitHub: Amazon Web Services products.
(string) --
The identifier of an AWS product.
AwsMarketplaceSolutions (list) --
Specifies the AWS Marketplace solutions to associate with the Opportunity. Each value is an Amazon Resource Name (ARN) that identifies a solution listing in AWS Marketplace.
(string) --
The Amazon Resource Name (ARN) that identifies an AWS Marketplace solution.
AwsMarketplaceProducts (list) --
Specifies the AWS Marketplace products to associate with the Opportunity. Each value is an Amazon Resource Name (ARN) that identifies a product listing in AWS Marketplace.
(string) --
The Amazon Resource Name (ARN) that identifies an AWS Marketplace product.
AwsOpportunitySummaryFullView (dict) --
Provides a comprehensive view of AwsOpportunitySummaryFullView template.
RelatedOpportunityId (string) --
Identifier of the related partner opportunity.
Origin (string) --
Source origin of the AWS opportunity.
InvolvementType (string) --
Type of AWS involvement in the opportunity.
Visibility (string) --
Visibility level for the AWS opportunity.
LifeCycle (dict) --
Contains lifecycle details of the AWS opportunity, such as its stage, review status, and target close date.
TargetCloseDate (string) --
Indicates the expected date by which the opportunity is projected to close. This field helps in planning resources and timelines for both the partner and AWS.
ClosedLostReason (string) --
Indicates the reason why an opportunity was marked as Closed Lost. This helps in understanding the context behind the lost opportunity and aids in refining future strategies.
Stage (string) --
Represents the current stage of the opportunity in its lifecycle, such as Qualification, Validation, or Closed Won. This helps in understanding the opportunity's progress.
NextSteps (string) --
Specifies the immediate next steps required to progress the opportunity. These steps are based on AWS guidance and the current stage of the opportunity.
NextStepsHistory (list) --
Provides a historical log of previous next steps that were taken to move the opportunity forward. This helps in tracking the decision-making process and identifying any delays or obstacles encountered.
(dict) --
Tracks the history of next steps associated with the opportunity. This field captures the actions planned for the future and their timeline.
Value (string) --
Represents the details of the next step recorded, such as follow-up actions or decisions made. This field helps in tracking progress and ensuring alignment with project goals.
Time (datetime) --
Indicates the date and time when a particular next step was recorded or planned. This helps in managing the timeline for the opportunity.
OpportunityTeam (list) --
AWS team members involved in the opportunity.
(dict) --
Represents an Amazon Web Services team member for the engagement. This structure includes details such as name, email, and business title.
Email (string) --
Provides the Amazon Web Services team member's email address.
FirstName (string) --
Provides the Amazon Web Services team member's first name.
LastName (string) --
Provides the Amazon Web Services team member's last name.
BusinessTitle (string) --
Specifies the Amazon Web Services team member's business title and indicates their organizational role.
Insights (dict) --
Contains the insights that AWS provides for the opportunity, such as the engagement score and the recommended next actions.
NextBestActions (string) --
Provides recommendations from AWS on the next best actions to take in order to move the opportunity forward and increase the likelihood of success.
EngagementScore (string) --
Represents a score assigned by AWS to indicate the level of engagement and potential success for the opportunity. This score helps partners prioritize their efforts.
AwsProductsSpendInsightsBySource (dict) --
Source-separated spend insights that provide independent analysis for AWS recommendations and partner estimates.
Partner (dict) --
Partner-sourced insights derived from Pricing Calculator URLs.
CurrencyCode (string) --
ISO 4217 currency code. Supported values are USD and EUR. Returns EUR when the opportunity is in the aws-eusc (AWS European Sovereign Cloud) partition.
Frequency (string) --
Time period for spend amounts.
TotalAmount (string) --
Total estimated spend for this source before optimizations.
TotalOptimizedAmount (string) --
Total estimated spend after applying recommended optimizations.
TotalPotentialSavingsAmount (string) --
Quantified savings achievable through implementing optimizations.
TotalAmountByCategory (dict) --
Spend amounts mapped to AWS programs and modernization pathways.
(string) --
The name of the AWS program or modernization pathway that the spend amount maps to.
(string) --
The spend amount that maps to the AWS program or modernization pathway.
AwsProducts (list) --
Product-level details including costs and optimization recommendations.
(dict) --
List of AWS services with program eligibility indicators (MAP, modernization pathways), cost estimates, and optimization recommendations.
ProductCode (string) --
AWS Partner Central product identifier used for opportunity association.
ServiceCode (string) --
Pricing Calculator service code.
Categories (list) --
List of program and pathway categories this product is eligible for.
(string) --
Amount (string) --
Baseline service cost before optimizations.
OptimizedAmount (string) --
Service cost after applying optimizations.
PotentialSavingsAmount (string) --
Service-specific cost reduction through optimizations.
Optimizations (list) --
List of specific optimization recommendations for this product.
(dict) --
Specific optimization strategies partners can implement to reduce costs.
Description (string) --
Human-readable explanation of the optimization strategy.
SavingsAmount (string) --
Quantified cost savings achievable by implementing this optimization.
AWS (dict) --
AI-generated insights including recommended products from AWS.
CurrencyCode (string) --
ISO 4217 currency code. Supported values are USD and EUR. Returns EUR when the opportunity is in the aws-eusc (AWS European Sovereign Cloud) partition.
Frequency (string) --
Time period for spend amounts.
TotalAmount (string) --
Total estimated spend for this source before optimizations.
TotalOptimizedAmount (string) --
Total estimated spend after applying recommended optimizations.
TotalPotentialSavingsAmount (string) --
Quantified savings achievable through implementing optimizations.
TotalAmountByCategory (dict) --
Spend amounts mapped to AWS programs and modernization pathways.
(string) --
The name of the AWS program or modernization pathway that the spend amount maps to.
(string) --
The spend amount that maps to the AWS program or modernization pathway.
AwsProducts (list) --
Product-level details including costs and optimization recommendations.
(dict) --
List of AWS services with program eligibility indicators (MAP, modernization pathways), cost estimates, and optimization recommendations.
ProductCode (string) --
AWS Partner Central product identifier used for opportunity association.
ServiceCode (string) --
Pricing Calculator service code.
Categories (list) --
List of program and pathway categories this product is eligible for.
(string) --
Amount (string) --
Baseline service cost before optimizations.
OptimizedAmount (string) --
Service cost after applying optimizations.
PotentialSavingsAmount (string) --
Service-specific cost reduction through optimizations.
Optimizations (list) --
List of specific optimization recommendations for this product.
(dict) --
Specific optimization strategies partners can implement to reduce costs.
Description (string) --
Human-readable explanation of the optimization strategy.
SavingsAmount (string) --
Quantified cost savings achievable by implementing this optimization.
OpportunityQuality (dict) --
Opportunity quality assessment. Null if not yet scored.
Score (integer) --
Deal quality score assigned to the opportunity. Values range from 0 to 100.
Trend (string) --
Direction of score change since last scoring iteration. Known values: Improving, Declining, No Change.
Recommendations (list) --
List of recommendations from various agent-driven sources.
(dict) --
A recommendation from an agent-driven source.
Type (string) --
The recommendation source type. Known values: OpportunityQuality, SolutionRecommendation, SpecialistRecommendation.
Details (string) --
Human-readable recommendation text from this source.
Attributes (dict) --
Source-specific metadata as key-value pairs.
(string) --
The name of the attribute.
(string) --
The value of the attribute.
InvolvementTypeChangeReason (string) --
Reason for changes in AWS involvement type for the opportunity.
RelatedEntityIds (dict) --
Lists the identifiers of entities that relate to the AWS opportunity, such as AWS products and partner solutions.
AwsProducts (list) --
Specifies the AWS products associated with the opportunity. This field helps track the specific products that are part of the proposed solution.
(string) --
The identifier of an AWS product.
Solutions (list) --
Specifies the partner solutions related to the opportunity. These solutions represent the partner's offerings that are being positioned as part of the overall AWS opportunity.
(string) --
The identifier of a partner solution. An identifier starts with S- followed by up to 19 digits.
AwsMarketplaceSolutions (list) --
The AWS Marketplace solution ARNs associated with this opportunity.
(string) --
The Amazon Resource Name (ARN) that identifies an AWS Marketplace solution.
AwsMarketplaceProducts (list) --
The AWS Marketplace product ARNs associated with this opportunity.
(string) --
The Amazon Resource Name (ARN) that identifies an AWS Marketplace product.
Customer (dict) --
Contains details about the customer that the AWS opportunity belongs to.
Contacts (list) --
Provides a list of customer contacts involved in the opportunity. These contacts may include decision makers, influencers, and other stakeholders within the customer's organization.
(dict) --
An object that contains a Customer Partner's contact details.
Email (string) --
The contact's email address associated with the Opportunity.
FirstName (string) --
The contact's first name associated with the Opportunity.
LastName (string) --
The contact's last name associated with the Opportunity.
BusinessTitle (string) --
The partner contact's title (job title or role) associated with the Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.
Phone (string) --
The contact's phone number associated with the Opportunity.
Project (dict) --
Contains details about the project that the AWS opportunity covers.
ExpectedCustomerSpend (list) --
Indicates the expected spending by the customer over the course of the project. This value helps partners and AWS estimate the financial impact of the opportunity. Use the AWS Pricing Calculator to create an estimate of the customer’s total spend. If only annual recurring revenue (ARR) is available, distribute it across 12 months to provide an average monthly value.
(dict) --
Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.
Amount (string) --
Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.
CurrencyCode (string) --
Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets. Accepted values are USD (US Dollars) and EUR (Euros). If the AWS Partition is aws-eusc (AWS European Sovereign Cloud), the currency code must be EUR.
Frequency (string) --
Indicates how frequently the customer is expected to spend the projected amount. Use Monthly for recurring monthly spend (required for TargetCompany: "AWS" entries). Use None for one-time deal value entries (required for TargetCompany: "Self" entries when providing Total Contract Value).
TargetCompany (string) --
Specifies the entity associated with this spend entry. Use AWS for the system’s AWS Monthly Recurring Revenue (MRR) estimate. Use Self for the partner’s own deal value entry when providing Total Contract Value (TCV) for automatic MRR conversion. When ExpectedContractDuration is present on the Project, only AWS and Self are accepted. When ExpectedContractDuration is not present, only AWS is accepted and any other value will be automatically set to AWS.
EstimationUrl (string) --
A URL providing additional information or context about the spend estimation.
AwsPartition (string) --
AWS partition where the opportunity will be deployed. Possible values: aws-eusc for AWS European Sovereign Cloud, null for all other partitions.
CosellMotion (string) --
Engagement classification for this opportunity. Read-only. Null before scoring. Known values: AWS Field-engaged, Agent-engaged, Partner-led.
CosellMotionReason (string) --
The plain-language reason for the current CosellMotion value. Read-only. Null when CosellMotion is null.
SoftwareRevenue (dict) --
Seller-provided PARC deal terms: commitment value, discount, and contract dates.
Value (dict) --
The committed value and currency for the procurement terms.
Amount (string) --
Specifies the payment amount.
CurrencyCode (string) --
Specifies the payment currency. Accepted values are USD (US Dollars) and EUR (Euros). If the AWS Partition is aws-eusc (AWS European Sovereign Cloud), the currency code must be EUR.
Discount (string) --
Discount percentage offered on the software revenue. Percent convention: 15.00 means 15%.
EffectiveDate (string) --
Contract effective (start) date in YYYY-MM-DD format.
ExpirationDate (string) --
Contract expiration (end) date in YYYY-MM-DD format.
TargetMemberAccounts (list) --
Target member accounts associated with the resource snapshot.
(string) --
An AWS account ID or an alias for an AWS account. An account ID has 12 digits, and an alias has up to 12 characters.
{'PayloadType': {'AccountPlanningInvitation'}}
Response {'EngagementInvitationSummaries': {'PayloadType': {'AccountPlanningInvitation'}}}
Retrieves a list of engagement invitations sent to the partner. This allows partners to view all pending or past engagement invitations, helping them track opportunities shared by AWS.
See also: AWS API Documentation
Request Syntax
client.list_engagement_invitations(
Catalog='string',
MaxResults=123,
NextToken='string',
Sort={
'SortOrder': 'ASCENDING'|'DESCENDING',
'SortBy': 'InvitationDate'
},
PayloadType=[
'OpportunityInvitation'|'LeadInvitation'|'AccountPlanningInvitation',
],
ParticipantType='SENDER'|'RECEIVER',
Status=[
'ACCEPTED'|'PENDING'|'REJECTED'|'EXPIRED',
],
EngagementIdentifier=[
'string',
],
SenderAwsAccountId=[
'string',
]
)
string
[REQUIRED]
Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.
integer
Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.
string
A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.
dict
Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as InvitationDate or Status to help partners view results in their preferred order.
SortOrder (string) -- [REQUIRED]
Defines the order in which the Engagement Invitations are sorted. The values can be ASC (ascending) or DESC (descending).
SortBy (string) -- [REQUIRED]
Specifies the field by which the Engagement Invitations are sorted. Common values include InvitationDate and Status.
list
Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.
(string) --
The type of payload that an engagement invitation carries. Valid values are OpportunityInvitation, LeadInvitation, and AccountPlanningInvitation.
string
[REQUIRED]
Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.
list
Status values to filter the invitations.
(string) --
The status of an engagement invitation. PENDING means the receiver hasn't responded yet. ACCEPTED and REJECTED mean the receiver accepted or rejected the invitation. EXPIRED means the invitation expired before the receiver responded.
list
Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days.
(string) --
The Amazon Resource Name (ARN) or the identifier of an engagement. An identifier starts with eng- followed by 14 lowercase letters or digits.
list
List of sender AWS account IDs to filter the invitations.
(string) --
An AWS account ID or an alias for an AWS account. An account ID has 12 digits, and an alias has up to 12 characters.
dict
Response Syntax
{
'EngagementInvitationSummaries': [
{
'Arn': 'string',
'PayloadType': 'OpportunityInvitation'|'LeadInvitation'|'AccountPlanningInvitation',
'Id': 'string',
'EngagementId': 'string',
'EngagementTitle': 'string',
'Status': 'ACCEPTED'|'PENDING'|'REJECTED'|'EXPIRED',
'InvitationDate': datetime(2015, 1, 1),
'ExpirationDate': datetime(2015, 1, 1),
'SenderAwsAccountId': 'string',
'SenderCompanyName': 'string',
'Receiver': {
'Account': {
'Alias': 'string',
'AwsAccountId': 'string'
}
},
'Catalog': 'string',
'ParticipantType': 'SENDER'|'RECEIVER'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the response that the ListEngagementInvitations action returns.
EngagementInvitationSummaries (list) --
An array containing summaries of engagement invitations. Each summary includes information such as the invitation title, invitation date, and the current status of the invitation.
(dict) --
Provides a summarized view of the Engagement Invitation, including details like the identifier, status, and sender. This summary helps partners track and manage AWS originated opportunities.
Arn (string) --
The Amazon Resource Name (ARN) of the Engagement Invitation. The ARN is a unique identifier that allows partners to reference the invitation in their system and manage its lifecycle.
PayloadType (string) --
Describes the type of payload associated with the Engagement Invitation, such as Opportunity or MarketplaceOffer. This helps partners understand the nature of the engagement request from AWS.
Id (string) --
Represents the unique identifier of the Engagement Invitation. This identifier is used to track the invitation and to manage responses like acceptance or rejection.
EngagementId (string) --
The identifier of the Engagement associated with this invitation. This links the invitation to its parent Engagement.
EngagementTitle (string) --
Provides a short title or description of the Engagement Invitation. This title helps partners quickly identify and differentiate between multiple engagement opportunities.
Status (string) --
Represents the current status of the Engagement Invitation, such as Pending, Accepted, or Rejected. The status helps track the progress and response to the invitation.
InvitationDate (datetime) --
Indicates the date when the Engagement Invitation was sent to the partner. This provides context for when the opportunity was shared and helps in tracking the timeline for engagement.
ExpirationDate (datetime) --
Indicates the date and time when the Engagement Invitation will expire. After this date, the invitation can no longer be accepted, and the opportunity will be unavailable to the partner.
SenderAwsAccountId (string) --
Specifies the AWS account ID of the sender who initiated the Engagement Invitation. This allows the partner to identify the AWS entity or representative responsible for sharing the opportunity.
SenderCompanyName (string) --
Indicates the name of the company or AWS division that sent the Engagement Invitation. This information is useful for partners to know which part of AWS is requesting engagement.
Receiver (dict) --
Specifies the partner company or individual that received the Engagement Invitation. This field is important for tracking who the invitation was sent to within the partner organization.
Account (dict) --
Specifies the AWS account of the partner who received the Engagement Invitation. This field is used to track the invitation recipient within the AWS ecosystem.
Alias (string) --
Represents the alias of the partner account receiving the Engagement Invitation, making it easier to identify and track the recipient in reports or logs.
AwsAccountId (string) --
Indicates the AWS account ID of the partner who received the Engagement Invitation. This is a unique identifier for managing engagements with specific AWS accounts.
Catalog (string) --
Specifies the catalog in which the Engagement Invitation resides. This can be either the AWS or Sandbox catalog, indicating whether the opportunity is live or being tested.
ParticipantType (string) --
Identifies the role of the caller in the engagement invitation.
NextToken (string) --
A pagination token returned when there are more results available than can be returned in a single call. Use this token to retrieve additional pages of engagement invitation summaries.
{'ContextTypes': {'CustomerAccount'},
'ExcludeContextTypes': {'CustomerAccount'}}
Response {'EngagementSummaryList': {'ContextTypes': {'CustomerAccount'}}}
This action allows users to retrieve a list of Engagement records from Partner Central. This action can be used to manage and track various engagements across different stages of the partner selling process.
See also: AWS API Documentation
Request Syntax
client.list_engagements(
Catalog='string',
CreatedBy=[
'string',
],
ExcludeCreatedBy=[
'string',
],
ContextTypes=[
'CustomerProject'|'Lead'|'ProspectingResult'|'CustomerAccount',
],
ExcludeContextTypes=[
'CustomerProject'|'Lead'|'ProspectingResult'|'CustomerAccount',
],
Sort={
'SortOrder': 'ASCENDING'|'DESCENDING',
'SortBy': 'CreatedDate'
},
MaxResults=123,
NextToken='string',
EngagementIdentifier=[
'string',
]
)
string
[REQUIRED]
Specifies the catalog related to the request.
list
A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.
(string) --
An AWS account ID or an alias for an AWS account. An account ID has 12 digits, and an alias has up to 12 characters.
list
An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.
(string) --
An AWS account ID or an alias for an AWS account. An account ID has 12 digits, and an alias has up to 12 characters.
list
Filters engagements to include only those containing the specified context types, such as "CustomerProject" or "Lead". Use this to find engagements that have specific types of contextual information associated with them.
(string) --
The type of an engagement context. Valid values are CustomerProject, Lead, ProspectingResult, and CustomerAccount.
list
Filters engagements to exclude those containing the specified context types. Use this to find engagements that do not have certain types of contextual information, helping to narrow results based on context exclusion criteria.
(string) --
The type of an engagement context. Valid values are CustomerProject, Lead, ProspectingResult, and CustomerAccount.
dict
Specifies how to sort the returned engagements.
SortOrder (string) -- [REQUIRED]
The order in which to sort the results.
SortBy (string) -- [REQUIRED]
The field by which to sort the results.
integer
The maximum number of results to return in a single call.
string
The token for the next set of results. This value is returned from a previous call.
list
An array of strings representing engagement identifiers to retrieve.
(string) --
The Amazon Resource Name (ARN) or the identifier of an engagement. An identifier starts with eng- followed by 14 lowercase letters or digits.
dict
Response Syntax
{
'EngagementSummaryList': [
{
'Arn': 'string',
'Id': 'string',
'Title': 'string',
'CreatedAt': datetime(2015, 1, 1),
'CreatedBy': 'string',
'MemberCount': 123,
'ModifiedAt': datetime(2015, 1, 1),
'ModifiedBy': 'string',
'ContextTypes': [
'CustomerProject'|'Lead'|'ProspectingResult'|'CustomerAccount',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the response that the ListEngagements action returns.
EngagementSummaryList (list) --
An array of engagement summary objects.
(dict) --
An object that contains an Engagement's subset of fields.
Arn (string) --
The Amazon Resource Name (ARN) of the created Engagement.
Id (string) --
The unique identifier for the Engagement.
Title (string) --
The title of the Engagement.
CreatedAt (datetime) --
The date and time when the Engagement was created.
CreatedBy (string) --
The AWS Account ID of the Engagement creator.
MemberCount (integer) --
The number of members in the Engagement.
ModifiedAt (datetime) --
The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z".
ModifiedBy (string) --
The AWS account ID of the user who last modified the engagement. This field helps track who made the most recent changes to the engagement.
ContextTypes (list) --
An array of context types associated with the engagement, such as "CustomerProject" or "Lead". This provides a quick overview of the types of contexts included in the engagement.
(string) --
The type of an engagement context. Valid values are CustomerProject, Lead, ProspectingResult, and CustomerAccount.
NextToken (string) --
The token to retrieve the next set of results. This field will be null if there are no more results.
{'Payload': {'Lead': {'Insights': {'ChannelRecommendation': {'BestOutreachWindows': [{'Day': 'MONDAY '
'| '
'TUESDAY '
'| '
'WEDNESDAY '
'| '
'THURSDAY '
'| '
'FRIDAY '
'| '
'SATURDAY '
'| '
'SUNDAY',
'EndTimeUtc': 'string',
'StartTimeUtc': 'string'}],
'RecommendedChannel': 'string'}}}},
'Type': {'CustomerAccount'}}
Updates the context information for an existing engagement with new or modified data.
See also: AWS API Documentation
Request Syntax
client.update_engagement_context(
Catalog='string',
EngagementIdentifier='string',
ContextIdentifier='string',
EngagementLastModifiedAt=datetime(2015, 1, 1),
Type='CustomerProject'|'Lead'|'ProspectingResult'|'CustomerAccount',
Payload={
'Lead': {
'QualificationStatus': 'string',
'Customer': {
'Industry': 'string',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'Address': {
'City': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'CountryCode': 'string'
},
'AwsMaturity': 'string',
'MarketSegment': 'string'
},
'Interaction': {
'SourceType': 'string',
'SourceId': 'string',
'SourceName': 'string',
'Usecase': 'string',
'InteractionDate': datetime(2015, 1, 1),
'CustomerAction': 'string',
'BusinessProblem': 'string',
'Contact': {
'BusinessTitle': 'string',
'Email': 'string',
'FirstName': 'string',
'LastName': 'string',
'Phone': 'string'
}
},
'Insights': {
'LeadReadinessScore': 'string',
'ChannelRecommendation': {
'RecommendedChannel': 'string',
'BestOutreachWindows': [
{
'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'StartTimeUtc': 'string',
'EndTimeUtc': 'string'
},
]
}
}
},
'CustomerProject': {
'Customer': {
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'CompanyName': 'string',
'WebsiteUrl': 'string',
'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
'Project': {
'Title': 'string',
'BusinessProblem': 'string',
'TargetCompletionDate': 'string'
}
},
'ProspectingResult': {
'Aws': {
'Customer': {
'AccountName': 'string',
'Geo': 'string',
'Region': 'string',
'SubRegion': 'string',
'Country': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
'SubIndustry': 'string',
'Segment': 'string',
'CompanySize': 'string',
'EligiblePrograms': [
'string',
],
'PublicProfileSummary': 'string'
},
'Insights': {
'MarketplaceEngagementScore': 'string',
'SolutionScore': 'string',
'SolutionCategory': 'string',
'SolutionSubCategory': 'string'
},
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TaskId': 'string',
'TaskArn': 'string',
'TaskName': 'string'
}
}
}
)
string
[REQUIRED]
Specifies the catalog associated with the engagement context update request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is updated in.
string
[REQUIRED]
The unique identifier of the Engagement containing the context to be updated. This parameter ensures the context update is applied to the correct engagement.
string
[REQUIRED]
The unique identifier of the specific engagement context to be updated. This ensures that the correct context within the engagement is modified.
datetime
[REQUIRED]
The timestamp when the engagement was last modified, used for optimistic concurrency control. This helps prevent conflicts when multiple users attempt to update the same engagement simultaneously.
string
[REQUIRED]
Specifies the type of context being updated within the engagement. This field determines the structure and content of the context payload being modified.
dict
[REQUIRED]
Contains the updated contextual information for the engagement. The structure of this payload varies based on the context type specified in the Type field.
Lead (dict) --
Contains updated information about a lead when the context type is "Lead". This field is present only when updating a lead context within the engagement.
QualificationStatus (string) --
The updated qualification status of the lead.
Customer (dict) -- [REQUIRED]
Updated customer information associated with the lead.
Industry (string) --
Specifies the industry sector to which the lead customer's company belongs. This categorization helps in understanding the customer's business context and tailoring appropriate solutions.
CompanyName (string) -- [REQUIRED]
The name of the lead customer's company. This field is essential for identifying and tracking the customer organization associated with the lead.
WebsiteUrl (string) --
The website URL of the lead customer's company. This provides additional context about the customer organization and helps verify company legitimacy and size.
Address (dict) --
The address information for the lead customer.
City (string) --
The city of the lead customer's address.
PostalCode (string) --
The postal code of the lead customer's address.
StateOrRegion (string) --
The state or region of the lead customer's address.
CountryCode (string) --
The country code of the lead customer's address.
AwsMaturity (string) --
Indicates the customer's level of experience and adoption with AWS services. This assessment helps determine the appropriate engagement approach and solution complexity.
MarketSegment (string) --
Specifies the market segment classification of the lead customer, such as enterprise, mid-market, or small business. This segmentation helps in targeting appropriate solutions and engagement strategies.
Interaction (dict) --
Updated interaction details for the lead context.
SourceType (string) --
Specifies the type of source that generated the lead interaction, such as "Event", "Website", "Referral", or "Campaign". This categorization helps track lead generation effectiveness across different channels.
SourceId (string) --
The unique identifier of the specific source that generated the lead interaction. This ID provides traceability back to the original lead generation activity.
SourceName (string) --
The descriptive name of the source that generated the lead interaction, providing a human-readable identifier for the lead generation channel or activity.
Usecase (string) --
Describes the specific use case or business scenario discussed during the lead interaction. This helps categorize the customer's interests and potential solutions.
InteractionDate (datetime) --
The date and time when the lead interaction occurred, in ISO 8601 format (UTC). This timestamp helps track the chronology of lead engagement activities.
CustomerAction (string) --
Describes the action taken by the customer during or as a result of the interaction, such as requesting information, scheduling a meeting, or expressing interest in a solution.
BusinessProblem (string) --
Describes the business problem or challenge that the customer discussed during the interaction. This information helps qualify the lead and identify appropriate solutions.
Contact (dict) -- [REQUIRED]
Contains contact information for the customer representative involved in the lead interaction, including their name, title, and contact details.
BusinessTitle (string) -- [REQUIRED]
The lead contact's business title or job role associated with the engagement.
Email (string) -- [REQUIRED]
The lead contact's email address associated with the engagement.
FirstName (string) -- [REQUIRED]
The lead contact's first name associated with the engagement.
LastName (string) -- [REQUIRED]
The lead contact's last name associated with the engagement.
Phone (string) --
The lead contact's phone number associated with the engagement.
Insights (dict) --
Insights that AI generates and associates with the lead. These insights provide automated analysis to help partners assess the lead quality and readiness.
LeadReadinessScore (string) --
A score that indicates the lead's readiness for engagement. Valid values are Low, Medium, and High. Use this score to prioritize leads based on their likelihood of conversion.
ChannelRecommendation (dict) --
The outreach channel most commonly recommended for leads that share this lead's country, geography, region, and company segment. It includes the days and the Coordinated Universal Time (UTC) hours when that channel is best used. This is guidance for the group of similar leads. It doesn't describe this lead's own contact history. Present only when a recommendation is available for the lead.
RecommendedChannel (string) -- [REQUIRED]
The recommended outreach channel for the group of similar leads. Valid values are EMAIL and CALL.
BestOutreachWindows (list) --
The recommended day-specific outreach windows for the recommended channel, expressed in Coordinated Universal Time (UTC). Each window applies to one day, and more than one window can fall on the same day. This field is optional and appears only when window guidance is available.
(dict) --
A single recommended outreach window for one day, expressed in Coordinated Universal Time (UTC).
Day (string) -- [REQUIRED]
The day of the week that this outreach window applies to. Valid values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY.
StartTimeUtc (string) -- [REQUIRED]
The inclusive start of the outreach window, in Coordinated Universal Time (UTC), in 24-hour HH:mm format.
EndTimeUtc (string) -- [REQUIRED]
The exclusive end of the outreach window, in Coordinated Universal Time (UTC), in 24-hour HH:mm format.
CustomerProject (dict) --
Contains the updated details of a customer project when the context type is CustomerProject.
Customer (dict) --
Contains details about the customer that the customer project belongs to.
Industry (string) -- [REQUIRED]
Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.
CompanyName (string) -- [REQUIRED]
Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.
WebsiteUrl (string) -- [REQUIRED]
Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.
CountryCode (string) -- [REQUIRED]
Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.
Project (dict) --
Information about the customer project associated with the Engagement.
Title (string) -- [REQUIRED]
The title of the project.
BusinessProblem (string) -- [REQUIRED]
A description of the business problem the project aims to solve.
TargetCompletionDate (string) -- [REQUIRED]
The target completion date for the customer's project.
ProspectingResult (dict) --
Contains updated prospecting result data when the context type is "ProspectingResult". This field includes enriched data and insights that the system generates when a partner runs an autonomous prospecting job on leads.
Aws (dict) --
Prospecting data and insights that AWS provides during the prospecting job. This includes customer details, task information, and scoring that AI generates.
Customer (dict) --
Contains details about the prospected customer account, including geographic, industry, and segment classifications.
AccountName (string) --
The name of the prospected customer account.
Geo (string) --
The geographic region classification of the prospected customer account.
Region (string) --
The specific region of the prospected customer account.
SubRegion (string) --
The subregion classification of the prospected customer account.
Country (string) --
The country code of the prospected customer account.
Industry (string) --
The industry classification of the prospected customer account.
SubIndustry (string) --
The sub-industry classification of the prospected customer account. This provides more granular categorization within the primary industry.
Segment (string) --
The market segment classification of the prospected customer account.
CompanySize (string) --
The company size classification of the prospected customer account.
EligiblePrograms (list) --
A list of AWS Greenfield programs that the prospected customer is eligible for. Use this list to identify relevant go-to-market opportunities.
(string) --
PublicProfileSummary (string) --
A summary of publicly available information about the prospected customer. The system uses this summary to generate customer insights and inform engagement strategies.
Insights (dict) --
Insights that AI generates from the prospecting analysis. These insights include engagement scores and solution fit assessments for the prospected customer.
MarketplaceEngagementScore (string) --
A score that indicates the prospected customer's level of engagement with AWS Marketplace. Valid values are High, Medium, and Low.
SolutionScore (string) --
A score that indicates how well the partner's solution fits the prospected customer's needs.
SolutionCategory (string) --
The primary solution category classification for the prospected customer. This indicates the type of solution that best addresses their needs.
SolutionSubCategory (string) --
The solution sub-category classification for the prospected customer. This provides more granular categorization of the recommended solution type.
StartTime (datetime) --
The timestamp when the prospecting result context was created. The format is ISO 8601 (UTC).
EndTime (datetime) --
The timestamp when the prospecting task completed processing. The format is ISO 8601 (UTC).
TaskId (string) --
The unique identifier of the prospecting task that generates this result.
TaskArn (string) --
The Amazon Resource Name (ARN) of the prospecting task. Use this ARN to track and manage the task within AWS.
TaskName (string) --
The name that the user provides for the prospecting task that generates this result.
dict
Response Syntax
{
'EngagementId': 'string',
'EngagementArn': 'string',
'EngagementLastModifiedAt': datetime(2015, 1, 1),
'ContextId': 'string'
}
Response Structure
(dict) --
Contains the response that the UpdateEngagementContext action returns.
EngagementId (string) --
The unique identifier of the engagement that was updated.
EngagementArn (string) --
The Amazon Resource Name (ARN) of the updated engagement.
EngagementLastModifiedAt (datetime) --
The timestamp when the engagement context was last modified.
ContextId (string) --
The unique identifier of the engagement context that was updated.