Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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.

The request accepts the following data in JSON format.

Note

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

Catalog

Specifies the catalog related to the engagement request. Valid values are AWS and Sandbox.

Type: String

Pattern: ^[a-zA-Z]+$

Required: Yes

Identifier

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": [ 
      { 
         "Payload": { ... },
         "Type": "string"
      }
   ],
   "CreatedAt": "string",
   "CreatedBy": "string",
   "Description": "string",
   "Id": "string",
   "MemberCount": number,
   "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

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

Type: String

Pattern: ^arn:.*

Contexts

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 objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

CreatedAt

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

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

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Id

The unique resource identifier of the engagement retrieved.

Type: String

Pattern: ^eng-[0-9a-z]{14}$

MemberCount

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

Title

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

Errors

For information about the errors that are common to all actions, see Common Errors.

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.

HTTP Status Code: 400

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

HTTP Status Code: 400