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 ListEngagementInvitations API operation.

Syntax

Get-PCEngagementInvitationList
-NextToken <String>
-Catalog <String>
-EngagementIdentifier <String[]>
-ParticipantType <ParticipantType>
-PayloadType <String[]>
-SenderAwsAccountId <String[]>
-Sort_SortBy <OpportunityEngagementInvitationSortName>
-Sort_SortOrder <SortOrder>
-Status <String[]>
-MaxResult <Int32>
-Select <String>
-PassThru <SwitchParameter>
-ClientConfig <AmazonPartnerCentralSellingConfig>

Description

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.

Parameters

-Catalog <String>
Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing 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)
-EngagementIdentifier <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxResult <Int32>
Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxResults
-NextToken <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.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ParticipantType <ParticipantType>
Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the NextToken parameter. The -PassThru parameter is deprecated, use -Select '^NextToken' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PayloadType <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'EngagementInvitationSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PartnerCentralSelling.Model.ListEngagementInvitationsResponse). Specifying the name of a property of type Amazon.PartnerCentralSelling.Model.ListEngagementInvitationsResponse 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)
-SenderAwsAccountId <String[]>
List of sender AWS account IDs to filter the invitations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Sort_SortBy <OpportunityEngagementInvitationSortName>
Specifies the field by which the Engagement Invitations are sorted. Common values include InvitationDate and Status.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Sort_SortOrder <SortOrder>
Defines the order in which the Engagement Invitations are sorted. The values can be ASC (ascending) or DESC (descending).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Status <String[]>
Status values to filter the invitations.
Required?False
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.EngagementInvitationSummary or Amazon.PartnerCentralSelling.Model.ListEngagementInvitationsResponse
This cmdlet returns a collection of Amazon.PartnerCentralSelling.Model.EngagementInvitationSummary objects. The service call response (type Amazon.PartnerCentralSelling.Model.ListEngagementInvitationsResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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