# Actions


The following actions are supported by Partner Central Selling API:
+  [AcceptEngagementInvitation](API_AcceptEngagementInvitation.md) 
+  [AssignOpportunity](API_AssignOpportunity.md) 
+  [AssociateOpportunity](API_AssociateOpportunity.md) 
+  [CreateEngagement](API_CreateEngagement.md) 
+  [CreateEngagementContext](API_CreateEngagementContext.md) 
+  [CreateEngagementInvitation](API_CreateEngagementInvitation.md) 
+  [CreateOpportunity](API_CreateOpportunity.md) 
+  [CreateResourceSnapshot](API_CreateResourceSnapshot.md) 
+  [CreateResourceSnapshotJob](API_CreateResourceSnapshotJob.md) 
+  [DeleteResourceSnapshotJob](API_DeleteResourceSnapshotJob.md) 
+  [DisassociateOpportunity](API_DisassociateOpportunity.md) 
+  [GetAwsOpportunitySummary](API_GetAwsOpportunitySummary.md) 
+  [GetEngagement](API_GetEngagement.md) 
+  [GetEngagementInvitation](API_GetEngagementInvitation.md) 
+  [GetOpportunity](API_GetOpportunity.md) 
+  [GetResourceSnapshot](API_GetResourceSnapshot.md) 
+  [GetResourceSnapshotJob](API_GetResourceSnapshotJob.md) 
+  [GetSellingSystemSettings](API_GetSellingSystemSettings.md) 
+  [ListEngagementByAcceptingInvitationTasks](API_ListEngagementByAcceptingInvitationTasks.md) 
+  [ListEngagementFromOpportunityTasks](API_ListEngagementFromOpportunityTasks.md) 
+  [ListEngagementInvitations](API_ListEngagementInvitations.md) 
+  [ListEngagementMembers](API_ListEngagementMembers.md) 
+  [ListEngagementResourceAssociations](API_ListEngagementResourceAssociations.md) 
+  [ListEngagements](API_ListEngagements.md) 
+  [ListOpportunities](API_ListOpportunities.md) 
+  [ListOpportunityFromEngagementTasks](API_ListOpportunityFromEngagementTasks.md) 
+  [ListResourceSnapshotJobs](API_ListResourceSnapshotJobs.md) 
+  [ListResourceSnapshots](API_ListResourceSnapshots.md) 
+  [ListSolutions](API_ListSolutions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [PutSellingSystemSettings](API_PutSellingSystemSettings.md) 
+  [RejectEngagementInvitation](API_RejectEngagementInvitation.md) 
+  [StartEngagementByAcceptingInvitationTask](API_StartEngagementByAcceptingInvitationTask.md) 
+  [StartEngagementFromOpportunityTask](API_StartEngagementFromOpportunityTask.md) 
+  [StartOpportunityFromEngagementTask](API_StartOpportunityFromEngagementTask.md) 
+  [StartResourceSnapshotJob](API_StartResourceSnapshotJob.md) 
+  [StopResourceSnapshotJob](API_StopResourceSnapshotJob.md) 
+  [SubmitOpportunity](API_SubmitOpportunity.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateEngagementContext](API_UpdateEngagementContext.md) 
+  [UpdateOpportunity](API_UpdateOpportunity.md) 

The following actions are supported by Partner Central Account API:
+  [AcceptConnectionInvitation](API_account_AcceptConnectionInvitation.md) 
+  [AssociateAwsTrainingCertificationEmailDomain](API_account_AssociateAwsTrainingCertificationEmailDomain.md) 
+  [CancelConnection](API_account_CancelConnection.md) 
+  [CancelConnectionInvitation](API_account_CancelConnectionInvitation.md) 
+  [CancelProfileUpdateTask](API_account_CancelProfileUpdateTask.md) 
+  [CreateConnectionInvitation](API_account_CreateConnectionInvitation.md) 
+  [CreatePartner](API_account_CreatePartner.md) 
+  [DisassociateAwsTrainingCertificationEmailDomain](API_account_DisassociateAwsTrainingCertificationEmailDomain.md) 
+  [GetAllianceLeadContact](API_account_GetAllianceLeadContact.md) 
+  [GetConnection](API_account_GetConnection.md) 
+  [GetConnectionInvitation](API_account_GetConnectionInvitation.md) 
+  [GetConnectionPreferences](API_account_GetConnectionPreferences.md) 
+  [GetPartner](API_account_GetPartner.md) 
+  [GetProfileUpdateTask](API_account_GetProfileUpdateTask.md) 
+  [GetProfileVisibility](API_account_GetProfileVisibility.md) 
+  [GetVerification](API_account_GetVerification.md) 
+  [ListConnectionInvitations](API_account_ListConnectionInvitations.md) 
+  [ListConnections](API_account_ListConnections.md) 
+  [ListPartners](API_account_ListPartners.md) 
+  [ListTagsForResource](API_account_ListTagsForResource.md) 
+  [PutAllianceLeadContact](API_account_PutAllianceLeadContact.md) 
+  [PutProfileVisibility](API_account_PutProfileVisibility.md) 
+  [RejectConnectionInvitation](API_account_RejectConnectionInvitation.md) 
+  [SendEmailVerificationCode](API_account_SendEmailVerificationCode.md) 
+  [StartProfileUpdateTask](API_account_StartProfileUpdateTask.md) 
+  [StartVerification](API_account_StartVerification.md) 
+  [TagResource](API_account_TagResource.md) 
+  [UntagResource](API_account_UntagResource.md) 
+  [UpdateConnectionPreferences](API_account_UpdateConnectionPreferences.md) 

The following actions are supported by Partner Central Benefits API:
+  [AmendBenefitApplication](API_benefits_AmendBenefitApplication.md) 
+  [AssociateBenefitApplicationResource](API_benefits_AssociateBenefitApplicationResource.md) 
+  [CancelBenefitApplication](API_benefits_CancelBenefitApplication.md) 
+  [CreateBenefitApplication](API_benefits_CreateBenefitApplication.md) 
+  [DisassociateBenefitApplicationResource](API_benefits_DisassociateBenefitApplicationResource.md) 
+  [GetBenefit](API_benefits_GetBenefit.md) 
+  [GetBenefitAllocation](API_benefits_GetBenefitAllocation.md) 
+  [GetBenefitApplication](API_benefits_GetBenefitApplication.md) 
+  [ListBenefitAllocations](API_benefits_ListBenefitAllocations.md) 
+  [ListBenefitApplications](API_benefits_ListBenefitApplications.md) 
+  [ListBenefits](API_benefits_ListBenefits.md) 
+  [ListTagsForResource](API_benefits_ListTagsForResource.md) 
+  [RecallBenefitApplication](API_benefits_RecallBenefitApplication.md) 
+  [SubmitBenefitApplication](API_benefits_SubmitBenefitApplication.md) 
+  [TagResource](API_benefits_TagResource.md) 
+  [UntagResource](API_benefits_UntagResource.md) 
+  [UpdateBenefitApplication](API_benefits_UpdateBenefitApplication.md) 

The following actions are supported by Partner Central Channel API:
+  [AcceptChannelHandshake](API_channel_AcceptChannelHandshake.md) 
+  [CancelChannelHandshake](API_channel_CancelChannelHandshake.md) 
+  [CreateChannelHandshake](API_channel_CreateChannelHandshake.md) 
+  [CreateProgramManagementAccount](API_channel_CreateProgramManagementAccount.md) 
+  [CreateRelationship](API_channel_CreateRelationship.md) 
+  [DeleteProgramManagementAccount](API_channel_DeleteProgramManagementAccount.md) 
+  [DeleteRelationship](API_channel_DeleteRelationship.md) 
+  [GetRelationship](API_channel_GetRelationship.md) 
+  [ListChannelHandshakes](API_channel_ListChannelHandshakes.md) 
+  [ListProgramManagementAccounts](API_channel_ListProgramManagementAccounts.md) 
+  [ListRelationships](API_channel_ListRelationships.md) 
+  [ListTagsForResource](API_channel_ListTagsForResource.md) 
+  [RejectChannelHandshake](API_channel_RejectChannelHandshake.md) 
+  [TagResource](API_channel_TagResource.md) 
+  [UntagResource](API_channel_UntagResource.md) 
+  [UpdateProgramManagementAccount](API_channel_UpdateProgramManagementAccount.md) 
+  [UpdateRelationship](API_channel_UpdateRelationship.md) 

# Partner Central Selling API


The following actions are supported by Partner Central Selling API:
+  [AcceptEngagementInvitation](API_AcceptEngagementInvitation.md) 
+  [AssignOpportunity](API_AssignOpportunity.md) 
+  [AssociateOpportunity](API_AssociateOpportunity.md) 
+  [CreateEngagement](API_CreateEngagement.md) 
+  [CreateEngagementContext](API_CreateEngagementContext.md) 
+  [CreateEngagementInvitation](API_CreateEngagementInvitation.md) 
+  [CreateOpportunity](API_CreateOpportunity.md) 
+  [CreateResourceSnapshot](API_CreateResourceSnapshot.md) 
+  [CreateResourceSnapshotJob](API_CreateResourceSnapshotJob.md) 
+  [DeleteResourceSnapshotJob](API_DeleteResourceSnapshotJob.md) 
+  [DisassociateOpportunity](API_DisassociateOpportunity.md) 
+  [GetAwsOpportunitySummary](API_GetAwsOpportunitySummary.md) 
+  [GetEngagement](API_GetEngagement.md) 
+  [GetEngagementInvitation](API_GetEngagementInvitation.md) 
+  [GetOpportunity](API_GetOpportunity.md) 
+  [GetResourceSnapshot](API_GetResourceSnapshot.md) 
+  [GetResourceSnapshotJob](API_GetResourceSnapshotJob.md) 
+  [GetSellingSystemSettings](API_GetSellingSystemSettings.md) 
+  [ListEngagementByAcceptingInvitationTasks](API_ListEngagementByAcceptingInvitationTasks.md) 
+  [ListEngagementFromOpportunityTasks](API_ListEngagementFromOpportunityTasks.md) 
+  [ListEngagementInvitations](API_ListEngagementInvitations.md) 
+  [ListEngagementMembers](API_ListEngagementMembers.md) 
+  [ListEngagementResourceAssociations](API_ListEngagementResourceAssociations.md) 
+  [ListEngagements](API_ListEngagements.md) 
+  [ListOpportunities](API_ListOpportunities.md) 
+  [ListOpportunityFromEngagementTasks](API_ListOpportunityFromEngagementTasks.md) 
+  [ListResourceSnapshotJobs](API_ListResourceSnapshotJobs.md) 
+  [ListResourceSnapshots](API_ListResourceSnapshots.md) 
+  [ListSolutions](API_ListSolutions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [PutSellingSystemSettings](API_PutSellingSystemSettings.md) 
+  [RejectEngagementInvitation](API_RejectEngagementInvitation.md) 
+  [StartEngagementByAcceptingInvitationTask](API_StartEngagementByAcceptingInvitationTask.md) 
+  [StartEngagementFromOpportunityTask](API_StartEngagementFromOpportunityTask.md) 
+  [StartOpportunityFromEngagementTask](API_StartOpportunityFromEngagementTask.md) 
+  [StartResourceSnapshotJob](API_StartResourceSnapshotJob.md) 
+  [StopResourceSnapshotJob](API_StopResourceSnapshotJob.md) 
+  [SubmitOpportunity](API_SubmitOpportunity.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateEngagementContext](API_UpdateEngagementContext.md) 
+  [UpdateOpportunity](API_UpdateOpportunity.md) 

# AcceptEngagementInvitation


Use the `AcceptEngagementInvitation` action to accept an engagement invitation shared by AWS. Accepting the invitation indicates your willingness to participate in the engagement, granting you access to all engagement-related data.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_AcceptEngagementInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-AcceptEngagementInvitation-request-Catalog"></a>
The `CatalogType` parameter specifies the catalog associated with the engagement invitation. Accepted values are `AWS` and `Sandbox`, which determine the environment in which the engagement invitation is managed.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [Identifier](#API_AcceptEngagementInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-AcceptEngagementInvitation-request-Identifier"></a>
 The `Identifier` parameter in the `AcceptEngagementInvitationRequest` specifies the unique identifier of the `EngagementInvitation` to be accepted. Providing the correct identifier ensures that the intended invitation is accepted.   
Type: String  
Pattern: `(?=.{1,255}$)(arn:.*|engi-[0-9a-z]{13})`   
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/AcceptEngagementInvitation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/AcceptEngagementInvitation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/AcceptEngagementInvitation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/AcceptEngagementInvitation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/AcceptEngagementInvitation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/AcceptEngagementInvitation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/AcceptEngagementInvitation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/AcceptEngagementInvitation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/AcceptEngagementInvitation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/AcceptEngagementInvitation) 

# AssignOpportunity


Enables you to reassign an existing `Opportunity` to another user within your Partner Central account. The specified user receives the opportunity, and it appears on their Partner Central dashboard, allowing them to take necessary actions or proceed with the opportunity.

This is useful for distributing opportunities to the appropriate team members or departments within your organization, ensuring that each opportunity is handled by the right person. By default, the opportunity owner is the one who creates it. Currently, there's no API to enumerate the list of available users.

## Request Syntax


```
{
   "Assignee": { 
      "BusinessTitle": "string",
      "Email": "string",
      "FirstName": "string",
      "LastName": "string",
      "Phone": "string"
   },
   "Catalog": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Assignee](#API_AssignOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-AssignOpportunity-request-Assignee"></a>
Specifies the user or team member responsible for managing the assigned opportunity. This field identifies the *Assignee* based on the partner's internal team structure. Ensure that the email address is associated with a registered user in your Partner Central account.  
Type: [AssigneeContact](API_AssigneeContact.md) object  
Required: Yes

 ** [Catalog](#API_AssignOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-AssignOpportunity-request-Catalog"></a>
Specifies the catalog associated with the request. This field takes a string value from a predefined list: `AWS` or `Sandbox`. The catalog determines which environment the opportunity is assigned in. Use `AWS` to assign real opportunities in the AWS catalog, and `Sandbox` for testing in secure, isolated environments.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [Identifier](#API_AssignOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-AssignOpportunity-request-Identifier"></a>
Requires the `Opportunity`'s unique identifier when you want to assign it to another user. Provide the correct identifier so the intended opportunity is reassigned.  
Type: String  
Pattern: `O[0-9]{1,19}`   
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/AssignOpportunity) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/AssignOpportunity) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/AssignOpportunity) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/AssignOpportunity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/AssignOpportunity) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/AssignOpportunity) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/AssignOpportunity) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/AssignOpportunity) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/AssignOpportunity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/AssignOpportunity) 

# AssociateOpportunity


Enables you to create a formal association between an `Opportunity` and various related entities, enriching the context and details of the opportunity for better collaboration and decision making. You can associate an opportunity with the following entity types:
+ Partner Solution: A software product or consulting practice created and delivered by AWS Partners. Partner Solutions help customers address business challenges using AWS services.
+  AWS Products: AWS offers many products and services that provide scalable, reliable, and cost-effective infrastructure solutions. For the latest list of AWS products, see [AWS products](https://github.com/aws-samples/partner-crm-integration-samples/blob/main/resources/aws_products.json).
+  AWS Marketplace private offer: Allows AWS Marketplace sellers to extend custom pricing and terms to individual AWS customers. Sellers can negotiate custom prices, payment schedules, and end user license terms through private offers, enabling AWS customers to acquire software solutions tailored to their specific needs. For more information, see [Private offers in AWS Marketplace](https://docs.aws.amazon.com/marketplace/latest/buyerguide/buyer-private-offers.html).

To obtain identifiers for these entities, use the following methods:
+ Solution: Use the `ListSolutions` operation.
+ AWS Products: For the latest list of AWS products, see [AWS products](https://github.com/aws-samples/partner-crm-integration-samples/blob/main/resources/aws_products.json).
+  AWS Marketplace private offer: Use the [Using the AWS Marketplace Catalog API](https://docs.aws.amazon.com/marketplace/latest/APIReference/catalog-apis.html) to list entities. Specifically, use the `ListEntities` operation to retrieve a list of private offers. The request returns the details of available private offers. For more information, see [ListEntities](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_ListEntities.html).

## Request Syntax


```
{
   "Catalog": "string",
   "OpportunityIdentifier": "string",
   "RelatedEntityIdentifier": "string",
   "RelatedEntityType": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_AssociateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-AssociateOpportunity-request-Catalog"></a>
Specifies the catalog associated with the request. This field takes a string value from a predefined list: `AWS` or `Sandbox`. The catalog determines which environment the opportunity association is made in. Use `AWS` to associate opportunities in the AWS catalog, and `Sandbox` for testing in secure, isolated environments.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [OpportunityIdentifier](#API_AssociateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-AssociateOpportunity-request-OpportunityIdentifier"></a>
Requires the `Opportunity`'s unique identifier when you want to associate it with a related entity. Provide the correct identifier so the intended opportunity is updated with the association.  
Type: String  
Pattern: `O[0-9]{1,19}`   
Required: Yes

 ** [RelatedEntityIdentifier](#API_AssociateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-AssociateOpportunity-request-RelatedEntityIdentifier"></a>
Requires the related entity's unique identifier when you want to associate it with the ` Opportunity`. For AWS Marketplace entities, provide the Amazon Resource Name (ARN). Use the [AWS Marketplace API](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html) to obtain the ARN.  
Type: String  
Pattern: `(?s).{1,255}`   
Required: Yes

 ** [RelatedEntityType](#API_AssociateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-AssociateOpportunity-request-RelatedEntityType"></a>
Specifies the entity type that you're associating with the ` Opportunity`. This helps to categorize and properly process the association.  
Type: String  
Valid Values: `Solutions | AwsProducts | AwsMarketplaceOffers | AwsMarketplaceOfferSets`   
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/AssociateOpportunity) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/AssociateOpportunity) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/AssociateOpportunity) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/AssociateOpportunity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/AssociateOpportunity) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/AssociateOpportunity) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/AssociateOpportunity) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/AssociateOpportunity) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/AssociateOpportunity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/AssociateOpportunity) 

# CreateEngagement


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`.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "Contexts": [ 
      { 
         "Id": "string",
         "Payload": { ... },
         "Type": "string"
      }
   ],
   "Description": "string",
   "Title": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_CreateEngagement_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagement-request-Catalog"></a>
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.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ClientToken](#API_CreateEngagement_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagement-request-ClientToken"></a>
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.  
Type: String  
Pattern: `.{1,255}`   
Required: Yes

 ** [Description](#API_CreateEngagement_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagement-request-Description"></a>
Provides a description of the `Engagement`.  
Type: String  
Pattern: `(?s).{0,255}`   
Required: Yes

 ** [Title](#API_CreateEngagement_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagement-request-Title"></a>
Specifies the title of the `Engagement`.  
Type: String  
Pattern: `(?s).{1,40}`   
Required: Yes

 ** [Contexts](#API_CreateEngagement_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagement-request-Contexts"></a>
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.  
Type: Array of [EngagementContextDetails](API_EngagementContextDetails.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

## Response Syntax


```
{
   "Arn": "string",
   "Id": "string",
   "ModifiedAt": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreateEngagement_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateEngagement-response-Arn"></a>
The Amazon Resource Name (ARN) that identifies the engagement.  
Type: String  
Pattern: `arn:.*` 

 ** [Id](#API_CreateEngagement_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateEngagement-response-Id"></a>
Unique identifier assigned to the newly created engagement.  
Type: String  
Pattern: `eng-[0-9a-z]{14}` 

 ** [ModifiedAt](#API_CreateEngagement_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateEngagement-response-ModifiedAt"></a>
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".  
Type: Timestamp

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.  
Suggested action: Review the [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) for the resource, and either reduce usage or request a quota increase.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/CreateEngagement) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/CreateEngagement) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/CreateEngagement) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/CreateEngagement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/CreateEngagement) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/CreateEngagement) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/CreateEngagement) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/CreateEngagement) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/CreateEngagement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/CreateEngagement) 

# CreateEngagementContext


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.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "EngagementIdentifier": "string",
   "Payload": { ... },
   "Type": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_CreateEngagementContext_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagementContext-request-Catalog"></a>
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.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ClientToken](#API_CreateEngagementContext_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagementContext-request-ClientToken"></a>
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.  
Type: String  
Pattern: `.{1,255}`   
Required: Yes

 ** [EngagementIdentifier](#API_CreateEngagementContext_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagementContext-request-EngagementIdentifier"></a>
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.  
Type: String  
Pattern: `(arn:.*|eng-[0-9a-z]{14})`   
Required: Yes

 ** [Payload](#API_CreateEngagementContext_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagementContext-request-Payload"></a>
Represents the payload of an Engagement context. The structure of this payload varies based on the context type specified in the EngagementContextDetails.   
Type: [EngagementContextPayload](API_EngagementContextPayload.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [Type](#API_CreateEngagementContext_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagementContext-request-Type"></a>
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.  
Type: String  
Valid Values: `CustomerProject | Lead`   
Required: Yes

## Response Syntax


```
{
   "ContextId": "string",
   "EngagementArn": "string",
   "EngagementId": "string",
   "EngagementLastModifiedAt": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContextId](#API_CreateEngagementContext_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateEngagementContext-response-ContextId"></a>
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.  
Type: String  
Pattern: `(?s).{1,3}` 

 ** [EngagementArn](#API_CreateEngagementContext_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateEngagementContext-response-EngagementArn"></a>
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.  
Type: String  
Pattern: `arn:.*` 

 ** [EngagementId](#API_CreateEngagementContext_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateEngagementContext-response-EngagementId"></a>
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.  
Type: String  
Pattern: `eng-[0-9a-z]{14}` 

 ** [EngagementLastModifiedAt](#API_CreateEngagementContext_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateEngagementContext-response-EngagementLastModifiedAt"></a>
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".  
Type: Timestamp

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.  
Suggested action: Review the [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) for the resource, and either reduce usage or request a quota increase.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/CreateEngagementContext) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/CreateEngagementContext) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/CreateEngagementContext) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/CreateEngagementContext) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/CreateEngagementContext) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/CreateEngagementContext) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/CreateEngagementContext) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/CreateEngagementContext) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/CreateEngagementContext) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/CreateEngagementContext) 

# CreateEngagementInvitation


 This action creates an invitation from a sender to a single receiver to join an engagement. 

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "EngagementIdentifier": "string",
   "Invitation": { 
      "Message": "string",
      "Payload": { ... },
      "Receiver": { ... }
   }
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_CreateEngagementInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagementInvitation-request-Catalog"></a>
 Specifies the catalog related to the engagement. Accepted values are `AWS` and `Sandbox`, which determine the environment in which the engagement is managed.   
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ClientToken](#API_CreateEngagementInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagementInvitation-request-ClientToken"></a>
 Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.   
Type: String  
Pattern: `.{1,255}`   
Required: Yes

 ** [EngagementIdentifier](#API_CreateEngagementInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagementInvitation-request-EngagementIdentifier"></a>
 The unique identifier of the `Engagement` associated with the invitation. This parameter ensures the invitation is created within the correct `Engagement` context.   
Type: String  
Pattern: `eng-[0-9a-z]{14}`   
Required: Yes

 ** [Invitation](#API_CreateEngagementInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagementInvitation-request-Invitation"></a>
 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.   
Type: [Invitation](API_Invitation.md) object  
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Id": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreateEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateEngagementInvitation-response-Arn"></a>
 The Amazon Resource Name (ARN) that uniquely identifies the engagement invitation.   
Type: String  
Pattern: `arn:aws:partnercentral::[0-9]{12}:[a-zA-Z]+/engagement-invitation/engi-[0-9,a-z]{13}` 

 ** [Id](#API_CreateEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateEngagementInvitation-response-Id"></a>
 Unique identifier assigned to the newly created engagement invitation.   
Type: String  
Pattern: `engi-[0-9,a-z]{13}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.  
Suggested action: Review the [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) for the resource, and either reduce usage or request a quota increase.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 

# CreateOpportunity


Creates an `Opportunity` record in Partner Central. Use this operation to create a potential business opportunity for submission to AWS. Creating an opportunity sets `Lifecycle.ReviewStatus` to `Pending Submission`.

To submit an opportunity, follow these steps:

1. To create the opportunity, use `CreateOpportunity`.

1. To associate a solution with the opportunity, use `AssociateOpportunity`.

1. To start the engagement with AWS, use `StartEngagementFromOpportunity`.

After submission, you can't edit the opportunity until the review is complete. But opportunities in the `Pending Submission` state must have complete details. You can update the opportunity while it's in the `Pending Submission` state.

There's a set of mandatory fields to create opportunities, but consider providing optional fields to enrich the opportunity record.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "Customer": { 
      "Account": { 
         "Address": { 
            "City": "string",
            "CountryCode": "string",
            "PostalCode": "string",
            "StateOrRegion": "string",
            "StreetAddress": "string"
         },
         "AwsAccountId": "string",
         "CompanyName": "string",
         "Duns": "string",
         "Industry": "string",
         "OtherIndustry": "string",
         "WebsiteUrl": "string"
      },
      "Contacts": [ 
         { 
            "BusinessTitle": "string",
            "Email": "string",
            "FirstName": "string",
            "LastName": "string",
            "Phone": "string"
         }
      ]
   },
   "LifeCycle": { 
      "ClosedLostReason": "string",
      "NextSteps": "string",
      "NextStepsHistory": [ 
         { 
            "Time": "string",
            "Value": "string"
         }
      ],
      "ReviewComments": "string",
      "ReviewStatus": "string",
      "ReviewStatusReason": "string",
      "Stage": "string",
      "TargetCloseDate": "string"
   },
   "Marketing": { 
      "AwsFundingUsed": "string",
      "CampaignName": "string",
      "Channels": [ "string" ],
      "Source": "string",
      "UseCases": [ "string" ]
   },
   "NationalSecurity": "string",
   "OpportunityTeam": [ 
      { 
         "BusinessTitle": "string",
         "Email": "string",
         "FirstName": "string",
         "LastName": "string",
         "Phone": "string"
      }
   ],
   "OpportunityType": "string",
   "Origin": "string",
   "PartnerOpportunityIdentifier": "string",
   "PrimaryNeedsFromAws": [ "string" ],
   "Project": { 
      "AdditionalComments": "string",
      "ApnPrograms": [ "string" ],
      "AwsPartition": "string",
      "CompetitorName": "string",
      "CustomerBusinessProblem": "string",
      "CustomerUseCase": "string",
      "DeliveryModels": [ "string" ],
      "ExpectedCustomerSpend": [ 
         { 
            "Amount": "string",
            "CurrencyCode": "string",
            "EstimationUrl": "string",
            "Frequency": "string",
            "TargetCompany": "string"
         }
      ],
      "OtherCompetitorNames": "string",
      "OtherSolutionDescription": "string",
      "RelatedOpportunityIdentifier": "string",
      "SalesActivities": [ "string" ],
      "Title": "string"
   },
   "SoftwareRevenue": { 
      "DeliveryModel": "string",
      "EffectiveDate": "string",
      "ExpirationDate": "string",
      "Value": { 
         "Amount": "string",
         "CurrencyCode": "string"
      }
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_CreateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-request-Catalog"></a>
Specifies the catalog associated with the request. This field takes a string value from a predefined list: `AWS` or `Sandbox`. The catalog determines which environment the opportunity is created in. Use `AWS` to create opportunities in the AWS catalog, and `Sandbox` for testing in secure, isolated environments.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ClientToken](#API_CreateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-request-ClientToken"></a>
Required to be unique, and should be unchanging, it can be randomly generated or a meaningful string.  
Default: None  
Best practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique Identifier (UUID) as the `ClientToken`. You can use standard libraries from most programming languages to generate this. If you use the same client token, the API returns the following error: "Conflicting client token submitted for a new request body."  
Type: String  
Pattern: `.{1,255}`   
Required: Yes

 ** [Customer](#API_CreateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-request-Customer"></a>
Specifies customer details associated with the `Opportunity`.  
Type: [Customer](API_Customer.md) object  
Required: No

 ** [LifeCycle](#API_CreateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-request-LifeCycle"></a>
An object that contains lifecycle details for the `Opportunity`.  
Type: [LifeCycle](API_LifeCycle.md) object  
Required: No

 ** [Marketing](#API_CreateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-request-Marketing"></a>
This object contains marketing details and is optional for an opportunity.  
Type: [Marketing](API_Marketing.md) object  
Required: No

 ** [NationalSecurity](#API_CreateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-request-NationalSecurity"></a>
Indicates whether the `Opportunity` pertains to a national security project. This field must be set to `true` only when the customer's industry is *Government*. Additional privacy and security measures apply during the review and management process for opportunities marked as `NationalSecurity`.  
Type: String  
Valid Values: `Yes | No`   
Required: No

 ** [OpportunityTeam](#API_CreateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-request-OpportunityTeam"></a>
Represents the internal team handling the opportunity. Specify collaborating members of this opportunity who are within the partner's organization.  
Type: Array of [Contact](API_Contact.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [OpportunityType](#API_CreateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-request-OpportunityType"></a>
Specifies the opportunity type as a renewal, new, or expansion.  
Opportunity types:  
+ New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.
+ Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.
+ Expansion opportunity: Represents 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.
Type: String  
Valid Values: `Net New Business | Flat Renewal | Expansion`   
Required: No

 ** [Origin](#API_CreateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-request-Origin"></a>
Specifies the origin of the opportunity, indicating if it was sourced from AWS or the partner. For all opportunities created with `Catalog: AWS`, this field must only be `Partner Referral`. However, when using `Catalog: Sandbox`, you can set this field to `AWS Referral` to simulate AWS referral creation. This allows AWS-originated flows testing in the sandbox catalog.  
Type: String  
Valid Values: `AWS Referral | Partner Referral`   
Required: No

 ** [PartnerOpportunityIdentifier](#API_CreateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-request-PartnerOpportunityIdentifier"></a>
Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload to the partner.  
This field allows partners to link an opportunity to their CRM, which helps to ensure seamless integration and accurate synchronization between the Partner Central API and the partner's internal systems.  
Type: String  
Pattern: `(?s).{0,64}`   
Required: No

 ** [PrimaryNeedsFromAws](#API_CreateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-request-PrimaryNeedsFromAws"></a>
Identifies the type of support the partner needs from AWS.  
Valid values:  
+ Cosell—Architectural Validation: Confirmation from AWS that the partner's proposed solution architecture is aligned with AWS best practices and poses minimal architectural risks.
+ Cosell—Business Presentation: Request AWS seller's participation in a joint customer presentation.
+ Cosell—Competitive Information: Access to AWS competitive resources and support for the partner's proposed solution.
+ Cosell—Pricing Assistance: Connect with an AWS seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).
+ Cosell—Technical Consultation: Connect with an AWS Solutions Architect to address the partner's questions about the proposed solution.
+ Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on AWS versus on-premises or a traditional hosting environment.
+ Cosell—Deal Support: Request AWS seller's support to progress the opportunity (for example: joint customer call, strategic positioning).
+ Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs AWS RFx support.
Type: Array of strings  
Valid Values: `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`   
Required: No

 ** [Project](#API_CreateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-request-Project"></a>
An object that contains project details for the `Opportunity`.  
Type: [Project](API_Project.md) object  
Required: No

 ** [SoftwareRevenue](#API_CreateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-request-SoftwareRevenue"></a>
Specifies details of a customer's procurement terms. This is required only for partners in eligible programs.  
Type: [SoftwareRevenue](API_SoftwareRevenue.md) object  
Required: No

 ** [Tags](#API_CreateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-request-Tags"></a>
A map of the key-value pairs of the tag or tags to assign.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: No

## Response Syntax


```
{
   "Id": "string",
   "LastModifiedDate": "string",
   "PartnerOpportunityIdentifier": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Id](#API_CreateOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-response-Id"></a>
Read-only, system-generated `Opportunity` unique identifier. AWS creates this identifier, and it's used for all subsequent opportunity actions, such as updates, associations, and submissions. It helps to ensure that each opportunity is accurately tracked and managed.  
Type: String  
Pattern: `O[0-9]{1,19}` 

 ** [LastModifiedDate](#API_CreateOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-response-LastModifiedDate"></a>
 `DateTime` when the opportunity was last modified. When the `Opportunity` is created, its value is `CreatedDate`.  
Type: Timestamp

 ** [PartnerOpportunityIdentifier](#API_CreateOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateOpportunity-response-PartnerOpportunityIdentifier"></a>
Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/CreateOpportunity) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/CreateOpportunity) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/CreateOpportunity) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/CreateOpportunity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/CreateOpportunity) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/CreateOpportunity) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/CreateOpportunity) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/CreateOpportunity) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/CreateOpportunity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/CreateOpportunity) 

# CreateResourceSnapshot


 This action allows you to create an immutable snapshot of a specific resource, such as an opportunity, within the context of an engagement. The snapshot captures a subset of the resource's data based on the schema defined by the provided template.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "EngagementIdentifier": "string",
   "ResourceIdentifier": "string",
   "ResourceSnapshotTemplateIdentifier": "string",
   "ResourceType": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_CreateResourceSnapshot_RequestSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshot-request-Catalog"></a>
 Specifies the catalog where the snapshot is created. Valid values are `AWS` and `Sandbox`.   
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ClientToken](#API_CreateResourceSnapshot_RequestSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshot-request-ClientToken"></a>
 Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot creations.   
Type: String  
Pattern: `.{1,255}`   
Required: Yes

 ** [EngagementIdentifier](#API_CreateResourceSnapshot_RequestSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshot-request-EngagementIdentifier"></a>
 The unique identifier of the engagement associated with this snapshot. This field links the snapshot to a specific engagement context.   
Type: String  
Pattern: `eng-[0-9a-z]{14}`   
Required: Yes

 ** [ResourceIdentifier](#API_CreateResourceSnapshot_RequestSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshot-request-ResourceIdentifier"></a>
 The unique identifier of the specific resource to be snapshotted. The format and constraints of this identifier depend on the `ResourceType` specified. For example: For `Opportunity` type, it will be an opportunity ID.   
Type: String  
Pattern: `O[0-9]{1,19}`   
Required: Yes

 ** [ResourceSnapshotTemplateIdentifier](#API_CreateResourceSnapshot_RequestSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshot-request-ResourceSnapshotTemplateIdentifier"></a>
 The name of the template that defines the schema for the snapshot. This template determines which subset of the resource data will be included in the snapshot. Must correspond to an existing and valid template for the specified `ResourceType`.   
Type: String  
Pattern: `[a-zA-Z0-9]{3,80}`   
Required: Yes

 ** [ResourceType](#API_CreateResourceSnapshot_RequestSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshot-request-ResourceType"></a>
 Specifies the type of resource for which the snapshot is being created. This field determines the structure and content of the snapshot. Must be one of the supported resource types, such as: `Opportunity`.   
Type: String  
Valid Values: `Opportunity`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Revision": number
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreateResourceSnapshot_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshot-response-Arn"></a>
 Specifies the Amazon Resource Name (ARN) that uniquely identifies the snapshot created.   
Type: String  
Pattern: `arn:.*` 

 ** [Revision](#API_CreateResourceSnapshot_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshot-response-Revision"></a>
 Specifies the revision number of the created snapshot. This field provides important information about the snapshot's place in the sequence of snapshots for the given resource.   
Type: Integer  
Valid Range: Minimum value of 1.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.  
Suggested action: Review the [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) for the resource, and either reduce usage or request a quota increase.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/CreateResourceSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/CreateResourceSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/CreateResourceSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/CreateResourceSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/CreateResourceSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/CreateResourceSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/CreateResourceSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/CreateResourceSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/CreateResourceSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/CreateResourceSnapshot) 

# CreateResourceSnapshotJob


Use this action to create a job to generate a snapshot of the specified resource within an engagement. It initiates an asynchronous process to create a resource snapshot. The job creates a new snapshot only if the resource state has changed, adhering to the same access control and immutability rules as direct snapshot creation.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "EngagementIdentifier": "string",
   "ResourceIdentifier": "string",
   "ResourceSnapshotTemplateIdentifier": "string",
   "ResourceType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_CreateResourceSnapshotJob_RequestSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshotJob-request-Catalog"></a>
Specifies the catalog in which to create the snapshot job. Valid values are `AWS` and ` Sandbox`.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ClientToken](#API_CreateResourceSnapshotJob_RequestSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshotJob-request-ClientToken"></a>
A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.  
Type: String  
Pattern: `.{1,255}`   
Required: Yes

 ** [EngagementIdentifier](#API_CreateResourceSnapshotJob_RequestSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshotJob-request-EngagementIdentifier"></a>
Specifies the identifier of the engagement associated with the resource to be snapshotted.  
Type: String  
Pattern: `eng-[0-9a-z]{14}`   
Required: Yes

 ** [ResourceIdentifier](#API_CreateResourceSnapshotJob_RequestSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshotJob-request-ResourceIdentifier"></a>
Specifies the identifier of the specific resource to be snapshotted. The format depends on the ` ResourceType`.  
Type: String  
Pattern: `O[0-9]{1,19}`   
Required: Yes

 ** [ResourceSnapshotTemplateIdentifier](#API_CreateResourceSnapshotJob_RequestSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshotJob-request-ResourceSnapshotTemplateIdentifier"></a>
Specifies the name of the template that defines the schema for the snapshot.  
Type: String  
Pattern: `[a-zA-Z0-9]{3,80}`   
Required: Yes

 ** [ResourceType](#API_CreateResourceSnapshotJob_RequestSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshotJob-request-ResourceType"></a>
The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. `Opportunity`   
Type: String  
Valid Values: `Opportunity`   
Required: Yes

 ** [Tags](#API_CreateResourceSnapshotJob_RequestSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshotJob-request-Tags"></a>
A map of the key-value pairs of the tag or tags to assign.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: No

## Response Syntax


```
{
   "Arn": "string",
   "Id": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreateResourceSnapshotJob_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshotJob-response-Arn"></a>
The Amazon Resource Name (ARN) of the created snapshot job.  
Type: String  
Pattern: `arn:.*` 

 ** [Id](#API_CreateResourceSnapshotJob_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateResourceSnapshotJob-response-Id"></a>
The unique identifier for the created snapshot job.  
Type: String  
Pattern: `job-[0-9a-z]{13}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.  
Suggested action: Review the [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) for the resource, and either reduce usage or request a quota increase.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/CreateResourceSnapshotJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/CreateResourceSnapshotJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/CreateResourceSnapshotJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/CreateResourceSnapshotJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/CreateResourceSnapshotJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/CreateResourceSnapshotJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/CreateResourceSnapshotJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/CreateResourceSnapshotJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/CreateResourceSnapshotJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/CreateResourceSnapshotJob) 

# DeleteResourceSnapshotJob


 Use this action to deletes a previously created resource snapshot job. The job must be in a stopped state before it can be deleted. 

## Request Syntax


```
{
   "Catalog": "string",
   "ResourceSnapshotJobIdentifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_DeleteResourceSnapshotJob_RequestSyntax) **   <a name="AWSPartnerCentral-DeleteResourceSnapshotJob-request-Catalog"></a>
 Specifies the catalog from which to delete the snapshot job. Valid values are `AWS` and `Sandbox`.   
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ResourceSnapshotJobIdentifier](#API_DeleteResourceSnapshotJob_RequestSyntax) **   <a name="AWSPartnerCentral-DeleteResourceSnapshotJob-request-ResourceSnapshotJobIdentifier"></a>
 The unique identifier of the resource snapshot job to be deleted.   
Type: String  
Pattern: `job-[0-9a-z]{13}`   
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/DeleteResourceSnapshotJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/DeleteResourceSnapshotJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/DeleteResourceSnapshotJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/DeleteResourceSnapshotJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/DeleteResourceSnapshotJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/DeleteResourceSnapshotJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/DeleteResourceSnapshotJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/DeleteResourceSnapshotJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/DeleteResourceSnapshotJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/DeleteResourceSnapshotJob) 

# DisassociateOpportunity


Allows you to remove an existing association between an `Opportunity` and related entities, such as a Partner Solution, AWS product, or an AWS Marketplace offer. This operation is the counterpart to `AssociateOpportunity`, and it provides flexibility to manage associations as business needs change.

Use this operation to update the associations of an `Opportunity` due to changes in the related entities, or if an association was made in error. Ensuring accurate associations helps maintain clarity and accuracy to track and manage business opportunities. When you replace an entity, first attach the new entity and then disassociate the one to be removed, especially if it's the last remaining entity that's required.

## Request Syntax


```
{
   "Catalog": "string",
   "OpportunityIdentifier": "string",
   "RelatedEntityIdentifier": "string",
   "RelatedEntityType": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_DisassociateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-DisassociateOpportunity-request-Catalog"></a>
Specifies the catalog associated with the request. This field takes a string value from a predefined list: `AWS` or `Sandbox`. The catalog determines which environment the opportunity disassociation is made in. Use `AWS` to disassociate opportunities in the AWS catalog, and `Sandbox` for testing in secure, isolated environments.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [OpportunityIdentifier](#API_DisassociateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-DisassociateOpportunity-request-OpportunityIdentifier"></a>
The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier helps to ensure that the correct opportunity is updated.  
Validation: Ensure that the provided identifier corresponds to an existing opportunity in the AWS system because incorrect identifiers result in an error and no changes are made.  
Type: String  
Pattern: `O[0-9]{1,19}`   
Required: Yes

 ** [RelatedEntityIdentifier](#API_DisassociateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-DisassociateOpportunity-request-RelatedEntityIdentifier"></a>
The related entity's identifier that you want to disassociate from the opportunity. Depending on the type of entity, this could be a simple identifier or an Amazon Resource Name (ARN) for entities managed through AWS Marketplace.  
For AWS Marketplace entities, use the AWS Marketplace API to obtain the necessary ARNs. For guidance on retrieving these ARNs, see [AWS MarketplaceUsing the AWS Marketplace Catalog API](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html).  
Validation: Ensure the identifier or ARN is valid and corresponds to an existing entity. An incorrect or invalid identifier results in an error.  
Type: String  
Pattern: `(?s).{1,255}`   
Required: Yes

 ** [RelatedEntityType](#API_DisassociateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-DisassociateOpportunity-request-RelatedEntityType"></a>
The type of the entity that you're disassociating from the opportunity. When you specify the entity type, it helps the system correctly process the disassociation request to ensure that the right connections are removed.  
Examples of entity types include Partner Solution, AWS product, and AWS Marketplaceoffer. Ensure that the value matches one of the expected entity types.  
Validation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error.  
Type: String  
Valid Values: `Solutions | AwsProducts | AwsMarketplaceOffers | AwsMarketplaceOfferSets`   
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/DisassociateOpportunity) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/DisassociateOpportunity) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/DisassociateOpportunity) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/DisassociateOpportunity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/DisassociateOpportunity) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/DisassociateOpportunity) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/DisassociateOpportunity) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/DisassociateOpportunity) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/DisassociateOpportunity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/DisassociateOpportunity) 

# GetAwsOpportunitySummary


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.

## Request Syntax


```
{
   "Catalog": "string",
   "RelatedOpportunityIdentifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_GetAwsOpportunitySummary_RequestSyntax) **   <a name="AWSPartnerCentral-GetAwsOpportunitySummary-request-Catalog"></a>
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.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [RelatedOpportunityIdentifier](#API_GetAwsOpportunitySummary_RequestSyntax) **   <a name="AWSPartnerCentral-GetAwsOpportunitySummary-request-RelatedOpportunityIdentifier"></a>
The unique identifier for the related partner opportunity. Use this field to correlate an AWS opportunity with its corresponding partner opportunity.  
Type: String  
Pattern: `O[0-9]{1,19}`   
Required: Yes

## Response Syntax


```
{
   "Catalog": "string",
   "Customer": { 
      "Contacts": [ 
         { 
            "BusinessTitle": "string",
            "Email": "string",
            "FirstName": "string",
            "LastName": "string",
            "Phone": "string"
         }
      ]
   },
   "Insights": { 
      "AwsProductsSpendInsightsBySource": { 
         "AWS": { 
            "AwsProducts": [ 
               { 
                  "Amount": "string",
                  "Categories": [ "string" ],
                  "Optimizations": [ 
                     { 
                        "Description": "string",
                        "SavingsAmount": "string"
                     }
                  ],
                  "OptimizedAmount": "string",
                  "PotentialSavingsAmount": "string",
                  "ProductCode": "string",
                  "ServiceCode": "string"
               }
            ],
            "CurrencyCode": "string",
            "Frequency": "string",
            "TotalAmount": "string",
            "TotalAmountByCategory": { 
               "string" : "string" 
            },
            "TotalOptimizedAmount": "string",
            "TotalPotentialSavingsAmount": "string"
         },
         "Partner": { 
            "AwsProducts": [ 
               { 
                  "Amount": "string",
                  "Categories": [ "string" ],
                  "Optimizations": [ 
                     { 
                        "Description": "string",
                        "SavingsAmount": "string"
                     }
                  ],
                  "OptimizedAmount": "string",
                  "PotentialSavingsAmount": "string",
                  "ProductCode": "string",
                  "ServiceCode": "string"
               }
            ],
            "CurrencyCode": "string",
            "Frequency": "string",
            "TotalAmount": "string",
            "TotalAmountByCategory": { 
               "string" : "string" 
            },
            "TotalOptimizedAmount": "string",
            "TotalPotentialSavingsAmount": "string"
         }
      },
      "EngagementScore": "string",
      "NextBestActions": "string"
   },
   "InvolvementType": "string",
   "InvolvementTypeChangeReason": "string",
   "LifeCycle": { 
      "ClosedLostReason": "string",
      "NextSteps": "string",
      "NextStepsHistory": [ 
         { 
            "Time": "string",
            "Value": "string"
         }
      ],
      "Stage": "string",
      "TargetCloseDate": "string"
   },
   "OpportunityTeam": [ 
      { 
         "BusinessTitle": "string",
         "Email": "string",
         "FirstName": "string",
         "LastName": "string"
      }
   ],
   "Origin": "string",
   "Project": { 
      "AwsPartition": "string",
      "ExpectedCustomerSpend": [ 
         { 
            "Amount": "string",
            "CurrencyCode": "string",
            "EstimationUrl": "string",
            "Frequency": "string",
            "TargetCompany": "string"
         }
      ]
   },
   "RelatedEntityIds": { 
      "AwsProducts": [ "string" ],
      "Solutions": [ "string" ]
   },
   "RelatedOpportunityId": "string",
   "Visibility": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Catalog](#API_GetAwsOpportunitySummary_ResponseSyntax) **   <a name="AWSPartnerCentral-GetAwsOpportunitySummary-response-Catalog"></a>
Specifies the catalog in which the AWS Opportunity exists. This is the environment (e.g., `AWS` or `Sandbox`) where the opportunity is being managed.  
Type: String  
Pattern: `[a-zA-Z]+` 

 ** [Customer](#API_GetAwsOpportunitySummary_ResponseSyntax) **   <a name="AWSPartnerCentral-GetAwsOpportunitySummary-response-Customer"></a>
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.  
Type: [AwsOpportunityCustomer](API_AwsOpportunityCustomer.md) object

 ** [Insights](#API_GetAwsOpportunitySummary_ResponseSyntax) **   <a name="AWSPartnerCentral-GetAwsOpportunitySummary-response-Insights"></a>
Provides insights into the AWS Opportunity, including engagement score and recommended actions that AWS suggests for the partner.  
Type: [AwsOpportunityInsights](API_AwsOpportunityInsights.md) object

 ** [InvolvementType](#API_GetAwsOpportunitySummary_ResponseSyntax) **   <a name="AWSPartnerCentral-GetAwsOpportunitySummary-response-InvolvementType"></a>
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.  
Type: String  
Valid Values: `For Visibility Only | Co-Sell` 

 ** [InvolvementTypeChangeReason](#API_GetAwsOpportunitySummary_ResponseSyntax) **   <a name="AWSPartnerCentral-GetAwsOpportunitySummary-response-InvolvementTypeChangeReason"></a>
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.  
Type: String  
Valid Values: `Expansion Opportunity | Change in Deal Information | Customer Requested | Technical Complexity | Risk Mitigation` 

 ** [LifeCycle](#API_GetAwsOpportunitySummary_ResponseSyntax) **   <a name="AWSPartnerCentral-GetAwsOpportunitySummary-response-LifeCycle"></a>
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.  
Type: [AwsOpportunityLifeCycle](API_AwsOpportunityLifeCycle.md) object

 ** [OpportunityTeam](#API_GetAwsOpportunitySummary_ResponseSyntax) **   <a name="AWSPartnerCentral-GetAwsOpportunitySummary-response-OpportunityTeam"></a>
Details the AWS opportunity team, including members involved. This information helps partners know who from AWS is engaged and what their role is.  
Type: Array of [AwsTeamMember](API_AwsTeamMember.md) objects

 ** [Origin](#API_GetAwsOpportunitySummary_ResponseSyntax) **   <a name="AWSPartnerCentral-GetAwsOpportunitySummary-response-Origin"></a>
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.  
Type: String  
Valid Values: `AWS Referral | Partner Referral` 

 ** [Project](#API_GetAwsOpportunitySummary_ResponseSyntax) **   <a name="AWSPartnerCentral-GetAwsOpportunitySummary-response-Project"></a>
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.  
Type: [AwsOpportunityProject](API_AwsOpportunityProject.md) object

 ** [RelatedEntityIds](#API_GetAwsOpportunitySummary_ResponseSyntax) **   <a name="AWSPartnerCentral-GetAwsOpportunitySummary-response-RelatedEntityIds"></a>
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.  
Type: [AwsOpportunityRelatedEntities](API_AwsOpportunityRelatedEntities.md) object

 ** [RelatedOpportunityId](#API_GetAwsOpportunitySummary_ResponseSyntax) **   <a name="AWSPartnerCentral-GetAwsOpportunitySummary-response-RelatedOpportunityId"></a>
Provides the unique identifier of the related partner opportunity, allowing partners to link the AWS Opportunity to their corresponding opportunity in their CRM system.  
Type: String  
Pattern: `O[0-9]{1,19}` 

 ** [Visibility](#API_GetAwsOpportunitySummary_ResponseSyntax) **   <a name="AWSPartnerCentral-GetAwsOpportunitySummary-response-Visibility"></a>
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.  
Type: String  
Valid Values: `Full | Limited` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/GetAwsOpportunitySummary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/GetAwsOpportunitySummary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/GetAwsOpportunitySummary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/GetAwsOpportunitySummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/GetAwsOpportunitySummary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/GetAwsOpportunitySummary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/GetAwsOpportunitySummary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/GetAwsOpportunitySummary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/GetAwsOpportunitySummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/GetAwsOpportunitySummary) 

# GetEngagement


Use this action to retrieve the engagement record for a given `EngagementIdentifier`.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_GetEngagement_RequestSyntax) **   <a name="AWSPartnerCentral-GetEngagement-request-Catalog"></a>
Specifies the catalog related to the engagement request. Valid values are `AWS` and `Sandbox`.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [Identifier](#API_GetEngagement_RequestSyntax) **   <a name="AWSPartnerCentral-GetEngagement-request-Identifier"></a>
Specifies the identifier of the Engagement record to retrieve.  
Type: String  
Pattern: `(arn:.*|eng-[0-9a-z]{14})`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Contexts": [ 
      { 
         "Id": "string",
         "Payload": { ... },
         "Type": "string"
      }
   ],
   "CreatedAt": "string",
   "CreatedBy": "string",
   "Description": "string",
   "Id": "string",
   "MemberCount": number,
   "ModifiedAt": "string",
   "ModifiedBy": "string",
   "Title": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_GetEngagement_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagement-response-Arn"></a>
The Amazon Resource Name (ARN) of the engagement retrieved.  
Type: String  
Pattern: `arn:.*` 

 ** [Contexts](#API_GetEngagement_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagement-response-Contexts"></a>
A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.  
Type: Array of [EngagementContextDetails](API_EngagementContextDetails.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.

 ** [CreatedAt](#API_GetEngagement_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagement-response-CreatedAt"></a>
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.  
Type: Timestamp

 ** [CreatedBy](#API_GetEngagement_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagement-response-CreatedBy"></a>
The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.  
Type: String  
Pattern: `([0-9]{12}|\w{1,12})` 

 ** [Description](#API_GetEngagement_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagement-response-Description"></a>
A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.  
Type: String  
Pattern: `(?s).{0,255}` 

 ** [Id](#API_GetEngagement_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagement-response-Id"></a>
The unique resource identifier of the engagement retrieved.  
Type: String  
Pattern: `eng-[0-9a-z]{14}` 

 ** [MemberCount](#API_GetEngagement_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagement-response-MemberCount"></a>
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.  
Type: Integer

 ** [ModifiedAt](#API_GetEngagement_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagement-response-ModifiedAt"></a>
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.  
Type: Timestamp

 ** [ModifiedBy](#API_GetEngagement_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagement-response-ModifiedBy"></a>
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.  
Type: String  
Pattern: `([0-9]{12}|\w{1,12})` 

 ** [Title](#API_GetEngagement_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagement-response-Title"></a>
The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.  
Type: String  
Pattern: `(?s).{1,40}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/GetEngagement) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/GetEngagement) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/GetEngagement) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/GetEngagement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/GetEngagement) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/GetEngagement) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/GetEngagement) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/GetEngagement) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/GetEngagement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/GetEngagement) 

# GetEngagementInvitation


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`.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_GetEngagementInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-request-Catalog"></a>
Specifies the catalog associated with the request. The field accepts values from the predefined set: `AWS` for live operations or `Sandbox` for testing environments.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [Identifier](#API_GetEngagementInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-request-Identifier"></a>
Specifies the unique identifier for the retrieved engagement invitation.  
Type: String  
Pattern: `(?=.{1,255}$)(arn:.*|engi-[0-9a-z]{13})`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Catalog": "string",
   "EngagementDescription": "string",
   "EngagementId": "string",
   "EngagementTitle": "string",
   "ExistingMembers": [ 
      { 
         "CompanyName": "string",
         "WebsiteUrl": "string"
      }
   ],
   "ExpirationDate": "string",
   "Id": "string",
   "InvitationDate": "string",
   "InvitationMessage": "string",
   "Payload": { ... },
   "PayloadType": "string",
   "Receiver": { ... },
   "RejectionReason": "string",
   "SenderAwsAccountId": "string",
   "SenderCompanyName": "string",
   "Status": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Catalog](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-Catalog"></a>
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.  
Type: String  
Pattern: `[a-zA-Z]+` 

 ** [Id](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-Id"></a>
Unique identifier assigned to the engagement invitation being retrieved.  
Type: String  
Pattern: `(?=.{1,255}$)(arn:.*|engi-[0-9a-z]{13})` 

 ** [Arn](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-Arn"></a>
The Amazon Resource Name (ARN) that identifies the engagement invitation.  
Type: String

 ** [EngagementDescription](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-EngagementDescription"></a>
The description of the engagement associated with this invitation.  
Type: String  
Pattern: `(?s).{0,255}` 

 ** [EngagementId](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-EngagementId"></a>
The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.  
Type: String  
Pattern: `eng-[0-9a-z]{14}` 

 ** [EngagementTitle](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-EngagementTitle"></a>
The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.  
Type: String  
Pattern: `(?s).{1,40}` 

 ** [ExistingMembers](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-ExistingMembers"></a>
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.
Type: Array of [EngagementMemberSummary](API_EngagementMemberSummary.md) objects

 ** [ExpirationDate](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-ExpirationDate"></a>
Indicates the date on which the engagement invitation will expire if not accepted by the partner.  
Type: Timestamp

 ** [InvitationDate](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-InvitationDate"></a>
The date when the engagement invitation was sent to the partner.  
Type: Timestamp

 ** [InvitationMessage](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-InvitationMessage"></a>
The message sent to the invited partner when the invitation was created.  
Type: String  
Pattern: `(?s).{1,255}` 

 ** [Payload](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-Payload"></a>
Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.  
Type: [Payload](API_Payload.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [PayloadType](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-PayloadType"></a>
The type of payload contained in the engagement invitation, indicating what data or context the payload covers.  
Type: String  
Valid Values: `OpportunityInvitation | LeadInvitation` 

 ** [Receiver](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-Receiver"></a>
Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.  
Type: [Receiver](API_Receiver.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [RejectionReason](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-RejectionReason"></a>
If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.  
Type: String  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]{1,80}` 

 ** [SenderAwsAccountId](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-SenderAwsAccountId"></a>
Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.  
Type: String  
Pattern: `([0-9]{12}|\w{1,12})` 

 ** [SenderCompanyName](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-SenderCompanyName"></a>
The name of the AWS organization or team that sent the engagement invitation.  
Type: String  
Pattern: `(?s).{0,120}` 

 ** [Status](#API_GetEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-GetEngagementInvitation-response-Status"></a>
The current status of the engagement invitation.  
Type: String  
Valid Values: `ACCEPTED | PENDING | REJECTED | EXPIRED` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/GetEngagementInvitation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/GetEngagementInvitation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/GetEngagementInvitation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/GetEngagementInvitation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/GetEngagementInvitation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/GetEngagementInvitation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/GetEngagementInvitation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/GetEngagementInvitation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/GetEngagementInvitation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/GetEngagementInvitation) 

# GetOpportunity


Fetches the `Opportunity` record from Partner Central by a given `Identifier`.

Use the `ListOpportunities` action or the event notification (from Amazon EventBridge) to obtain this identifier.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_GetOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-request-Catalog"></a>
Specifies the catalog associated with the request. This field takes a string value from a predefined list: `AWS` or `Sandbox`. The catalog determines which environment the opportunity is fetched from. Use `AWS` to retrieve opportunities in the AWS catalog, and `Sandbox` to retrieve opportunities in a secure, isolated testing environment.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [Identifier](#API_GetOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-request-Identifier"></a>
Read-only, system generated `Opportunity` unique identifier.  
Type: String  
Pattern: `O[0-9]{1,19}`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Catalog": "string",
   "CreatedDate": "string",
   "Customer": { 
      "Account": { 
         "Address": { 
            "City": "string",
            "CountryCode": "string",
            "PostalCode": "string",
            "StateOrRegion": "string",
            "StreetAddress": "string"
         },
         "AwsAccountId": "string",
         "CompanyName": "string",
         "Duns": "string",
         "Industry": "string",
         "OtherIndustry": "string",
         "WebsiteUrl": "string"
      },
      "Contacts": [ 
         { 
            "BusinessTitle": "string",
            "Email": "string",
            "FirstName": "string",
            "LastName": "string",
            "Phone": "string"
         }
      ]
   },
   "Id": "string",
   "LastModifiedDate": "string",
   "LifeCycle": { 
      "ClosedLostReason": "string",
      "NextSteps": "string",
      "NextStepsHistory": [ 
         { 
            "Time": "string",
            "Value": "string"
         }
      ],
      "ReviewComments": "string",
      "ReviewStatus": "string",
      "ReviewStatusReason": "string",
      "Stage": "string",
      "TargetCloseDate": "string"
   },
   "Marketing": { 
      "AwsFundingUsed": "string",
      "CampaignName": "string",
      "Channels": [ "string" ],
      "Source": "string",
      "UseCases": [ "string" ]
   },
   "NationalSecurity": "string",
   "OpportunityTeam": [ 
      { 
         "BusinessTitle": "string",
         "Email": "string",
         "FirstName": "string",
         "LastName": "string",
         "Phone": "string"
      }
   ],
   "OpportunityType": "string",
   "PartnerOpportunityIdentifier": "string",
   "PrimaryNeedsFromAws": [ "string" ],
   "Project": { 
      "AdditionalComments": "string",
      "ApnPrograms": [ "string" ],
      "AwsPartition": "string",
      "CompetitorName": "string",
      "CustomerBusinessProblem": "string",
      "CustomerUseCase": "string",
      "DeliveryModels": [ "string" ],
      "ExpectedCustomerSpend": [ 
         { 
            "Amount": "string",
            "CurrencyCode": "string",
            "EstimationUrl": "string",
            "Frequency": "string",
            "TargetCompany": "string"
         }
      ],
      "OtherCompetitorNames": "string",
      "OtherSolutionDescription": "string",
      "RelatedOpportunityIdentifier": "string",
      "SalesActivities": [ "string" ],
      "Title": "string"
   },
   "RelatedEntityIdentifiers": { 
      "AwsMarketplaceOffers": [ "string" ],
      "AwsMarketplaceOfferSets": [ "string" ],
      "AwsProducts": [ "string" ],
      "Solutions": [ "string" ]
   },
   "SoftwareRevenue": { 
      "DeliveryModel": "string",
      "EffectiveDate": "string",
      "ExpirationDate": "string",
      "Value": { 
         "Amount": "string",
         "CurrencyCode": "string"
      }
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Catalog](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-Catalog"></a>
Specifies the catalog associated with the request. This field takes a string value from a predefined list: `AWS` or `Sandbox`. The catalog determines which environment the opportunity information is retrieved from. Use `AWS` to retrieve opportunities in the AWS catalog, and `Sandbox` to retrieve opportunities in a secure and isolated testing environment.  
Type: String  
Pattern: `[a-zA-Z]+` 

 ** [CreatedDate](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-CreatedDate"></a>
 `DateTime` when the `Opportunity` was last created.  
Type: Timestamp

 ** [Id](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-Id"></a>
Read-only, system generated `Opportunity` unique identifier.  
Type: String  
Pattern: `O[0-9]{1,19}` 

 ** [LastModifiedDate](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-LastModifiedDate"></a>
 `DateTime` when the opportunity was last modified.  
Type: Timestamp

 ** [RelatedEntityIdentifiers](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-RelatedEntityIdentifiers"></a>
Provides information about the associations of other entities with the opportunity. These entities include identifiers for `AWSProducts`, `Partner Solutions`, and `AWSMarketplaceOffers`.  
Type: [RelatedEntityIdentifiers](API_RelatedEntityIdentifiers.md) object

 ** [Arn](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-Arn"></a>
The Amazon Resource Name (ARN) that uniquely identifies the opportunity.  
Type: String  
Pattern: `arn:.*` 

 ** [Customer](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-Customer"></a>
Specifies details of the customer associated with the `Opportunity`.  
Type: [Customer](API_Customer.md) object

 ** [LifeCycle](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-LifeCycle"></a>
An object that contains lifecycle details for the `Opportunity`.  
Type: [LifeCycle](API_LifeCycle.md) object

 ** [Marketing](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-Marketing"></a>
An object that contains marketing details for the `Opportunity`.  
Type: [Marketing](API_Marketing.md) object

 ** [NationalSecurity](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-NationalSecurity"></a>
Indicates whether the `Opportunity` pertains to a national security project. This field must be set to `true` only when the customer's industry is *Government*. Additional privacy and security measures apply during the review and management process for opportunities marked as `NationalSecurity`.  
Type: String  
Valid Values: `Yes | No` 

 ** [OpportunityTeam](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-OpportunityTeam"></a>
Represents the internal team handling the opportunity. Specify the members involved in collaborating on this opportunity within the partner's organization.  
Type: Array of [Contact](API_Contact.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [OpportunityType](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-OpportunityType"></a>
Specifies the opportunity type as renewal, new, or expansion.  
Opportunity types:  
+ New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.
+ Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, which helps to ensure service continuity.
+ Expansion opportunity: Represents an opportunity to expand the scope of a customer's contract or subscription, either by adding new services or increasing the volume of existing services.
Type: String  
Valid Values: `Net New Business | Flat Renewal | Expansion` 

 ** [PartnerOpportunityIdentifier](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-PartnerOpportunityIdentifier"></a>
Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.  
Type: String  
Pattern: `(?s).{0,64}` 

 ** [PrimaryNeedsFromAws](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-PrimaryNeedsFromAws"></a>
Identifies the type of support the partner needs from AWS.  
Valid values:  
+ Cosell—Architectural Validation: Confirmation from AWS that the partner's proposed solution architecture is aligned with AWS best practices and poses minimal architectural risks.
+ Cosell—Business Presentation: Request AWS seller's participation in a joint customer presentation.
+ Cosell—Competitive Information: Access to AWS competitive resources and support for the partner's proposed solution.
+ Cosell—Pricing Assistance: Connect with an AWS seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).
+ Cosell—Technical Consultation: Connect with an AWS Solutions Architect to address the partner's questions about the proposed solution.
+ Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on AWS versus on-premises or a traditional hosting environment.
+ Cosell—Deal Support: Request AWS seller's support to progress the opportunity (for example: joint customer call, strategic positioning).
+ Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs AWS RFx support.
Type: Array of strings  
Valid Values: `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` 

 ** [Project](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-Project"></a>
An object that contains project details summary for the `Opportunity`.  
Type: [Project](API_Project.md) object

 ** [SoftwareRevenue](#API_GetOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-GetOpportunity-response-SoftwareRevenue"></a>
Specifies details of a customer's procurement terms. Required only for partners in eligible programs.  
Type: [SoftwareRevenue](API_SoftwareRevenue.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/GetOpportunity) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/GetOpportunity) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/GetOpportunity) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/GetOpportunity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/GetOpportunity) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/GetOpportunity) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/GetOpportunity) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/GetOpportunity) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/GetOpportunity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/GetOpportunity) 

# GetResourceSnapshot


Use this action to retrieve a specific snapshot record.

## Request Syntax


```
{
   "Catalog": "string",
   "EngagementIdentifier": "string",
   "ResourceIdentifier": "string",
   "ResourceSnapshotTemplateIdentifier": "string",
   "ResourceType": "string",
   "Revision": number
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_GetResourceSnapshot_RequestSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-request-Catalog"></a>
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.
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [EngagementIdentifier](#API_GetResourceSnapshot_RequestSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-request-EngagementIdentifier"></a>
The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.  
Type: String  
Pattern: `eng-[0-9a-z]{14}`   
Required: Yes

 ** [ResourceIdentifier](#API_GetResourceSnapshot_RequestSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-request-ResourceIdentifier"></a>
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`   
Type: String  
Pattern: `O[0-9]{1,19}`   
Required: Yes

 ** [ResourceSnapshotTemplateIdentifier](#API_GetResourceSnapshot_RequestSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-request-ResourceSnapshotTemplateIdentifier"></a>
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`.  
Type: String  
Pattern: `[a-zA-Z0-9]{3,80}`   
Required: Yes

 ** [ResourceType](#API_GetResourceSnapshot_RequestSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-request-ResourceType"></a>
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.   
Type: String  
Valid Values: `Opportunity`   
Required: Yes

 ** [Revision](#API_GetResourceSnapshot_RequestSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-request-Revision"></a>
Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

## Response Syntax


```
{
   "Arn": "string",
   "Catalog": "string",
   "CreatedAt": "string",
   "CreatedBy": "string",
   "EngagementId": "string",
   "Payload": { ... },
   "ResourceId": "string",
   "ResourceSnapshotTemplateName": "string",
   "ResourceType": "string",
   "Revision": number,
   "TargetMemberAccounts": [ "string" ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Catalog](#API_GetResourceSnapshot_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-response-Catalog"></a>
The catalog in which the snapshot was created. Matches the Catalog specified in the request.  
Type: String  
Pattern: `[a-zA-Z]+` 

 ** [Arn](#API_GetResourceSnapshot_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-response-Arn"></a>
The Amazon Resource Name (ARN) that uniquely identifies the resource snapshot.  
Type: String  
Pattern: `arn:.*` 

 ** [CreatedAt](#API_GetResourceSnapshot_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-response-CreatedAt"></a>
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.   
Type: Timestamp

 ** [CreatedBy](#API_GetResourceSnapshot_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-response-CreatedBy"></a>
The AWS account ID of the principal (user or role) who created the snapshot. This helps in tracking the origin of the snapshot.   
Type: String  
Pattern: `([0-9]{12}|\w{1,12})` 

 ** [EngagementId](#API_GetResourceSnapshot_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-response-EngagementId"></a>
The identifier of the engagement associated with this snapshot. Matches the EngagementIdentifier specified in the request.   
Type: String  
Pattern: `eng-[0-9a-z]{14}` 

 ** [Payload](#API_GetResourceSnapshot_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-response-Payload"></a>
 Represents the payload of a resource snapshot. This structure is designed to accommodate different types of resource snapshots, currently supporting opportunity summaries.   
Type: [ResourceSnapshotPayload](API_ResourceSnapshotPayload.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [ResourceId](#API_GetResourceSnapshot_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-response-ResourceId"></a>
The identifier of the specific resource that was snapshotted. Matches the ResourceIdentifier specified in the request.  
Type: String  
Pattern: `O[0-9]{1,19}` 

 ** [ResourceSnapshotTemplateName](#API_GetResourceSnapshot_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-response-ResourceSnapshotTemplateName"></a>
The name of the view used for this snapshot. This is the same as the template name.  
Type: String  
Pattern: `[a-zA-Z0-9]{3,80}` 

 ** [ResourceType](#API_GetResourceSnapshot_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-response-ResourceType"></a>
The type of the resource that was snapshotted. Matches the ResourceType specified in the request.  
Type: String  
Valid Values: `Opportunity` 

 ** [Revision](#API_GetResourceSnapshot_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-response-Revision"></a>
The revision number of this snapshot. This is a positive integer that is sequential and unique within the context of a resource view.  
Type: Integer  
Valid Range: Minimum value of 1.

 ** [TargetMemberAccounts](#API_GetResourceSnapshot_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshot-response-TargetMemberAccounts"></a>
Target member accounts associated with the resource snapshot.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `([0-9]{12}|\w{1,12})` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/GetResourceSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/GetResourceSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/GetResourceSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/GetResourceSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/GetResourceSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/GetResourceSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/GetResourceSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/GetResourceSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/GetResourceSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/GetResourceSnapshot) 

# GetResourceSnapshotJob


Use this action to retrieves information about a specific resource snapshot job.

## Request Syntax


```
{
   "Catalog": "string",
   "ResourceSnapshotJobIdentifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_GetResourceSnapshotJob_RequestSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshotJob-request-Catalog"></a>
Specifies the catalog related to the request. Valid values are:  
+  AWS: Retrieves the snapshot job from the production AWS environment. 
+  Sandbox: Retrieves the snapshot job from a sandbox environment used for testing or development purposes. 
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ResourceSnapshotJobIdentifier](#API_GetResourceSnapshotJob_RequestSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshotJob-request-ResourceSnapshotJobIdentifier"></a>
The unique identifier of the resource snapshot job to be retrieved. This identifier is crucial for pinpointing the specific job you want to query.   
Type: String  
Pattern: `job-[0-9a-z]{13}`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Catalog": "string",
   "CreatedAt": "string",
   "EngagementId": "string",
   "Id": "string",
   "LastFailure": "string",
   "LastSuccessfulExecutionDate": "string",
   "ResourceArn": "string",
   "ResourceId": "string",
   "ResourceSnapshotTemplateName": "string",
   "ResourceType": "string",
   "Status": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Catalog](#API_GetResourceSnapshotJob_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshotJob-response-Catalog"></a>
The catalog in which the snapshot job was created. This will match the Catalog specified in the request.   
Type: String  
Pattern: `[a-zA-Z]+` 

 ** [Arn](#API_GetResourceSnapshotJob_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshotJob-response-Arn"></a>
The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.   
Type: String  
Pattern: `arn:.*` 

 ** [CreatedAt](#API_GetResourceSnapshotJob_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshotJob-response-CreatedAt"></a>
The date and time when the snapshot job was created in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"   
Type: Timestamp

 ** [EngagementId](#API_GetResourceSnapshotJob_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshotJob-response-EngagementId"></a>
The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context.   
Type: String  
Pattern: `eng-[0-9a-z]{14}` 

 ** [Id](#API_GetResourceSnapshotJob_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshotJob-response-Id"></a>
The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request.   
Type: String  
Pattern: `job-[0-9a-z]{13}` 

 ** [LastFailure](#API_GetResourceSnapshotJob_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshotJob-response-LastFailure"></a>
If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job.   
Type: String

 ** [LastSuccessfulExecutionDate](#API_GetResourceSnapshotJob_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshotJob-response-LastSuccessfulExecutionDate"></a>
The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"   
Type: Timestamp

 ** [ResourceArn](#API_GetResourceSnapshotJob_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshotJob-response-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.   
Type: String  
Pattern: `arn:.*` 

 ** [ResourceId](#API_GetResourceSnapshotJob_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshotJob-response-ResourceId"></a>
The identifier of the specific resource being snapshotted. The format might vary depending on the ResourceType.   
Type: String  
Pattern: `O[0-9]{1,19}` 

 ** [ResourceSnapshotTemplateName](#API_GetResourceSnapshotJob_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshotJob-response-ResourceSnapshotTemplateName"></a>
The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot.  
Type: String  
Pattern: `[a-zA-Z0-9]{3,80}` 

 ** [ResourceType](#API_GetResourceSnapshotJob_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshotJob-response-ResourceType"></a>
The type of resource being snapshotted. This would have "Opportunity" as a value as it is dependent on the supported resource type.  
Type: String  
Valid Values: `Opportunity` 

 ** [Status](#API_GetResourceSnapshotJob_ResponseSyntax) **   <a name="AWSPartnerCentral-GetResourceSnapshotJob-response-Status"></a>
The current status of the snapshot job. Valid values:  
+ STOPPED: The job is not currently running.
+ RUNNING: The job is actively executing.
Type: String  
Valid Values: `Running | Stopped` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/GetResourceSnapshotJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/GetResourceSnapshotJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/GetResourceSnapshotJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/GetResourceSnapshotJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/GetResourceSnapshotJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/GetResourceSnapshotJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/GetResourceSnapshotJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/GetResourceSnapshotJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/GetResourceSnapshotJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/GetResourceSnapshotJob) 

# GetSellingSystemSettings


Retrieves the currently set system settings, which include the IAM Role used for resource snapshot jobs.

## Request Syntax


```
{
   "Catalog": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_GetSellingSystemSettings_RequestSyntax) **   <a name="AWSPartnerCentral-GetSellingSystemSettings-request-Catalog"></a>
Specifies the catalog in which the settings are defined. Acceptable values include `AWS` for production and `Sandbox` for testing environments.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

## Response Syntax


```
{
   "Catalog": "string",
   "ResourceSnapshotJobRoleArn": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Catalog](#API_GetSellingSystemSettings_ResponseSyntax) **   <a name="AWSPartnerCentral-GetSellingSystemSettings-response-Catalog"></a>
Specifies the catalog in which the settings are defined. Acceptable values include `AWS` for production and `Sandbox` for testing environments.  
Type: String  
Pattern: `[a-zA-Z]+` 

 ** [ResourceSnapshotJobRoleArn](#API_GetSellingSystemSettings_ResponseSyntax) **   <a name="AWSPartnerCentral-GetSellingSystemSettings-response-ResourceSnapshotJobRoleArn"></a>
Specifies the ARN of the IAM Role used for resource snapshot job executions.  
Type: String  
Pattern: `(?=.{0,2048}$)arn:aws:iam::\d{12}:role/([-+=,.@_a-zA-Z0-9]+/)*[-+=,.@_a-zA-Z0-9]{1,64}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/GetSellingSystemSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/GetSellingSystemSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/GetSellingSystemSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/GetSellingSystemSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/GetSellingSystemSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/GetSellingSystemSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/GetSellingSystemSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/GetSellingSystemSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/GetSellingSystemSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/GetSellingSystemSettings) 

# ListEngagementByAcceptingInvitationTasks


 Lists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask tasks that were initiated by the caller's account. 

## Request Syntax


```
{
   "Catalog": "string",
   "EngagementInvitationIdentifier": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "OpportunityIdentifier": [ "string" ],
   "Sort": { 
      "SortBy": "string",
      "SortOrder": "string"
   },
   "TaskIdentifier": [ "string" ],
   "TaskStatus": [ "string" ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_ListEngagementByAcceptingInvitationTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementByAcceptingInvitationTasks-request-Catalog"></a>
 Specifies the catalog related to the request. Valid values are:   
+  AWS: Retrieves the request from the production AWS environment. 
+  Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes. 
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [EngagementInvitationIdentifier](#API_ListEngagementByAcceptingInvitationTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementByAcceptingInvitationTasks-request-EngagementInvitationIdentifier"></a>
 Filters tasks by the identifiers of the engagement invitations they are processing.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `(?=.{1,255}$)(arn:.*|engi-[0-9a-z]{13})`   
Required: No

 ** [MaxResults](#API_ListEngagementByAcceptingInvitationTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementByAcceptingInvitationTasks-request-MaxResults"></a>
 Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [NextToken](#API_ListEngagementByAcceptingInvitationTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementByAcceptingInvitationTasks-request-NextToken"></a>
 Use this parameter for pagination when the result set spans multiple pages. This value is obtained from the NextToken field in the response of a previous call to this API.   
Type: String  
Pattern: `(?s).{1,2048}`   
Required: No

 ** [OpportunityIdentifier](#API_ListEngagementByAcceptingInvitationTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementByAcceptingInvitationTasks-request-OpportunityIdentifier"></a>
 Filters tasks by the identifiers of the opportunities they created or are associated with.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `O[0-9]{1,19}`   
Required: No

 ** [Sort](#API_ListEngagementByAcceptingInvitationTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementByAcceptingInvitationTasks-request-Sort"></a>
 Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.   
Type: [ListTasksSortBase](API_ListTasksSortBase.md) object  
Required: No

 ** [TaskIdentifier](#API_ListEngagementByAcceptingInvitationTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementByAcceptingInvitationTasks-request-TaskIdentifier"></a>
 Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `(arn:.*|task-[0-9a-z]{13})`   
Required: No

 ** [TaskStatus](#API_ListEngagementByAcceptingInvitationTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementByAcceptingInvitationTasks-request-TaskStatus"></a>
 Filters the tasks based on their current status. This allows you to focus on tasks in specific states.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 3 items.  
Valid Values: `IN_PROGRESS | COMPLETE | FAILED`   
Required: No

## Response Syntax


```
{
   "NextToken": "string",
   "TaskSummaries": [ 
      { 
         "EngagementInvitationId": "string",
         "Message": "string",
         "OpportunityId": "string",
         "ReasonCode": "string",
         "ResourceSnapshotJobId": "string",
         "StartTime": "string",
         "TaskArn": "string",
         "TaskId": "string",
         "TaskStatus": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListEngagementByAcceptingInvitationTasks_ResponseSyntax) **   <a name="AWSPartnerCentral-ListEngagementByAcceptingInvitationTasks-response-NextToken"></a>
 A token used for pagination to retrieve the next page of results.If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.   
Type: String

 ** [TaskSummaries](#API_ListEngagementByAcceptingInvitationTasks_ResponseSyntax) **   <a name="AWSPartnerCentral-ListEngagementByAcceptingInvitationTasks-response-TaskSummaries"></a>
 An array of `EngagementByAcceptingInvitationTaskSummary` objects, each representing a task that matches the specified filters. The array may be empty if no tasks match the criteria.   
Type: Array of [ListEngagementByAcceptingInvitationTaskSummary](API_ListEngagementByAcceptingInvitationTaskSummary.md) objects

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTasks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTasks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTasks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTasks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTasks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTasks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTasks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTasks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTasks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/ListEngagementByAcceptingInvitationTasks) 

# ListEngagementFromOpportunityTasks


 Lists all in-progress, completed, or failed `EngagementFromOpportunity` tasks that were initiated by the caller's account. 

## Request Syntax


```
{
   "Catalog": "string",
   "EngagementIdentifier": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "OpportunityIdentifier": [ "string" ],
   "Sort": { 
      "SortBy": "string",
      "SortOrder": "string"
   },
   "TaskIdentifier": [ "string" ],
   "TaskStatus": [ "string" ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_ListEngagementFromOpportunityTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementFromOpportunityTasks-request-Catalog"></a>
 Specifies the catalog related to the request. Valid values are:   
+  AWS: Retrieves the request from the production AWS environment. 
+  Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes. 
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [EngagementIdentifier](#API_ListEngagementFromOpportunityTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementFromOpportunityTasks-request-EngagementIdentifier"></a>
 Filters tasks by the identifiers of the engagements they created or are associated with.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `(arn:.*|eng-[0-9a-z]{14})`   
Required: No

 ** [MaxResults](#API_ListEngagementFromOpportunityTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementFromOpportunityTasks-request-MaxResults"></a>
 Specifies the maximum number of results to return in a single page of the response.Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [NextToken](#API_ListEngagementFromOpportunityTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementFromOpportunityTasks-request-NextToken"></a>
 The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.   
Type: String  
Pattern: `(?s).{1,2048}`   
Required: No

 ** [OpportunityIdentifier](#API_ListEngagementFromOpportunityTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementFromOpportunityTasks-request-OpportunityIdentifier"></a>
 The identifier of the original opportunity associated with this task.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `O[0-9]{1,19}`   
Required: No

 ** [Sort](#API_ListEngagementFromOpportunityTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementFromOpportunityTasks-request-Sort"></a>
 Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.   
Type: [ListTasksSortBase](API_ListTasksSortBase.md) object  
Required: No

 ** [TaskIdentifier](#API_ListEngagementFromOpportunityTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementFromOpportunityTasks-request-TaskIdentifier"></a>
 Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `(arn:.*|task-[0-9a-z]{13})`   
Required: No

 ** [TaskStatus](#API_ListEngagementFromOpportunityTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementFromOpportunityTasks-request-TaskStatus"></a>
 Filters the tasks based on their current status. This allows you to focus on tasks in specific states.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 3 items.  
Valid Values: `IN_PROGRESS | COMPLETE | FAILED`   
Required: No

## Response Syntax


```
{
   "NextToken": "string",
   "TaskSummaries": [ 
      { 
         "EngagementId": "string",
         "EngagementInvitationId": "string",
         "Message": "string",
         "OpportunityId": "string",
         "ReasonCode": "string",
         "ResourceSnapshotJobId": "string",
         "StartTime": "string",
         "TaskArn": "string",
         "TaskId": "string",
         "TaskStatus": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListEngagementFromOpportunityTasks_ResponseSyntax) **   <a name="AWSPartnerCentral-ListEngagementFromOpportunityTasks-response-NextToken"></a>
 A token used for pagination to retrieve the next page of results. If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.   
Type: String

 ** [TaskSummaries](#API_ListEngagementFromOpportunityTasks_ResponseSyntax) **   <a name="AWSPartnerCentral-ListEngagementFromOpportunityTasks-response-TaskSummaries"></a>
 TaskSummaries An array of TaskSummary objects containing details about each task.   
Type: Array of [ListEngagementFromOpportunityTaskSummary](API_ListEngagementFromOpportunityTaskSummary.md) objects

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTasks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTasks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTasks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTasks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTasks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTasks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTasks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTasks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTasks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/ListEngagementFromOpportunityTasks) 

# ListEngagementInvitations


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.

## Request Syntax


```
{
   "Catalog": "string",
   "EngagementIdentifier": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "ParticipantType": "string",
   "PayloadType": [ "string" ],
   "SenderAwsAccountId": [ "string" ],
   "Sort": { 
      "SortBy": "string",
      "SortOrder": "string"
   },
   "Status": [ "string" ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_ListEngagementInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementInvitations-request-Catalog"></a>
Specifies the catalog from which to list the engagement invitations. Use `AWS` for production invitations or `Sandbox` for testing environments.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ParticipantType](#API_ListEngagementInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementInvitations-request-ParticipantType"></a>
Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.  
Type: String  
Valid Values: `SENDER | RECEIVER`   
Required: Yes

 ** [EngagementIdentifier](#API_ListEngagementInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementInvitations-request-EngagementIdentifier"></a>
 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.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `(arn:.*|eng-[0-9a-z]{14})`   
Required: No

 ** [MaxResults](#API_ListEngagementInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementInvitations-request-MaxResults"></a>
Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListEngagementInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementInvitations-request-NextToken"></a>
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.  
Type: String  
Required: No

 ** [PayloadType](#API_ListEngagementInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementInvitations-request-PayloadType"></a>
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.  
Type: Array of strings  
Valid Values: `OpportunityInvitation | LeadInvitation`   
Required: No

 ** [SenderAwsAccountId](#API_ListEngagementInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementInvitations-request-SenderAwsAccountId"></a>
 List of sender AWS account IDs to filter the invitations.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `([0-9]{12}|\w{1,12})`   
Required: No

 ** [Sort](#API_ListEngagementInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementInvitations-request-Sort"></a>
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.  
Type: [OpportunityEngagementInvitationSort](API_OpportunityEngagementInvitationSort.md) object  
Required: No

 ** [Status](#API_ListEngagementInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementInvitations-request-Status"></a>
 Status values to filter the invitations.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Valid Values: `ACCEPTED | PENDING | REJECTED | EXPIRED`   
Required: No

## Response Syntax


```
{
   "EngagementInvitationSummaries": [ 
      { 
         "Arn": "string",
         "Catalog": "string",
         "EngagementId": "string",
         "EngagementTitle": "string",
         "ExpirationDate": "string",
         "Id": "string",
         "InvitationDate": "string",
         "ParticipantType": "string",
         "PayloadType": "string",
         "Receiver": { ... },
         "SenderAwsAccountId": "string",
         "SenderCompanyName": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EngagementInvitationSummaries](#API_ListEngagementInvitations_ResponseSyntax) **   <a name="AWSPartnerCentral-ListEngagementInvitations-response-EngagementInvitationSummaries"></a>
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.  
Type: Array of [EngagementInvitationSummary](API_EngagementInvitationSummary.md) objects

 ** [NextToken](#API_ListEngagementInvitations_ResponseSyntax) **   <a name="AWSPartnerCentral-ListEngagementInvitations-response-NextToken"></a>
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.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/ListEngagementInvitations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/ListEngagementInvitations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/ListEngagementInvitations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/ListEngagementInvitations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/ListEngagementInvitations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/ListEngagementInvitations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/ListEngagementInvitations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/ListEngagementInvitations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/ListEngagementInvitations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/ListEngagementInvitations) 

# ListEngagementMembers


Retrieves the details of member partners in an Engagement. This operation can only be invoked by members of the Engagement. The `ListEngagementMembers` operation allows you to fetch information about the members of a specific Engagement. This action is restricted to members of the Engagement being queried. 

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_ListEngagementMembers_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementMembers-request-Catalog"></a>
The catalog related to the request.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [Identifier](#API_ListEngagementMembers_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementMembers-request-Identifier"></a>
Identifier of the Engagement record to retrieve members from.  
Type: String  
Pattern: `(arn:.*|eng-[0-9a-z]{14})`   
Required: Yes

 ** [MaxResults](#API_ListEngagementMembers_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementMembers-request-MaxResults"></a>
The maximum number of results to return in a single call.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: No

 ** [NextToken](#API_ListEngagementMembers_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementMembers-request-NextToken"></a>
The token for the next set of results.  
Type: String  
Required: No

## Response Syntax


```
{
   "EngagementMemberList": [ 
      { 
         "AccountId": "string",
         "CompanyName": "string",
         "WebsiteUrl": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EngagementMemberList](#API_ListEngagementMembers_ResponseSyntax) **   <a name="AWSPartnerCentral-ListEngagementMembers-response-EngagementMemberList"></a>
 Provides a list of engagement members.   
Type: Array of [EngagementMember](API_EngagementMember.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [NextToken](#API_ListEngagementMembers_ResponseSyntax) **   <a name="AWSPartnerCentral-ListEngagementMembers-response-NextToken"></a>
A pagination token used to retrieve the next set of results. If there are more results available than can be returned in a single response, this token will be present. Use this token in a subsequent request to retrieve the next page of results. If there are no more results, this value will be null.   
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/ListEngagementMembers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/ListEngagementMembers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/ListEngagementMembers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/ListEngagementMembers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/ListEngagementMembers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/ListEngagementMembers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/ListEngagementMembers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/ListEngagementMembers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/ListEngagementMembers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/ListEngagementMembers) 

# ListEngagementResourceAssociations


Lists the associations between resources and engagements where the caller is a member and has at least one snapshot in the engagement.

## Request Syntax


```
{
   "Catalog": "string",
   "CreatedBy": "string",
   "EngagementIdentifier": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ResourceIdentifier": "string",
   "ResourceType": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_ListEngagementResourceAssociations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementResourceAssociations-request-Catalog"></a>
Specifies the catalog in which to search for engagement-resource associations. Valid Values: "AWS" or "Sandbox"  
+  `AWS` for production environments.
+  `Sandbox` for testing and development purposes.
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [CreatedBy](#API_ListEngagementResourceAssociations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementResourceAssociations-request-CreatedBy"></a>
Filters the response to include only snapshots of resources owned by the specified AWS account ID. Use this when you want to find associations related to resources owned by a particular account.   
Type: String  
Pattern: `([0-9]{12}|\w{1,12})`   
Required: No

 ** [EngagementIdentifier](#API_ListEngagementResourceAssociations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementResourceAssociations-request-EngagementIdentifier"></a>
Filters the results to include only associations related to the specified engagement. Use this when you want to find all resources associated with a specific engagement.  
Type: String  
Pattern: `eng-[0-9a-z]{14}`   
Required: No

 ** [MaxResults](#API_ListEngagementResourceAssociations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementResourceAssociations-request-MaxResults"></a>
Limits the number of results returned in a single call. Use this to control the number of results returned, especially useful for pagination.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [NextToken](#API_ListEngagementResourceAssociations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementResourceAssociations-request-NextToken"></a>
A token used for pagination of results. Include this token in subsequent requests to retrieve the next set of results.  
Type: String  
Required: No

 ** [ResourceIdentifier](#API_ListEngagementResourceAssociations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementResourceAssociations-request-ResourceIdentifier"></a>
Filters the results to include only associations with the specified resource. Varies depending on the resource type. Use this when you want to find all engagements associated with a specific resource.  
Type: String  
Pattern: `O[0-9]{1,19}`   
Required: No

 ** [ResourceType](#API_ListEngagementResourceAssociations_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagementResourceAssociations-request-ResourceType"></a>
 Filters the results to include only associations with resources of the specified type.   
Type: String  
Valid Values: `Opportunity`   
Required: No

## Response Syntax


```
{
   "EngagementResourceAssociationSummaries": [ 
      { 
         "Catalog": "string",
         "CreatedBy": "string",
         "EngagementId": "string",
         "ResourceId": "string",
         "ResourceType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EngagementResourceAssociationSummaries](#API_ListEngagementResourceAssociations_ResponseSyntax) **   <a name="AWSPartnerCentral-ListEngagementResourceAssociations-response-EngagementResourceAssociationSummaries"></a>
 A list of engagement-resource association summaries.   
Type: Array of [EngagementResourceAssociationSummary](API_EngagementResourceAssociationSummary.md) objects

 ** [NextToken](#API_ListEngagementResourceAssociations_ResponseSyntax) **   <a name="AWSPartnerCentral-ListEngagementResourceAssociations-response-NextToken"></a>
 A token to retrieve the next set of results. Use this token in a subsequent request to retrieve additional results if the response was truncated.   
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/ListEngagementResourceAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/ListEngagementResourceAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/ListEngagementResourceAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/ListEngagementResourceAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/ListEngagementResourceAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/ListEngagementResourceAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/ListEngagementResourceAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/ListEngagementResourceAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/ListEngagementResourceAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/ListEngagementResourceAssociations) 

# ListEngagements


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. 

## Request Syntax


```
{
   "Catalog": "string",
   "ContextTypes": [ "string" ],
   "CreatedBy": [ "string" ],
   "EngagementIdentifier": [ "string" ],
   "ExcludeContextTypes": [ "string" ],
   "ExcludeCreatedBy": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "Sort": { 
      "SortBy": "string",
      "SortOrder": "string"
   }
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_ListEngagements_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagements-request-Catalog"></a>
 Specifies the catalog related to the request.   
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ContextTypes](#API_ListEngagements_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagements-request-ContextTypes"></a>
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.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Valid Values: `CustomerProject | Lead`   
Required: No

 ** [CreatedBy](#API_ListEngagements_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagements-request-CreatedBy"></a>
 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.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `([0-9]{12}|\w{1,12})`   
Required: No

 ** [EngagementIdentifier](#API_ListEngagements_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagements-request-EngagementIdentifier"></a>
An array of strings representing engagement identifiers to retrieve.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `(arn:.*|eng-[0-9a-z]{14})`   
Required: No

 ** [ExcludeContextTypes](#API_ListEngagements_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagements-request-ExcludeContextTypes"></a>
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.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Valid Values: `CustomerProject | Lead`   
Required: No

 ** [ExcludeCreatedBy](#API_ListEngagements_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagements-request-ExcludeCreatedBy"></a>
An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `([0-9]{12}|\w{1,12})`   
Required: No

 ** [MaxResults](#API_ListEngagements_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagements-request-MaxResults"></a>
The maximum number of results to return in a single call.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListEngagements_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagements-request-NextToken"></a>
The token for the next set of results. This value is returned from a previous call.  
Type: String  
Required: No

 ** [Sort](#API_ListEngagements_RequestSyntax) **   <a name="AWSPartnerCentral-ListEngagements-request-Sort"></a>
Specifies the sorting parameters for listing Engagements.  
Type: [EngagementSort](API_EngagementSort.md) object  
Required: No

## Response Syntax


```
{
   "EngagementSummaryList": [ 
      { 
         "Arn": "string",
         "ContextTypes": [ "string" ],
         "CreatedAt": "string",
         "CreatedBy": "string",
         "Id": "string",
         "MemberCount": number,
         "ModifiedAt": "string",
         "ModifiedBy": "string",
         "Title": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EngagementSummaryList](#API_ListEngagements_ResponseSyntax) **   <a name="AWSPartnerCentral-ListEngagements-response-EngagementSummaryList"></a>
An array of engagement summary objects.  
Type: Array of [EngagementSummary](API_EngagementSummary.md) objects

 ** [NextToken](#API_ListEngagements_ResponseSyntax) **   <a name="AWSPartnerCentral-ListEngagements-response-NextToken"></a>
The token to retrieve the next set of results. This field will be null if there are no more results.   
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/ListEngagements) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/ListEngagements) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/ListEngagements) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/ListEngagements) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/ListEngagements) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/ListEngagements) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/ListEngagements) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/ListEngagements) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/ListEngagements) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/ListEngagements) 

# ListOpportunities


This request accepts a list of filters that retrieve opportunity subsets as well as sort options. This feature is available to partners from [Partner Central](https://partnercentral.awspartner.com/) using the `ListOpportunities` API action.

To synchronize your system with AWS, list only the opportunities that were newly created or updated. We recommend you rely on events emitted by the service into your AWS account’s Amazon EventBridge default event bus. You can also use the `ListOpportunities` action.

We recommend the following approach:

1. Find the latest `LastModifiedDate` that you stored, and only use the values that came from AWS. Don’t use values generated by your system.

1. When you send a `ListOpportunities` request, submit the date in ISO 8601 format in the `AfterLastModifiedDate` filter.

1.  AWS only returns opportunities created or updated on or after that date and time. Use `NextToken` to iterate over all pages.

## Request Syntax


```
{
   "Catalog": "string",
   "CreatedDate": { 
      "AfterCreatedDate": "string",
      "BeforeCreatedDate": "string"
   },
   "CustomerCompanyName": [ "string" ],
   "Identifier": [ "string" ],
   "LastModifiedDate": { 
      "AfterLastModifiedDate": "string",
      "BeforeLastModifiedDate": "string"
   },
   "LifeCycleReviewStatus": [ "string" ],
   "LifeCycleStage": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "Sort": { 
      "SortBy": "string",
      "SortOrder": "string"
   },
   "TargetCloseDate": { 
      "AfterTargetCloseDate": "string",
      "BeforeTargetCloseDate": "string"
   }
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_ListOpportunities_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunities-request-Catalog"></a>
Specifies the catalog associated with the request. This field takes a string value from a predefined list: `AWS` or `Sandbox`. The catalog determines which environment the opportunities are listed in. Use `AWS` for listing real opportunities in the AWS catalog, and `Sandbox` for testing in secure, isolated environments.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [CreatedDate](#API_ListOpportunities_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunities-request-CreatedDate"></a>
Filter opportunities by creation date criteria.  
Type: [CreatedDateFilter](API_CreatedDateFilter.md) object  
Required: No

 ** [CustomerCompanyName](#API_ListOpportunities_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunities-request-CustomerCompanyName"></a>
Filters the opportunities based on the customer's company name. This allows partners to search for opportunities associated with a specific customer by matching the provided company name string.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [Identifier](#API_ListOpportunities_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunities-request-Identifier"></a>
Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Pattern: `O[0-9]{1,19}`   
Required: No

 ** [LastModifiedDate](#API_ListOpportunities_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunities-request-LastModifiedDate"></a>
Filters the opportunities based on their last modified date. This filter helps retrieve opportunities that were updated after the specified date, allowing partners to track recent changes or updates.  
Type: [LastModifiedDate](API_LastModifiedDate.md) object  
Required: No

 ** [LifeCycleReviewStatus](#API_ListOpportunities_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunities-request-LifeCycleReviewStatus"></a>
Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as `Pending Submission`, `In Review`, `Action Required`, or `Approved`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Valid Values: `Pending Submission | Submitted | In review | Approved | Rejected | Action Required`   
Required: No

 ** [LifeCycleStage](#API_ListOpportunities_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunities-request-LifeCycleStage"></a>
Filters the opportunities based on their lifecycle stage. This filter allows partners to retrieve opportunities at various stages in the sales cycle, such as `Qualified`, `Technical Validation`, `Business Validation`, or `Closed Won`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Valid Values: `Prospect | Qualified | Technical Validation | Business Validation | Committed | Launched | Closed Lost`   
Required: No

 ** [MaxResults](#API_ListOpportunities_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunities-request-MaxResults"></a>
Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid providing too many results at once.  
Default: 20  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListOpportunities_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunities-request-NextToken"></a>
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.  
Type: String  
Required: No

 ** [Sort](#API_ListOpportunities_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunities-request-Sort"></a>
An object that specifies how the response is sorted. The default `Sort.SortBy` value is `LastModifiedDate`.  
Type: [OpportunitySort](API_OpportunitySort.md) object  
Required: No

 ** [TargetCloseDate](#API_ListOpportunities_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunities-request-TargetCloseDate"></a>
Filters opportunities based on their target close date. This filter helps retrieve opportunities with an expected close date before or after a specified date.  
Type: [TargetCloseDateFilter](API_TargetCloseDateFilter.md) object  
Required: No

## Response Syntax


```
{
   "NextToken": "string",
   "OpportunitySummaries": [ 
      { 
         "Arn": "string",
         "Catalog": "string",
         "CreatedDate": "string",
         "Customer": { 
            "Account": { 
               "Address": { 
                  "City": "string",
                  "CountryCode": "string",
                  "PostalCode": "string",
                  "StateOrRegion": "string"
               },
               "CompanyName": "string",
               "Industry": "string",
               "OtherIndustry": "string",
               "WebsiteUrl": "string"
            }
         },
         "Id": "string",
         "LastModifiedDate": "string",
         "LifeCycle": { 
            "ClosedLostReason": "string",
            "NextSteps": "string",
            "ReviewComments": "string",
            "ReviewStatus": "string",
            "ReviewStatusReason": "string",
            "Stage": "string",
            "TargetCloseDate": "string"
         },
         "OpportunityType": "string",
         "PartnerOpportunityIdentifier": "string",
         "Project": { 
            "DeliveryModels": [ "string" ],
            "ExpectedCustomerSpend": [ 
               { 
                  "Amount": "string",
                  "CurrencyCode": "string",
                  "EstimationUrl": "string",
                  "Frequency": "string",
                  "TargetCompany": "string"
               }
            ]
         }
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [OpportunitySummaries](#API_ListOpportunities_ResponseSyntax) **   <a name="AWSPartnerCentral-ListOpportunities-response-OpportunitySummaries"></a>
An array that contains minimal details for opportunities that match the request criteria. This summary view provides a quick overview of relevant opportunities.  
Type: Array of [OpportunitySummary](API_OpportunitySummary.md) objects

 ** [NextToken](#API_ListOpportunities_ResponseSyntax) **   <a name="AWSPartnerCentral-ListOpportunities-response-NextToken"></a>
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.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/ListOpportunities) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/ListOpportunities) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/ListOpportunities) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/ListOpportunities) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/ListOpportunities) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/ListOpportunities) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/ListOpportunities) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/ListOpportunities) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/ListOpportunities) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/ListOpportunities) 

# ListOpportunityFromEngagementTasks


Lists all in-progress, completed, or failed opportunity creation tasks from engagements that were initiated by the caller's account.

## Request Syntax


```
{
   "Catalog": "string",
   "ContextIdentifier": [ "string" ],
   "EngagementIdentifier": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "OpportunityIdentifier": [ "string" ],
   "Sort": { 
      "SortBy": "string",
      "SortOrder": "string"
   },
   "TaskIdentifier": [ "string" ],
   "TaskStatus": [ "string" ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_ListOpportunityFromEngagementTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunityFromEngagementTasks-request-Catalog"></a>
Specifies the catalog related to the request. Valid values are `AWS` for production environments and `Sandbox` for testing or development purposes. The catalog determines which environment the task data is retrieved from.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ContextIdentifier](#API_ListOpportunityFromEngagementTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunityFromEngagementTasks-request-ContextIdentifier"></a>
Filters tasks by the identifiers of the engagement contexts associated with the opportunity creation. Use this to find tasks related to specific contextual information within engagements that are being converted to opportunities.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `[1-9][0-9]*`   
Required: No

 ** [EngagementIdentifier](#API_ListOpportunityFromEngagementTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunityFromEngagementTasks-request-EngagementIdentifier"></a>
Filters tasks by the identifiers of the engagements from which opportunities are being created. Use this to find all opportunity creation tasks associated with a specific engagement.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `(arn:.*|eng-[0-9a-z]{14})`   
Required: No

 ** [MaxResults](#API_ListOpportunityFromEngagementTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunityFromEngagementTasks-request-MaxResults"></a>
Specifies the maximum number of results to return in a single page of the response. Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [NextToken](#API_ListOpportunityFromEngagementTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunityFromEngagementTasks-request-NextToken"></a>
The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.  
Type: String  
Pattern: `(?s).{1,2048}`   
Required: No

 ** [OpportunityIdentifier](#API_ListOpportunityFromEngagementTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunityFromEngagementTasks-request-OpportunityIdentifier"></a>
Filters tasks by the identifiers of the opportunities they created or are associated with. Use this to find tasks related to specific opportunity creation processes.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `O[0-9]{1,19}`   
Required: No

 ** [Sort](#API_ListOpportunityFromEngagementTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunityFromEngagementTasks-request-Sort"></a>
 Defines the sorting parameters for listing tasks. This structure allows for specifying the field to sort by and the order of sorting.   
Type: [ListTasksSortBase](API_ListTasksSortBase.md) object  
Required: No

 ** [TaskIdentifier](#API_ListOpportunityFromEngagementTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunityFromEngagementTasks-request-TaskIdentifier"></a>
Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks. Provide the task ID to get details about a particular opportunity creation task.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `(arn:.*|task-[0-9a-z]{13})`   
Required: No

 ** [TaskStatus](#API_ListOpportunityFromEngagementTasks_RequestSyntax) **   <a name="AWSPartnerCentral-ListOpportunityFromEngagementTasks-request-TaskStatus"></a>
Filters the tasks based on their current status. This allows you to focus on tasks in specific states. Valid values are `COMPLETE` for tasks that have finished successfully, `INPROGRESS` for tasks that are currently running, and `FAILED` for tasks that have encountered an error and failed to complete.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 3 items.  
Valid Values: `IN_PROGRESS | COMPLETE | FAILED`   
Required: No

## Response Syntax


```
{
   "NextToken": "string",
   "TaskSummaries": [ 
      { 
         "ContextId": "string",
         "EngagementId": "string",
         "Message": "string",
         "OpportunityId": "string",
         "ReasonCode": "string",
         "ResourceSnapshotJobId": "string",
         "StartTime": "string",
         "TaskArn": "string",
         "TaskId": "string",
         "TaskStatus": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListOpportunityFromEngagementTasks_ResponseSyntax) **   <a name="AWSPartnerCentral-ListOpportunityFromEngagementTasks-response-NextToken"></a>
A token used for pagination to retrieve the next page of results. If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.  
Type: String

 ** [TaskSummaries](#API_ListOpportunityFromEngagementTasks_ResponseSyntax) **   <a name="AWSPartnerCentral-ListOpportunityFromEngagementTasks-response-TaskSummaries"></a>
An array of `ListOpportunityFromEngagementTaskSummary` objects, each representing a task that matches the specified filters. The array may be empty if no tasks match the criteria.  
Type: Array of [ListOpportunityFromEngagementTaskSummary](API_ListOpportunityFromEngagementTaskSummary.md) objects

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/ListOpportunityFromEngagementTasks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/ListOpportunityFromEngagementTasks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/ListOpportunityFromEngagementTasks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/ListOpportunityFromEngagementTasks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/ListOpportunityFromEngagementTasks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/ListOpportunityFromEngagementTasks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/ListOpportunityFromEngagementTasks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/ListOpportunityFromEngagementTasks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/ListOpportunityFromEngagementTasks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/ListOpportunityFromEngagementTasks) 

# ListResourceSnapshotJobs


 Lists resource snapshot jobs owned by the customer. This operation supports various filtering scenarios, including listing all jobs owned by the caller, jobs for a specific engagement, jobs with a specific status, or any combination of these filters. 

## Request Syntax


```
{
   "Catalog": "string",
   "EngagementIdentifier": "string",
   "MaxResults": number,
   "NextToken": "string",
   "Sort": { 
      "SortBy": "string",
      "SortOrder": "string"
   },
   "Status": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_ListResourceSnapshotJobs_RequestSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshotJobs-request-Catalog"></a>
 Specifies the catalog related to the request.   
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [EngagementIdentifier](#API_ListResourceSnapshotJobs_RequestSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshotJobs-request-EngagementIdentifier"></a>
 The identifier of the engagement to filter the response.   
Type: String  
Pattern: `eng-[0-9a-z]{14}`   
Required: No

 ** [MaxResults](#API_ListResourceSnapshotJobs_RequestSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshotJobs-request-MaxResults"></a>
 The maximum number of results to return in a single call. If omitted, defaults to 50.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [NextToken](#API_ListResourceSnapshotJobs_RequestSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshotJobs-request-NextToken"></a>
 The token for the next set of results.   
Type: String  
Required: No

 ** [Sort](#API_ListResourceSnapshotJobs_RequestSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshotJobs-request-Sort"></a>
 Configures the sorting of the response. If omitted, results are sorted by `CreatedDate` in descending order.   
Type: [SortObject](API_SortObject.md) object  
Required: No

 ** [Status](#API_ListResourceSnapshotJobs_RequestSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshotJobs-request-Status"></a>
 The status of the jobs to filter the response.   
Type: String  
Valid Values: `Running | Stopped`   
Required: No

## Response Syntax


```
{
   "NextToken": "string",
   "ResourceSnapshotJobSummaries": [ 
      { 
         "Arn": "string",
         "EngagementId": "string",
         "Id": "string",
         "Status": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ResourceSnapshotJobSummaries](#API_ListResourceSnapshotJobs_ResponseSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshotJobs-response-ResourceSnapshotJobSummaries"></a>
 An array of resource snapshot job summary objects.   
Type: Array of [ResourceSnapshotJobSummary](API_ResourceSnapshotJobSummary.md) objects

 ** [NextToken](#API_ListResourceSnapshotJobs_ResponseSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshotJobs-response-NextToken"></a>
 The token to retrieve the next set of results. If there are no additional results, this value is null.   
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/ListResourceSnapshotJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/ListResourceSnapshotJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/ListResourceSnapshotJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/ListResourceSnapshotJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/ListResourceSnapshotJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/ListResourceSnapshotJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/ListResourceSnapshotJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/ListResourceSnapshotJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/ListResourceSnapshotJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/ListResourceSnapshotJobs) 

# ListResourceSnapshots


Retrieves a list of resource view snapshots based on specified criteria. This operation supports various use cases, including: 
+ Fetching all snapshots associated with an engagement.
+ Retrieving snapshots of a specific resource type within an engagement.
+ Obtaining snapshots for a particular resource using a specified template.
+ Accessing the latest snapshot of a resource within an engagement.
+ Filtering snapshots by resource owner.

## Request Syntax


```
{
   "Catalog": "string",
   "CreatedBy": "string",
   "EngagementIdentifier": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ResourceIdentifier": "string",
   "ResourceSnapshotTemplateIdentifier": "string",
   "ResourceType": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_ListResourceSnapshots_RequestSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshots-request-Catalog"></a>
 Specifies the catalog related to the request.   
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [EngagementIdentifier](#API_ListResourceSnapshots_RequestSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshots-request-EngagementIdentifier"></a>
 The unique identifier of the engagement associated with the snapshots.   
Type: String  
Pattern: `eng-[0-9a-z]{14}`   
Required: Yes

 ** [CreatedBy](#API_ListResourceSnapshots_RequestSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshots-request-CreatedBy"></a>
Filters the response to include only snapshots of resources owned by the specified AWS account.   
Type: String  
Pattern: `([0-9]{12}|\w{1,12})`   
Required: No

 ** [MaxResults](#API_ListResourceSnapshots_RequestSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshots-request-MaxResults"></a>
 The maximum number of results to return in a single call.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [NextToken](#API_ListResourceSnapshots_RequestSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshots-request-NextToken"></a>
 The token for the next set of results.   
Type: String  
Required: No

 ** [ResourceIdentifier](#API_ListResourceSnapshots_RequestSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshots-request-ResourceIdentifier"></a>
 Filters the response to include only snapshots of the specified resource.   
Type: String  
Pattern: `O[0-9]{1,19}`   
Required: No

 ** [ResourceSnapshotTemplateIdentifier](#API_ListResourceSnapshots_RequestSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshots-request-ResourceSnapshotTemplateIdentifier"></a>
Filters the response to include only snapshots created using the specified template.  
Type: String  
Pattern: `[a-zA-Z0-9]{3,80}`   
Required: No

 ** [ResourceType](#API_ListResourceSnapshots_RequestSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshots-request-ResourceType"></a>
 Filters the response to include only snapshots of the specified resource type.   
Type: String  
Valid Values: `Opportunity`   
Required: No

## Response Syntax


```
{
   "NextToken": "string",
   "ResourceSnapshotSummaries": [ 
      { 
         "Arn": "string",
         "CreatedBy": "string",
         "ResourceId": "string",
         "ResourceSnapshotTemplateName": "string",
         "ResourceType": "string",
         "Revision": number
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ResourceSnapshotSummaries](#API_ListResourceSnapshots_ResponseSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshots-response-ResourceSnapshotSummaries"></a>
 An array of resource snapshot summary objects.   
Type: Array of [ResourceSnapshotSummary](API_ResourceSnapshotSummary.md) objects

 ** [NextToken](#API_ListResourceSnapshots_ResponseSyntax) **   <a name="AWSPartnerCentral-ListResourceSnapshots-response-NextToken"></a>
 The token to retrieve the next set of results. If there are no additional results, this value is null.   
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/ListResourceSnapshots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/ListResourceSnapshots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/ListResourceSnapshots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/ListResourceSnapshots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/ListResourceSnapshots) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/ListResourceSnapshots) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/ListResourceSnapshots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/ListResourceSnapshots) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/ListResourceSnapshots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/ListResourceSnapshots) 

# ListSolutions


Retrieves a list of Partner Solutions that the partner registered on Partner Central. This API is used to generate a list of solutions that an end user selects from for association with an opportunity.

## Request Syntax


```
{
   "Catalog": "string",
   "Category": [ "string" ],
   "Identifier": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "Sort": { 
      "SortBy": "string",
      "SortOrder": "string"
   },
   "Status": [ "string" ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_ListSolutions_RequestSyntax) **   <a name="AWSPartnerCentral-ListSolutions-request-Catalog"></a>
Specifies the catalog associated with the request. This field takes a string value from a predefined list: `AWS` or `Sandbox`. The catalog determines which environment the solutions are listed in. Use `AWS` to list solutions in the AWS catalog, and `Sandbox` to list solutions in a secure and isolated testing environment.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [Category](#API_ListSolutions_RequestSyntax) **   <a name="AWSPartnerCentral-ListSolutions-request-Category"></a>
Filters the solutions based on the category to which they belong. This allows partners to search for solutions within specific categories, such as `Software`, `Consulting`, or `Managed Services`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [Identifier](#API_ListSolutions_RequestSyntax) **   <a name="AWSPartnerCentral-ListSolutions-request-Identifier"></a>
Filters the solutions based on their unique identifier. Use this filter to retrieve specific solutions by providing the solution's identifier for accurate results.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Pattern: `S-[0-9]{1,19}`   
Required: No

 ** [MaxResults](#API_ListSolutions_RequestSyntax) **   <a name="AWSPartnerCentral-ListSolutions-request-MaxResults"></a>
The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results.  
Default: 20  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListSolutions_RequestSyntax) **   <a name="AWSPartnerCentral-ListSolutions-request-NextToken"></a>
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.  
Type: String  
Required: No

 ** [Sort](#API_ListSolutions_RequestSyntax) **   <a name="AWSPartnerCentral-ListSolutions-request-Sort"></a>
Object that configures sorting done on the response. Default `Sort.SortBy` is `Identifier`.  
Type: [SolutionSort](API_SolutionSort.md) object  
Required: No

 ** [Status](#API_ListSolutions_RequestSyntax) **   <a name="AWSPartnerCentral-ListSolutions-request-Status"></a>
Filters solutions based on their status. This filter helps partners manage their solution portfolios effectively.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Valid Values: `Active | Inactive | Draft`   
Required: No

## Response Syntax


```
{
   "NextToken": "string",
   "SolutionSummaries": [ 
      { 
         "Arn": "string",
         "Catalog": "string",
         "Category": "string",
         "CreatedDate": "string",
         "Id": "string",
         "Name": "string",
         "Status": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SolutionSummaries](#API_ListSolutions_ResponseSyntax) **   <a name="AWSPartnerCentral-ListSolutions-response-SolutionSummaries"></a>
An array with minimal details for solutions matching the request criteria.  
Type: Array of [SolutionBase](API_SolutionBase.md) objects

 ** [NextToken](#API_ListSolutions_ResponseSyntax) **   <a name="AWSPartnerCentral-ListSolutions-response-NextToken"></a>
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.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/ListSolutions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/ListSolutions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/ListSolutions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/ListSolutions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/ListSolutions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/ListSolutions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/ListSolutions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/ListSolutions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/ListSolutions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/ListSolutions) 

# ListTagsForResource


Returns a list of tags for a resource.

## Request Syntax


```
{
   "ResourceArn": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="AWSPartnerCentral-ListTagsForResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.  
Type: String  
Pattern: `(?=.{1,1000}$)arn:[\w+=/,.@-]+:partnercentral:[\w+=/,.@-]*:[0-9]{12}:catalog/([a-zA-Z]+)/[\w+=,.@-]+(/[\w+=,.@-]+)*`   
Required: Yes

## Response Syntax


```
{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="AWSPartnerCentral-ListTagsForResource-response-Tags"></a>
A map of the key-value pairs for the tag or tags assigned to the specified resource.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/ListTagsForResource) 

# PutSellingSystemSettings


Updates the currently set system settings, which include the IAM Role used for resource snapshot jobs.

## Request Syntax


```
{
   "Catalog": "string",
   "ResourceSnapshotJobRoleIdentifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_PutSellingSystemSettings_RequestSyntax) **   <a name="AWSPartnerCentral-PutSellingSystemSettings-request-Catalog"></a>
Specifies the catalog in which the settings will be updated. Acceptable values include `AWS` for production and `Sandbox` for testing environments.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ResourceSnapshotJobRoleIdentifier](#API_PutSellingSystemSettings_RequestSyntax) **   <a name="AWSPartnerCentral-PutSellingSystemSettings-request-ResourceSnapshotJobRoleIdentifier"></a>
Specifies the ARN of the IAM Role used for resource snapshot job executions.  
Type: String  
Pattern: `(?=.{0,2048}$)(arn:aws:iam::\d{12}:role/([-+=,.@_a-zA-Z0-9]+/)*)?[-+=,.@_a-zA-Z0-9]{1,64}`   
Required: No

## Response Syntax


```
{
   "Catalog": "string",
   "ResourceSnapshotJobRoleArn": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Catalog](#API_PutSellingSystemSettings_ResponseSyntax) **   <a name="AWSPartnerCentral-PutSellingSystemSettings-response-Catalog"></a>
Specifies the catalog in which the settings are defined. Acceptable values include `AWS` for production and `Sandbox` for testing environments.  
Type: String  
Pattern: `[a-zA-Z]+` 

 ** [ResourceSnapshotJobRoleArn](#API_PutSellingSystemSettings_ResponseSyntax) **   <a name="AWSPartnerCentral-PutSellingSystemSettings-response-ResourceSnapshotJobRoleArn"></a>
Specifies the ARN of the IAM Role used for resource snapshot job executions.  
Type: String  
Pattern: `(?=.{0,2048}$)arn:aws:iam::\d{12}:role/([-+=,.@_a-zA-Z0-9]+/)*[-+=,.@_a-zA-Z0-9]{1,64}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/PutSellingSystemSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/PutSellingSystemSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/PutSellingSystemSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/PutSellingSystemSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/PutSellingSystemSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/PutSellingSystemSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/PutSellingSystemSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/PutSellingSystemSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/PutSellingSystemSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/PutSellingSystemSettings) 

# RejectEngagementInvitation


This action rejects an `EngagementInvitation` that AWS shared. Rejecting an invitation indicates that the partner doesn't want to pursue the opportunity, and all related data will become inaccessible thereafter.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string",
   "RejectionReason": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_RejectEngagementInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-RejectEngagementInvitation-request-Catalog"></a>
This is the catalog that's associated with the engagement invitation. Acceptable values are `AWS` or `Sandbox`, and these values determine the environment in which the opportunity is managed.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [Identifier](#API_RejectEngagementInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-RejectEngagementInvitation-request-Identifier"></a>
This is the unique identifier of the rejected `EngagementInvitation`. Providing the correct identifier helps to ensure that the intended invitation is rejected.  
Type: String  
Pattern: `(?=.{1,255}$)(arn:.*|engi-[0-9a-z]{13})`   
Required: Yes

 ** [RejectionReason](#API_RejectEngagementInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-RejectEngagementInvitation-request-RejectionReason"></a>
This describes the reason for rejecting the engagement invitation, which helps AWS track usage patterns. Acceptable values include the following:  
+  *Customer problem unclear:* The customer's problem isn't understood.
+  *Next steps unclear:* The next steps required to proceed aren't understood.
+  *Unable to support:* The partner is unable to provide support due to resource or capability constraints.
+  *Duplicate of partner referral:* The opportunity is a duplicate of an existing referral.
+  *Other:* Any reason not covered by other values.
Type: String  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]{1,80}`   
Required: No

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/RejectEngagementInvitation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/RejectEngagementInvitation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/RejectEngagementInvitation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/RejectEngagementInvitation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/RejectEngagementInvitation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/RejectEngagementInvitation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/RejectEngagementInvitation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/RejectEngagementInvitation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/RejectEngagementInvitation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/RejectEngagementInvitation) 

# StartEngagementByAcceptingInvitationTask


This action starts the engagement by accepting an `EngagementInvitation`. The task is asynchronous and involves the following steps: accepting the invitation, creating an opportunity in the partner’s account from the AWS opportunity, and copying details for tracking. When completed, an `Opportunity Created` event is generated, indicating that the opportunity has been successfully created in the partner's account.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "Identifier": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_StartEngagementByAcceptingInvitationTask_RequestSyntax) **   <a name="AWSPartnerCentral-StartEngagementByAcceptingInvitationTask-request-Catalog"></a>
Specifies the catalog related to the task. Use `AWS` for production engagements and `Sandbox` for testing scenarios.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ClientToken](#API_StartEngagementByAcceptingInvitationTask_RequestSyntax) **   <a name="AWSPartnerCentral-StartEngagementByAcceptingInvitationTask-request-ClientToken"></a>
A unique, case-sensitive identifier provided by the client that helps to ensure the idempotency of the request. This can be a random or meaningful string but must be unique for each request.  
Type: String  
Pattern: `.{1,255}`   
Required: Yes

 ** [Identifier](#API_StartEngagementByAcceptingInvitationTask_RequestSyntax) **   <a name="AWSPartnerCentral-StartEngagementByAcceptingInvitationTask-request-Identifier"></a>
Specifies the unique identifier of the `EngagementInvitation` to be accepted. Providing the correct identifier helps ensure that the correct engagement is processed.  
Type: String  
Pattern: `(?=.{1,255}$)(arn:.*|engi-[0-9a-z]{13})`   
Required: Yes

 ** [Tags](#API_StartEngagementByAcceptingInvitationTask_RequestSyntax) **   <a name="AWSPartnerCentral-StartEngagementByAcceptingInvitationTask-request-Tags"></a>
A map of the key-value pairs of the tag or tags to assign.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: No

## Response Syntax


```
{
   "EngagementInvitationId": "string",
   "Message": "string",
   "OpportunityId": "string",
   "ReasonCode": "string",
   "ResourceSnapshotJobId": "string",
   "StartTime": "string",
   "TaskArn": "string",
   "TaskId": "string",
   "TaskStatus": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EngagementInvitationId](#API_StartEngagementByAcceptingInvitationTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementByAcceptingInvitationTask-response-EngagementInvitationId"></a>
Returns the identifier of the engagement invitation that was accepted and used to create the opportunity.  
Type: String  
Pattern: `engi-[0-9,a-z]{13}` 

 ** [Message](#API_StartEngagementByAcceptingInvitationTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementByAcceptingInvitationTask-response-Message"></a>
If the task fails, this field contains a detailed message describing the failure and possible recovery steps.  
Type: String

 ** [OpportunityId](#API_StartEngagementByAcceptingInvitationTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementByAcceptingInvitationTask-response-OpportunityId"></a>
Returns the original opportunity identifier passed in the request. This is the unique identifier for the opportunity.  
Type: String  
Pattern: `O[0-9]{1,19}` 

 ** [ReasonCode](#API_StartEngagementByAcceptingInvitationTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementByAcceptingInvitationTask-response-ReasonCode"></a>
Indicates the reason for task failure using an enumerated code.  
Type: String  
Valid Values: `InvitationAccessDenied | InvitationValidationFailed | EngagementAccessDenied | OpportunityAccessDenied | ResourceSnapshotJobAccessDenied | ResourceSnapshotJobValidationFailed | ResourceSnapshotJobConflict | EngagementValidationFailed | EngagementConflict | OpportunitySubmissionFailed | EngagementInvitationConflict | InternalError | OpportunityValidationFailed | OpportunityConflict | ResourceSnapshotAccessDenied | ResourceSnapshotValidationFailed | ResourceSnapshotConflict | ServiceQuotaExceeded | RequestThrottled | ContextNotFound | CustomerProjectContextNotPermitted | DisqualifiedLeadNotPermitted` 

 ** [ResourceSnapshotJobId](#API_StartEngagementByAcceptingInvitationTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementByAcceptingInvitationTask-response-ResourceSnapshotJobId"></a>
The identifier of the Resource Snapshot Job created as part of this task.  
Type: String  
Pattern: `job-[0-9a-z]{13}` 

 ** [StartTime](#API_StartEngagementByAcceptingInvitationTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementByAcceptingInvitationTask-response-StartTime"></a>
The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.  
Type: Timestamp

 ** [TaskArn](#API_StartEngagementByAcceptingInvitationTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementByAcceptingInvitationTask-response-TaskArn"></a>
The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.  
Type: String  
Pattern: `arn:.*` 

 ** [TaskId](#API_StartEngagementByAcceptingInvitationTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementByAcceptingInvitationTask-response-TaskId"></a>
The unique identifier of the task, used to track the task’s progress.  
Type: String  
Pattern: `.*task-[0-9a-z]{13}` 

 ** [TaskStatus](#API_StartEngagementByAcceptingInvitationTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementByAcceptingInvitationTask-response-TaskStatus"></a>
Indicates the current status of the task.  
Type: String  
Valid Values: `IN_PROGRESS | COMPLETE | FAILED` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.  
Suggested action: Review the [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) for the resource, and either reduce usage or request a quota increase.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/StartEngagementByAcceptingInvitationTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/StartEngagementByAcceptingInvitationTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/StartEngagementByAcceptingInvitationTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/StartEngagementByAcceptingInvitationTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/StartEngagementByAcceptingInvitationTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/StartEngagementByAcceptingInvitationTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/StartEngagementByAcceptingInvitationTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/StartEngagementByAcceptingInvitationTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/StartEngagementByAcceptingInvitationTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/StartEngagementByAcceptingInvitationTask) 

# StartEngagementFromOpportunityTask


Similar to `StartEngagementByAcceptingInvitationTask`, this action is asynchronous and performs multiple steps before completion. This action orchestrates a comprehensive workflow that combines multiple API operations into a single task to create and initiate an engagement from an existing opportunity. It automatically executes a sequence of operations including `GetOpportunity`, `CreateEngagement` (if it doesn't exist), `CreateResourceSnapshot`, `CreateResourceSnapshotJob`, `CreateEngagementInvitation` (if not already invited/accepted), and `SubmitOpportunity`. 

## Request Syntax


```
{
   "AwsSubmission": { 
      "InvolvementType": "string",
      "Visibility": "string"
   },
   "Catalog": "string",
   "ClientToken": "string",
   "Identifier": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [AwsSubmission](#API_StartEngagementFromOpportunityTask_RequestSyntax) **   <a name="AWSPartnerCentral-StartEngagementFromOpportunityTask-request-AwsSubmission"></a>
Indicates the level of AWS involvement in the opportunity. This field helps track AWS participation throughout the engagement, such as providing technical support, deal assistance, and sales support.  
Type: [AwsSubmission](API_AwsSubmission.md) object  
Required: Yes

 ** [Catalog](#API_StartEngagementFromOpportunityTask_RequestSyntax) **   <a name="AWSPartnerCentral-StartEngagementFromOpportunityTask-request-Catalog"></a>
Specifies the catalog in which the engagement is tracked. Acceptable values include `AWS` for production and `Sandbox` for testing environments.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ClientToken](#API_StartEngagementFromOpportunityTask_RequestSyntax) **   <a name="AWSPartnerCentral-StartEngagementFromOpportunityTask-request-ClientToken"></a>
A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.  
Type: String  
Pattern: `.{1,255}`   
Required: Yes

 ** [Identifier](#API_StartEngagementFromOpportunityTask_RequestSyntax) **   <a name="AWSPartnerCentral-StartEngagementFromOpportunityTask-request-Identifier"></a>
The unique identifier of the opportunity from which the engagement task is to be initiated. This helps ensure that the task is applied to the correct opportunity.  
Type: String  
Pattern: `O[0-9]{1,19}`   
Required: Yes

 ** [Tags](#API_StartEngagementFromOpportunityTask_RequestSyntax) **   <a name="AWSPartnerCentral-StartEngagementFromOpportunityTask-request-Tags"></a>
A map of the key-value pairs of the tag or tags to assign.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: No

## Response Syntax


```
{
   "EngagementId": "string",
   "EngagementInvitationId": "string",
   "Message": "string",
   "OpportunityId": "string",
   "ReasonCode": "string",
   "ResourceSnapshotJobId": "string",
   "StartTime": "string",
   "TaskArn": "string",
   "TaskId": "string",
   "TaskStatus": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EngagementId](#API_StartEngagementFromOpportunityTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementFromOpportunityTask-response-EngagementId"></a>
The identifier of the newly created Engagement. Only populated if TaskStatus is COMPLETE.  
Type: String  
Pattern: `eng-[0-9a-z]{14}` 

 ** [EngagementInvitationId](#API_StartEngagementFromOpportunityTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementFromOpportunityTask-response-EngagementInvitationId"></a>
The identifier of the new Engagement invitation. Only populated if TaskStatus is COMPLETE.  
Type: String  
Pattern: `engi-[0-9,a-z]{13}` 

 ** [Message](#API_StartEngagementFromOpportunityTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementFromOpportunityTask-response-Message"></a>
If the task fails, this field contains a detailed message describing the failure and possible recovery steps.  
Type: String

 ** [OpportunityId](#API_StartEngagementFromOpportunityTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementFromOpportunityTask-response-OpportunityId"></a>
Returns the original opportunity identifier passed in the request, which is the unique identifier for the opportunity created in the partner’s system.  
Type: String  
Pattern: `O[0-9]{1,19}` 

 ** [ReasonCode](#API_StartEngagementFromOpportunityTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementFromOpportunityTask-response-ReasonCode"></a>
Indicates the reason for task failure using an enumerated code.  
Type: String  
Valid Values: `InvitationAccessDenied | InvitationValidationFailed | EngagementAccessDenied | OpportunityAccessDenied | ResourceSnapshotJobAccessDenied | ResourceSnapshotJobValidationFailed | ResourceSnapshotJobConflict | EngagementValidationFailed | EngagementConflict | OpportunitySubmissionFailed | EngagementInvitationConflict | InternalError | OpportunityValidationFailed | OpportunityConflict | ResourceSnapshotAccessDenied | ResourceSnapshotValidationFailed | ResourceSnapshotConflict | ServiceQuotaExceeded | RequestThrottled | ContextNotFound | CustomerProjectContextNotPermitted | DisqualifiedLeadNotPermitted` 

 ** [ResourceSnapshotJobId](#API_StartEngagementFromOpportunityTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementFromOpportunityTask-response-ResourceSnapshotJobId"></a>
The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement. Only populated if TaskStatus is COMPLETE  
Type: String  
Pattern: `job-[0-9a-z]{13}` 

 ** [StartTime](#API_StartEngagementFromOpportunityTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementFromOpportunityTask-response-StartTime"></a>
The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.  
Type: Timestamp

 ** [TaskArn](#API_StartEngagementFromOpportunityTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementFromOpportunityTask-response-TaskArn"></a>
The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.  
Type: String  
Pattern: `arn:.*` 

 ** [TaskId](#API_StartEngagementFromOpportunityTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementFromOpportunityTask-response-TaskId"></a>
The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: `^oit-[0-9a-z]{13}$`.  
Type: String  
Pattern: `.*task-[0-9a-z]{13}` 

 ** [TaskStatus](#API_StartEngagementFromOpportunityTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartEngagementFromOpportunityTask-response-TaskStatus"></a>
Indicates the current status of the task. Valid values include `IN_PROGRESS`, `COMPLETE`, and `FAILED`.  
Type: String  
Valid Values: `IN_PROGRESS | COMPLETE | FAILED` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.  
Suggested action: Review the [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) for the resource, and either reduce usage or request a quota increase.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/StartEngagementFromOpportunityTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/StartEngagementFromOpportunityTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/StartEngagementFromOpportunityTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/StartEngagementFromOpportunityTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/StartEngagementFromOpportunityTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/StartEngagementFromOpportunityTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/StartEngagementFromOpportunityTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/StartEngagementFromOpportunityTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/StartEngagementFromOpportunityTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/StartEngagementFromOpportunityTask) 

# StartOpportunityFromEngagementTask


This action creates an opportunity from an existing engagement context. The task is asynchronous and orchestrates the process of converting engagement contextual information into a structured opportunity record within the partner's account.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "ContextIdentifier": "string",
   "Identifier": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_StartOpportunityFromEngagementTask_RequestSyntax) **   <a name="AWSPartnerCentral-StartOpportunityFromEngagementTask-request-Catalog"></a>
Specifies the catalog in which the opportunity creation task is executed. Acceptable values include `AWS` for production and `Sandbox` for testing environments.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ClientToken](#API_StartOpportunityFromEngagementTask_RequestSyntax) **   <a name="AWSPartnerCentral-StartOpportunityFromEngagementTask-request-ClientToken"></a>
A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.  
Type: String  
Pattern: `.{1,255}`   
Required: Yes

 ** [ContextIdentifier](#API_StartOpportunityFromEngagementTask_RequestSyntax) **   <a name="AWSPartnerCentral-StartOpportunityFromEngagementTask-request-ContextIdentifier"></a>
The unique identifier of the engagement context from which to create the opportunity. This specifies the specific contextual information within the engagement that will be used for opportunity creation.  
Type: String  
Pattern: `[1-9][0-9]*`   
Required: Yes

 ** [Identifier](#API_StartOpportunityFromEngagementTask_RequestSyntax) **   <a name="AWSPartnerCentral-StartOpportunityFromEngagementTask-request-Identifier"></a>
The unique identifier of the engagement from which the opportunity creation task is to be initiated. This helps ensure that the task is applied to the correct engagement.  
Type: String  
Pattern: `(arn:.*|eng-[0-9a-z]{14})`   
Required: Yes

 ** [Tags](#API_StartOpportunityFromEngagementTask_RequestSyntax) **   <a name="AWSPartnerCentral-StartOpportunityFromEngagementTask-request-Tags"></a>
A map of the key-value pairs of the tag or tags to assign.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: No

## Response Syntax


```
{
   "ContextId": "string",
   "EngagementId": "string",
   "Message": "string",
   "OpportunityId": "string",
   "ReasonCode": "string",
   "ResourceSnapshotJobId": "string",
   "StartTime": "string",
   "TaskArn": "string",
   "TaskId": "string",
   "TaskStatus": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContextId](#API_StartOpportunityFromEngagementTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartOpportunityFromEngagementTask-response-ContextId"></a>
The unique identifier of the engagement context used to create the opportunity.  
Type: String  
Pattern: `[1-9][0-9]*` 

 ** [EngagementId](#API_StartOpportunityFromEngagementTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartOpportunityFromEngagementTask-response-EngagementId"></a>
The unique identifier of the engagement from which the opportunity was created.  
Type: String  
Pattern: `eng-[0-9a-z]{14}` 

 ** [Message](#API_StartOpportunityFromEngagementTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartOpportunityFromEngagementTask-response-Message"></a>
If the task fails, this field contains a detailed message describing the failure and possible recovery steps.  
Type: String

 ** [OpportunityId](#API_StartOpportunityFromEngagementTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartOpportunityFromEngagementTask-response-OpportunityId"></a>
The unique identifier of the opportunity created as a result of the task. This field is populated when the task is completed successfully.  
Type: String  
Pattern: `O[0-9]{1,19}` 

 ** [ReasonCode](#API_StartOpportunityFromEngagementTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartOpportunityFromEngagementTask-response-ReasonCode"></a>
Indicates the reason for task failure using an enumerated code.  
Type: String  
Valid Values: `InvitationAccessDenied | InvitationValidationFailed | EngagementAccessDenied | OpportunityAccessDenied | ResourceSnapshotJobAccessDenied | ResourceSnapshotJobValidationFailed | ResourceSnapshotJobConflict | EngagementValidationFailed | EngagementConflict | OpportunitySubmissionFailed | EngagementInvitationConflict | InternalError | OpportunityValidationFailed | OpportunityConflict | ResourceSnapshotAccessDenied | ResourceSnapshotValidationFailed | ResourceSnapshotConflict | ServiceQuotaExceeded | RequestThrottled | ContextNotFound | CustomerProjectContextNotPermitted | DisqualifiedLeadNotPermitted` 

 ** [ResourceSnapshotJobId](#API_StartOpportunityFromEngagementTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartOpportunityFromEngagementTask-response-ResourceSnapshotJobId"></a>
The identifier of the resource snapshot job created as part of the opportunity creation process.  
Type: String  
Pattern: `job-[0-9a-z]{13}` 

 ** [StartTime](#API_StartOpportunityFromEngagementTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartOpportunityFromEngagementTask-response-StartTime"></a>
The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.  
Type: Timestamp

 ** [TaskArn](#API_StartOpportunityFromEngagementTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartOpportunityFromEngagementTask-response-TaskArn"></a>
The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.  
Type: String  
Pattern: `arn:.*` 

 ** [TaskId](#API_StartOpportunityFromEngagementTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartOpportunityFromEngagementTask-response-TaskId"></a>
The unique identifier of the task, used to track the task's progress.  
Type: String  
Pattern: `.*task-[0-9a-z]{13}` 

 ** [TaskStatus](#API_StartOpportunityFromEngagementTask_ResponseSyntax) **   <a name="AWSPartnerCentral-StartOpportunityFromEngagementTask-response-TaskStatus"></a>
Indicates the current status of the task.  
Type: String  
Valid Values: `IN_PROGRESS | COMPLETE | FAILED` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.  
Suggested action: Review the [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) for the resource, and either reduce usage or request a quota increase.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/StartOpportunityFromEngagementTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/StartOpportunityFromEngagementTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/StartOpportunityFromEngagementTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/StartOpportunityFromEngagementTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/StartOpportunityFromEngagementTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/StartOpportunityFromEngagementTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/StartOpportunityFromEngagementTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/StartOpportunityFromEngagementTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/StartOpportunityFromEngagementTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/StartOpportunityFromEngagementTask) 

# StartResourceSnapshotJob


Starts a resource snapshot job that has been previously created.

## Request Syntax


```
{
   "Catalog": "string",
   "ResourceSnapshotJobIdentifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_StartResourceSnapshotJob_RequestSyntax) **   <a name="AWSPartnerCentral-StartResourceSnapshotJob-request-Catalog"></a>
Specifies the catalog related to the request. Valid values are:  
+ AWS: Starts the request from the production AWS environment.
+ Sandbox: Starts the request from a sandbox environment used for testing or development purposes.
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ResourceSnapshotJobIdentifier](#API_StartResourceSnapshotJob_RequestSyntax) **   <a name="AWSPartnerCentral-StartResourceSnapshotJob-request-ResourceSnapshotJobIdentifier"></a>
The identifier of the resource snapshot job to start.  
Type: String  
Pattern: `job-[0-9a-z]{13}`   
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/StartResourceSnapshotJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/StartResourceSnapshotJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/StartResourceSnapshotJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/StartResourceSnapshotJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/StartResourceSnapshotJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/StartResourceSnapshotJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/StartResourceSnapshotJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/StartResourceSnapshotJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/StartResourceSnapshotJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/StartResourceSnapshotJob) 

# StopResourceSnapshotJob


Stops a resource snapshot job. The job must be started prior to being stopped.

## Request Syntax


```
{
   "Catalog": "string",
   "ResourceSnapshotJobIdentifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_StopResourceSnapshotJob_RequestSyntax) **   <a name="AWSPartnerCentral-StopResourceSnapshotJob-request-Catalog"></a>
Specifies the catalog related to the request. Valid values are:  
+ AWS: Stops the request from the production AWS environment.
+ Sandbox: Stops the request from a sandbox environment used for testing or development purposes.
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ResourceSnapshotJobIdentifier](#API_StopResourceSnapshotJob_RequestSyntax) **   <a name="AWSPartnerCentral-StopResourceSnapshotJob-request-ResourceSnapshotJobIdentifier"></a>
The identifier of the job to stop.  
Type: String  
Pattern: `job-[0-9a-z]{13}`   
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/StopResourceSnapshotJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/StopResourceSnapshotJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/StopResourceSnapshotJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/StopResourceSnapshotJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/StopResourceSnapshotJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/StopResourceSnapshotJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/StopResourceSnapshotJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/StopResourceSnapshotJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/StopResourceSnapshotJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/StopResourceSnapshotJob) 

# SubmitOpportunity


Use this action to submit an Opportunity that was previously created by partner for AWS review. After you perform this action, the Opportunity becomes non-editable until it is reviewed by AWS and has ` LifeCycle.ReviewStatus ` as either `Approved` or `Action Required`. 

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string",
   "InvolvementType": "string",
   "Visibility": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_SubmitOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-SubmitOpportunity-request-Catalog"></a>
Specifies the catalog related to the request. Valid values are:  
+ AWS: Submits the opportunity request from the production AWS environment.
+ Sandbox: Submits the opportunity request from a sandbox environment used for testing or development purposes.
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [Identifier](#API_SubmitOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-SubmitOpportunity-request-Identifier"></a>
The identifier of the Opportunity previously created by partner and needs to be submitted.  
Type: String  
Pattern: `O[0-9]{1,19}`   
Required: Yes

 ** [InvolvementType](#API_SubmitOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-SubmitOpportunity-request-InvolvementType"></a>
Specifies the level of AWS sellers' involvement on the opportunity. Valid values:  
+  `Co-sell`: Indicates the user wants to co-sell with AWS. Share the opportunity with AWS to receive deal assistance and support.
+  `For Visibility Only`: Indicates that the user does not need support from AWS Sales Rep. Share this opportunity with AWS for visibility only, you will not receive deal assistance and support.
Type: String  
Valid Values: `For Visibility Only | Co-Sell`   
Required: Yes

 ** [Visibility](#API_SubmitOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-SubmitOpportunity-request-Visibility"></a>
Determines whether to restrict visibility of the opportunity from AWS sales. Default value is Full. Valid values:  
+  `Full`: The opportunity is fully visible to AWS sales.
+  `Limited`: The opportunity has restricted visibility to AWS sales.
Type: String  
Valid Values: `Full | Limited`   
Required: No

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/SubmitOpportunity) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/SubmitOpportunity) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/SubmitOpportunity) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/SubmitOpportunity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/SubmitOpportunity) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/SubmitOpportunity) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/SubmitOpportunity) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/SubmitOpportunity) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/SubmitOpportunity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/SubmitOpportunity) 

# TagResource


Assigns one or more tags (key-value pairs) to the specified resource.

## Request Syntax


```
{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="AWSPartnerCentral-TagResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource that you want to tag.  
Type: String  
Pattern: `(?=.{1,1000}$)arn:[\w+=/,.@-]+:partnercentral:[\w+=/,.@-]*:[0-9]{12}:catalog/([a-zA-Z]+)/[\w+=,.@-]+(/[\w+=,.@-]+)*`   
Required: Yes

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="AWSPartnerCentral-TagResource-request-Tags"></a>
A map of the key-value pairs of the tag or tags to assign.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/TagResource) 

# UntagResource


Removes a tag or tags from a resource.

## Request Syntax


```
{
   "ResourceArn": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="AWSPartnerCentral-UntagResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource that you want to untag.  
Type: String  
Pattern: `(?=.{1,1000}$)arn:[\w+=/,.@-]+:partnercentral:[\w+=/,.@-]*:[0-9]{12}:catalog/([a-zA-Z]+)/[\w+=,.@-]+(/[\w+=,.@-]+)*`   
Required: Yes

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="AWSPartnerCentral-UntagResource-request-TagKeys"></a>
The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Pattern: `(?=.{1,128}$)([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/UntagResource) 

# UpdateEngagementContext


Updates the context information for an existing engagement with new or modified data.

## Request Syntax


```
{
   "Catalog": "string",
   "ContextIdentifier": "string",
   "EngagementIdentifier": "string",
   "EngagementLastModifiedAt": "string",
   "Payload": { ... },
   "Type": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_UpdateEngagementContext_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateEngagementContext-request-Catalog"></a>
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.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ContextIdentifier](#API_UpdateEngagementContext_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateEngagementContext-request-ContextIdentifier"></a>
The unique identifier of the specific engagement context to be updated. This ensures that the correct context within the engagement is modified.  
Type: String  
Pattern: `(?s).{1,3}`   
Required: Yes

 ** [EngagementIdentifier](#API_UpdateEngagementContext_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateEngagementContext-request-EngagementIdentifier"></a>
The unique identifier of the `Engagement` containing the context to be updated. This parameter ensures the context update is applied to the correct engagement.  
Type: String  
Pattern: `(arn:.*|eng-[0-9a-z]{14})`   
Required: Yes

 ** [EngagementLastModifiedAt](#API_UpdateEngagementContext_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateEngagementContext-request-EngagementLastModifiedAt"></a>
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.  
Type: Timestamp  
Required: Yes

 ** [Payload](#API_UpdateEngagementContext_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateEngagementContext-request-Payload"></a>
Contains the updated contextual information for the engagement. The structure of this payload varies based on the context type specified in the Type field.  
Type: [UpdateEngagementContextPayload](API_UpdateEngagementContextPayload.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [Type](#API_UpdateEngagementContext_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateEngagementContext-request-Type"></a>
Specifies the type of context being updated within the engagement. This field determines the structure and content of the context payload being modified.  
Type: String  
Valid Values: `CustomerProject | Lead`   
Required: Yes

## Response Syntax


```
{
   "ContextId": "string",
   "EngagementArn": "string",
   "EngagementId": "string",
   "EngagementLastModifiedAt": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContextId](#API_UpdateEngagementContext_ResponseSyntax) **   <a name="AWSPartnerCentral-UpdateEngagementContext-response-ContextId"></a>
The unique identifier of the engagement context that was updated.  
Type: String  
Pattern: `(?s).{1,3}` 

 ** [EngagementArn](#API_UpdateEngagementContext_ResponseSyntax) **   <a name="AWSPartnerCentral-UpdateEngagementContext-response-EngagementArn"></a>
The Amazon Resource Name (ARN) of the updated engagement.  
Type: String  
Pattern: `arn:.*` 

 ** [EngagementId](#API_UpdateEngagementContext_ResponseSyntax) **   <a name="AWSPartnerCentral-UpdateEngagementContext-response-EngagementId"></a>
The unique identifier of the engagement that was updated.  
Type: String  
Pattern: `eng-[0-9a-z]{14}` 

 ** [EngagementLastModifiedAt](#API_UpdateEngagementContext_ResponseSyntax) **   <a name="AWSPartnerCentral-UpdateEngagementContext-response-EngagementLastModifiedAt"></a>
The timestamp when the engagement context was last modified.  
Type: Timestamp

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.  
Suggested action: Review the [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) for the resource, and either reduce usage or request a quota increase.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/UpdateEngagementContext) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/UpdateEngagementContext) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/UpdateEngagementContext) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/UpdateEngagementContext) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/UpdateEngagementContext) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/UpdateEngagementContext) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/UpdateEngagementContext) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/UpdateEngagementContext) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/UpdateEngagementContext) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/UpdateEngagementContext) 

# UpdateOpportunity


Updates the `Opportunity` record identified by a given `Identifier`. This operation allows you to modify the details of an existing opportunity to reflect the latest information and progress. Use this action to keep the opportunity record up-to-date and accurate.

When you perform updates, include the entire payload with each request. If any field is omitted, the API assumes that the field is set to `null`. The best practice is to always perform a `GetOpportunity` to retrieve the latest values, then send the complete payload with the updated values to be changed.

## Request Syntax


```
{
   "Catalog": "string",
   "Customer": { 
      "Account": { 
         "Address": { 
            "City": "string",
            "CountryCode": "string",
            "PostalCode": "string",
            "StateOrRegion": "string",
            "StreetAddress": "string"
         },
         "AwsAccountId": "string",
         "CompanyName": "string",
         "Duns": "string",
         "Industry": "string",
         "OtherIndustry": "string",
         "WebsiteUrl": "string"
      },
      "Contacts": [ 
         { 
            "BusinessTitle": "string",
            "Email": "string",
            "FirstName": "string",
            "LastName": "string",
            "Phone": "string"
         }
      ]
   },
   "Identifier": "string",
   "LastModifiedDate": "string",
   "LifeCycle": { 
      "ClosedLostReason": "string",
      "NextSteps": "string",
      "NextStepsHistory": [ 
         { 
            "Time": "string",
            "Value": "string"
         }
      ],
      "ReviewComments": "string",
      "ReviewStatus": "string",
      "ReviewStatusReason": "string",
      "Stage": "string",
      "TargetCloseDate": "string"
   },
   "Marketing": { 
      "AwsFundingUsed": "string",
      "CampaignName": "string",
      "Channels": [ "string" ],
      "Source": "string",
      "UseCases": [ "string" ]
   },
   "NationalSecurity": "string",
   "OpportunityType": "string",
   "PartnerOpportunityIdentifier": "string",
   "PrimaryNeedsFromAws": [ "string" ],
   "Project": { 
      "AdditionalComments": "string",
      "ApnPrograms": [ "string" ],
      "AwsPartition": "string",
      "CompetitorName": "string",
      "CustomerBusinessProblem": "string",
      "CustomerUseCase": "string",
      "DeliveryModels": [ "string" ],
      "ExpectedCustomerSpend": [ 
         { 
            "Amount": "string",
            "CurrencyCode": "string",
            "EstimationUrl": "string",
            "Frequency": "string",
            "TargetCompany": "string"
         }
      ],
      "OtherCompetitorNames": "string",
      "OtherSolutionDescription": "string",
      "RelatedOpportunityIdentifier": "string",
      "SalesActivities": [ "string" ],
      "Title": "string"
   },
   "SoftwareRevenue": { 
      "DeliveryModel": "string",
      "EffectiveDate": "string",
      "ExpirationDate": "string",
      "Value": { 
         "Amount": "string",
         "CurrencyCode": "string"
      }
   }
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_UpdateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateOpportunity-request-Catalog"></a>
Specifies the catalog associated with the request. This field takes a string value from a predefined list: `AWS` or `Sandbox`. The catalog determines which environment the opportunity is updated in. Use `AWS` to update real opportunities in the production environment, and `Sandbox` for testing in secure, isolated environments. When you use the `Sandbox` catalog, it allows you to simulate and validate your interactions with AWS services without affecting live data or operations.  
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [Identifier](#API_UpdateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateOpportunity-request-Identifier"></a>
Read-only, system generated `Opportunity` unique identifier.  
Type: String  
Pattern: `O[0-9]{1,19}`   
Required: Yes

 ** [LastModifiedDate](#API_UpdateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateOpportunity-request-LastModifiedDate"></a>
 `DateTime` when the opportunity was last modified.  
Type: Timestamp  
Required: Yes

 ** [Customer](#API_UpdateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateOpportunity-request-Customer"></a>
Specifies details of the customer associated with the `Opportunity`.  
Type: [Customer](API_Customer.md) object  
Required: No

 ** [LifeCycle](#API_UpdateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateOpportunity-request-LifeCycle"></a>
An object that contains lifecycle details for the `Opportunity`.  
Type: [LifeCycle](API_LifeCycle.md) object  
Required: No

 ** [Marketing](#API_UpdateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateOpportunity-request-Marketing"></a>
An object that contains marketing details for the `Opportunity`.  
Type: [Marketing](API_Marketing.md) object  
Required: No

 ** [NationalSecurity](#API_UpdateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateOpportunity-request-NationalSecurity"></a>
Specifies if the opportunity is associated with national security concerns. This flag is only applicable when the industry is `Government`. For national-security-related opportunities, validation and compliance rules may apply, impacting the opportunity's visibility and processing.  
Type: String  
Valid Values: `Yes | No`   
Required: No

 ** [OpportunityType](#API_UpdateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateOpportunity-request-OpportunityType"></a>
Specifies the opportunity type as a renewal, new, or expansion.  
Opportunity types:  
+ New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.
+ Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.
+ Expansion opportunity: Represents 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.
Type: String  
Valid Values: `Net New Business | Flat Renewal | Expansion`   
Required: No

 ** [PartnerOpportunityIdentifier](#API_UpdateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateOpportunity-request-PartnerOpportunityIdentifier"></a>
Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.  
Type: String  
Pattern: `(?s).{0,64}`   
Required: No

 ** [PrimaryNeedsFromAws](#API_UpdateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateOpportunity-request-PrimaryNeedsFromAws"></a>
Identifies the type of support the partner needs from AWS.  
Valid values:  
+ Cosell—Architectural Validation: Confirmation from AWS that the partner's proposed solution architecture is aligned with AWS best practices and poses minimal architectural risks.
+ Cosell—Business Presentation: Request AWS seller's participation in a joint customer presentation.
+ Cosell—Competitive Information: Access to AWS competitive resources and support for the partner's proposed solution.
+ Cosell—Pricing Assistance: Connect with an AWS seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).
+ Cosell—Technical Consultation: Connection with an AWS Solutions Architect to address the partner's questions about the proposed solution.
+ Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on AWS versus on-premises or a traditional hosting environment.
+ Cosell—Deal Support: Request AWS seller's support to progress the opportunity (for example: joint customer call, strategic positioning).
+ Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs RFx support from AWS.
Type: Array of strings  
Valid Values: `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`   
Required: No

 ** [Project](#API_UpdateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateOpportunity-request-Project"></a>
An object that contains project details summary for the `Opportunity`.  
Type: [Project](API_Project.md) object  
Required: No

 ** [SoftwareRevenue](#API_UpdateOpportunity_RequestSyntax) **   <a name="AWSPartnerCentral-UpdateOpportunity-request-SoftwareRevenue"></a>
Specifies details of a customer's procurement terms. Required only for partners in eligible programs.  
Type: [SoftwareRevenue](API_SoftwareRevenue.md) object  
Required: No

## Response Syntax


```
{
   "Id": "string",
   "LastModifiedDate": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Id](#API_UpdateOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-UpdateOpportunity-response-Id"></a>
Read-only, system generated `Opportunity` unique identifier.  
Type: String  
Pattern: `O[0-9]{1,19}` 

 ** [LastModifiedDate](#API_UpdateOpportunity_ResponseSyntax) **   <a name="AWSPartnerCentral-UpdateOpportunity-response-LastModifiedDate"></a>
 `DateTime` when the opportunity was last modified.  
Type: Timestamp

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/UpdateOpportunity) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/UpdateOpportunity) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/UpdateOpportunity) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/UpdateOpportunity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/UpdateOpportunity) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/UpdateOpportunity) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/UpdateOpportunity) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/UpdateOpportunity) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/UpdateOpportunity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/UpdateOpportunity) 

# Partner Central Account API


The following actions are supported by Partner Central Account API:
+  [AcceptConnectionInvitation](API_account_AcceptConnectionInvitation.md) 
+  [AssociateAwsTrainingCertificationEmailDomain](API_account_AssociateAwsTrainingCertificationEmailDomain.md) 
+  [CancelConnection](API_account_CancelConnection.md) 
+  [CancelConnectionInvitation](API_account_CancelConnectionInvitation.md) 
+  [CancelProfileUpdateTask](API_account_CancelProfileUpdateTask.md) 
+  [CreateConnectionInvitation](API_account_CreateConnectionInvitation.md) 
+  [CreatePartner](API_account_CreatePartner.md) 
+  [DisassociateAwsTrainingCertificationEmailDomain](API_account_DisassociateAwsTrainingCertificationEmailDomain.md) 
+  [GetAllianceLeadContact](API_account_GetAllianceLeadContact.md) 
+  [GetConnection](API_account_GetConnection.md) 
+  [GetConnectionInvitation](API_account_GetConnectionInvitation.md) 
+  [GetConnectionPreferences](API_account_GetConnectionPreferences.md) 
+  [GetPartner](API_account_GetPartner.md) 
+  [GetProfileUpdateTask](API_account_GetProfileUpdateTask.md) 
+  [GetProfileVisibility](API_account_GetProfileVisibility.md) 
+  [GetVerification](API_account_GetVerification.md) 
+  [ListConnectionInvitations](API_account_ListConnectionInvitations.md) 
+  [ListConnections](API_account_ListConnections.md) 
+  [ListPartners](API_account_ListPartners.md) 
+  [ListTagsForResource](API_account_ListTagsForResource.md) 
+  [PutAllianceLeadContact](API_account_PutAllianceLeadContact.md) 
+  [PutProfileVisibility](API_account_PutProfileVisibility.md) 
+  [RejectConnectionInvitation](API_account_RejectConnectionInvitation.md) 
+  [SendEmailVerificationCode](API_account_SendEmailVerificationCode.md) 
+  [StartProfileUpdateTask](API_account_StartProfileUpdateTask.md) 
+  [StartVerification](API_account_StartVerification.md) 
+  [TagResource](API_account_TagResource.md) 
+  [UntagResource](API_account_UntagResource.md) 
+  [UpdateConnectionPreferences](API_account_UpdateConnectionPreferences.md) 

# AcceptConnectionInvitation


Accepts a connection invitation from another partner, establishing a formal partnership connection between the two parties.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_AcceptConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_AcceptConnectionInvitation-request-Catalog"></a>
The catalog identifier where the connection invitation exists.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [ClientToken](#API_account_AcceptConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_AcceptConnectionInvitation-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9-_]+`   
Required: Yes

 ** [Identifier](#API_account_AcceptConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_AcceptConnectionInvitation-request-Identifier"></a>
The unique identifier of the connection invitation to accept.  
Type: String  
Pattern: `pacinv-[A-Za-z0-9]{13}`   
Required: Yes

## Response Syntax


```
{
   "Connection": { 
      "Arn": "string",
      "Catalog": "string",
      "ConnectionTypes": { 
         "string" : { 
            "CanceledAt": "string",
            "CanceledBy": "string",
            "CreatedAt": "string",
            "InviterEmail": "string",
            "InviterName": "string",
            "OtherParticipant": { ... },
            "Status": "string"
         }
      },
      "Id": "string",
      "OtherParticipantAccountId": "string",
      "UpdatedAt": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Connection](#API_account_AcceptConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_AcceptConnectionInvitation-response-Connection"></a>
The details of the accepted connection between the two partners.  
Type: [Connection](API_account_Connection.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.    
 ** Reason **   
The specific reason for the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request was rejected because it would exceed a service quota or limit. This may occur when trying to create more resources than allowed by the service limits.    
 ** Reason **   
The specific reason for the service quota being exceeded.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/AcceptConnectionInvitation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/AcceptConnectionInvitation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/AcceptConnectionInvitation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/AcceptConnectionInvitation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/AcceptConnectionInvitation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/AcceptConnectionInvitation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/AcceptConnectionInvitation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/AcceptConnectionInvitation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/AcceptConnectionInvitation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/AcceptConnectionInvitation) 

# AssociateAwsTrainingCertificationEmailDomain


Associates an email domain with AWS training and certification for the partner account, enabling automatic verification of employee certifications.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "Email": "string",
   "EmailVerificationCode": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_AssociateAwsTrainingCertificationEmailDomain_RequestSyntax) **   <a name="AWSPartnerCentral-account_AssociateAwsTrainingCertificationEmailDomain-request-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [Email](#API_account_AssociateAwsTrainingCertificationEmailDomain_RequestSyntax) **   <a name="AWSPartnerCentral-account_AssociateAwsTrainingCertificationEmailDomain-request-Email"></a>
The email address used to verify domain ownership for AWS training and certification association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 320.  
Pattern: `[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*`   
Required: Yes

 ** [EmailVerificationCode](#API_account_AssociateAwsTrainingCertificationEmailDomain_RequestSyntax) **   <a name="AWSPartnerCentral-account_AssociateAwsTrainingCertificationEmailDomain-request-EmailVerificationCode"></a>
The verification code sent to the email address to confirm domain ownership.  
Type: String  
Length Constraints: Fixed length of 6.  
Pattern: `[0-9]+`   
Required: Yes

 ** [Identifier](#API_account_AssociateAwsTrainingCertificationEmailDomain_RequestSyntax) **   <a name="AWSPartnerCentral-account_AssociateAwsTrainingCertificationEmailDomain-request-Identifier"></a>
The unique identifier of the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `(partner-[A-Za-z0-9]{13}|arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13})`   
Required: Yes

 ** [ClientToken](#API_account_AssociateAwsTrainingCertificationEmailDomain_RequestSyntax) **   <a name="AWSPartnerCentral-account_AssociateAwsTrainingCertificationEmailDomain-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9-_]+`   
Required: No

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.    
 ** Reason **   
The specific reason for the conflict.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request was rejected because it would exceed a service quota or limit. This may occur when trying to create more resources than allowed by the service limits.    
 ** Reason **   
The specific reason for the service quota being exceeded.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/AssociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/AssociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/AssociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/AssociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/AssociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/AssociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/AssociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/AssociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/AssociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/AssociateAwsTrainingCertificationEmailDomain) 

# CancelConnection


Cancels an existing connection between partners, terminating the partnership relationship.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "ConnectionType": "string",
   "Identifier": "string",
   "Reason": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_CancelConnection_RequestSyntax) **   <a name="AWSPartnerCentral-account_CancelConnection-request-Catalog"></a>
The catalog identifier where the connection exists.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [ClientToken](#API_account_CancelConnection_RequestSyntax) **   <a name="AWSPartnerCentral-account_CancelConnection-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9-_]+`   
Required: Yes

 ** [ConnectionType](#API_account_CancelConnection_RequestSyntax) **   <a name="AWSPartnerCentral-account_CancelConnection-request-ConnectionType"></a>
The type of connection to cancel (e.g., reseller, distributor, technology partner).  
Type: String  
Valid Values: `OPPORTUNITY_COLLABORATION | SUBSIDIARY`   
Required: Yes

 ** [Identifier](#API_account_CancelConnection_RequestSyntax) **   <a name="AWSPartnerCentral-account_CancelConnection-request-Identifier"></a>
The unique identifier of the connection to cancel.  
Type: String  
Pattern: `pac-[A-Za-z0-9]{13}`   
Required: Yes

 ** [Reason](#API_account_CancelConnection_RequestSyntax) **   <a name="AWSPartnerCentral-account_CancelConnection-request-Reason"></a>
The reason for canceling the connection, providing context for the termination.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Catalog": "string",
   "ConnectionTypes": { 
      "string" : { 
         "CanceledAt": "string",
         "CanceledBy": "string",
         "CreatedAt": "string",
         "InviterEmail": "string",
         "InviterName": "string",
         "OtherParticipant": { ... },
         "Status": "string"
      }
   },
   "Id": "string",
   "OtherParticipantAccountId": "string",
   "UpdatedAt": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_account_CancelConnection_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnection-response-Arn"></a>
The Amazon Resource Name (ARN) of the canceled connection.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-zA-Z0-9-]+:partnercentral:[a-z0-9\-]*::catalog/[a-zA-Z]+/connection/pac-[A-Za-z0-9]{13}` 

 ** [Catalog](#API_account_CancelConnection_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnection-response-Catalog"></a>
The catalog identifier where the connection was canceled.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [ConnectionTypes](#API_account_CancelConnection_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnection-response-ConnectionTypes"></a>
The list of connection types that were active before cancellation.  
Type: String to [ConnectionTypeDetail](API_account_ConnectionTypeDetail.md) object map  
Valid Keys: `OPPORTUNITY_COLLABORATION | SUBSIDIARY` 

 ** [Id](#API_account_CancelConnection_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnection-response-Id"></a>
The unique identifier of the canceled connection.  
Type: String  
Pattern: `pac-[A-Za-z0-9]{13}` 

 ** [OtherParticipantAccountId](#API_account_CancelConnection_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnection-response-OtherParticipantAccountId"></a>
The AWS account ID of the other participant in the canceled connection.  
Type: String  
Pattern: `[0-9]{12}` 

 ** [UpdatedAt](#API_account_CancelConnection_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnection-response-UpdatedAt"></a>
The timestamp when the connection was last updated (canceled).  
Type: Timestamp

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.    
 ** Reason **   
The specific reason for the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/CancelConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/CancelConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/CancelConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/CancelConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/CancelConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/CancelConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/CancelConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/CancelConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/CancelConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/CancelConnection) 

# CancelConnectionInvitation


Cancels a pending connection invitation before it has been accepted or rejected.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_CancelConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-request-Catalog"></a>
The catalog identifier where the connection invitation exists.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [ClientToken](#API_account_CancelConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9-_]+`   
Required: Yes

 ** [Identifier](#API_account_CancelConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-request-Identifier"></a>
The unique identifier of the connection invitation to cancel.  
Type: String  
Pattern: `pacinv-[A-Za-z0-9]{13}`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Catalog": "string",
   "ConnectionId": "string",
   "ConnectionType": "string",
   "CreatedAt": "string",
   "ExpiresAt": "string",
   "Id": "string",
   "InvitationMessage": "string",
   "InviterEmail": "string",
   "InviterName": "string",
   "OtherParticipantIdentifier": "string",
   "ParticipantType": "string",
   "Status": "string",
   "UpdatedAt": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_account_CancelConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-response-Arn"></a>
The Amazon Resource Name (ARN) of the canceled connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-zA-Z0-9-]+:partnercentral:[a-z0-9\-]*::catalog/[a-zA-Z]+/connection-invitation/pacinv-[A-Za-z0-9]{13}` 

 ** [Catalog](#API_account_CancelConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-response-Catalog"></a>
The catalog identifier where the connection invitation was canceled.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [ConnectionType](#API_account_CancelConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-response-ConnectionType"></a>
The type of connection that was being invited for.  
Type: String  
Valid Values: `OPPORTUNITY_COLLABORATION | SUBSIDIARY` 

 ** [CreatedAt](#API_account_CancelConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-response-CreatedAt"></a>
The timestamp when the connection invitation was originally created.  
Type: Timestamp

 ** [Id](#API_account_CancelConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-response-Id"></a>
The unique identifier of the canceled connection invitation.  
Type: String  
Pattern: `pacinv-[A-Za-z0-9]{13}` 

 ** [InvitationMessage](#API_account_CancelConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-response-InvitationMessage"></a>
The message that was included with the original connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD\n]+` 

 ** [InviterEmail](#API_account_CancelConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-response-InviterEmail"></a>
The email address of the person who sent the connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 320.  
Pattern: `[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*` 

 ** [InviterName](#API_account_CancelConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-response-InviterName"></a>
The name of the person who sent the connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+` 

 ** [OtherParticipantIdentifier](#API_account_CancelConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-response-OtherParticipantIdentifier"></a>
The identifier of the other participant who was invited to connect.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [ParticipantType](#API_account_CancelConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-response-ParticipantType"></a>
The type of participant (inviter or invitee) in the connection invitation.  
Type: String  
Valid Values: `SENDER | RECEIVER` 

 ** [Status](#API_account_CancelConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-response-Status"></a>
The current status of the connection invitation (canceled).  
Type: String  
Valid Values: `PENDING | ACCEPTED | REJECTED | CANCELED | EXPIRED` 

 ** [UpdatedAt](#API_account_CancelConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-response-UpdatedAt"></a>
The timestamp when the connection invitation was last updated (canceled).  
Type: Timestamp

 ** [ConnectionId](#API_account_CancelConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-response-ConnectionId"></a>
The identifier of the connection associated with the canceled invitation.  
Type: String  
Pattern: `pac-[A-Za-z0-9]{13}` 

 ** [ExpiresAt](#API_account_CancelConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelConnectionInvitation-response-ExpiresAt"></a>
The timestamp when the connection invitation would have expired if not canceled.  
Type: Timestamp

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.    
 ** Reason **   
The specific reason for the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/CancelConnectionInvitation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/CancelConnectionInvitation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/CancelConnectionInvitation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/CancelConnectionInvitation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/CancelConnectionInvitation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/CancelConnectionInvitation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/CancelConnectionInvitation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/CancelConnectionInvitation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/CancelConnectionInvitation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/CancelConnectionInvitation) 

# CancelProfileUpdateTask


Cancels an in-progress profile update task, stopping any pending changes to the partner profile.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "Identifier": "string",
   "TaskId": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_CancelProfileUpdateTask_RequestSyntax) **   <a name="AWSPartnerCentral-account_CancelProfileUpdateTask-request-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [Identifier](#API_account_CancelProfileUpdateTask_RequestSyntax) **   <a name="AWSPartnerCentral-account_CancelProfileUpdateTask-request-Identifier"></a>
The unique identifier of the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `(partner-[A-Za-z0-9]{13}|arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13})`   
Required: Yes

 ** [TaskId](#API_account_CancelProfileUpdateTask_RequestSyntax) **   <a name="AWSPartnerCentral-account_CancelProfileUpdateTask-request-TaskId"></a>
The unique identifier of the profile update task to cancel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Pattern: `pprofiletask-[A-Za-z0-9]{13}`   
Required: Yes

 ** [ClientToken](#API_account_CancelProfileUpdateTask_RequestSyntax) **   <a name="AWSPartnerCentral-account_CancelProfileUpdateTask-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9-_]+`   
Required: No

## Response Syntax


```
{
   "Arn": "string",
   "Catalog": "string",
   "EndedAt": "string",
   "ErrorDetailList": [ 
      { 
         "Locale": "string",
         "Message": "string",
         "Reason": "string"
      }
   ],
   "Id": "string",
   "StartedAt": "string",
   "Status": "string",
   "TaskDetails": { 
      "Description": "string",
      "DisplayName": "string",
      "IndustrySegments": [ "string" ],
      "LocalizedContents": [ 
         { 
            "Description": "string",
            "DisplayName": "string",
            "Locale": "string",
            "LogoUrl": "string",
            "WebsiteUrl": "string"
         }
      ],
      "LogoUrl": "string",
      "PrimarySolutionType": "string",
      "TranslationSourceLocale": "string",
      "WebsiteUrl": "string"
   },
   "TaskId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_account_CancelProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelProfileUpdateTask-response-Arn"></a>
The Amazon Resource Name (ARN) of the canceled profile update task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13}` 

 ** [Catalog](#API_account_CancelProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelProfileUpdateTask-response-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [Id](#API_account_CancelProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelProfileUpdateTask-response-Id"></a>
The unique identifier of the partner account.  
Type: String  
Pattern: `partner-[A-Za-z0-9]{13}` 

 ** [StartedAt](#API_account_CancelProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelProfileUpdateTask-response-StartedAt"></a>
The timestamp when the profile update task was started.  
Type: Timestamp

 ** [Status](#API_account_CancelProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelProfileUpdateTask-response-Status"></a>
The current status of the profile update task (canceled).  
Type: String  
Valid Values: `IN_PROGRESS | CANCELED | SUCCEEDED | FAILED` 

 ** [TaskDetails](#API_account_CancelProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelProfileUpdateTask-response-TaskDetails"></a>
The details of the profile update task that was canceled.  
Type: [TaskDetails](API_account_TaskDetails.md) object

 ** [TaskId](#API_account_CancelProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelProfileUpdateTask-response-TaskId"></a>
The unique identifier of the canceled profile update task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Pattern: `pprofiletask-[A-Za-z0-9]{13}` 

 ** [EndedAt](#API_account_CancelProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelProfileUpdateTask-response-EndedAt"></a>
The timestamp when the profile update task was ended (canceled).  
Type: Timestamp

 ** [ErrorDetailList](#API_account_CancelProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CancelProfileUpdateTask-response-ErrorDetailList"></a>
A list of error details if any errors occurred during the profile update task.  
Type: Array of [ErrorDetail](API_account_ErrorDetail.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.    
 ** Reason **   
The specific reason for the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/CancelProfileUpdateTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/CancelProfileUpdateTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/CancelProfileUpdateTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/CancelProfileUpdateTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/CancelProfileUpdateTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/CancelProfileUpdateTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/CancelProfileUpdateTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/CancelProfileUpdateTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/CancelProfileUpdateTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/CancelProfileUpdateTask) 

# CreateConnectionInvitation


Creates a new connection invitation to establish a partnership with another organization.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "ConnectionType": "string",
   "Email": "string",
   "Message": "string",
   "Name": "string",
   "ReceiverIdentifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_CreateConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-request-Catalog"></a>
The catalog identifier where the connection invitation will be created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [ClientToken](#API_account_CreateConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9-_]+`   
Required: Yes

 ** [ConnectionType](#API_account_CreateConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-request-ConnectionType"></a>
The type of connection being requested (e.g., reseller, distributor, technology partner).  
Type: String  
Valid Values: `OPPORTUNITY_COLLABORATION | SUBSIDIARY`   
Required: Yes

 ** [Email](#API_account_CreateConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-request-Email"></a>
The email address of the person to send the connection invitation to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 320.  
Pattern: `[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*`   
Required: Yes

 ** [Message](#API_account_CreateConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-request-Message"></a>
A custom message to include with the connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD\n]+`   
Required: Yes

 ** [Name](#API_account_CreateConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-request-Name"></a>
The name of the person sending the connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+`   
Required: Yes

 ** [ReceiverIdentifier](#API_account_CreateConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-request-ReceiverIdentifier"></a>
The identifier of the organization or partner to invite for connection.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Catalog": "string",
   "ConnectionId": "string",
   "ConnectionType": "string",
   "CreatedAt": "string",
   "ExpiresAt": "string",
   "Id": "string",
   "InvitationMessage": "string",
   "InviterEmail": "string",
   "InviterName": "string",
   "OtherParticipantIdentifier": "string",
   "ParticipantType": "string",
   "Status": "string",
   "UpdatedAt": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_account_CreateConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-response-Arn"></a>
The Amazon Resource Name (ARN) of the created connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-zA-Z0-9-]+:partnercentral:[a-z0-9\-]*::catalog/[a-zA-Z]+/connection-invitation/pacinv-[A-Za-z0-9]{13}` 

 ** [Catalog](#API_account_CreateConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-response-Catalog"></a>
The catalog identifier where the connection invitation was created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [ConnectionType](#API_account_CreateConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-response-ConnectionType"></a>
The type of connection being requested in the invitation.  
Type: String  
Valid Values: `OPPORTUNITY_COLLABORATION | SUBSIDIARY` 

 ** [CreatedAt](#API_account_CreateConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-response-CreatedAt"></a>
The timestamp when the connection invitation was created.  
Type: Timestamp

 ** [Id](#API_account_CreateConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-response-Id"></a>
The unique identifier of the created connection invitation.  
Type: String  
Pattern: `pacinv-[A-Za-z0-9]{13}` 

 ** [InvitationMessage](#API_account_CreateConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-response-InvitationMessage"></a>
The custom message included with the connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD\n]+` 

 ** [InviterEmail](#API_account_CreateConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-response-InviterEmail"></a>
The email address of the person who sent the connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 320.  
Pattern: `[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*` 

 ** [InviterName](#API_account_CreateConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-response-InviterName"></a>
The name of the person who sent the connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+` 

 ** [OtherParticipantIdentifier](#API_account_CreateConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-response-OtherParticipantIdentifier"></a>
The identifier of the organization or partner being invited.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [ParticipantType](#API_account_CreateConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-response-ParticipantType"></a>
The type of participant (inviter or invitee) in the connection invitation.  
Type: String  
Valid Values: `SENDER | RECEIVER` 

 ** [Status](#API_account_CreateConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-response-Status"></a>
The current status of the connection invitation (pending, accepted, rejected, etc.).  
Type: String  
Valid Values: `PENDING | ACCEPTED | REJECTED | CANCELED | EXPIRED` 

 ** [UpdatedAt](#API_account_CreateConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-response-UpdatedAt"></a>
The timestamp when the connection invitation was last updated.  
Type: Timestamp

 ** [ConnectionId](#API_account_CreateConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-response-ConnectionId"></a>
The identifier of the connection associated with this invitation.  
Type: String  
Pattern: `pac-[A-Za-z0-9]{13}` 

 ** [ExpiresAt](#API_account_CreateConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreateConnectionInvitation-response-ExpiresAt"></a>
The timestamp when the connection invitation will expire if not responded to.  
Type: Timestamp

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.    
 ** Reason **   
The specific reason for the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request was rejected because it would exceed a service quota or limit. This may occur when trying to create more resources than allowed by the service limits.    
 ** Reason **   
The specific reason for the service quota being exceeded.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/CreateConnectionInvitation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/CreateConnectionInvitation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/CreateConnectionInvitation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/CreateConnectionInvitation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/CreateConnectionInvitation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/CreateConnectionInvitation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/CreateConnectionInvitation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/CreateConnectionInvitation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/CreateConnectionInvitation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/CreateConnectionInvitation) 

# CreatePartner


Creates a new partner account in the AWS Partner Network with the specified details and configuration.

## Request Syntax


```
{
   "AllianceLeadContact": { 
      "BusinessTitle": "string",
      "Email": "string",
      "FirstName": "string",
      "LastName": "string"
   },
   "Catalog": "string",
   "ClientToken": "string",
   "EmailVerificationCode": "string",
   "LegalName": "string",
   "PrimarySolutionType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [AllianceLeadContact](#API_account_CreatePartner_RequestSyntax) **   <a name="AWSPartnerCentral-account_CreatePartner-request-AllianceLeadContact"></a>
The primary contact person for alliance and partnership matters.  
Type: [AllianceLeadContact](API_account_AllianceLeadContact.md) object  
Required: Yes

 ** [Catalog](#API_account_CreatePartner_RequestSyntax) **   <a name="AWSPartnerCentral-account_CreatePartner-request-Catalog"></a>
The catalog identifier where the partner account will be created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [EmailVerificationCode](#API_account_CreatePartner_RequestSyntax) **   <a name="AWSPartnerCentral-account_CreatePartner-request-EmailVerificationCode"></a>
The verification code sent to the alliance lead contact's email to confirm account creation.  
Type: String  
Length Constraints: Fixed length of 6.  
Pattern: `[0-9]+`   
Required: Yes

 ** [LegalName](#API_account_CreatePartner_RequestSyntax) **   <a name="AWSPartnerCentral-account_CreatePartner-request-LegalName"></a>
The legal name of the organization becoming a partner.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+`   
Required: Yes

 ** [PrimarySolutionType](#API_account_CreatePartner_RequestSyntax) **   <a name="AWSPartnerCentral-account_CreatePartner-request-PrimarySolutionType"></a>
The primary type of solution or service the partner provides (e.g., consulting, software, managed services).  
Type: String  
Valid Values: `SOFTWARE_PRODUCTS | CONSULTING_SERVICES | PROFESSIONAL_SERVICES | MANAGED_SERVICES | HARDWARE_PRODUCTS | COMMUNICATION_SERVICES | VALUE_ADDED_RESALE_AWS_SERVICES | TRAINING_SERVICES`   
Required: Yes

 ** [ClientToken](#API_account_CreatePartner_RequestSyntax) **   <a name="AWSPartnerCentral-account_CreatePartner-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9-_]+`   
Required: No

 ** [Tags](#API_account_CreatePartner_RequestSyntax) **   <a name="AWSPartnerCentral-account_CreatePartner-request-Tags"></a>
A list of tags to associate with the partner account for organization and billing purposes.  
Type: Array of [Tag](API_account_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax


```
{
   "AllianceLeadContact": { 
      "BusinessTitle": "string",
      "Email": "string",
      "FirstName": "string",
      "LastName": "string"
   },
   "Arn": "string",
   "AwsTrainingCertificationEmailDomains": [ 
      { 
         "DomainName": "string",
         "RegisteredAt": "string"
      }
   ],
   "Catalog": "string",
   "CreatedAt": "string",
   "Id": "string",
   "LegalName": "string",
   "Profile": { 
      "Description": "string",
      "DisplayName": "string",
      "IndustrySegments": [ "string" ],
      "LocalizedContents": [ 
         { 
            "Description": "string",
            "DisplayName": "string",
            "Locale": "string",
            "LogoUrl": "string",
            "WebsiteUrl": "string"
         }
      ],
      "LogoUrl": "string",
      "PrimarySolutionType": "string",
      "ProfileId": "string",
      "TranslationSourceLocale": "string",
      "WebsiteUrl": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AllianceLeadContact](#API_account_CreatePartner_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreatePartner-response-AllianceLeadContact"></a>
The alliance lead contact information for the partner account.  
Type: [AllianceLeadContact](API_account_AllianceLeadContact.md) object

 ** [Arn](#API_account_CreatePartner_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreatePartner-response-Arn"></a>
The Amazon Resource Name (ARN) of the created partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13}` 

 ** [Catalog](#API_account_CreatePartner_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreatePartner-response-Catalog"></a>
The catalog identifier where the partner account was created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [CreatedAt](#API_account_CreatePartner_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreatePartner-response-CreatedAt"></a>
The timestamp when the partner account was created.  
Type: Timestamp

 ** [Id](#API_account_CreatePartner_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreatePartner-response-Id"></a>
The unique identifier of the created partner account.  
Type: String  
Pattern: `partner-[A-Za-z0-9]{13}` 

 ** [LegalName](#API_account_CreatePartner_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreatePartner-response-LegalName"></a>
The legal name of the partner organization.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+` 

 ** [Profile](#API_account_CreatePartner_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreatePartner-response-Profile"></a>
The partner profile information including display name, description, and other public details.  
Type: [PartnerProfile](API_account_PartnerProfile.md) object

 ** [AwsTrainingCertificationEmailDomains](#API_account_CreatePartner_ResponseSyntax) **   <a name="AWSPartnerCentral-account_CreatePartner-response-AwsTrainingCertificationEmailDomains"></a>
The list of verified email domains associated with AWS training and certification credentials for the partner organization.  
Type: Array of [PartnerDomain](API_account_PartnerDomain.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.    
 ** Reason **   
The specific reason for the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/CreatePartner) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/CreatePartner) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/CreatePartner) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/CreatePartner) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/CreatePartner) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/CreatePartner) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/CreatePartner) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/CreatePartner) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/CreatePartner) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/CreatePartner) 

# DisassociateAwsTrainingCertificationEmailDomain


Removes the association between an email domain and AWS training and certification for the partner account.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "DomainName": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_DisassociateAwsTrainingCertificationEmailDomain_RequestSyntax) **   <a name="AWSPartnerCentral-account_DisassociateAwsTrainingCertificationEmailDomain-request-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [DomainName](#API_account_DisassociateAwsTrainingCertificationEmailDomain_RequestSyntax) **   <a name="AWSPartnerCentral-account_DisassociateAwsTrainingCertificationEmailDomain-request-DomainName"></a>
The domain name to disassociate from AWS training and certification.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*`   
Required: Yes

 ** [Identifier](#API_account_DisassociateAwsTrainingCertificationEmailDomain_RequestSyntax) **   <a name="AWSPartnerCentral-account_DisassociateAwsTrainingCertificationEmailDomain-request-Identifier"></a>
The unique identifier of the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `(partner-[A-Za-z0-9]{13}|arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13})`   
Required: Yes

 ** [ClientToken](#API_account_DisassociateAwsTrainingCertificationEmailDomain_RequestSyntax) **   <a name="AWSPartnerCentral-account_DisassociateAwsTrainingCertificationEmailDomain-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9-_]+`   
Required: No

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.    
 ** Reason **   
The specific reason for the conflict.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/DisassociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/DisassociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/DisassociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/DisassociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/DisassociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/DisassociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/DisassociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/DisassociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/DisassociateAwsTrainingCertificationEmailDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/DisassociateAwsTrainingCertificationEmailDomain) 

# GetAllianceLeadContact


Retrieves the alliance lead contact information for a partner account.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_GetAllianceLeadContact_RequestSyntax) **   <a name="AWSPartnerCentral-account_GetAllianceLeadContact-request-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [Identifier](#API_account_GetAllianceLeadContact_RequestSyntax) **   <a name="AWSPartnerCentral-account_GetAllianceLeadContact-request-Identifier"></a>
The unique identifier of the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `(partner-[A-Za-z0-9]{13}|arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13})`   
Required: Yes

## Response Syntax


```
{
   "AllianceLeadContact": { 
      "BusinessTitle": "string",
      "Email": "string",
      "FirstName": "string",
      "LastName": "string"
   },
   "Arn": "string",
   "Catalog": "string",
   "Id": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AllianceLeadContact](#API_account_GetAllianceLeadContact_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetAllianceLeadContact-response-AllianceLeadContact"></a>
The alliance lead contact information including name, email, and business title.  
Type: [AllianceLeadContact](API_account_AllianceLeadContact.md) object

 ** [Arn](#API_account_GetAllianceLeadContact_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetAllianceLeadContact-response-Arn"></a>
The Amazon Resource Name (ARN) of the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13}` 

 ** [Catalog](#API_account_GetAllianceLeadContact_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetAllianceLeadContact-response-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [Id](#API_account_GetAllianceLeadContact_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetAllianceLeadContact-response-Id"></a>
The unique identifier of the partner account.  
Type: String  
Pattern: `partner-[A-Za-z0-9]{13}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/GetAllianceLeadContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/GetAllianceLeadContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/GetAllianceLeadContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/GetAllianceLeadContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/GetAllianceLeadContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/GetAllianceLeadContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/GetAllianceLeadContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/GetAllianceLeadContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/GetAllianceLeadContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/GetAllianceLeadContact) 

# GetConnection


Retrieves detailed information about a specific connection between partners.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_GetConnection_RequestSyntax) **   <a name="AWSPartnerCentral-account_GetConnection-request-Catalog"></a>
The catalog identifier where the connection exists.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [Identifier](#API_account_GetConnection_RequestSyntax) **   <a name="AWSPartnerCentral-account_GetConnection-request-Identifier"></a>
The unique identifier of the connection to retrieve.  
Type: String  
Pattern: `pac-[A-Za-z0-9]{13}`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Catalog": "string",
   "ConnectionTypes": { 
      "string" : { 
         "CanceledAt": "string",
         "CanceledBy": "string",
         "CreatedAt": "string",
         "InviterEmail": "string",
         "InviterName": "string",
         "OtherParticipant": { ... },
         "Status": "string"
      }
   },
   "Id": "string",
   "OtherParticipantAccountId": "string",
   "UpdatedAt": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_account_GetConnection_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnection-response-Arn"></a>
The Amazon Resource Name (ARN) of the connection.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-zA-Z0-9-]+:partnercentral:[a-z0-9\-]*::catalog/[a-zA-Z]+/connection/pac-[A-Za-z0-9]{13}` 

 ** [Catalog](#API_account_GetConnection_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnection-response-Catalog"></a>
The catalog identifier where the connection exists.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [ConnectionTypes](#API_account_GetConnection_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnection-response-ConnectionTypes"></a>
The list of connection types active between the partners.  
Type: String to [ConnectionTypeDetail](API_account_ConnectionTypeDetail.md) object map  
Valid Keys: `OPPORTUNITY_COLLABORATION | SUBSIDIARY` 

 ** [Id](#API_account_GetConnection_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnection-response-Id"></a>
The unique identifier of the connection.  
Type: String  
Pattern: `pac-[A-Za-z0-9]{13}` 

 ** [OtherParticipantAccountId](#API_account_GetConnection_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnection-response-OtherParticipantAccountId"></a>
The AWS account ID of the other participant in the connection.  
Type: String  
Pattern: `[0-9]{12}` 

 ** [UpdatedAt](#API_account_GetConnection_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnection-response-UpdatedAt"></a>
The timestamp when the connection was last updated.  
Type: Timestamp

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/GetConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/GetConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/GetConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/GetConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/GetConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/GetConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/GetConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/GetConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/GetConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/GetConnection) 

# GetConnectionInvitation


Retrieves detailed information about a specific connection invitation.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_GetConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-request-Catalog"></a>
The catalog identifier where the connection invitation exists.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [Identifier](#API_account_GetConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-request-Identifier"></a>
The unique identifier of the connection invitation to retrieve.  
Type: String  
Pattern: `pacinv-[A-Za-z0-9]{13}`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Catalog": "string",
   "ConnectionId": "string",
   "ConnectionType": "string",
   "CreatedAt": "string",
   "ExpiresAt": "string",
   "Id": "string",
   "InvitationMessage": "string",
   "InviterEmail": "string",
   "InviterName": "string",
   "OtherParticipantIdentifier": "string",
   "ParticipantType": "string",
   "Status": "string",
   "UpdatedAt": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_account_GetConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-response-Arn"></a>
The Amazon Resource Name (ARN) of the connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-zA-Z0-9-]+:partnercentral:[a-z0-9\-]*::catalog/[a-zA-Z]+/connection-invitation/pacinv-[A-Za-z0-9]{13}` 

 ** [Catalog](#API_account_GetConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-response-Catalog"></a>
The catalog identifier where the connection invitation exists.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [ConnectionType](#API_account_GetConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-response-ConnectionType"></a>
The type of connection being requested in the invitation.  
Type: String  
Valid Values: `OPPORTUNITY_COLLABORATION | SUBSIDIARY` 

 ** [CreatedAt](#API_account_GetConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-response-CreatedAt"></a>
The timestamp when the connection invitation was created.  
Type: Timestamp

 ** [Id](#API_account_GetConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-response-Id"></a>
The unique identifier of the connection invitation.  
Type: String  
Pattern: `pacinv-[A-Za-z0-9]{13}` 

 ** [InvitationMessage](#API_account_GetConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-response-InvitationMessage"></a>
The custom message included with the connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD\n]+` 

 ** [InviterEmail](#API_account_GetConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-response-InviterEmail"></a>
The email address of the person who sent the connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 320.  
Pattern: `[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*` 

 ** [InviterName](#API_account_GetConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-response-InviterName"></a>
The name of the person who sent the connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+` 

 ** [OtherParticipantIdentifier](#API_account_GetConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-response-OtherParticipantIdentifier"></a>
The identifier of the other participant in the connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [ParticipantType](#API_account_GetConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-response-ParticipantType"></a>
The type of participant (inviter or invitee) in the connection invitation.  
Type: String  
Valid Values: `SENDER | RECEIVER` 

 ** [Status](#API_account_GetConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-response-Status"></a>
The current status of the connection invitation.  
Type: String  
Valid Values: `PENDING | ACCEPTED | REJECTED | CANCELED | EXPIRED` 

 ** [UpdatedAt](#API_account_GetConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-response-UpdatedAt"></a>
The timestamp when the connection invitation was last updated.  
Type: Timestamp

 ** [ConnectionId](#API_account_GetConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-response-ConnectionId"></a>
The identifier of the connection associated with this invitation.  
Type: String  
Pattern: `pac-[A-Za-z0-9]{13}` 

 ** [ExpiresAt](#API_account_GetConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionInvitation-response-ExpiresAt"></a>
The timestamp when the connection invitation will expire.  
Type: Timestamp

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/GetConnectionInvitation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/GetConnectionInvitation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/GetConnectionInvitation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/GetConnectionInvitation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/GetConnectionInvitation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/GetConnectionInvitation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/GetConnectionInvitation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/GetConnectionInvitation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/GetConnectionInvitation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/GetConnectionInvitation) 

# GetConnectionPreferences


Retrieves the connection preferences for a partner account, including access settings and exclusions.

## Request Syntax


```
{
   "Catalog": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_GetConnectionPreferences_RequestSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionPreferences-request-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

## Response Syntax


```
{
   "AccessType": "string",
   "Arn": "string",
   "Catalog": "string",
   "ExcludedParticipantIds": [ "string" ],
   "Revision": number,
   "UpdatedAt": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccessType](#API_account_GetConnectionPreferences_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionPreferences-response-AccessType"></a>
The access type setting for connections (e.g., open, restricted, invitation-only).  
Type: String  
Valid Values: `ALLOW_ALL | DENY_ALL | ALLOW_BY_DEFAULT_DENY_SOME` 

 ** [Arn](#API_account_GetConnectionPreferences_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionPreferences-response-Arn"></a>
The Amazon Resource Name (ARN) of the connection preferences.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-zA-Z0-9-]+:partnercentral:[a-z0-9\-]*:[0-9]{12}:catalog/[a-zA-Z]+/connection-preferences` 

 ** [Catalog](#API_account_GetConnectionPreferences_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionPreferences-response-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [Revision](#API_account_GetConnectionPreferences_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionPreferences-response-Revision"></a>
The revision number of the connection preferences for optimistic locking.  
Type: Long

 ** [UpdatedAt](#API_account_GetConnectionPreferences_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionPreferences-response-UpdatedAt"></a>
The timestamp when the connection preferences were last updated.  
Type: Timestamp

 ** [ExcludedParticipantIds](#API_account_GetConnectionPreferences_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetConnectionPreferences-response-ExcludedParticipantIds"></a>
A list of participant IDs that are excluded from connection requests or interactions.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]+` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/GetConnectionPreferences) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/GetConnectionPreferences) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/GetConnectionPreferences) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/GetConnectionPreferences) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/GetConnectionPreferences) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/GetConnectionPreferences) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/GetConnectionPreferences) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/GetConnectionPreferences) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/GetConnectionPreferences) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/GetConnectionPreferences) 

# GetPartner


Retrieves detailed information about a specific partner account.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_GetPartner_RequestSyntax) **   <a name="AWSPartnerCentral-account_GetPartner-request-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [Identifier](#API_account_GetPartner_RequestSyntax) **   <a name="AWSPartnerCentral-account_GetPartner-request-Identifier"></a>
The unique identifier of the partner account to retrieve.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `(partner-[A-Za-z0-9]{13}|arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13})`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "AwsTrainingCertificationEmailDomains": [ 
      { 
         "DomainName": "string",
         "RegisteredAt": "string"
      }
   ],
   "Catalog": "string",
   "CreatedAt": "string",
   "Id": "string",
   "LegalName": "string",
   "Profile": { 
      "Description": "string",
      "DisplayName": "string",
      "IndustrySegments": [ "string" ],
      "LocalizedContents": [ 
         { 
            "Description": "string",
            "DisplayName": "string",
            "Locale": "string",
            "LogoUrl": "string",
            "WebsiteUrl": "string"
         }
      ],
      "LogoUrl": "string",
      "PrimarySolutionType": "string",
      "ProfileId": "string",
      "TranslationSourceLocale": "string",
      "WebsiteUrl": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_account_GetPartner_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetPartner-response-Arn"></a>
The Amazon Resource Name (ARN) of the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13}` 

 ** [Catalog](#API_account_GetPartner_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetPartner-response-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [CreatedAt](#API_account_GetPartner_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetPartner-response-CreatedAt"></a>
The timestamp when the partner account was created.  
Type: Timestamp

 ** [Id](#API_account_GetPartner_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetPartner-response-Id"></a>
The unique identifier of the partner account.  
Type: String  
Pattern: `partner-[A-Za-z0-9]{13}` 

 ** [LegalName](#API_account_GetPartner_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetPartner-response-LegalName"></a>
The legal name of the partner organization.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+` 

 ** [Profile](#API_account_GetPartner_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetPartner-response-Profile"></a>
The partner profile information including display name, description, and other public details.  
Type: [PartnerProfile](API_account_PartnerProfile.md) object

 ** [AwsTrainingCertificationEmailDomains](#API_account_GetPartner_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetPartner-response-AwsTrainingCertificationEmailDomains"></a>
The list of verified email domains associated with AWS training and certification credentials for the partner organization.  
Type: Array of [PartnerDomain](API_account_PartnerDomain.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/GetPartner) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/GetPartner) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/GetPartner) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/GetPartner) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/GetPartner) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/GetPartner) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/GetPartner) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/GetPartner) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/GetPartner) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/GetPartner) 

# GetProfileUpdateTask


Retrieves information about a specific profile update task.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_GetProfileUpdateTask_RequestSyntax) **   <a name="AWSPartnerCentral-account_GetProfileUpdateTask-request-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [Identifier](#API_account_GetProfileUpdateTask_RequestSyntax) **   <a name="AWSPartnerCentral-account_GetProfileUpdateTask-request-Identifier"></a>
The unique identifier of the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `(partner-[A-Za-z0-9]{13}|arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13})`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Catalog": "string",
   "EndedAt": "string",
   "ErrorDetailList": [ 
      { 
         "Locale": "string",
         "Message": "string",
         "Reason": "string"
      }
   ],
   "Id": "string",
   "StartedAt": "string",
   "Status": "string",
   "TaskDetails": { 
      "Description": "string",
      "DisplayName": "string",
      "IndustrySegments": [ "string" ],
      "LocalizedContents": [ 
         { 
            "Description": "string",
            "DisplayName": "string",
            "Locale": "string",
            "LogoUrl": "string",
            "WebsiteUrl": "string"
         }
      ],
      "LogoUrl": "string",
      "PrimarySolutionType": "string",
      "TranslationSourceLocale": "string",
      "WebsiteUrl": "string"
   },
   "TaskId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_account_GetProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetProfileUpdateTask-response-Arn"></a>
The Amazon Resource Name (ARN) of the profile update task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13}` 

 ** [Catalog](#API_account_GetProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetProfileUpdateTask-response-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [Id](#API_account_GetProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetProfileUpdateTask-response-Id"></a>
The unique identifier of the partner account.  
Type: String  
Pattern: `partner-[A-Za-z0-9]{13}` 

 ** [StartedAt](#API_account_GetProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetProfileUpdateTask-response-StartedAt"></a>
The timestamp when the profile update task was started.  
Type: Timestamp

 ** [Status](#API_account_GetProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetProfileUpdateTask-response-Status"></a>
The current status of the profile update task (in progress, completed, failed, etc.).  
Type: String  
Valid Values: `IN_PROGRESS | CANCELED | SUCCEEDED | FAILED` 

 ** [TaskDetails](#API_account_GetProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetProfileUpdateTask-response-TaskDetails"></a>
The details of the profile update task including what changes are being made.  
Type: [TaskDetails](API_account_TaskDetails.md) object

 ** [TaskId](#API_account_GetProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetProfileUpdateTask-response-TaskId"></a>
The unique identifier of the profile update task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Pattern: `pprofiletask-[A-Za-z0-9]{13}` 

 ** [EndedAt](#API_account_GetProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetProfileUpdateTask-response-EndedAt"></a>
The timestamp when the profile update task was completed or failed.  
Type: Timestamp

 ** [ErrorDetailList](#API_account_GetProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetProfileUpdateTask-response-ErrorDetailList"></a>
A list of error details if any errors occurred during the profile update task.  
Type: Array of [ErrorDetail](API_account_ErrorDetail.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/GetProfileUpdateTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/GetProfileUpdateTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/GetProfileUpdateTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/GetProfileUpdateTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/GetProfileUpdateTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/GetProfileUpdateTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/GetProfileUpdateTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/GetProfileUpdateTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/GetProfileUpdateTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/GetProfileUpdateTask) 

# GetProfileVisibility


Retrieves the visibility settings for a partner profile, determining who can see the profile information.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_GetProfileVisibility_RequestSyntax) **   <a name="AWSPartnerCentral-account_GetProfileVisibility-request-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [Identifier](#API_account_GetProfileVisibility_RequestSyntax) **   <a name="AWSPartnerCentral-account_GetProfileVisibility-request-Identifier"></a>
The unique identifier of the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `(partner-[A-Za-z0-9]{13}|arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13})`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Catalog": "string",
   "Id": "string",
   "ProfileId": "string",
   "Visibility": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_account_GetProfileVisibility_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetProfileVisibility-response-Arn"></a>
The Amazon Resource Name (ARN) of the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13}` 

 ** [Catalog](#API_account_GetProfileVisibility_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetProfileVisibility-response-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [Id](#API_account_GetProfileVisibility_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetProfileVisibility-response-Id"></a>
The unique identifier of the partner account.  
Type: String  
Pattern: `partner-[A-Za-z0-9]{13}` 

 ** [ProfileId](#API_account_GetProfileVisibility_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetProfileVisibility-response-ProfileId"></a>
The unique identifier of the partner profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `pprofile-[A-Za-z0-9]{13}` 

 ** [Visibility](#API_account_GetProfileVisibility_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetProfileVisibility-response-Visibility"></a>
The visibility setting for the partner profile (public, private, restricted, etc.).  
Type: String  
Valid Values: `PRIVATE | PUBLIC` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/GetProfileVisibility) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/GetProfileVisibility) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/GetProfileVisibility) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/GetProfileVisibility) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/GetProfileVisibility) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/GetProfileVisibility) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/GetProfileVisibility) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/GetProfileVisibility) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/GetProfileVisibility) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/GetProfileVisibility) 

# GetVerification


Retrieves the current status and details of a verification process for a partner account. This operation allows partners to check the progress and results of business or registrant verification processes.

## Request Syntax


```
{
   "VerificationType": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [VerificationType](#API_account_GetVerification_RequestSyntax) **   <a name="AWSPartnerCentral-account_GetVerification-request-VerificationType"></a>
The type of verification to retrieve information for. Valid values include business verification for company registration details and registrant verification for individual identity confirmation.  
Type: String  
Valid Values: `BUSINESS_VERIFICATION | REGISTRANT_VERIFICATION`   
Required: Yes

## Response Syntax


```
{
   "CompletedAt": "string",
   "StartedAt": "string",
   "VerificationResponseDetails": { ... },
   "VerificationStatus": "string",
   "VerificationStatusReason": "string",
   "VerificationType": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [StartedAt](#API_account_GetVerification_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetVerification-response-StartedAt"></a>
The timestamp when the verification process was initiated.  
Type: Timestamp

 ** [VerificationResponseDetails](#API_account_GetVerification_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetVerification-response-VerificationResponseDetails"></a>
Detailed response information specific to the type of verification performed, including any verification-specific data or results.  
Type: [VerificationResponseDetails](API_account_VerificationResponseDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [VerificationStatus](#API_account_GetVerification_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetVerification-response-VerificationStatus"></a>
The current status of the verification process. Possible values include pending, in-progress, completed, failed, or expired.  
Type: String  
Valid Values: `PENDING_CUSTOMER_ACTION | IN_PROGRESS | FAILED | SUCCEEDED | REJECTED` 

 ** [VerificationType](#API_account_GetVerification_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetVerification-response-VerificationType"></a>
The type of verification that was requested and processed.  
Type: String  
Valid Values: `BUSINESS_VERIFICATION | REGISTRANT_VERIFICATION` 

 ** [CompletedAt](#API_account_GetVerification_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetVerification-response-CompletedAt"></a>
The timestamp when the verification process was completed. This field is null if the verification is still in progress.  
Type: Timestamp

 ** [VerificationStatusReason](#API_account_GetVerification_ResponseSyntax) **   <a name="AWSPartnerCentral-account_GetVerification-response-VerificationStatusReason"></a>
Additional information explaining the current verification status, particularly useful when the status indicates a failure or requires additional action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/GetVerification) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/GetVerification) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/GetVerification) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/GetVerification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/GetVerification) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/GetVerification) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/GetVerification) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/GetVerification) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/GetVerification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/GetVerification) 

# ListConnectionInvitations


Lists connection invitations for the partner account, with optional filtering by status, type, and other criteria.

## Request Syntax


```
{
   "Catalog": "string",
   "ConnectionType": "string",
   "MaxResults": number,
   "NextToken": "string",
   "OtherParticipantIdentifiers": [ "string" ],
   "ParticipantType": "string",
   "Status": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_ListConnectionInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-account_ListConnectionInvitations-request-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [ConnectionType](#API_account_ListConnectionInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-account_ListConnectionInvitations-request-ConnectionType"></a>
Filter results by connection type (e.g., reseller, distributor, technology partner).  
Type: String  
Valid Values: `OPPORTUNITY_COLLABORATION | SUBSIDIARY`   
Required: No

 ** [MaxResults](#API_account_ListConnectionInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-account_ListConnectionInvitations-request-MaxResults"></a>
The maximum number of connection invitations to return in a single response.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_account_ListConnectionInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-account_ListConnectionInvitations-request-NextToken"></a>
The token for retrieving the next page of results in paginated responses.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\S]+`   
Required: No

 ** [OtherParticipantIdentifiers](#API_account_ListConnectionInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-account_ListConnectionInvitations-request-OtherParticipantIdentifiers"></a>
Filter results by specific participant identifiers.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]+`   
Required: No

 ** [ParticipantType](#API_account_ListConnectionInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-account_ListConnectionInvitations-request-ParticipantType"></a>
Filter results by participant type (inviter or invitee).  
Type: String  
Valid Values: `SENDER | RECEIVER`   
Required: No

 ** [Status](#API_account_ListConnectionInvitations_RequestSyntax) **   <a name="AWSPartnerCentral-account_ListConnectionInvitations-request-Status"></a>
Filter results by invitation status (pending, accepted, rejected, canceled, expired).  
Type: String  
Valid Values: `PENDING | ACCEPTED | REJECTED | CANCELED | EXPIRED`   
Required: No

## Response Syntax


```
{
   "ConnectionInvitationSummaries": [ 
      { 
         "Arn": "string",
         "Catalog": "string",
         "ConnectionId": "string",
         "ConnectionType": "string",
         "CreatedAt": "string",
         "ExpiresAt": "string",
         "Id": "string",
         "OtherParticipantIdentifier": "string",
         "ParticipantType": "string",
         "Status": "string",
         "UpdatedAt": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConnectionInvitationSummaries](#API_account_ListConnectionInvitations_ResponseSyntax) **   <a name="AWSPartnerCentral-account_ListConnectionInvitations-response-ConnectionInvitationSummaries"></a>
A list of connection invitation summaries matching the specified criteria.  
Type: Array of [ConnectionInvitationSummary](API_account_ConnectionInvitationSummary.md) objects

 ** [NextToken](#API_account_ListConnectionInvitations_ResponseSyntax) **   <a name="AWSPartnerCentral-account_ListConnectionInvitations-response-NextToken"></a>
The token for retrieving the next page of results if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\S]+` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/ListConnectionInvitations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/ListConnectionInvitations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/ListConnectionInvitations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/ListConnectionInvitations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/ListConnectionInvitations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/ListConnectionInvitations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/ListConnectionInvitations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/ListConnectionInvitations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/ListConnectionInvitations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/ListConnectionInvitations) 

# ListConnections


Lists active connections for the partner account, with optional filtering by connection type and participant.

## Request Syntax


```
{
   "Catalog": "string",
   "ConnectionType": "string",
   "MaxResults": number,
   "NextToken": "string",
   "OtherParticipantIdentifiers": [ "string" ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_ListConnections_RequestSyntax) **   <a name="AWSPartnerCentral-account_ListConnections-request-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [ConnectionType](#API_account_ListConnections_RequestSyntax) **   <a name="AWSPartnerCentral-account_ListConnections-request-ConnectionType"></a>
Filter results by connection type (e.g., reseller, distributor, technology partner).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[a-zA-Z_-]+(:[a-zA-Z]+)?`   
Required: No

 ** [MaxResults](#API_account_ListConnections_RequestSyntax) **   <a name="AWSPartnerCentral-account_ListConnections-request-MaxResults"></a>
The maximum number of connections to return in a single response.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_account_ListConnections_RequestSyntax) **   <a name="AWSPartnerCentral-account_ListConnections-request-NextToken"></a>
The token for retrieving the next page of results in paginated responses.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\S]+`   
Required: No

 ** [OtherParticipantIdentifiers](#API_account_ListConnections_RequestSyntax) **   <a name="AWSPartnerCentral-account_ListConnections-request-OtherParticipantIdentifiers"></a>
Filter results by specific participant identifiers.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]+`   
Required: No

## Response Syntax


```
{
   "ConnectionSummaries": [ 
      { 
         "Arn": "string",
         "Catalog": "string",
         "ConnectionTypes": { 
            "string" : { 
               "OtherParticipant": { ... },
               "Status": "string"
            }
         },
         "Id": "string",
         "OtherParticipantAccountId": "string",
         "UpdatedAt": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConnectionSummaries](#API_account_ListConnections_ResponseSyntax) **   <a name="AWSPartnerCentral-account_ListConnections-response-ConnectionSummaries"></a>
A list of connection summaries matching the specified criteria.  
Type: Array of [ConnectionSummary](API_account_ConnectionSummary.md) objects

 ** [NextToken](#API_account_ListConnections_ResponseSyntax) **   <a name="AWSPartnerCentral-account_ListConnections-response-NextToken"></a>
The token for retrieving the next page of results if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\S]+` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/ListConnections) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/ListConnections) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/ListConnections) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/ListConnections) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/ListConnections) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/ListConnections) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/ListConnections) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/ListConnections) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/ListConnections) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/ListConnections) 

# ListPartners


Lists partner accounts in the catalog, providing a summary view of all partners.

## Request Syntax


```
{
   "Catalog": "string",
   "NextToken": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_ListPartners_RequestSyntax) **   <a name="AWSPartnerCentral-account_ListPartners-request-Catalog"></a>
The catalog identifier to list partners from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [NextToken](#API_account_ListPartners_RequestSyntax) **   <a name="AWSPartnerCentral-account_ListPartners-request-NextToken"></a>
The token for retrieving the next page of results in paginated responses.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\S]+`   
Required: No

## Response Syntax


```
{
   "NextToken": "string",
   "PartnerSummaryList": [ 
      { 
         "Arn": "string",
         "Catalog": "string",
         "CreatedAt": "string",
         "Id": "string",
         "LegalName": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PartnerSummaryList](#API_account_ListPartners_ResponseSyntax) **   <a name="AWSPartnerCentral-account_ListPartners-response-PartnerSummaryList"></a>
A list of partner summaries including basic information about each partner account.  
Type: Array of [PartnerSummary](API_account_PartnerSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

 ** [NextToken](#API_account_ListPartners_ResponseSyntax) **   <a name="AWSPartnerCentral-account_ListPartners-response-NextToken"></a>
The token for retrieving the next page of results if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\S]+` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/ListPartners) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/ListPartners) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/ListPartners) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/ListPartners) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/ListPartners) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/ListPartners) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/ListPartners) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/ListPartners) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/ListPartners) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/ListPartners) 

# ListTagsForResource


Lists all tags associated with a specific AWS Partner Central Account resource.

## Request Syntax


```
{
   "ResourceArn": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [ResourceArn](#API_account_ListTagsForResource_RequestSyntax) **   <a name="AWSPartnerCentral-account_ListTagsForResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource to list tags for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:[A-Za-z0-9._:/-]+`   
Required: Yes

## Response Syntax


```
{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ResourceArn](#API_account_ListTagsForResource_ResponseSyntax) **   <a name="AWSPartnerCentral-account_ListTagsForResource-response-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource that the tags are associated with.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:[A-Za-z0-9._:/-]+` 

 ** [Tags](#API_account_ListTagsForResource_ResponseSyntax) **   <a name="AWSPartnerCentral-account_ListTagsForResource-response-Tags"></a>
A list of tags associated with the specified resource.  
Type: Array of [Tag](API_account_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/ListTagsForResource) 

# PutAllianceLeadContact


Creates or updates the alliance lead contact information for a partner account.

## Request Syntax


```
{
   "AllianceLeadContact": { 
      "BusinessTitle": "string",
      "Email": "string",
      "FirstName": "string",
      "LastName": "string"
   },
   "Catalog": "string",
   "EmailVerificationCode": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [AllianceLeadContact](#API_account_PutAllianceLeadContact_RequestSyntax) **   <a name="AWSPartnerCentral-account_PutAllianceLeadContact-request-AllianceLeadContact"></a>
The alliance lead contact information to set for the partner account.  
Type: [AllianceLeadContact](API_account_AllianceLeadContact.md) object  
Required: Yes

 ** [Catalog](#API_account_PutAllianceLeadContact_RequestSyntax) **   <a name="AWSPartnerCentral-account_PutAllianceLeadContact-request-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [Identifier](#API_account_PutAllianceLeadContact_RequestSyntax) **   <a name="AWSPartnerCentral-account_PutAllianceLeadContact-request-Identifier"></a>
The unique identifier of the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `(partner-[A-Za-z0-9]{13}|arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13})`   
Required: Yes

 ** [EmailVerificationCode](#API_account_PutAllianceLeadContact_RequestSyntax) **   <a name="AWSPartnerCentral-account_PutAllianceLeadContact-request-EmailVerificationCode"></a>
The verification code sent to the alliance lead contact's email to confirm the update.  
Type: String  
Length Constraints: Fixed length of 6.  
Pattern: `[0-9]+`   
Required: No

## Response Syntax


```
{
   "AllianceLeadContact": { 
      "BusinessTitle": "string",
      "Email": "string",
      "FirstName": "string",
      "LastName": "string"
   },
   "Arn": "string",
   "Catalog": "string",
   "Id": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AllianceLeadContact](#API_account_PutAllianceLeadContact_ResponseSyntax) **   <a name="AWSPartnerCentral-account_PutAllianceLeadContact-response-AllianceLeadContact"></a>
The updated alliance lead contact information.  
Type: [AllianceLeadContact](API_account_AllianceLeadContact.md) object

 ** [Arn](#API_account_PutAllianceLeadContact_ResponseSyntax) **   <a name="AWSPartnerCentral-account_PutAllianceLeadContact-response-Arn"></a>
The Amazon Resource Name (ARN) of the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13}` 

 ** [Catalog](#API_account_PutAllianceLeadContact_ResponseSyntax) **   <a name="AWSPartnerCentral-account_PutAllianceLeadContact-response-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [Id](#API_account_PutAllianceLeadContact_ResponseSyntax) **   <a name="AWSPartnerCentral-account_PutAllianceLeadContact-response-Id"></a>
The unique identifier of the partner account.  
Type: String  
Pattern: `partner-[A-Za-z0-9]{13}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/PutAllianceLeadContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/PutAllianceLeadContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/PutAllianceLeadContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/PutAllianceLeadContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/PutAllianceLeadContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/PutAllianceLeadContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/PutAllianceLeadContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/PutAllianceLeadContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/PutAllianceLeadContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/PutAllianceLeadContact) 

# PutProfileVisibility


Sets the visibility level for a partner profile, controlling who can view the profile information.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string",
   "Visibility": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_PutProfileVisibility_RequestSyntax) **   <a name="AWSPartnerCentral-account_PutProfileVisibility-request-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [Identifier](#API_account_PutProfileVisibility_RequestSyntax) **   <a name="AWSPartnerCentral-account_PutProfileVisibility-request-Identifier"></a>
The unique identifier of the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `(partner-[A-Za-z0-9]{13}|arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13})`   
Required: Yes

 ** [Visibility](#API_account_PutProfileVisibility_RequestSyntax) **   <a name="AWSPartnerCentral-account_PutProfileVisibility-request-Visibility"></a>
The visibility setting to apply to the partner profile.  
Type: String  
Valid Values: `PRIVATE | PUBLIC`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Catalog": "string",
   "Id": "string",
   "ProfileId": "string",
   "Visibility": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_account_PutProfileVisibility_ResponseSyntax) **   <a name="AWSPartnerCentral-account_PutProfileVisibility-response-Arn"></a>
The Amazon Resource Name (ARN) of the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13}` 

 ** [Catalog](#API_account_PutProfileVisibility_ResponseSyntax) **   <a name="AWSPartnerCentral-account_PutProfileVisibility-response-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [Id](#API_account_PutProfileVisibility_ResponseSyntax) **   <a name="AWSPartnerCentral-account_PutProfileVisibility-response-Id"></a>
The unique identifier of the partner account.  
Type: String  
Pattern: `partner-[A-Za-z0-9]{13}` 

 ** [ProfileId](#API_account_PutProfileVisibility_ResponseSyntax) **   <a name="AWSPartnerCentral-account_PutProfileVisibility-response-ProfileId"></a>
The unique identifier of the partner profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `pprofile-[A-Za-z0-9]{13}` 

 ** [Visibility](#API_account_PutProfileVisibility_ResponseSyntax) **   <a name="AWSPartnerCentral-account_PutProfileVisibility-response-Visibility"></a>
The updated visibility setting for the partner profile.  
Type: String  
Valid Values: `PRIVATE | PUBLIC` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/PutProfileVisibility) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/PutProfileVisibility) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/PutProfileVisibility) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/PutProfileVisibility) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/PutProfileVisibility) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/PutProfileVisibility) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/PutProfileVisibility) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/PutProfileVisibility) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/PutProfileVisibility) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/PutProfileVisibility) 

# RejectConnectionInvitation


Rejects a connection invitation from another partner, declining the partnership request.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "Identifier": "string",
   "Reason": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_RejectConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-request-Catalog"></a>
The catalog identifier where the connection invitation exists.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [ClientToken](#API_account_RejectConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9-_]+`   
Required: Yes

 ** [Identifier](#API_account_RejectConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-request-Identifier"></a>
The unique identifier of the connection invitation to reject.  
Type: String  
Pattern: `pacinv-[A-Za-z0-9]{13}`   
Required: Yes

 ** [Reason](#API_account_RejectConnectionInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-request-Reason"></a>
The reason for rejecting the connection invitation.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax


```
{
   "Arn": "string",
   "Catalog": "string",
   "ConnectionId": "string",
   "ConnectionType": "string",
   "CreatedAt": "string",
   "ExpiresAt": "string",
   "Id": "string",
   "InvitationMessage": "string",
   "InviterEmail": "string",
   "InviterName": "string",
   "OtherParticipantIdentifier": "string",
   "ParticipantType": "string",
   "Status": "string",
   "UpdatedAt": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_account_RejectConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-response-Arn"></a>
The Amazon Resource Name (ARN) of the rejected connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-zA-Z0-9-]+:partnercentral:[a-z0-9\-]*::catalog/[a-zA-Z]+/connection-invitation/pacinv-[A-Za-z0-9]{13}` 

 ** [Catalog](#API_account_RejectConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-response-Catalog"></a>
The catalog identifier where the connection invitation was rejected.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [ConnectionType](#API_account_RejectConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-response-ConnectionType"></a>
The type of connection that was being invited for.  
Type: String  
Valid Values: `OPPORTUNITY_COLLABORATION | SUBSIDIARY` 

 ** [CreatedAt](#API_account_RejectConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-response-CreatedAt"></a>
The timestamp when the connection invitation was originally created.  
Type: Timestamp

 ** [Id](#API_account_RejectConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-response-Id"></a>
The unique identifier of the rejected connection invitation.  
Type: String  
Pattern: `pacinv-[A-Za-z0-9]{13}` 

 ** [InvitationMessage](#API_account_RejectConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-response-InvitationMessage"></a>
The message that was included with the original connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD\n]+` 

 ** [InviterEmail](#API_account_RejectConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-response-InviterEmail"></a>
The email address of the person who sent the connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 320.  
Pattern: `[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*` 

 ** [InviterName](#API_account_RejectConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-response-InviterName"></a>
The name of the person who sent the connection invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+` 

 ** [OtherParticipantIdentifier](#API_account_RejectConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-response-OtherParticipantIdentifier"></a>
The identifier of the other participant who sent the invitation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [ParticipantType](#API_account_RejectConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-response-ParticipantType"></a>
The type of participant (inviter or invitee) in the connection invitation.  
Type: String  
Valid Values: `SENDER | RECEIVER` 

 ** [Status](#API_account_RejectConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-response-Status"></a>
The current status of the connection invitation (rejected).  
Type: String  
Valid Values: `PENDING | ACCEPTED | REJECTED | CANCELED | EXPIRED` 

 ** [UpdatedAt](#API_account_RejectConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-response-UpdatedAt"></a>
The timestamp when the connection invitation was last updated (rejected).  
Type: Timestamp

 ** [ConnectionId](#API_account_RejectConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-response-ConnectionId"></a>
The identifier of the connection associated with the rejected invitation.  
Type: String  
Pattern: `pac-[A-Za-z0-9]{13}` 

 ** [ExpiresAt](#API_account_RejectConnectionInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-account_RejectConnectionInvitation-response-ExpiresAt"></a>
The timestamp when the connection invitation would have expired.  
Type: Timestamp

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.    
 ** Reason **   
The specific reason for the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/RejectConnectionInvitation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/RejectConnectionInvitation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/RejectConnectionInvitation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/RejectConnectionInvitation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/RejectConnectionInvitation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/RejectConnectionInvitation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/RejectConnectionInvitation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/RejectConnectionInvitation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/RejectConnectionInvitation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/RejectConnectionInvitation) 

# SendEmailVerificationCode


Sends an email verification code to the specified email address for account verification purposes.

## Request Syntax


```
{
   "Catalog": "string",
   "Email": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_SendEmailVerificationCode_RequestSyntax) **   <a name="AWSPartnerCentral-account_SendEmailVerificationCode-request-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [Email](#API_account_SendEmailVerificationCode_RequestSyntax) **   <a name="AWSPartnerCentral-account_SendEmailVerificationCode-request-Email"></a>
The email address to send the verification code to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 320.  
Pattern: `[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*`   
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The request was rejected because it would exceed a service quota or limit. This may occur when trying to create more resources than allowed by the service limits.    
 ** Reason **   
The specific reason for the service quota being exceeded.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/SendEmailVerificationCode) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/SendEmailVerificationCode) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/SendEmailVerificationCode) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/SendEmailVerificationCode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/SendEmailVerificationCode) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/SendEmailVerificationCode) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/SendEmailVerificationCode) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/SendEmailVerificationCode) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/SendEmailVerificationCode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/SendEmailVerificationCode) 

# StartProfileUpdateTask


Initiates a profile update task to modify partner profile information asynchronously.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "Identifier": "string",
   "TaskDetails": { 
      "Description": "string",
      "DisplayName": "string",
      "IndustrySegments": [ "string" ],
      "LocalizedContents": [ 
         { 
            "Description": "string",
            "DisplayName": "string",
            "Locale": "string",
            "LogoUrl": "string",
            "WebsiteUrl": "string"
         }
      ],
      "LogoUrl": "string",
      "PrimarySolutionType": "string",
      "TranslationSourceLocale": "string",
      "WebsiteUrl": "string"
   }
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_account_StartProfileUpdateTask_RequestSyntax) **   <a name="AWSPartnerCentral-account_StartProfileUpdateTask-request-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [Identifier](#API_account_StartProfileUpdateTask_RequestSyntax) **   <a name="AWSPartnerCentral-account_StartProfileUpdateTask-request-Identifier"></a>
The unique identifier of the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `(partner-[A-Za-z0-9]{13}|arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13})`   
Required: Yes

 ** [TaskDetails](#API_account_StartProfileUpdateTask_RequestSyntax) **   <a name="AWSPartnerCentral-account_StartProfileUpdateTask-request-TaskDetails"></a>
The details of the profile updates to be performed.  
Type: [TaskDetails](API_account_TaskDetails.md) object  
Required: Yes

 ** [ClientToken](#API_account_StartProfileUpdateTask_RequestSyntax) **   <a name="AWSPartnerCentral-account_StartProfileUpdateTask-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9-_]+`   
Required: No

## Response Syntax


```
{
   "Arn": "string",
   "Catalog": "string",
   "EndedAt": "string",
   "ErrorDetailList": [ 
      { 
         "Locale": "string",
         "Message": "string",
         "Reason": "string"
      }
   ],
   "Id": "string",
   "StartedAt": "string",
   "Status": "string",
   "TaskDetails": { 
      "Description": "string",
      "DisplayName": "string",
      "IndustrySegments": [ "string" ],
      "LocalizedContents": [ 
         { 
            "Description": "string",
            "DisplayName": "string",
            "Locale": "string",
            "LogoUrl": "string",
            "WebsiteUrl": "string"
         }
      ],
      "LogoUrl": "string",
      "PrimarySolutionType": "string",
      "TranslationSourceLocale": "string",
      "WebsiteUrl": "string"
   },
   "TaskId": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_account_StartProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_StartProfileUpdateTask-response-Arn"></a>
The Amazon Resource Name (ARN) of the started profile update task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13}` 

 ** [Catalog](#API_account_StartProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_StartProfileUpdateTask-response-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [Id](#API_account_StartProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_StartProfileUpdateTask-response-Id"></a>
The unique identifier of the partner account.  
Type: String  
Pattern: `partner-[A-Za-z0-9]{13}` 

 ** [StartedAt](#API_account_StartProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_StartProfileUpdateTask-response-StartedAt"></a>
The timestamp when the profile update task was started.  
Type: Timestamp

 ** [Status](#API_account_StartProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_StartProfileUpdateTask-response-Status"></a>
The current status of the profile update task (in progress).  
Type: String  
Valid Values: `IN_PROGRESS | CANCELED | SUCCEEDED | FAILED` 

 ** [TaskDetails](#API_account_StartProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_StartProfileUpdateTask-response-TaskDetails"></a>
The details of the profile update task that was started.  
Type: [TaskDetails](API_account_TaskDetails.md) object

 ** [TaskId](#API_account_StartProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_StartProfileUpdateTask-response-TaskId"></a>
The unique identifier of the started profile update task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Pattern: `pprofiletask-[A-Za-z0-9]{13}` 

 ** [EndedAt](#API_account_StartProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_StartProfileUpdateTask-response-EndedAt"></a>
The timestamp when the profile update task ended (null for in-progress tasks).  
Type: Timestamp

 ** [ErrorDetailList](#API_account_StartProfileUpdateTask_ResponseSyntax) **   <a name="AWSPartnerCentral-account_StartProfileUpdateTask-response-ErrorDetailList"></a>
A list of error details if any errors occurred during the profile update task.  
Type: Array of [ErrorDetail](API_account_ErrorDetail.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.    
 ** Reason **   
The specific reason for the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/StartProfileUpdateTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/StartProfileUpdateTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/StartProfileUpdateTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/StartProfileUpdateTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/StartProfileUpdateTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/StartProfileUpdateTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/StartProfileUpdateTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/StartProfileUpdateTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/StartProfileUpdateTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/StartProfileUpdateTask) 

# StartVerification


Initiates a new verification process for a partner account. This operation begins the verification workflow for either business registration or individual registrant identity verification as required by AWS Partner Central.

## Request Syntax


```
{
   "ClientToken": "string",
   "VerificationDetails": { ... }
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [ClientToken](#API_account_StartVerification_RequestSyntax) **   <a name="AWSPartnerCentral-account_StartVerification-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This prevents duplicate verification processes from being started accidentally.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9-_]+`   
Required: No

 ** [VerificationDetails](#API_account_StartVerification_RequestSyntax) **   <a name="AWSPartnerCentral-account_StartVerification-request-VerificationDetails"></a>
The specific details required for the verification process, including business information for business verification or personal information for registrant verification.  
Type: [VerificationDetails](API_account_VerificationDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax


```
{
   "CompletedAt": "string",
   "StartedAt": "string",
   "VerificationResponseDetails": { ... },
   "VerificationStatus": "string",
   "VerificationStatusReason": "string",
   "VerificationType": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [StartedAt](#API_account_StartVerification_ResponseSyntax) **   <a name="AWSPartnerCentral-account_StartVerification-response-StartedAt"></a>
The timestamp when the verification process was successfully initiated.  
Type: Timestamp

 ** [VerificationResponseDetails](#API_account_StartVerification_ResponseSyntax) **   <a name="AWSPartnerCentral-account_StartVerification-response-VerificationResponseDetails"></a>
Initial response details specific to the type of verification started, which may include next steps or additional requirements.  
Type: [VerificationResponseDetails](API_account_VerificationResponseDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [VerificationStatus](#API_account_StartVerification_ResponseSyntax) **   <a name="AWSPartnerCentral-account_StartVerification-response-VerificationStatus"></a>
The initial status of the verification process after it has been started. Typically this will be pending or in-progress.  
Type: String  
Valid Values: `PENDING_CUSTOMER_ACTION | IN_PROGRESS | FAILED | SUCCEEDED | REJECTED` 

 ** [VerificationType](#API_account_StartVerification_ResponseSyntax) **   <a name="AWSPartnerCentral-account_StartVerification-response-VerificationType"></a>
The type of verification that was started based on the provided verification details.  
Type: String  
Valid Values: `BUSINESS_VERIFICATION | REGISTRANT_VERIFICATION` 

 ** [CompletedAt](#API_account_StartVerification_ResponseSyntax) **   <a name="AWSPartnerCentral-account_StartVerification-response-CompletedAt"></a>
The timestamp when the verification process was completed. This field is typically null for newly started verifications unless they complete immediately.  
Type: Timestamp

 ** [VerificationStatusReason](#API_account_StartVerification_ResponseSyntax) **   <a name="AWSPartnerCentral-account_StartVerification-response-VerificationStatusReason"></a>
Additional information about the initial verification status, including any immediate feedback about the submitted verification details.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.    
 ** Reason **   
The specific reason for the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The request was rejected because it would exceed a service quota or limit. This may occur when trying to create more resources than allowed by the service limits.    
 ** Reason **   
The specific reason for the service quota being exceeded.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/StartVerification) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/StartVerification) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/StartVerification) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/StartVerification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/StartVerification) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/StartVerification) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/StartVerification) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/StartVerification) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/StartVerification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/StartVerification) 

# TagResource


Adds or updates tags for a specified AWS Partner Central Account resource.

## Request Syntax


```
{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [ResourceArn](#API_account_TagResource_RequestSyntax) **   <a name="AWSPartnerCentral-account_TagResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource to tag.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:[A-Za-z0-9._:/-]+`   
Required: Yes

 ** [Tags](#API_account_TagResource_RequestSyntax) **   <a name="AWSPartnerCentral-account_TagResource-request-Tags"></a>
A list of tags to add or update for the specified resource.  
Type: Array of [Tag](API_account_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.    
 ** Reason **   
The specific reason for the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/TagResource) 

# UntagResource


Removes specified tags from an AWS Partner Central Account resource.

## Request Syntax


```
{
   "ResourceArn": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [ResourceArn](#API_account_UntagResource_RequestSyntax) **   <a name="AWSPartnerCentral-account_UntagResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource to remove tags from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:[A-Za-z0-9._:/-]+`   
Required: Yes

 ** [TagKeys](#API_account_UntagResource_RequestSyntax) **   <a name="AWSPartnerCentral-account_UntagResource-request-TagKeys"></a>
A list of tag keys to remove from the specified resource.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.    
 ** Reason **   
The specific reason for the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.    
 ** Reason **   
The specific reason why the resource was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/UntagResource) 

# UpdateConnectionPreferences


Updates the connection preferences for a partner account, modifying access settings and exclusions.

## Request Syntax


```
{
   "AccessType": "string",
   "Catalog": "string",
   "ExcludedParticipantIdentifiers": [ "string" ],
   "Revision": number
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [AccessType](#API_account_UpdateConnectionPreferences_RequestSyntax) **   <a name="AWSPartnerCentral-account_UpdateConnectionPreferences-request-AccessType"></a>
The access type setting for connections (e.g., open, restricted, invitation-only).  
Type: String  
Valid Values: `ALLOW_ALL | DENY_ALL | ALLOW_BY_DEFAULT_DENY_SOME`   
Required: Yes

 ** [Catalog](#API_account_UpdateConnectionPreferences_RequestSyntax) **   <a name="AWSPartnerCentral-account_UpdateConnectionPreferences-request-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

 ** [Revision](#API_account_UpdateConnectionPreferences_RequestSyntax) **   <a name="AWSPartnerCentral-account_UpdateConnectionPreferences-request-Revision"></a>
The revision number of the connection preferences for optimistic locking.  
Type: Long  
Required: Yes

 ** [ExcludedParticipantIdentifiers](#API_account_UpdateConnectionPreferences_RequestSyntax) **   <a name="AWSPartnerCentral-account_UpdateConnectionPreferences-request-ExcludedParticipantIdentifiers"></a>
The updated list of participant identifiers to exclude from connections.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]+`   
Required: No

## Response Syntax


```
{
   "AccessType": "string",
   "Arn": "string",
   "Catalog": "string",
   "ExcludedParticipantIds": [ "string" ],
   "Revision": number,
   "UpdatedAt": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccessType](#API_account_UpdateConnectionPreferences_ResponseSyntax) **   <a name="AWSPartnerCentral-account_UpdateConnectionPreferences-response-AccessType"></a>
The updated access type setting for connections.  
Type: String  
Valid Values: `ALLOW_ALL | DENY_ALL | ALLOW_BY_DEFAULT_DENY_SOME` 

 ** [Arn](#API_account_UpdateConnectionPreferences_ResponseSyntax) **   <a name="AWSPartnerCentral-account_UpdateConnectionPreferences-response-Arn"></a>
The Amazon Resource Name (ARN) of the updated connection preferences.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `arn:[a-zA-Z0-9-]+:partnercentral:[a-z0-9\-]*:[0-9]{12}:catalog/[a-zA-Z]+/connection-preferences` 

 ** [Catalog](#API_account_UpdateConnectionPreferences_ResponseSyntax) **   <a name="AWSPartnerCentral-account_UpdateConnectionPreferences-response-Catalog"></a>
The catalog identifier for the partner account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [Revision](#API_account_UpdateConnectionPreferences_ResponseSyntax) **   <a name="AWSPartnerCentral-account_UpdateConnectionPreferences-response-Revision"></a>
The updated revision number of the connection preferences.  
Type: Long

 ** [UpdatedAt](#API_account_UpdateConnectionPreferences_ResponseSyntax) **   <a name="AWSPartnerCentral-account_UpdateConnectionPreferences-response-UpdatedAt"></a>
The timestamp when the connection preferences were last updated.  
Type: Timestamp

 ** [ExcludedParticipantIds](#API_account_UpdateConnectionPreferences_ResponseSyntax) **   <a name="AWSPartnerCentral-account_UpdateConnectionPreferences-response-ExcludedParticipantIds"></a>
A list of participant IDs that are excluded from connection requests or interactions.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]+` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.    
 ** Reason **   
The specific reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.    
 ** Reason **   
The specific reason for the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.    
 ** QuotaCode **   
The quota code associated with the throttling error.  
 ** ServiceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.    
 ** ErrorDetails **   
A list of detailed validation errors that occurred during request processing.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-account-2025-04-04/UpdateConnectionPreferences) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-account-2025-04-04/UpdateConnectionPreferences) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-account-2025-04-04/UpdateConnectionPreferences) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-account-2025-04-04/UpdateConnectionPreferences) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-account-2025-04-04/UpdateConnectionPreferences) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-account-2025-04-04/UpdateConnectionPreferences) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-account-2025-04-04/UpdateConnectionPreferences) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-account-2025-04-04/UpdateConnectionPreferences) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-account-2025-04-04/UpdateConnectionPreferences) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-account-2025-04-04/UpdateConnectionPreferences) 

# Partner Central Benefits API


The following actions are supported by Partner Central Benefits API:
+  [AmendBenefitApplication](API_benefits_AmendBenefitApplication.md) 
+  [AssociateBenefitApplicationResource](API_benefits_AssociateBenefitApplicationResource.md) 
+  [CancelBenefitApplication](API_benefits_CancelBenefitApplication.md) 
+  [CreateBenefitApplication](API_benefits_CreateBenefitApplication.md) 
+  [DisassociateBenefitApplicationResource](API_benefits_DisassociateBenefitApplicationResource.md) 
+  [GetBenefit](API_benefits_GetBenefit.md) 
+  [GetBenefitAllocation](API_benefits_GetBenefitAllocation.md) 
+  [GetBenefitApplication](API_benefits_GetBenefitApplication.md) 
+  [ListBenefitAllocations](API_benefits_ListBenefitAllocations.md) 
+  [ListBenefitApplications](API_benefits_ListBenefitApplications.md) 
+  [ListBenefits](API_benefits_ListBenefits.md) 
+  [ListTagsForResource](API_benefits_ListTagsForResource.md) 
+  [RecallBenefitApplication](API_benefits_RecallBenefitApplication.md) 
+  [SubmitBenefitApplication](API_benefits_SubmitBenefitApplication.md) 
+  [TagResource](API_benefits_TagResource.md) 
+  [UntagResource](API_benefits_UntagResource.md) 
+  [UpdateBenefitApplication](API_benefits_UpdateBenefitApplication.md) 

# AmendBenefitApplication


Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control. The following fields paths can be modified using this API based on benefit program type.

For MAP and POC Programs: `$.AccountId` 

For ISVWMP Programs: `$.IsvWmpSecondTrancheConsentCaptured` 

## Request Syntax


```
{
   "AmendmentReason": "string",
   "Amendments": [ 
      { 
         "FieldPath": "string",
         "NewValue": "string"
      }
   ],
   "Catalog": "string",
   "ClientToken": "string",
   "Identifier": "string",
   "Revision": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [AmendmentReason](#API_benefits_AmendBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_AmendBenefitApplication-request-AmendmentReason"></a>
A descriptive reason explaining why the benefit application is being amended.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: Yes

 ** [Amendments](#API_benefits_AmendBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_AmendBenefitApplication-request-Amendments"></a>
A list of specific field amendments to apply to the benefit application.  
Type: Array of [Amendment](API_benefits_Amendment.md) objects  
Required: Yes

 ** [Catalog](#API_benefits_AmendBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_AmendBenefitApplication-request-Catalog"></a>
The catalog identifier that specifies which benefit catalog the application belongs to.  
Type: String  
Pattern: `[A-Za-z0-9_-]+`   
Required: Yes

 ** [ClientToken](#API_benefits_AmendBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_AmendBenefitApplication-request-ClientToken"></a>
A unique, case-sensitive identifier to ensure idempotent processing of the amendment request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]{1,64}`   
Required: Yes

 ** [Identifier](#API_benefits_AmendBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_AmendBenefitApplication-request-Identifier"></a>
The unique identifier of the benefit application to be amended.  
Type: String  
Pattern: `(arn:.+|benappl-[0-9a-z]{14})`   
Required: Yes

 ** [Revision](#API_benefits_AmendBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_AmendBenefitApplication-request-Revision"></a>
The current revision number of the benefit application to ensure optimistic concurrency control.  
Type: String  
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** ConflictException **   
Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.    
 ** Message **   
A message describing the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/AmendBenefitApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/AmendBenefitApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/AmendBenefitApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/AmendBenefitApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/AmendBenefitApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/AmendBenefitApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/AmendBenefitApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/AmendBenefitApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/AmendBenefitApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/AmendBenefitApplication) 

# AssociateBenefitApplicationResource


Links an AWS resource to an existing benefit application for tracking and management purposes.

## Request Syntax


```
{
   "BenefitApplicationIdentifier": "string",
   "Catalog": "string",
   "ResourceArn": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [BenefitApplicationIdentifier](#API_benefits_AssociateBenefitApplicationResource_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_AssociateBenefitApplicationResource-request-BenefitApplicationIdentifier"></a>
The unique identifier of the benefit application to associate the resource with.  
Type: String  
Pattern: `(arn:.+|benappl-[0-9a-z]{14})`   
Required: Yes

 ** [Catalog](#API_benefits_AssociateBenefitApplicationResource_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_AssociateBenefitApplicationResource-request-Catalog"></a>
The catalog identifier that specifies which benefit catalog the application belongs to.  
Type: String  
Pattern: `[A-Za-z0-9_-]+`   
Required: Yes

 ** [ResourceArn](#API_benefits_AssociateBenefitApplicationResource_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_AssociateBenefitApplicationResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the AWS resource to associate with the benefit application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1600.  
Pattern: `arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.+)`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Id": "string",
   "Revision": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_benefits_AssociateBenefitApplicationResource_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_AssociateBenefitApplicationResource-response-Arn"></a>
The Amazon Resource Name (ARN) of the benefit application after the resource association.  
Type: String

 ** [Id](#API_benefits_AssociateBenefitApplicationResource_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_AssociateBenefitApplicationResource-response-Id"></a>
The unique identifier of the benefit application after the resource association.  
Type: String  
Pattern: `benappl-[0-9a-z]{14}` 

 ** [Revision](#API_benefits_AssociateBenefitApplicationResource_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_AssociateBenefitApplicationResource-response-Revision"></a>
The updated revision number of the benefit application after the resource association.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** ConflictException **   
Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.    
 ** Message **   
A message describing the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/AssociateBenefitApplicationResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/AssociateBenefitApplicationResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/AssociateBenefitApplicationResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/AssociateBenefitApplicationResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/AssociateBenefitApplicationResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/AssociateBenefitApplicationResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/AssociateBenefitApplicationResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/AssociateBenefitApplicationResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/AssociateBenefitApplicationResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/AssociateBenefitApplicationResource) 

# CancelBenefitApplication


Cancels a benefit application that is currently in progress, preventing further processing.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "Identifier": "string",
   "Reason": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_benefits_CancelBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_CancelBenefitApplication-request-Catalog"></a>
The catalog identifier that specifies which benefit catalog the application belongs to.  
Type: String  
Pattern: `[A-Za-z0-9_-]+`   
Required: Yes

 ** [ClientToken](#API_benefits_CancelBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_CancelBenefitApplication-request-ClientToken"></a>
A unique, case-sensitive identifier to ensure idempotent processing of the cancellation request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]{1,64}`   
Required: Yes

 ** [Identifier](#API_benefits_CancelBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_CancelBenefitApplication-request-Identifier"></a>
The unique identifier of the benefit application to cancel.  
Type: String  
Pattern: `(arn:.+|benappl-[0-9a-z]{14})`   
Required: Yes

 ** [Reason](#API_benefits_CancelBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_CancelBenefitApplication-request-Reason"></a>
A descriptive reason explaining why the benefit application is being cancelled.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `[\s\S]{1,1000}`   
Required: No

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** ConflictException **   
Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.    
 ** Message **   
A message describing the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/CancelBenefitApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/CancelBenefitApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/CancelBenefitApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/CancelBenefitApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/CancelBenefitApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/CancelBenefitApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/CancelBenefitApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/CancelBenefitApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/CancelBenefitApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/CancelBenefitApplication) 

# CreateBenefitApplication


Creates a new benefit application for a partner to request access to AWS benefits and programs.

## Request Syntax


```
{
   "AssociatedResources": [ "string" ],
   "BenefitApplicationDetails": JSON value,
   "BenefitIdentifier": "string",
   "Catalog": "string",
   "ClientToken": "string",
   "Description": "string",
   "FileDetails": [ 
      { 
         "BusinessUseCase": "string",
         "FileURI": "string"
      }
   ],
   "FulfillmentTypes": [ "string" ],
   "Name": "string",
   "PartnerContacts": [ 
      { 
         "BusinessTitle": "string",
         "Email": "string",
         "FirstName": "string",
         "LastName": "string",
         "Phone": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [BenefitIdentifier](#API_benefits_CreateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_CreateBenefitApplication-request-BenefitIdentifier"></a>
The unique identifier of the benefit being requested in this application.  
Type: String  
Pattern: `(arn:.+|ben-[0-9a-z]{14})`   
Required: Yes

 ** [Catalog](#API_benefits_CreateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_CreateBenefitApplication-request-Catalog"></a>
The catalog identifier that specifies which benefit catalog to create the application in.  
Type: String  
Pattern: `[A-Za-z0-9_-]+`   
Required: Yes

 ** [ClientToken](#API_benefits_CreateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_CreateBenefitApplication-request-ClientToken"></a>
A unique, case-sensitive identifier to ensure idempotent processing of the creation request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[!-~]{1,64}`   
Required: Yes

 ** [AssociatedResources](#API_benefits_CreateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_CreateBenefitApplication-request-AssociatedResources"></a>
AWS resources that are associated with this benefit application.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Pattern: `arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.+)`   
Required: No

 ** [BenefitApplicationDetails](#API_benefits_CreateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_CreateBenefitApplication-request-BenefitApplicationDetails"></a>
Detailed information and requirements specific to the benefit being requested. To retrieve the detailed specifications for any benefit, make a `GetBenefit` API call using the benefit identifier.  
Type: JSON value  
Required: No

 ** [Description](#API_benefits_CreateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_CreateBenefitApplication-request-Description"></a>
A detailed description of the benefit application and its intended use.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** [FileDetails](#API_benefits_CreateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_CreateBenefitApplication-request-FileDetails"></a>
Supporting documents and files attached to the benefit application.  
Type: Array of [FileInput](API_benefits_FileInput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 30 items.  
Required: No

 ** [FulfillmentTypes](#API_benefits_CreateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_CreateBenefitApplication-request-FulfillmentTypes"></a>
The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).  
Type: Array of strings  
Valid Values: `CREDITS | CASH | ACCESS`   
Required: No

 ** [Name](#API_benefits_CreateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_CreateBenefitApplication-request-Name"></a>
A human-readable name for the benefit application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [PartnerContacts](#API_benefits_CreateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_CreateBenefitApplication-request-PartnerContacts"></a>
Contact information for partner representatives responsible for this benefit application.  
Type: Array of [Contact](API_benefits_Contact.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: No

 ** [Tags](#API_benefits_CreateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_CreateBenefitApplication-request-Tags"></a>
Key-value pairs to categorize and organize the benefit application.  
Type: Array of [Tag](API_benefits_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax


```
{
   "Arn": "string",
   "Id": "string",
   "Revision": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_benefits_CreateBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_CreateBenefitApplication-response-Arn"></a>
The Amazon Resource Name (ARN) of the newly created benefit application.  
Type: String

 ** [Id](#API_benefits_CreateBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_CreateBenefitApplication-response-Id"></a>
The unique identifier assigned to the newly created benefit application.  
Type: String  
Pattern: `benappl-[0-9a-z]{14}` 

 ** [Revision](#API_benefits_CreateBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_CreateBenefitApplication-response-Revision"></a>
The initial revision number of the newly created benefit application.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** ConflictException **   
Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.    
 ** Message **   
A message describing the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/CreateBenefitApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/CreateBenefitApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/CreateBenefitApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/CreateBenefitApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/CreateBenefitApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/CreateBenefitApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/CreateBenefitApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/CreateBenefitApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/CreateBenefitApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/CreateBenefitApplication) 

# DisassociateBenefitApplicationResource


Removes the association between an AWS resource and a benefit application.

## Request Syntax


```
{
   "BenefitApplicationIdentifier": "string",
   "Catalog": "string",
   "ResourceArn": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [BenefitApplicationIdentifier](#API_benefits_DisassociateBenefitApplicationResource_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_DisassociateBenefitApplicationResource-request-BenefitApplicationIdentifier"></a>
The unique identifier of the benefit application to disassociate the resource from.  
Type: String  
Pattern: `(arn:.+|benappl-[0-9a-z]{14})`   
Required: Yes

 ** [Catalog](#API_benefits_DisassociateBenefitApplicationResource_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_DisassociateBenefitApplicationResource-request-Catalog"></a>
The catalog identifier that specifies which benefit catalog the application belongs to.  
Type: String  
Pattern: `[A-Za-z0-9_-]+`   
Required: Yes

 ** [ResourceArn](#API_benefits_DisassociateBenefitApplicationResource_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_DisassociateBenefitApplicationResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the AWS resource to disassociate from the benefit application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1600.  
Pattern: `arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.+)`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Id": "string",
   "Revision": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_benefits_DisassociateBenefitApplicationResource_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_DisassociateBenefitApplicationResource-response-Arn"></a>
The Amazon Resource Name (ARN) of the benefit application after the resource disassociation.  
Type: String

 ** [Id](#API_benefits_DisassociateBenefitApplicationResource_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_DisassociateBenefitApplicationResource-response-Id"></a>
The unique identifier of the benefit application after the resource disassociation.  
Type: String  
Pattern: `benappl-[0-9a-z]{14}` 

 ** [Revision](#API_benefits_DisassociateBenefitApplicationResource_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_DisassociateBenefitApplicationResource-response-Revision"></a>
The updated revision number of the benefit application after the resource disassociation.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** ConflictException **   
Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.    
 ** Message **   
A message describing the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/DisassociateBenefitApplicationResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/DisassociateBenefitApplicationResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/DisassociateBenefitApplicationResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/DisassociateBenefitApplicationResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/DisassociateBenefitApplicationResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/DisassociateBenefitApplicationResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/DisassociateBenefitApplicationResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/DisassociateBenefitApplicationResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/DisassociateBenefitApplicationResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/DisassociateBenefitApplicationResource) 

# GetBenefit


Retrieves detailed information about a specific benefit available in the partner catalog.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_benefits_GetBenefit_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefit-request-Catalog"></a>
The catalog identifier that specifies which benefit catalog to query.  
Type: String  
Pattern: `[A-Za-z0-9_-]+`   
Required: Yes

 ** [Identifier](#API_benefits_GetBenefit_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefit-request-Identifier"></a>
The unique identifier of the benefit to retrieve.  
Type: String  
Pattern: `(arn:.+|ben-[0-9a-z]{14})`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "BenefitRequestSchema": JSON value,
   "Catalog": "string",
   "Description": "string",
   "FulfillmentTypes": [ "string" ],
   "Id": "string",
   "Name": "string",
   "Programs": [ "string" ],
   "Status": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_benefits_GetBenefit_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefit-response-Arn"></a>
The Amazon Resource Name (ARN) of the benefit.  
Type: String

 ** [BenefitRequestSchema](#API_benefits_GetBenefit_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefit-response-BenefitRequestSchema"></a>
The schema definition that describes the required fields for requesting this benefit.  
Type: JSON value

 ** [Catalog](#API_benefits_GetBenefit_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefit-response-Catalog"></a>
The catalog identifier that the benefit belongs to.  
Type: String  
Pattern: `[A-Za-z0-9_-]+` 

 ** [Description](#API_benefits_GetBenefit_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefit-response-Description"></a>
A detailed description of the benefit and its purpose.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.

 ** [FulfillmentTypes](#API_benefits_GetBenefit_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefit-response-FulfillmentTypes"></a>
The available fulfillment types for this benefit (e.g., credits, access, disbursement).  
Type: Array of strings  
Valid Values: `CREDITS | CASH | ACCESS` 

 ** [Id](#API_benefits_GetBenefit_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefit-response-Id"></a>
The unique identifier of the benefit.  
Type: String  
Pattern: `ben-[0-9a-z]{14}` 

 ** [Name](#API_benefits_GetBenefit_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefit-response-Name"></a>
The human-readable name of the benefit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [Programs](#API_benefits_GetBenefit_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefit-response-Programs"></a>
The AWS partner programs that this benefit is associated with.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z0-9_-]+` 

 ** [Status](#API_benefits_GetBenefit_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefit-response-Status"></a>
The current status of the benefit (e.g., active, inactive, deprecated).  
Type: String  
Valid Values: `ACTIVE | INACTIVE` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/GetBenefit) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/GetBenefit) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/GetBenefit) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/GetBenefit) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/GetBenefit) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/GetBenefit) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/GetBenefit) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/GetBenefit) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/GetBenefit) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/GetBenefit) 

# GetBenefitAllocation


Retrieves detailed information about a specific benefit allocation that has been granted to a partner.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_benefits_GetBenefitAllocation_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-request-Catalog"></a>
The catalog identifier that specifies which benefit catalog to query.  
Type: String  
Pattern: `[A-Za-z0-9_-]+`   
Required: Yes

 ** [Identifier](#API_benefits_GetBenefitAllocation_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-request-Identifier"></a>
The unique identifier of the benefit allocation to retrieve.  
Type: String  
Pattern: `(arn:.+|benalloc-[0-9a-z]{14})`   
Required: Yes

## Response Syntax


```
{
   "ApplicableBenefitIds": [ "string" ],
   "Arn": "string",
   "BenefitApplicationId": "string",
   "BenefitId": "string",
   "Catalog": "string",
   "CreatedAt": "string",
   "Description": "string",
   "ExpiresAt": "string",
   "FulfillmentDetail": { ... },
   "FulfillmentType": "string",
   "Id": "string",
   "Name": "string",
   "StartsAt": "string",
   "Status": "string",
   "StatusReason": "string",
   "UpdatedAt": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApplicableBenefitIds](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-ApplicableBenefitIds"></a>
A list of benefit identifiers that this allocation can be applied to.  
Type: Array of strings  
Pattern: `(arn:.+|ben-[0-9a-z]{14})` 

 ** [Arn](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-Arn"></a>
The Amazon Resource Name (ARN) of the benefit allocation.  
Type: String  
Pattern: `(arn:.+benalloc-[0-9a-z]{14})` 

 ** [BenefitApplicationId](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-BenefitApplicationId"></a>
The identifier of the benefit application that resulted in this allocation.  
Type: String  
Pattern: `benappl-[0-9a-z]{14}` 

 ** [BenefitId](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-BenefitId"></a>
The identifier of the benefit that this allocation is based on.  
Type: String  
Pattern: `(arn:.+|ben-[0-9a-z]{14})` 

 ** [Catalog](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-Catalog"></a>
The catalog identifier that the benefit allocation belongs to.  
Type: String  
Pattern: `[A-Za-z0-9_-]+` 

 ** [CreatedAt](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-CreatedAt"></a>
The timestamp when the benefit allocation was created.  
Type: Timestamp

 ** [Description](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-Description"></a>
A detailed description of the benefit allocation.  
Type: String

 ** [ExpiresAt](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-ExpiresAt"></a>
The timestamp when the benefit allocation expires and is no longer usable.  
Type: Timestamp

 ** [FulfillmentDetail](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-FulfillmentDetail"></a>
Detailed information about how the benefit allocation is fulfilled.  
Type: [FulfillmentDetails](API_benefits_FulfillmentDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [FulfillmentType](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-FulfillmentType"></a>
The fulfillment type used for this benefit allocation.  
Type: String  
Valid Values: `CREDITS | CASH | ACCESS` 

 ** [Id](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-Id"></a>
The unique identifier of the benefit allocation.  
Type: String  
Pattern: `benalloc-[0-9a-z]{14}` 

 ** [Name](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-Name"></a>
The human-readable name of the benefit allocation.  
Type: String

 ** [StartsAt](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-StartsAt"></a>
The timestamp when the benefit allocation becomes active and usable.  
Type: Timestamp

 ** [Status](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-Status"></a>
The current status of the benefit allocation (e.g., active, expired, consumed).  
Type: String  
Valid Values: `ACTIVE | INACTIVE | FULFILLED` 

 ** [StatusReason](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-StatusReason"></a>
Additional information explaining the current status of the benefit allocation.  
Type: String

 ** [UpdatedAt](#API_benefits_GetBenefitAllocation_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitAllocation-response-UpdatedAt"></a>
The timestamp when the benefit allocation was last updated.  
Type: Timestamp

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/GetBenefitAllocation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/GetBenefitAllocation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/GetBenefitAllocation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/GetBenefitAllocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/GetBenefitAllocation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/GetBenefitAllocation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/GetBenefitAllocation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/GetBenefitAllocation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/GetBenefitAllocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/GetBenefitAllocation) 

# GetBenefitApplication


Retrieves detailed information about a specific benefit application.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_benefits_GetBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-request-Catalog"></a>
The catalog identifier that specifies which benefit catalog to query.  
Type: String  
Pattern: `[A-Za-z0-9_-]+`   
Required: Yes

 ** [Identifier](#API_benefits_GetBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-request-Identifier"></a>
The unique identifier of the benefit application to retrieve.  
Type: String  
Pattern: `(arn:.+|benappl-[0-9a-z]{14})`   
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "AssociatedResources": [ "string" ],
   "BenefitApplicationDetails": JSON value,
   "BenefitId": "string",
   "Catalog": "string",
   "CreatedAt": "string",
   "Description": "string",
   "FileDetails": [ 
      { 
         "BusinessUseCase": "string",
         "CreatedAt": "string",
         "CreatedBy": "string",
         "FileName": "string",
         "FileStatus": "string",
         "FileStatusReason": "string",
         "FileType": "string",
         "FileURI": "string"
      }
   ],
   "FulfillmentTypes": [ "string" ],
   "Id": "string",
   "Name": "string",
   "PartnerContacts": [ 
      { 
         "BusinessTitle": "string",
         "Email": "string",
         "FirstName": "string",
         "LastName": "string",
         "Phone": "string"
      }
   ],
   "Programs": [ "string" ],
   "Revision": "string",
   "Stage": "string",
   "Status": "string",
   "StatusReason": "string",
   "StatusReasonCode": "string",
   "StatusReasonCodes": [ "string" ],
   "UpdatedAt": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-Arn"></a>
The Amazon Resource Name (ARN) of the benefit application.  
Type: String  
Pattern: `arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.+)` 

 ** [AssociatedResources](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-AssociatedResources"></a>
AWS resources that are associated with this benefit application.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Pattern: `arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.+)` 

 ** [BenefitApplicationDetails](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-BenefitApplicationDetails"></a>
Detailed information and requirements specific to the benefit being requested.  
Type: JSON value

 ** [BenefitId](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-BenefitId"></a>
The identifier of the benefit being requested in this application.  
Type: String  
Pattern: `(arn:.+|ben-[0-9a-z]{14})` 

 ** [Catalog](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-Catalog"></a>
The catalog identifier that the benefit application belongs to.  
Type: String  
Pattern: `[A-Za-z0-9_-]+` 

 ** [CreatedAt](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-CreatedAt"></a>
The timestamp when the benefit application was created.  
Type: Timestamp

 ** [Description](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-Description"></a>
A detailed description of the benefit application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [FileDetails](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-FileDetails"></a>
Supporting documents and files attached to the benefit application.  
Type: Array of [FileDetail](API_benefits_FileDetail.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 30 items.

 ** [FulfillmentTypes](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-FulfillmentTypes"></a>
The fulfillment types requested for this benefit application.  
Type: Array of strings  
Valid Values: `CREDITS | CASH | ACCESS` 

 ** [Id](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-Id"></a>
The unique identifier of the benefit application.  
Type: String  
Pattern: `benappl-[0-9a-z]{14}` 

 ** [Name](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-Name"></a>
The human-readable name of the benefit application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [PartnerContacts](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-PartnerContacts"></a>
Contact information for partner representatives responsible for this benefit application.  
Type: Array of [Contact](API_benefits_Contact.md) objects

 ** [Programs](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-Programs"></a>
The AWS partner programs associated with this benefit application.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z0-9_-]+` 

 ** [Revision](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-Revision"></a>
The current revision number of the benefit application.  
Type: String

 ** [Stage](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-Stage"></a>
The current stage in the benefit application processing workflow.  
Type: String

 ** [Status](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-Status"></a>
The current processing status of the benefit application.  
Type: String  
Valid Values: `PENDING_SUBMISSION | IN_REVIEW | ACTION_REQUIRED | APPROVED | REJECTED | CANCELED` 

 ** [StatusReason](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-StatusReason"></a>
Additional information explaining the current status of the benefit application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.

 ** [StatusReasonCode](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-StatusReasonCode"></a>
 *This parameter has been deprecated.*   
A standardized code representing the reason for the current status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [StatusReasonCodes](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-StatusReasonCodes"></a>
The list of standardized codes representing the reason for the current status.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [UpdatedAt](#API_benefits_GetBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_GetBenefitApplication-response-UpdatedAt"></a>
The timestamp when the benefit application was last updated.  
Type: Timestamp

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** ConflictException **   
Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.    
 ** Message **   
A message describing the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/GetBenefitApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/GetBenefitApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/GetBenefitApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/GetBenefitApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/GetBenefitApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/GetBenefitApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/GetBenefitApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/GetBenefitApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/GetBenefitApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/GetBenefitApplication) 

# ListBenefitAllocations


Retrieves a paginated list of benefit allocations based on specified filter criteria.

## Request Syntax


```
{
   "BenefitApplicationIdentifiers": [ "string" ],
   "BenefitIdentifiers": [ "string" ],
   "Catalog": "string",
   "FulfillmentTypes": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "Status": [ "string" ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_benefits_ListBenefitAllocations_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitAllocations-request-Catalog"></a>
The catalog identifier to filter benefit allocations by catalog.  
Type: String  
Pattern: `[A-Za-z0-9_-]+`   
Required: Yes

 ** [BenefitApplicationIdentifiers](#API_benefits_ListBenefitAllocations_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitAllocations-request-BenefitApplicationIdentifiers"></a>
Filter benefit allocations by specific benefit application identifiers.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Pattern: `(arn:.+|benappl-[0-9a-z]{14})`   
Required: No

 ** [BenefitIdentifiers](#API_benefits_ListBenefitAllocations_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitAllocations-request-BenefitIdentifiers"></a>
Filter benefit allocations by specific benefit identifiers.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Pattern: `(arn:.+|ben-[0-9a-z]{14})`   
Required: No

 ** [FulfillmentTypes](#API_benefits_ListBenefitAllocations_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitAllocations-request-FulfillmentTypes"></a>
Filter benefit allocations by specific fulfillment types.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Valid Values: `CREDITS | CASH | ACCESS`   
Required: No

 ** [MaxResults](#API_benefits_ListBenefitAllocations_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitAllocations-request-MaxResults"></a>
The maximum number of benefit allocations to return in a single response.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_benefits_ListBenefitAllocations_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitAllocations-request-NextToken"></a>
A pagination token to retrieve the next set of results from a previous request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\s\S]*`   
Required: No

 ** [Status](#API_benefits_ListBenefitAllocations_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitAllocations-request-Status"></a>
Filter benefit allocations by their current status.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Valid Values: `ACTIVE | INACTIVE | FULFILLED`   
Required: No

## Response Syntax


```
{
   "BenefitAllocationSummaries": [ 
      { 
         "ApplicableBenefitIds": [ "string" ],
         "Arn": "string",
         "BenefitApplicationId": "string",
         "BenefitId": "string",
         "Catalog": "string",
         "CreatedAt": "string",
         "ExpiresAt": "string",
         "FulfillmentTypes": [ "string" ],
         "Id": "string",
         "Name": "string",
         "Status": "string",
         "StatusReason": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BenefitAllocationSummaries](#API_benefits_ListBenefitAllocations_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitAllocations-response-BenefitAllocationSummaries"></a>
A list of benefit allocation summaries matching the specified criteria.  
Type: Array of [BenefitAllocationSummary](API_benefits_BenefitAllocationSummary.md) objects

 ** [NextToken](#API_benefits_ListBenefitAllocations_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitAllocations-response-NextToken"></a>
A pagination token to retrieve the next set of results, if more results are available.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/ListBenefitAllocations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/ListBenefitAllocations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/ListBenefitAllocations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/ListBenefitAllocations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/ListBenefitAllocations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/ListBenefitAllocations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/ListBenefitAllocations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/ListBenefitAllocations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/ListBenefitAllocations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/ListBenefitAllocations) 

# ListBenefitApplications


Retrieves a paginated list of benefit applications based on specified filter criteria.

## Request Syntax


```
{
   "AssociatedResourceArns": [ "string" ],
   "AssociatedResources": [ 
      { 
         "ResourceArn": "string",
         "ResourceIdentifier": "string",
         "ResourceType": "string"
      }
   ],
   "BenefitIdentifiers": [ "string" ],
   "Catalog": "string",
   "FulfillmentTypes": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "Programs": [ "string" ],
   "Stages": [ "string" ],
   "Status": [ "string" ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_benefits_ListBenefitApplications_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitApplications-request-Catalog"></a>
The catalog identifier to filter benefit applications by catalog.  
Type: String  
Pattern: `[A-Za-z0-9_-]+`   
Required: Yes

 ** [AssociatedResourceArns](#API_benefits_ListBenefitApplications_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitApplications-request-AssociatedResourceArns"></a>
Filter benefit applications by specific AWS resource ARNs.  
Type: Array of strings  
Pattern: `arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.+)`   
Required: No

 ** [AssociatedResources](#API_benefits_ListBenefitApplications_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitApplications-request-AssociatedResources"></a>
 *This parameter has been deprecated.*   
Filter benefit applications by associated AWS resources.  
Type: Array of [AssociatedResource](API_benefits_AssociatedResource.md) objects  
Required: No

 ** [BenefitIdentifiers](#API_benefits_ListBenefitApplications_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitApplications-request-BenefitIdentifiers"></a>
Filter benefit applications by specific benefit identifiers.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Pattern: `(arn:.+|ben-[0-9a-z]{14})`   
Required: No

 ** [FulfillmentTypes](#API_benefits_ListBenefitApplications_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitApplications-request-FulfillmentTypes"></a>
Filter benefit applications by specific fulfillment types.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Valid Values: `CREDITS | CASH | ACCESS`   
Required: No

 ** [MaxResults](#API_benefits_ListBenefitApplications_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitApplications-request-MaxResults"></a>
The maximum number of benefit applications to return in a single response.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_benefits_ListBenefitApplications_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitApplications-request-NextToken"></a>
A pagination token to retrieve the next set of results from a previous request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\s\S]*`   
Required: No

 ** [Programs](#API_benefits_ListBenefitApplications_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitApplications-request-Programs"></a>
Filter benefit applications by specific AWS partner programs.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z0-9_-]+`   
Required: No

 ** [Stages](#API_benefits_ListBenefitApplications_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitApplications-request-Stages"></a>
Filter benefit applications by their current processing stage.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: No

 ** [Status](#API_benefits_ListBenefitApplications_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitApplications-request-Status"></a>
Filter benefit applications by their current processing status.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Valid Values: `PENDING_SUBMISSION | IN_REVIEW | ACTION_REQUIRED | APPROVED | REJECTED | CANCELED`   
Required: No

## Response Syntax


```
{
   "BenefitApplicationSummaries": [ 
      { 
         "Arn": "string",
         "AssociatedResources": [ "string" ],
         "BenefitApplicationDetails": { 
            "string" : "string" 
         },
         "BenefitId": "string",
         "Catalog": "string",
         "CreatedAt": "string",
         "FulfillmentTypes": [ "string" ],
         "Id": "string",
         "Name": "string",
         "Programs": [ "string" ],
         "Stage": "string",
         "Status": "string",
         "UpdatedAt": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BenefitApplicationSummaries](#API_benefits_ListBenefitApplications_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitApplications-response-BenefitApplicationSummaries"></a>
A list of benefit application summaries matching the specified criteria.  
Type: Array of [BenefitApplicationSummary](API_benefits_BenefitApplicationSummary.md) objects

 ** [NextToken](#API_benefits_ListBenefitApplications_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefitApplications-response-NextToken"></a>
A pagination token to retrieve the next set of results, if more results are available.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/ListBenefitApplications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/ListBenefitApplications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/ListBenefitApplications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/ListBenefitApplications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/ListBenefitApplications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/ListBenefitApplications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/ListBenefitApplications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/ListBenefitApplications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/ListBenefitApplications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/ListBenefitApplications) 

# ListBenefits


Retrieves a paginated list of available benefits based on specified filter criteria.

## Request Syntax


```
{
   "Catalog": "string",
   "FulfillmentTypes": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "Programs": [ "string" ],
   "Status": [ "string" ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_benefits_ListBenefits_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefits-request-Catalog"></a>
The catalog identifier to filter benefits by catalog.  
Type: String  
Pattern: `[A-Za-z0-9_-]+`   
Required: Yes

 ** [FulfillmentTypes](#API_benefits_ListBenefits_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefits-request-FulfillmentTypes"></a>
Filter benefits by specific fulfillment types.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Valid Values: `CREDITS | CASH | ACCESS`   
Required: No

 ** [MaxResults](#API_benefits_ListBenefits_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefits-request-MaxResults"></a>
The maximum number of benefits to return in a single response.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_benefits_ListBenefits_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefits-request-NextToken"></a>
A pagination token to retrieve the next set of results from a previous request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\s\S]*`   
Required: No

 ** [Programs](#API_benefits_ListBenefits_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefits-request-Programs"></a>
Filter benefits by specific AWS partner programs.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[A-Za-z0-9_-]+`   
Required: No

 ** [Status](#API_benefits_ListBenefits_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefits-request-Status"></a>
Filter benefits by their current status.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Valid Values: `ACTIVE | INACTIVE`   
Required: No

## Response Syntax


```
{
   "BenefitSummaries": [ 
      { 
         "Arn": "string",
         "Catalog": "string",
         "Description": "string",
         "FulfillmentTypes": [ "string" ],
         "Id": "string",
         "Name": "string",
         "Programs": [ "string" ],
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BenefitSummaries](#API_benefits_ListBenefits_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefits-response-BenefitSummaries"></a>
A list of benefit summaries matching the specified criteria.  
Type: Array of [BenefitSummary](API_benefits_BenefitSummary.md) objects

 ** [NextToken](#API_benefits_ListBenefits_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_ListBenefits-response-NextToken"></a>
A pagination token to retrieve the next set of results, if more results are available.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/ListBenefits) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/ListBenefits) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/ListBenefits) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/ListBenefits) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/ListBenefits) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/ListBenefits) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/ListBenefits) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/ListBenefits) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/ListBenefits) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/ListBenefits) 

# ListTagsForResource


Retrieves all tags associated with a specific resource.

## Request Syntax


```
{
   "resourceArn": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [resourceArn](#API_benefits_ListTagsForResource_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_ListTagsForResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to list tags for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `arn:[\w+=/,.@-]+:partnercentral:[\w+=/,.@-]*:[0-9]{12}:catalog/([a-zA-Z]+)/[\w+=,.@-]+(/[\w+=,.@-]+)*`   
Required: Yes

## Response Syntax


```
{
   "tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_benefits_ListTagsForResource_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_ListTagsForResource-response-tags"></a>
A list of key-value pairs representing the tags associated with the resource.  
Type: Array of [Tag](API_benefits_Tag.md) objects

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/ListTagsForResource) 

# RecallBenefitApplication


Recalls a submitted benefit application, returning it to draft status for further modifications.

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "Identifier": "string",
   "Reason": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_benefits_RecallBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_RecallBenefitApplication-request-Catalog"></a>
The catalog identifier that specifies which benefit catalog the application belongs to.  
Type: String  
Pattern: `[A-Za-z0-9_-]+`   
Required: Yes

 ** [Identifier](#API_benefits_RecallBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_RecallBenefitApplication-request-Identifier"></a>
The unique identifier of the benefit application to recall.  
Type: String  
Pattern: `(arn:.+|benappl-[0-9a-z]{14})`   
Required: Yes

 ** [Reason](#API_benefits_RecallBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_RecallBenefitApplication-request-Reason"></a>
A descriptive reason explaining why the benefit application is being recalled.  
Type: String  
Required: Yes

 ** [ClientToken](#API_benefits_RecallBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_RecallBenefitApplication-request-ClientToken"></a>
A unique, case-sensitive identifier to ensure idempotent processing of the recall request.  
Type: String  
Required: No

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** ConflictException **   
Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.    
 ** Message **   
A message describing the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/RecallBenefitApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/RecallBenefitApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/RecallBenefitApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/RecallBenefitApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/RecallBenefitApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/RecallBenefitApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/RecallBenefitApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/RecallBenefitApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/RecallBenefitApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/RecallBenefitApplication) 

# SubmitBenefitApplication


Submits a benefit application for review and processing by AWS.

## Request Syntax


```
{
   "Catalog": "string",
   "Identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_benefits_SubmitBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_SubmitBenefitApplication-request-Catalog"></a>
The catalog identifier that specifies which benefit catalog the application belongs to.  
Type: String  
Pattern: `[A-Za-z0-9_-]+`   
Required: Yes

 ** [Identifier](#API_benefits_SubmitBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_SubmitBenefitApplication-request-Identifier"></a>
The unique identifier of the benefit application to submit.  
Type: String  
Pattern: `(arn:.+|benappl-[0-9a-z]{14})`   
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** ConflictException **   
Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.    
 ** Message **   
A message describing the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/SubmitBenefitApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/SubmitBenefitApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/SubmitBenefitApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/SubmitBenefitApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/SubmitBenefitApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/SubmitBenefitApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/SubmitBenefitApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/SubmitBenefitApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/SubmitBenefitApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/SubmitBenefitApplication) 

# TagResource


Adds or updates tags for a specified resource.

## Request Syntax


```
{
   "resourceArn": "string",
   "tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [resourceArn](#API_benefits_TagResource_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_TagResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to add tags to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `arn:[\w+=/,.@-]+:partnercentral:[\w+=/,.@-]*:[0-9]{12}:catalog/([a-zA-Z]+)/[\w+=,.@-]+(/[\w+=,.@-]+)*`   
Required: Yes

 ** [tags](#API_benefits_TagResource_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_TagResource-request-tags"></a>
A list of key-value pairs to add as tags to the resource.  
Type: Array of [Tag](API_benefits_Tag.md) objects  
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** ConflictException **   
Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.    
 ** Message **   
A message describing the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Thrown when the request would exceed the service quotas or limits for the account.    
 ** Message **   
A message describing the service quota exceeded error.  
 ** QuotaCode **   
The code identifying the specific quota that would be exceeded.  
 ** ResourceId **   
The identifier of the resource that would exceed the quota.  
 ** ResourceType **   
The type of the resource that would exceed the quota.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/TagResource) 

# UntagResource


Removes specified tags from a resource.

## Request Syntax


```
{
   "resourceArn": "string",
   "tagKeys": [ "string" ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [resourceArn](#API_benefits_UntagResource_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_UntagResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to remove tags from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `arn:[\w+=/,.@-]+:partnercentral:[\w+=/,.@-]*:[0-9]{12}:catalog/([a-zA-Z]+)/[\w+=,.@-]+(/[\w+=,.@-]+)*`   
Required: Yes

 ** [tagKeys](#API_benefits_UntagResource_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_UntagResource-request-tagKeys"></a>
A list of tag keys to remove from the resource.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** ConflictException **   
Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.    
 ** Message **   
A message describing the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Thrown when the request would exceed the service quotas or limits for the account.    
 ** Message **   
A message describing the service quota exceeded error.  
 ** QuotaCode **   
The code identifying the specific quota that would be exceeded.  
 ** ResourceId **   
The identifier of the resource that would exceed the quota.  
 ** ResourceType **   
The type of the resource that would exceed the quota.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/UntagResource) 

# UpdateBenefitApplication


Updates an existing benefit application with new information while maintaining revision control.

## Request Syntax


```
{
   "BenefitApplicationDetails": JSON value,
   "Catalog": "string",
   "ClientToken": "string",
   "Description": "string",
   "FileDetails": [ 
      { 
         "BusinessUseCase": "string",
         "FileURI": "string"
      }
   ],
   "Identifier": "string",
   "Name": "string",
   "PartnerContacts": [ 
      { 
         "BusinessTitle": "string",
         "Email": "string",
         "FirstName": "string",
         "LastName": "string",
         "Phone": "string"
      }
   ],
   "Revision": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_benefits_UpdateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_UpdateBenefitApplication-request-Catalog"></a>
The catalog identifier that specifies which benefit catalog the application belongs to.  
Type: String  
Pattern: `[A-Za-z0-9_-]+`   
Required: Yes

 ** [ClientToken](#API_benefits_UpdateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_UpdateBenefitApplication-request-ClientToken"></a>
A unique, case-sensitive identifier to ensure idempotent processing of the update request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[!-~]{1,64}`   
Required: Yes

 ** [Identifier](#API_benefits_UpdateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_UpdateBenefitApplication-request-Identifier"></a>
The unique identifier of the benefit application to update.  
Type: String  
Pattern: `(arn:.+|benappl-[0-9a-z]{14})`   
Required: Yes

 ** [Revision](#API_benefits_UpdateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_UpdateBenefitApplication-request-Revision"></a>
The current revision number of the benefit application to ensure optimistic concurrency control.  
Type: String  
Required: Yes

 ** [BenefitApplicationDetails](#API_benefits_UpdateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_UpdateBenefitApplication-request-BenefitApplicationDetails"></a>
Updated detailed information and requirements specific to the benefit being requested.  
Type: JSON value  
Required: No

 ** [Description](#API_benefits_UpdateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_UpdateBenefitApplication-request-Description"></a>
The updated detailed description of the benefit application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** [FileDetails](#API_benefits_UpdateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_UpdateBenefitApplication-request-FileDetails"></a>
Updated supporting documents and files attached to the benefit application.  
Type: Array of [FileInput](API_benefits_FileInput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 30 items.  
Required: No

 ** [Name](#API_benefits_UpdateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_UpdateBenefitApplication-request-Name"></a>
The updated human-readable name for the benefit application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [PartnerContacts](#API_benefits_UpdateBenefitApplication_RequestSyntax) **   <a name="AWSPartnerCentral-benefits_UpdateBenefitApplication-request-PartnerContacts"></a>
Updated contact information for partner representatives responsible for this benefit application.  
Type: Array of [Contact](API_benefits_Contact.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: No

## Response Syntax


```
{
   "Arn": "string",
   "Id": "string",
   "Revision": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_benefits_UpdateBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_UpdateBenefitApplication-response-Arn"></a>
The Amazon Resource Name (ARN) of the updated benefit application.  
Type: String

 ** [Id](#API_benefits_UpdateBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_UpdateBenefitApplication-response-Id"></a>
The unique identifier of the updated benefit application.  
Type: String  
Pattern: `benappl-[0-9a-z]{14}` 

 ** [Revision](#API_benefits_UpdateBenefitApplication_ResponseSyntax) **   <a name="AWSPartnerCentral-benefits_UpdateBenefitApplication-response-Revision"></a>
The new revision number of the benefit application after the update.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Thrown when the caller does not have sufficient permissions to perform the requested operation.    
 ** Message **   
A message describing the access denial.
HTTP Status Code: 400

 ** ConflictException **   
Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.    
 ** Message **   
A message describing the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Thrown when an unexpected error occurs on the server side during request processing.    
 ** Message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Thrown when the requested resource cannot be found or does not exist.    
 ** Message **   
A message describing the resource not found error.
HTTP Status Code: 400

 ** ThrottlingException **   
Thrown when the request rate exceeds the allowed limits and the request is being throttled.    
 ** Message **   
A message describing the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
Thrown when the request contains invalid parameters or fails input validation requirements.    
 ** FieldList **   
A list of fields that failed validation.  
 ** Message **   
A message describing the validation error.  
 ** Reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-benefits-2018-05-10/UpdateBenefitApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-benefits-2018-05-10/UpdateBenefitApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-benefits-2018-05-10/UpdateBenefitApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-benefits-2018-05-10/UpdateBenefitApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-benefits-2018-05-10/UpdateBenefitApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-benefits-2018-05-10/UpdateBenefitApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-benefits-2018-05-10/UpdateBenefitApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-benefits-2018-05-10/UpdateBenefitApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-benefits-2018-05-10/UpdateBenefitApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-benefits-2018-05-10/UpdateBenefitApplication) 

# Partner Central Channel API


The following actions are supported by Partner Central Channel API:
+  [AcceptChannelHandshake](API_channel_AcceptChannelHandshake.md) 
+  [CancelChannelHandshake](API_channel_CancelChannelHandshake.md) 
+  [CreateChannelHandshake](API_channel_CreateChannelHandshake.md) 
+  [CreateProgramManagementAccount](API_channel_CreateProgramManagementAccount.md) 
+  [CreateRelationship](API_channel_CreateRelationship.md) 
+  [DeleteProgramManagementAccount](API_channel_DeleteProgramManagementAccount.md) 
+  [DeleteRelationship](API_channel_DeleteRelationship.md) 
+  [GetRelationship](API_channel_GetRelationship.md) 
+  [ListChannelHandshakes](API_channel_ListChannelHandshakes.md) 
+  [ListProgramManagementAccounts](API_channel_ListProgramManagementAccounts.md) 
+  [ListRelationships](API_channel_ListRelationships.md) 
+  [ListTagsForResource](API_channel_ListTagsForResource.md) 
+  [RejectChannelHandshake](API_channel_RejectChannelHandshake.md) 
+  [TagResource](API_channel_TagResource.md) 
+  [UntagResource](API_channel_UntagResource.md) 
+  [UpdateProgramManagementAccount](API_channel_UpdateProgramManagementAccount.md) 
+  [UpdateRelationship](API_channel_UpdateRelationship.md) 

# AcceptChannelHandshake


Accepts a pending channel handshake request from another AWS account.

## Request Syntax


```
{
   "catalog": "string",
   "identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [catalog](#API_channel_AcceptChannelHandshake_RequestSyntax) **   <a name="AWSPartnerCentral-channel_AcceptChannelHandshake-request-catalog"></a>
The catalog identifier for the handshake request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** [identifier](#API_channel_AcceptChannelHandshake_RequestSyntax) **   <a name="AWSPartnerCentral-channel_AcceptChannelHandshake-request-identifier"></a>
The unique identifier of the channel handshake to accept.  
Type: String  
Length Constraints: Minimum length of 16. Maximum length of 1011.  
Pattern: `(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/channel-handshake/)?ch-[a-z0-9]{13}`   
Required: Yes

## Response Syntax


```
{
   "channelHandshakeDetail": { 
      "arn": "string",
      "id": "string",
      "status": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [channelHandshakeDetail](#API_channel_AcceptChannelHandshake_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_AcceptChannelHandshake-response-channelHandshakeDetail"></a>
Details of the accepted channel handshake.  
Type: [AcceptChannelHandshakeDetail](API_channel_AcceptChannelHandshakeDetail.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/AcceptChannelHandshake) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/AcceptChannelHandshake) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/AcceptChannelHandshake) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/AcceptChannelHandshake) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/AcceptChannelHandshake) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/AcceptChannelHandshake) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/AcceptChannelHandshake) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/AcceptChannelHandshake) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/AcceptChannelHandshake) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/AcceptChannelHandshake) 

# CancelChannelHandshake


Cancels a pending channel handshake request.

## Request Syntax


```
{
   "catalog": "string",
   "identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [catalog](#API_channel_CancelChannelHandshake_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CancelChannelHandshake-request-catalog"></a>
The catalog identifier for the handshake request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** [identifier](#API_channel_CancelChannelHandshake_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CancelChannelHandshake-request-identifier"></a>
The unique identifier of the channel handshake to cancel.  
Type: String  
Length Constraints: Minimum length of 16. Maximum length of 1011.  
Pattern: `(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/channel-handshake/)?ch-[a-z0-9]{13}`   
Required: Yes

## Response Syntax


```
{
   "channelHandshakeDetail": { 
      "arn": "string",
      "id": "string",
      "status": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [channelHandshakeDetail](#API_channel_CancelChannelHandshake_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_CancelChannelHandshake-response-channelHandshakeDetail"></a>
Details of the canceled channel handshake.  
Type: [CancelChannelHandshakeDetail](API_channel_CancelChannelHandshakeDetail.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/CancelChannelHandshake) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/CancelChannelHandshake) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/CancelChannelHandshake) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/CancelChannelHandshake) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/CancelChannelHandshake) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/CancelChannelHandshake) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/CancelChannelHandshake) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/CancelChannelHandshake) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/CancelChannelHandshake) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/CancelChannelHandshake) 

# CreateChannelHandshake


Creates a new channel handshake request to establish a partnership with another AWS account.

## Request Syntax


```
{
   "associatedResourceIdentifier": "string",
   "catalog": "string",
   "clientToken": "string",
   "handshakeType": "string",
   "payload": { ... },
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [associatedResourceIdentifier](#API_channel_CreateChannelHandshake_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateChannelHandshake-request-associatedResourceIdentifier"></a>
The identifier of the resource associated with this handshake.  
Type: String  
Length Constraints: Minimum length of 16. Maximum length of 1011.  
Pattern: `((arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/pma-[a-z0-9]{13}(/relationship/rs-[a-z0-9]{13})?)|(pma|rs)-[a-z0-9]{13})`   
Required: Yes

 ** [catalog](#API_channel_CreateChannelHandshake_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateChannelHandshake-request-catalog"></a>
The catalog identifier for the handshake request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** [handshakeType](#API_channel_CreateChannelHandshake_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateChannelHandshake-request-handshakeType"></a>
The type of handshake to create (e.g., start service period, revoke service period).  
Type: String  
Valid Values: `START_SERVICE_PERIOD | REVOKE_SERVICE_PERIOD | PROGRAM_MANAGEMENT_ACCOUNT`   
Required: Yes

 ** [clientToken](#API_channel_CreateChannelHandshake_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateChannelHandshake-request-clientToken"></a>
A unique, case-sensitive identifier to ensure idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[!-~]*`   
Required: No

 ** [payload](#API_channel_CreateChannelHandshake_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateChannelHandshake-request-payload"></a>
The payload containing specific details for the handshake type.  
Type: [ChannelHandshakePayload](API_channel_ChannelHandshakePayload.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [tags](#API_channel_CreateChannelHandshake_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateChannelHandshake-request-tags"></a>
Key-value pairs to associate with the channel handshake.  
Type: Array of [Tag](API_channel_Tag.md) objects  
Required: No

## Response Syntax


```
{
   "channelHandshakeDetail": { 
      "arn": "string",
      "id": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [channelHandshakeDetail](#API_channel_CreateChannelHandshake_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_CreateChannelHandshake-response-channelHandshakeDetail"></a>
Details of the created channel handshake.  
Type: [CreateChannelHandshakeDetail](API_channel_CreateChannelHandshakeDetail.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource.    
 ** message **   
A message describing the conflict.  
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of the resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request would exceed a service quota limit.    
 ** message **   
A message describing the service quota exceeded error.  
 ** quotaCode **   
The code identifying the specific quota that would be exceeded.  
 ** resourceId **   
The identifier of the resource that would exceed the quota.  
 ** resourceType **   
The type of the resource that would exceed the quota.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/CreateChannelHandshake) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/CreateChannelHandshake) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/CreateChannelHandshake) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/CreateChannelHandshake) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/CreateChannelHandshake) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/CreateChannelHandshake) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/CreateChannelHandshake) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/CreateChannelHandshake) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/CreateChannelHandshake) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/CreateChannelHandshake) 

# CreateProgramManagementAccount


Creates a new program management account for managing partner relationships.

## Request Syntax


```
{
   "accountId": "string",
   "catalog": "string",
   "clientToken": "string",
   "displayName": "string",
   "program": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [accountId](#API_channel_CreateProgramManagementAccount_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateProgramManagementAccount-request-accountId"></a>
The AWS account ID to associate with the program management account.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `[0-9]*`   
Required: Yes

 ** [catalog](#API_channel_CreateProgramManagementAccount_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateProgramManagementAccount-request-catalog"></a>
The catalog identifier for the program management account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** [displayName](#API_channel_CreateProgramManagementAccount_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateProgramManagementAccount-request-displayName"></a>
A human-readable name for the program management account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 30.  
Pattern: `[^\x00-\x1F\x7F]*`   
Required: Yes

 ** [program](#API_channel_CreateProgramManagementAccount_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateProgramManagementAccount-request-program"></a>
The program type for the management account.  
Type: String  
Valid Values: `SOLUTION_PROVIDER | DISTRIBUTION | DISTRIBUTION_SELLER`   
Required: Yes

 ** [clientToken](#API_channel_CreateProgramManagementAccount_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateProgramManagementAccount-request-clientToken"></a>
A unique, case-sensitive identifier to ensure idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[!-~]*`   
Required: No

 ** [tags](#API_channel_CreateProgramManagementAccount_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateProgramManagementAccount-request-tags"></a>
Key-value pairs to associate with the program management account.  
Type: Array of [Tag](API_channel_Tag.md) objects  
Required: No

## Response Syntax


```
{
   "programManagementAccountDetail": { 
      "arn": "string",
      "id": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [programManagementAccountDetail](#API_channel_CreateProgramManagementAccount_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_CreateProgramManagementAccount-response-programManagementAccountDetail"></a>
Details of the created program management account.  
Type: [CreateProgramManagementAccountDetail](API_channel_CreateProgramManagementAccountDetail.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource.    
 ** message **   
A message describing the conflict.  
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of the resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request would exceed a service quota limit.    
 ** message **   
A message describing the service quota exceeded error.  
 ** quotaCode **   
The code identifying the specific quota that would be exceeded.  
 ** resourceId **   
The identifier of the resource that would exceed the quota.  
 ** resourceType **   
The type of the resource that would exceed the quota.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/CreateProgramManagementAccount) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/CreateProgramManagementAccount) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/CreateProgramManagementAccount) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/CreateProgramManagementAccount) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/CreateProgramManagementAccount) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/CreateProgramManagementAccount) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/CreateProgramManagementAccount) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/CreateProgramManagementAccount) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/CreateProgramManagementAccount) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/CreateProgramManagementAccount) 

# CreateRelationship


Creates a new partner relationship between accounts.

## Request Syntax


```
{
   "associatedAccountId": "string",
   "associationType": "string",
   "catalog": "string",
   "clientToken": "string",
   "displayName": "string",
   "programManagementAccountIdentifier": "string",
   "requestedSupportPlan": { ... },
   "resaleAccountModel": "string",
   "sector": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [associatedAccountId](#API_channel_CreateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateRelationship-request-associatedAccountId"></a>
The AWS account ID to associate in this relationship.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `[0-9]*`   
Required: Yes

 ** [associationType](#API_channel_CreateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateRelationship-request-associationType"></a>
The type of association for the relationship (e.g., reseller, distributor).  
Type: String  
Valid Values: `DOWNSTREAM_SELLER | END_CUSTOMER | INTERNAL`   
Required: Yes

 ** [catalog](#API_channel_CreateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateRelationship-request-catalog"></a>
The catalog identifier for the relationship.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** [displayName](#API_channel_CreateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateRelationship-request-displayName"></a>
A human-readable name for the relationship.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 30.  
Pattern: `[^\x00-\x1F\x7F]*`   
Required: Yes

 ** [programManagementAccountIdentifier](#API_channel_CreateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateRelationship-request-programManagementAccountIdentifier"></a>
The identifier of the program management account for this relationship.  
Type: String  
Length Constraints: Minimum length of 17. Maximum length of 1011.  
Pattern: `(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/)?pma-[a-z0-9]{13}`   
Required: Yes

 ** [sector](#API_channel_CreateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateRelationship-request-sector"></a>
The business sector for the relationship.  
Type: String  
Valid Values: `COMMERCIAL | GOVERNMENT | GOVERNMENT_EXCEPTION`   
Required: Yes

 ** [clientToken](#API_channel_CreateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateRelationship-request-clientToken"></a>
A unique, case-sensitive identifier to ensure idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[!-~]*`   
Required: No

 ** [requestedSupportPlan](#API_channel_CreateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateRelationship-request-requestedSupportPlan"></a>
The support plan requested for this relationship.  
Type: [SupportPlan](API_channel_SupportPlan.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [resaleAccountModel](#API_channel_CreateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateRelationship-request-resaleAccountModel"></a>
The resale account model for the relationship.  
Type: String  
Valid Values: `DISTRIBUTOR | END_CUSTOMER | SOLUTION_PROVIDER`   
Required: No

 ** [tags](#API_channel_CreateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_CreateRelationship-request-tags"></a>
Key-value pairs to associate with the relationship.  
Type: Array of [Tag](API_channel_Tag.md) objects  
Required: No

## Response Syntax


```
{
   "relationshipDetail": { 
      "arn": "string",
      "id": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [relationshipDetail](#API_channel_CreateRelationship_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_CreateRelationship-response-relationshipDetail"></a>
Details of the created relationship.  
Type: [CreateRelationshipDetail](API_channel_CreateRelationshipDetail.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource.    
 ** message **   
A message describing the conflict.  
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of the resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request would exceed a service quota limit.    
 ** message **   
A message describing the service quota exceeded error.  
 ** quotaCode **   
The code identifying the specific quota that would be exceeded.  
 ** resourceId **   
The identifier of the resource that would exceed the quota.  
 ** resourceType **   
The type of the resource that would exceed the quota.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/CreateRelationship) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/CreateRelationship) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/CreateRelationship) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/CreateRelationship) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/CreateRelationship) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/CreateRelationship) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/CreateRelationship) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/CreateRelationship) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/CreateRelationship) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/CreateRelationship) 

# DeleteProgramManagementAccount


Deletes a program management account.

## Request Syntax


```
{
   "catalog": "string",
   "clientToken": "string",
   "identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [catalog](#API_channel_DeleteProgramManagementAccount_RequestSyntax) **   <a name="AWSPartnerCentral-channel_DeleteProgramManagementAccount-request-catalog"></a>
The catalog identifier for the program management account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** [identifier](#API_channel_DeleteProgramManagementAccount_RequestSyntax) **   <a name="AWSPartnerCentral-channel_DeleteProgramManagementAccount-request-identifier"></a>
The unique identifier of the program management account to delete.  
Type: String  
Length Constraints: Minimum length of 17. Maximum length of 1011.  
Pattern: `(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/)?pma-[a-z0-9]{13}`   
Required: Yes

 ** [clientToken](#API_channel_DeleteProgramManagementAccount_RequestSyntax) **   <a name="AWSPartnerCentral-channel_DeleteProgramManagementAccount-request-clientToken"></a>
A unique, case-sensitive identifier to ensure idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[!-~]*`   
Required: No

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource.    
 ** message **   
A message describing the conflict.  
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of the resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/DeleteProgramManagementAccount) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/DeleteProgramManagementAccount) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/DeleteProgramManagementAccount) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/DeleteProgramManagementAccount) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/DeleteProgramManagementAccount) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/DeleteProgramManagementAccount) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/DeleteProgramManagementAccount) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/DeleteProgramManagementAccount) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/DeleteProgramManagementAccount) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/DeleteProgramManagementAccount) 

# DeleteRelationship


Deletes a partner relationship.

## Request Syntax


```
{
   "catalog": "string",
   "clientToken": "string",
   "identifier": "string",
   "programManagementAccountIdentifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [catalog](#API_channel_DeleteRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_DeleteRelationship-request-catalog"></a>
The catalog identifier for the relationship.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** [identifier](#API_channel_DeleteRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_DeleteRelationship-request-identifier"></a>
The unique identifier of the relationship to delete.  
Type: String  
Length Constraints: Minimum length of 16. Maximum length of 1011.  
Pattern: `(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/pma-[a-z0-9]{13}/relationship/)?rs-[a-z0-9]{13}`   
Required: Yes

 ** [programManagementAccountIdentifier](#API_channel_DeleteRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_DeleteRelationship-request-programManagementAccountIdentifier"></a>
The identifier of the program management account associated with the relationship.  
Type: String  
Length Constraints: Minimum length of 17. Maximum length of 1011.  
Pattern: `(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/)?pma-[a-z0-9]{13}`   
Required: Yes

 ** [clientToken](#API_channel_DeleteRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_DeleteRelationship-request-clientToken"></a>
A unique, case-sensitive identifier to ensure idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[!-~]*`   
Required: No

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource.    
 ** message **   
A message describing the conflict.  
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of the resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/DeleteRelationship) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/DeleteRelationship) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/DeleteRelationship) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/DeleteRelationship) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/DeleteRelationship) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/DeleteRelationship) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/DeleteRelationship) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/DeleteRelationship) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/DeleteRelationship) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/DeleteRelationship) 

# GetRelationship


Retrieves details of a specific partner relationship.

## Request Syntax


```
{
   "catalog": "string",
   "identifier": "string",
   "programManagementAccountIdentifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [catalog](#API_channel_GetRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_GetRelationship-request-catalog"></a>
The catalog identifier for the relationship.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** [identifier](#API_channel_GetRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_GetRelationship-request-identifier"></a>
The unique identifier of the relationship to retrieve.  
Type: String  
Length Constraints: Minimum length of 16. Maximum length of 1011.  
Pattern: `(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/pma-[a-z0-9]{13}/relationship/)?rs-[a-z0-9]{13}`   
Required: Yes

 ** [programManagementAccountIdentifier](#API_channel_GetRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_GetRelationship-request-programManagementAccountIdentifier"></a>
The identifier of the program management account associated with the relationship.  
Type: String  
Length Constraints: Minimum length of 17. Maximum length of 1011.  
Pattern: `(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/)?pma-[a-z0-9]{13}`   
Required: Yes

## Response Syntax


```
{
   "relationshipDetail": { 
      "arn": "string",
      "associatedAccountId": "string",
      "associationType": "string",
      "catalog": "string",
      "createdAt": "string",
      "displayName": "string",
      "id": "string",
      "programManagementAccountId": "string",
      "resaleAccountModel": "string",
      "revision": "string",
      "sector": "string",
      "startDate": "string",
      "updatedAt": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [relationshipDetail](#API_channel_GetRelationship_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_GetRelationship-response-relationshipDetail"></a>
Details of the requested relationship.  
Type: [RelationshipDetail](API_channel_RelationshipDetail.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/GetRelationship) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/GetRelationship) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/GetRelationship) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/GetRelationship) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/GetRelationship) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/GetRelationship) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/GetRelationship) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/GetRelationship) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/GetRelationship) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/GetRelationship) 

# ListChannelHandshakes


Lists channel handshakes based on specified criteria.

## Request Syntax


```
{
   "associatedResourceIdentifiers": [ "string" ],
   "catalog": "string",
   "handshakeType": "string",
   "handshakeTypeFilters": { ... },
   "handshakeTypeSort": { ... },
   "maxResults": number,
   "nextToken": "string",
   "participantType": "string",
   "statuses": [ "string" ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [catalog](#API_channel_ListChannelHandshakes_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListChannelHandshakes-request-catalog"></a>
The catalog identifier to filter handshakes.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** [handshakeType](#API_channel_ListChannelHandshakes_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListChannelHandshakes-request-handshakeType"></a>
Filter results by handshake type.  
Type: String  
Valid Values: `START_SERVICE_PERIOD | REVOKE_SERVICE_PERIOD | PROGRAM_MANAGEMENT_ACCOUNT`   
Required: Yes

 ** [participantType](#API_channel_ListChannelHandshakes_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListChannelHandshakes-request-participantType"></a>
Filter by participant type (sender or receiver).  
Type: String  
Valid Values: `SENDER | RECEIVER`   
Required: Yes

 ** [associatedResourceIdentifiers](#API_channel_ListChannelHandshakes_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListChannelHandshakes-request-associatedResourceIdentifiers"></a>
Filter by associated resource identifiers.  
Type: Array of strings  
Length Constraints: Minimum length of 16. Maximum length of 1011.  
Pattern: `((arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/pma-[a-z0-9]{13}(/relationship/rs-[a-z0-9]{13})?)|(pma|rs)-[a-z0-9]{13})`   
Required: No

 ** [handshakeTypeFilters](#API_channel_ListChannelHandshakes_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListChannelHandshakes-request-handshakeTypeFilters"></a>
Type-specific filters for handshakes.  
Type: [ListChannelHandshakesTypeFilters](API_channel_ListChannelHandshakesTypeFilters.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [handshakeTypeSort](#API_channel_ListChannelHandshakes_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListChannelHandshakes-request-handshakeTypeSort"></a>
Type-specific sorting options for handshakes.  
Type: [ListChannelHandshakesTypeSort](API_channel_ListChannelHandshakesTypeSort.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [maxResults](#API_channel_ListChannelHandshakes_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListChannelHandshakes-request-maxResults"></a>
The maximum number of results to return in a single call.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_channel_ListChannelHandshakes_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListChannelHandshakes-request-nextToken"></a>
Token for retrieving the next page of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\x00-\x1F\x7F\x20]*`   
Required: No

 ** [statuses](#API_channel_ListChannelHandshakes_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListChannelHandshakes-request-statuses"></a>
Filter results by handshake status.  
Type: Array of strings  
Valid Values: `PENDING | ACCEPTED | REJECTED | CANCELED | EXPIRED`   
Required: No

## Response Syntax


```
{
   "items": [ 
      { 
         "arn": "string",
         "associatedResourceId": "string",
         "catalog": "string",
         "createdAt": "string",
         "detail": { ... },
         "handshakeType": "string",
         "id": "string",
         "ownerAccountId": "string",
         "receiverAccountId": "string",
         "senderAccountId": "string",
         "senderDisplayName": "string",
         "status": "string",
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_channel_ListChannelHandshakes_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_ListChannelHandshakes-response-items"></a>
List of channel handshakes matching the criteria.  
Type: Array of [ChannelHandshakeSummary](API_channel_ChannelHandshakeSummary.md) objects

 ** [nextToken](#API_channel_ListChannelHandshakes_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_ListChannelHandshakes-response-nextToken"></a>
Token for retrieving the next page of results, if available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\x00-\x1F\x7F\x20]*` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/ListChannelHandshakes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/ListChannelHandshakes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/ListChannelHandshakes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/ListChannelHandshakes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/ListChannelHandshakes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/ListChannelHandshakes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/ListChannelHandshakes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/ListChannelHandshakes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/ListChannelHandshakes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/ListChannelHandshakes) 

# ListProgramManagementAccounts


Lists program management accounts based on specified criteria.

## Request Syntax


```
{
   "accountIds": [ "string" ],
   "catalog": "string",
   "displayNames": [ "string" ],
   "maxResults": number,
   "nextToken": "string",
   "programs": [ "string" ],
   "sort": { 
      "sortBy": "string",
      "sortOrder": "string"
   },
   "statuses": [ "string" ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [catalog](#API_channel_ListProgramManagementAccounts_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListProgramManagementAccounts-request-catalog"></a>
The catalog identifier to filter accounts.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** [accountIds](#API_channel_ListProgramManagementAccounts_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListProgramManagementAccounts-request-accountIds"></a>
Filter by AWS account IDs.  
Type: Array of strings  
Length Constraints: Fixed length of 12.  
Pattern: `[0-9]*`   
Required: No

 ** [displayNames](#API_channel_ListProgramManagementAccounts_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListProgramManagementAccounts-request-displayNames"></a>
Filter by display names.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 30.  
Pattern: `[^\x00-\x1F\x7F]*`   
Required: No

 ** [maxResults](#API_channel_ListProgramManagementAccounts_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListProgramManagementAccounts-request-maxResults"></a>
The maximum number of results to return in a single call.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_channel_ListProgramManagementAccounts_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListProgramManagementAccounts-request-nextToken"></a>
Token for retrieving the next page of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\x00-\x1F\x7F\x20]*`   
Required: No

 ** [programs](#API_channel_ListProgramManagementAccounts_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListProgramManagementAccounts-request-programs"></a>
Filter by program types.  
Type: Array of strings  
Valid Values: `SOLUTION_PROVIDER | DISTRIBUTION | DISTRIBUTION_SELLER`   
Required: No

 ** [sort](#API_channel_ListProgramManagementAccounts_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListProgramManagementAccounts-request-sort"></a>
Sorting options for the results.  
Type: [ListProgramManagementAccountsSortBase](API_channel_ListProgramManagementAccountsSortBase.md) object  
Required: No

 ** [statuses](#API_channel_ListProgramManagementAccounts_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListProgramManagementAccounts-request-statuses"></a>
Filter by program management account statuses.  
Type: Array of strings  
Valid Values: `PENDING | ACTIVE | INACTIVE`   
Required: No

## Response Syntax


```
{
   "items": [ 
      { 
         "accountId": "string",
         "arn": "string",
         "catalog": "string",
         "createdAt": "string",
         "displayName": "string",
         "id": "string",
         "program": "string",
         "revision": "string",
         "startDate": "string",
         "status": "string",
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_channel_ListProgramManagementAccounts_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_ListProgramManagementAccounts-response-items"></a>
List of program management accounts matching the criteria.  
Type: Array of [ProgramManagementAccountSummary](API_channel_ProgramManagementAccountSummary.md) objects

 ** [nextToken](#API_channel_ListProgramManagementAccounts_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_ListProgramManagementAccounts-response-nextToken"></a>
Token for retrieving the next page of results, if available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\x00-\x1F\x7F\x20]*` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/ListProgramManagementAccounts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/ListProgramManagementAccounts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/ListProgramManagementAccounts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/ListProgramManagementAccounts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/ListProgramManagementAccounts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/ListProgramManagementAccounts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/ListProgramManagementAccounts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/ListProgramManagementAccounts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/ListProgramManagementAccounts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/ListProgramManagementAccounts) 

# ListRelationships


Lists partner relationships based on specified criteria.

## Request Syntax


```
{
   "associatedAccountIds": [ "string" ],
   "associationTypes": [ "string" ],
   "catalog": "string",
   "displayNames": [ "string" ],
   "maxResults": number,
   "nextToken": "string",
   "programManagementAccountIdentifiers": [ "string" ],
   "sort": { 
      "sortBy": "string",
      "sortOrder": "string"
   }
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [catalog](#API_channel_ListRelationships_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListRelationships-request-catalog"></a>
The catalog identifier to filter relationships.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** [associatedAccountIds](#API_channel_ListRelationships_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListRelationships-request-associatedAccountIds"></a>
Filter by associated AWS account IDs.  
Type: Array of strings  
Length Constraints: Fixed length of 12.  
Pattern: `[0-9]*`   
Required: No

 ** [associationTypes](#API_channel_ListRelationships_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListRelationships-request-associationTypes"></a>
Filter by association types.  
Type: Array of strings  
Valid Values: `DOWNSTREAM_SELLER | END_CUSTOMER | INTERNAL`   
Required: No

 ** [displayNames](#API_channel_ListRelationships_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListRelationships-request-displayNames"></a>
Filter by display names.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 30.  
Pattern: `[^\x00-\x1F\x7F]*`   
Required: No

 ** [maxResults](#API_channel_ListRelationships_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListRelationships-request-maxResults"></a>
The maximum number of results to return in a single call.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_channel_ListRelationships_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListRelationships-request-nextToken"></a>
Token for retrieving the next page of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\x00-\x1F\x7F\x20]*`   
Required: No

 ** [programManagementAccountIdentifiers](#API_channel_ListRelationships_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListRelationships-request-programManagementAccountIdentifiers"></a>
Filter by program management account identifiers.  
Type: Array of strings  
Length Constraints: Minimum length of 17. Maximum length of 1011.  
Pattern: `(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/)?pma-[a-z0-9]{13}`   
Required: No

 ** [sort](#API_channel_ListRelationships_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListRelationships-request-sort"></a>
Sorting options for the results.  
Type: [ListRelationshipsSortBase](API_channel_ListRelationshipsSortBase.md) object  
Required: No

## Response Syntax


```
{
   "items": [ 
      { 
         "arn": "string",
         "associatedAccountId": "string",
         "associationType": "string",
         "catalog": "string",
         "createdAt": "string",
         "displayName": "string",
         "id": "string",
         "programManagementAccountId": "string",
         "revision": "string",
         "sector": "string",
         "startDate": "string",
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_channel_ListRelationships_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_ListRelationships-response-items"></a>
List of relationships matching the criteria.  
Type: Array of [RelationshipSummary](API_channel_RelationshipSummary.md) objects

 ** [nextToken](#API_channel_ListRelationships_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_ListRelationships-response-nextToken"></a>
Token for retrieving the next page of results, if available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[^\x00-\x1F\x7F\x20]*` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/ListRelationships) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/ListRelationships) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/ListRelationships) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/ListRelationships) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/ListRelationships) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/ListRelationships) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/ListRelationships) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/ListRelationships) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/ListRelationships) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/ListRelationships) 

# ListTagsForResource


Lists tags associated with a specific resource.

## Request Syntax


```
{
   "resourceArn": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [resourceArn](#API_channel_ListTagsForResource_RequestSyntax) **   <a name="AWSPartnerCentral-channel_ListTagsForResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to list tags for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/(program-management-account/pma-[a-z0-9]{13}(/relationship/rs-[a-z0-9]{13})?|channel-handshake/ch-[a-z0-9]{13})`   
Required: Yes

## Response Syntax


```
{
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_channel_ListTagsForResource_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_ListTagsForResource-response-tags"></a>
Key-value pairs associated with the resource.  
Type: Array of [Tag](API_channel_Tag.md) objects

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/ListTagsForResource) 

# RejectChannelHandshake


Rejects a pending channel handshake request.

## Request Syntax


```
{
   "catalog": "string",
   "identifier": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [catalog](#API_channel_RejectChannelHandshake_RequestSyntax) **   <a name="AWSPartnerCentral-channel_RejectChannelHandshake-request-catalog"></a>
The catalog identifier for the handshake request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** [identifier](#API_channel_RejectChannelHandshake_RequestSyntax) **   <a name="AWSPartnerCentral-channel_RejectChannelHandshake-request-identifier"></a>
The unique identifier of the channel handshake to reject.  
Type: String  
Length Constraints: Minimum length of 16. Maximum length of 1011.  
Pattern: `(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/channel-handshake/)?ch-[a-z0-9]{13}`   
Required: Yes

## Response Syntax


```
{
   "channelHandshakeDetail": { 
      "arn": "string",
      "id": "string",
      "status": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [channelHandshakeDetail](#API_channel_RejectChannelHandshake_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_RejectChannelHandshake-response-channelHandshakeDetail"></a>
Details of the rejected channel handshake.  
Type: [RejectChannelHandshakeDetail](API_channel_RejectChannelHandshakeDetail.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/RejectChannelHandshake) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/RejectChannelHandshake) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/RejectChannelHandshake) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/RejectChannelHandshake) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/RejectChannelHandshake) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/RejectChannelHandshake) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/RejectChannelHandshake) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/RejectChannelHandshake) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/RejectChannelHandshake) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/RejectChannelHandshake) 

# TagResource


Adds or updates tags for a specified resource.

## Request Syntax


```
{
   "resourceArn": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [resourceArn](#API_channel_TagResource_RequestSyntax) **   <a name="AWSPartnerCentral-channel_TagResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to tag.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/(program-management-account/pma-[a-z0-9]{13}(/relationship/rs-[a-z0-9]{13})?|channel-handshake/ch-[a-z0-9]{13})`   
Required: Yes

 ** [tags](#API_channel_TagResource_RequestSyntax) **   <a name="AWSPartnerCentral-channel_TagResource-request-tags"></a>
Key-value pairs to associate with the resource.  
Type: Array of [Tag](API_channel_Tag.md) objects  
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource.    
 ** message **   
A message describing the conflict.  
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of the resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/TagResource) 

# UntagResource


Removes tags from a specified resource.

## Request Syntax


```
{
   "resourceArn": "string",
   "tagKeys": [ "string" ]
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [resourceArn](#API_channel_UntagResource_RequestSyntax) **   <a name="AWSPartnerCentral-channel_UntagResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to remove tags from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/(program-management-account/pma-[a-z0-9]{13}(/relationship/rs-[a-z0-9]{13})?|channel-handshake/ch-[a-z0-9]{13})`   
Required: Yes

 ** [tagKeys](#API_channel_UntagResource_RequestSyntax) **   <a name="AWSPartnerCentral-channel_UntagResource-request-tagKeys"></a>
The keys of the tags to remove from the resource.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: Yes

## Response Elements


If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource.    
 ** message **   
A message describing the conflict.  
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of the resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/UntagResource) 

# UpdateProgramManagementAccount


Updates the properties of a program management account.

## Request Syntax


```
{
   "catalog": "string",
   "displayName": "string",
   "identifier": "string",
   "revision": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [catalog](#API_channel_UpdateProgramManagementAccount_RequestSyntax) **   <a name="AWSPartnerCentral-channel_UpdateProgramManagementAccount-request-catalog"></a>
The catalog identifier for the program management account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** [identifier](#API_channel_UpdateProgramManagementAccount_RequestSyntax) **   <a name="AWSPartnerCentral-channel_UpdateProgramManagementAccount-request-identifier"></a>
The unique identifier of the program management account to update.  
Type: String  
Length Constraints: Minimum length of 17. Maximum length of 1011.  
Pattern: `(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/)?pma-[a-z0-9]{13}`   
Required: Yes

 ** [displayName](#API_channel_UpdateProgramManagementAccount_RequestSyntax) **   <a name="AWSPartnerCentral-channel_UpdateProgramManagementAccount-request-displayName"></a>
The new display name for the program management account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 30.  
Pattern: `[^\x00-\x1F\x7F]*`   
Required: No

 ** [revision](#API_channel_UpdateProgramManagementAccount_RequestSyntax) **   <a name="AWSPartnerCentral-channel_UpdateProgramManagementAccount-request-revision"></a>
The current revision number of the program management account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `[0-9]*`   
Required: No

## Response Syntax


```
{
   "programManagementAccountDetail": { 
      "arn": "string",
      "displayName": "string",
      "id": "string",
      "revision": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [programManagementAccountDetail](#API_channel_UpdateProgramManagementAccount_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_UpdateProgramManagementAccount-response-programManagementAccountDetail"></a>
Details of the updated program management account.  
Type: [UpdateProgramManagementAccountDetail](API_channel_UpdateProgramManagementAccountDetail.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource.    
 ** message **   
A message describing the conflict.  
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of the resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/UpdateProgramManagementAccount) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/UpdateProgramManagementAccount) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/UpdateProgramManagementAccount) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/UpdateProgramManagementAccount) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/UpdateProgramManagementAccount) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/UpdateProgramManagementAccount) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/UpdateProgramManagementAccount) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/UpdateProgramManagementAccount) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/UpdateProgramManagementAccount) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/UpdateProgramManagementAccount) 

# UpdateRelationship


Updates the properties of a partner relationship.

## Request Syntax


```
{
   "catalog": "string",
   "displayName": "string",
   "identifier": "string",
   "programManagementAccountIdentifier": "string",
   "requestedSupportPlan": { ... },
   "revision": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [catalog](#API_channel_UpdateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_UpdateRelationship-request-catalog"></a>
The catalog identifier for the relationship.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** [identifier](#API_channel_UpdateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_UpdateRelationship-request-identifier"></a>
The unique identifier of the relationship to update.  
Type: String  
Length Constraints: Minimum length of 16. Maximum length of 1011.  
Pattern: `(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/pma-[a-z0-9]{13}/relationship/)?rs-[a-z0-9]{13}`   
Required: Yes

 ** [programManagementAccountIdentifier](#API_channel_UpdateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_UpdateRelationship-request-programManagementAccountIdentifier"></a>
The identifier of the program management account associated with the relationship.  
Type: String  
Length Constraints: Minimum length of 17. Maximum length of 1011.  
Pattern: `(arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/)?pma-[a-z0-9]{13}`   
Required: Yes

 ** [displayName](#API_channel_UpdateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_UpdateRelationship-request-displayName"></a>
The new display name for the relationship.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 30.  
Pattern: `[^\x00-\x1F\x7F]*`   
Required: No

 ** [requestedSupportPlan](#API_channel_UpdateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_UpdateRelationship-request-requestedSupportPlan"></a>
The updated support plan for the relationship.  
Type: [SupportPlan](API_channel_SupportPlan.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [revision](#API_channel_UpdateRelationship_RequestSyntax) **   <a name="AWSPartnerCentral-channel_UpdateRelationship-request-revision"></a>
The current revision number of the relationship.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `[0-9]*`   
Required: No

## Response Syntax


```
{
   "relationshipDetail": { 
      "arn": "string",
      "displayName": "string",
      "id": "string",
      "revision": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [relationshipDetail](#API_channel_UpdateRelationship_ResponseSyntax) **   <a name="AWSPartnerCentral-channel_UpdateRelationship-response-relationshipDetail"></a>
Details of the updated relationship.  
Type: [UpdateRelationshipDetail](API_channel_UpdateRelationshipDetail.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied due to insufficient permissions.    
 ** message **   
A message describing the access denial.  
 ** reason **   
The reason for the access denial.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource.    
 ** message **   
A message describing the conflict.  
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of the resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.    
 ** message **   
A message describing the internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** message **   
A message describing the resource not found error.  
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of the resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to too many requests being sent in a short period.    
 ** message **   
A message describing the throttling error.  
 ** quotaCode **   
The quota code associated with the throttling error.  
 ** serviceCode **   
The service code associated with the throttling error.
HTTP Status Code: 400

 ** ValidationException **   
The request failed validation due to invalid input parameters.    
 ** fieldList **   
A list of fields that failed validation.  
 ** message **   
A message describing the validation error.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-channel-2024-03-18/UpdateRelationship) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-channel-2024-03-18/UpdateRelationship) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-channel-2024-03-18/UpdateRelationship) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-channel-2024-03-18/UpdateRelationship) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-channel-2024-03-18/UpdateRelationship) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-channel-2024-03-18/UpdateRelationship) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-channel-2024-03-18/UpdateRelationship) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-channel-2024-03-18/UpdateRelationship) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-channel-2024-03-18/UpdateRelationship) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-channel-2024-03-18/UpdateRelationship)