ReferenceSummary

PDF

Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.

Contents

Important

This data type is a UNION, so only one of the following members can be specified when used or returned.

Attachment

Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.

Type: AttachmentReference object

Required: No

Date

Information about a reference when the referenceType is DATE. Otherwise, null.

Type: DateReference object

Required: No

Email

Information about a reference when the referenceType is EMAIL. Otherwise, null.

Type: EmailReference object

Required: No

EmailMessage

Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.

Type: EmailMessageReference object

Required: No

Number

Information about a reference when the referenceType is NUMBER. Otherwise, null.

Type: NumberReference object

Required: No

String

Information about a reference when the referenceType is STRING. Otherwise, null.

Type: StringReference object

Required: No

Url

Information about the reference when the referenceType is URL. Otherwise, null.

Type: UrlReference object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3