IntegrationSummary
Contains summary information about an integration.
Contents
- displayName
-
The display name of the integration.
Type: String
Required: Yes
- installationId
-
The installation identifier from the integration provider.
Type: String
Required: Yes
- integrationId
-
The unique identifier of the integration.
Type: String
Required: Yes
- provider
-
The integration provider.
Type: String
Valid Values:
GITHUB | GITLAB | BITBUCKET | CONFLUENCERequired: Yes
- providerType
-
The type of the integration provider.
Type: String
Valid Values:
SOURCE_CODE | DOCUMENTATIONRequired: Yes
- privateConnectionName
-
The name of the private connection used to reach the integration's self-hosted instance over private networking, if one is configured.
Type: String
Required: No
- targetUrl
-
The HTTPS URL of the customer self-hosted instance, such as a GitHub Enterprise Server or self-managed GitLab instance. This value is absent for SaaS integrations.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: