Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1445428373.9 KB

Use this action to retrieve the engagement record for a given <code>EngagementIdentifier</code>.

post/#X-Amz-Target=AWSPartnerCentralSelling.GetEngagement

Headers

X-Amz-Target'AWSPartnerCentralSelling.GetEngagement' required

Request body

Catalogstring required

Specifies the catalog related to the engagement request. Valid values are <code>AWS</code> and <code>Sandbox</code>.

Identifierstring required

Specifies the identifier of the Engagement record to retrieve.

Response

Success

Idstring

The unique resource identifier of the engagement retrieved.

Arnstring

The Amazon Resource Name (ARN) of the engagement retrieved.

Titlestring

The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.

Descriptionstring

A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.

CreatedAtstring date-time

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.

CreatedBystring password

The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.

MemberCountinteger

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.

ModifiedAtstring date-time

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.

ModifiedBystring password

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.