AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Partner Central Selling API CreateEngagementContext API operation.

Syntax

New-PCEngagementContext
-Customer_AwsMaturity <String>
-Project_BusinessProblem <String>
-Catalog <String>
-Address_City <String>
-Payload_CustomerProject_Customer_CompanyName <String>
-Lead_Customer_CompanyName <String>
-Customer_CountryCode <CountryCode>
-Address_CountryCode <CountryCode>
-EngagementIdentifier <String>
-Payload_CustomerProject_Customer_Industry <Industry>
-Lead_Customer_Industry <Industry>
-Lead_Interaction <LeadInteraction[]>
-Customer_MarketSegment <MarketSegment>
-Address_PostalCode <String>
-Lead_QualificationStatus <String>
-Address_StateOrRegion <String>
-Project_TargetCompletionDate <String>
-Project_Title <String>
-Type <EngagementContextType>
-Payload_CustomerProject_Customer_WebsiteUrl <String>
-Lead_Customer_WebsiteUrl <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonPartnerCentralSellingConfig>

Description

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.

Parameters

-Address_City <String>
Specifies the end Customer's city associated with the Opportunity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPayload_Lead_Customer_Address_City
-Address_CountryCode <CountryCode>
Specifies the end Customer's country associated with the Opportunity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPayload_Lead_Customer_Address_CountryCode
-Address_PostalCode <String>
Specifies the end Customer's postal code associated with the Opportunity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPayload_Lead_Customer_Address_PostalCode
-Address_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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPayload_Lead_Customer_Address_StateOrRegion
-Catalog <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonPartnerCentralSellingConfig>
Amazon.PowerShell.Cmdlets.PC.AmazonPartnerCentralSellingClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Customer_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPayload_Lead_Customer_AwsMaturity
-Customer_CountryCode <CountryCode>
Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPayload_CustomerProject_Customer_CountryCode
-Customer_MarketSegment <MarketSegment>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPayload_Lead_Customer_MarketSegment
-EngagementIdentifier <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Lead_Customer_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPayload_Lead_Customer_CompanyName
-Lead_Customer_Industry <Industry>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPayload_Lead_Customer_Industry
-Lead_Customer_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPayload_Lead_Customer_WebsiteUrl
-Lead_Interaction <LeadInteraction[]>
An array of interactions that have occurred with the lead, providing a history of communications, meetings, and other engagement activities related to the lead.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPayload_Lead_Interactions
-Lead_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPayload_Lead_QualificationStatus
-Payload_CustomerProject_Customer_CompanyName <String>
Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomer_CompanyName
-Payload_CustomerProject_Customer_Industry <Industry>
Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomer_Industry
-Payload_CustomerProject_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomer_WebsiteUrl
-Project_BusinessProblem <String>
A description of the business problem the project aims to solve.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPayload_CustomerProject_Project_BusinessProblem
-Project_TargetCompletionDate <String>
The target completion date for the customer's project.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPayload_CustomerProject_Project_TargetCompletionDate
-Project_Title <String>
The title of the project.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPayload_CustomerProject_Project_Title
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PartnerCentralSelling.Model.CreateEngagementContextResponse). Specifying the name of a property of type Amazon.PartnerCentralSelling.Model.CreateEngagementContextResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Type <EngagementContextType>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.PartnerCentralSelling.Model.CreateEngagementContextResponse
This cmdlet returns an Amazon.PartnerCentralSelling.Model.CreateEngagementContextResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z