Documentation
¶
Index ¶
- type AccessDeniedException
- type ApiKeyCredential
- type AppAuthorization
- type AppAuthorizationStatus
- type AppAuthorizationSummary
- type AppBundle
- type AppBundleSummary
- type AuditLogDestinationConfiguration
- type AuditLogProcessingConfiguration
- type AuthRequest
- type AuthType
- type ConflictException
- type Credential
- type CredentialMemberApiKeyCredential
- type CredentialMemberOauth2Credential
- type Destination
- type DestinationConfiguration
- type DestinationConfigurationMemberAuditLog
- type DestinationMemberFirehoseStream
- type DestinationMemberS3Bucket
- type FirehoseStream
- type Format
- type Ingestion
- type IngestionDestination
- type IngestionDestinationStatus
- type IngestionDestinationSummary
- type IngestionState
- type IngestionSummary
- type IngestionType
- type InternalServerException
- type Oauth2Credential
- type Persona
- type ProcessingConfiguration
- type ProcessingConfigurationMemberAuditLog
- type ResourceNotFoundException
- type ResultStatus
- type S3Bucket
- type Schema
- type ServiceQuotaExceededException
- type Tag
- type TaskError
- type Tenant
- type ThrottlingException
- type UnknownUnionMember
- type UserAccessResultItem
- type UserAccessTaskItem
- type ValidationException
- type ValidationExceptionField
- type ValidationExceptionReason
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
You are not authorized to perform this operation.
func (*AccessDeniedException) Error ¶
func (e *AccessDeniedException) Error() string
func (*AccessDeniedException) ErrorCode ¶
func (e *AccessDeniedException) ErrorCode() string
func (*AccessDeniedException) ErrorFault ¶
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
func (*AccessDeniedException) ErrorMessage ¶
func (e *AccessDeniedException) ErrorMessage() string
type ApiKeyCredential ¶
type ApiKeyCredential struct { // An API key for an application. // // This member is required. ApiKey *string // contains filtered or unexported fields }
Contains API key credential information.
type AppAuthorization ¶
type AppAuthorization struct { // The name of the application. // // This member is required. App *string // The Amazon Resource Name (ARN) of the app authorization. // // This member is required. AppAuthorizationArn *string // The Amazon Resource Name (ARN) of the app bundle for the app authorization. // // This member is required. AppBundleArn *string // The authorization type. // // This member is required. AuthType AuthType // The timestamp of when the app authorization was created. // // This member is required. CreatedAt *time.Time // The state of the app authorization. // // The following states are possible: // // - PendingConnect : The initial state of the app authorization. The app // authorization is created but not yet connected. // // - Connected : The app authorization is connected to the application, and is // ready to be used. // // - ConnectionValidationFailed : The app authorization received a validation // exception when trying to connect to the application. If the app authorization is // in this state, you should verify the configured credentials and try to connect // the app authorization again. // // - TokenAutoRotationFailed : AppFabric failed to refresh the access token. If // the app authorization is in this state, you should try to reconnect the app // authorization. // // This member is required. Status AppAuthorizationStatus // Contains information about an application tenant, such as the application // display name and identifier. // // This member is required. Tenant *Tenant // The timestamp of when the app authorization was last updated. // // This member is required. UpdatedAt *time.Time // The application URL for the OAuth flow. AuthUrl *string // The user persona of the app authorization. // // This field should always be admin . Persona Persona // contains filtered or unexported fields }
Contains information about an app authorization.
type AppAuthorizationStatus ¶
type AppAuthorizationStatus string
const ( AppAuthorizationStatusPendingConnect AppAuthorizationStatus = "PendingConnect" AppAuthorizationStatusConnected AppAuthorizationStatus = "Connected" AppAuthorizationStatusConnectionValidationFailed AppAuthorizationStatus = "ConnectionValidationFailed" AppAuthorizationStatusTokenAutoRotationFailed AppAuthorizationStatus = "TokenAutoRotationFailed" )
Enum values for AppAuthorizationStatus
func (AppAuthorizationStatus) Values ¶
func (AppAuthorizationStatus) Values() []AppAuthorizationStatus
Values returns all known values for AppAuthorizationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type AppAuthorizationSummary ¶
type AppAuthorizationSummary struct { // The name of the application. // // This member is required. App *string // The Amazon Resource Name (ARN) of the app authorization. // // This member is required. AppAuthorizationArn *string // The Amazon Resource Name (ARN) of the app bundle for the app authorization. // // This member is required. AppBundleArn *string // The state of the app authorization. // // The following states are possible: // // - PendingConnect : The initial state of the app authorization. The app // authorization is created but not yet connected. // // - Connected : The app authorization is connected to the application, and is // ready to be used. // // - ConnectionValidationFailed : The app authorization received a validation // exception when trying to connect to the application. If the app authorization is // in this state, you should verify the configured credentials and try to connect // the app authorization again. // // - TokenAutoRotationFailed : AppFabric failed to refresh the access token. If // the app authorization is in this state, you should try to reconnect the app // authorization. // // This member is required. Status AppAuthorizationStatus // Contains information about an application tenant, such as the application // display name and identifier. // // This member is required. Tenant *Tenant // Timestamp for when the app authorization was last updated. // // This member is required. UpdatedAt *time.Time // contains filtered or unexported fields }
Contains a summary of an app authorization.
type AppBundle ¶
type AppBundle struct { // The Amazon Resource Name (ARN) of the app bundle. // // This member is required. Arn *string // The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to // encrypt the application data. CustomerManagedKeyArn *string // contains filtered or unexported fields }
Contains information about an app bundle.
type AppBundleSummary ¶
type AppBundleSummary struct { // The Amazon Resource Name (ARN) of the app bundle. // // This member is required. Arn *string // contains filtered or unexported fields }
Contains a summary of an app bundle.
type AuditLogDestinationConfiguration ¶
type AuditLogDestinationConfiguration struct { // Contains information about an audit log destination. // // This member is required. Destination Destination // contains filtered or unexported fields }
Contains information about an audit log destination configuration.
type AuditLogProcessingConfiguration ¶
type AuditLogProcessingConfiguration struct { // The format in which the audit logs need to be formatted. // // This member is required. Format Format // The event schema in which the audit logs need to be formatted. // // This member is required. Schema Schema // contains filtered or unexported fields }
Contains information about an audit log processing configuration.
type AuthRequest ¶
type AuthRequest struct { // The authorization code returned by the application after permission is granted // in the application OAuth page (after clicking on the AuthURL). // // This member is required. Code *string // The redirect URL that is specified in the AuthURL and the application client. // // This member is required. RedirectUri *string // contains filtered or unexported fields }
Contains authorization request information, which is required for Amazon Web Services AppFabric to get the OAuth2 access token for an application.
type ConflictException ¶
type ConflictException struct { Message *string ErrorCodeOverride *string ResourceId *string ResourceType *string // contains filtered or unexported fields }
The request has created a conflict. Check the request parameters and try again.
func (*ConflictException) Error ¶
func (e *ConflictException) Error() string
func (*ConflictException) ErrorCode ¶
func (e *ConflictException) ErrorCode() string
func (*ConflictException) ErrorFault ¶
func (e *ConflictException) ErrorFault() smithy.ErrorFault
func (*ConflictException) ErrorMessage ¶
func (e *ConflictException) ErrorMessage() string
type Credential ¶
type Credential interface {
// contains filtered or unexported methods
}
Contains credential information for an application.
The following types satisfy this interface:
CredentialMemberApiKeyCredential CredentialMemberOauth2Credential
Example (OutputUsage) ¶
package main import ( "e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/appfabric/types" "fmt" ) func main() { var union types.Credential // type switches can be used to check the union value switch v := union.(type) { case *types.CredentialMemberApiKeyCredential: _ = v.Value // Value is types.ApiKeyCredential case *types.CredentialMemberOauth2Credential: _ = v.Value // Value is types.Oauth2Credential case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
Output:
type CredentialMemberApiKeyCredential ¶
type CredentialMemberApiKeyCredential struct { Value ApiKeyCredential // contains filtered or unexported fields }
Contains API key credential information.
type CredentialMemberOauth2Credential ¶
type CredentialMemberOauth2Credential struct { Value Oauth2Credential // contains filtered or unexported fields }
Contains OAuth2 client credential information.
type Destination ¶
type Destination interface {
// contains filtered or unexported methods
}
Contains information about an audit log destination.
The following types satisfy this interface:
DestinationMemberFirehoseStream DestinationMemberS3Bucket
Example (OutputUsage) ¶
package main import ( "e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/appfabric/types" "fmt" ) func main() { var union types.Destination // type switches can be used to check the union value switch v := union.(type) { case *types.DestinationMemberFirehoseStream: _ = v.Value // Value is types.FirehoseStream case *types.DestinationMemberS3Bucket: _ = v.Value // Value is types.S3Bucket case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
Output:
type DestinationConfiguration ¶
type DestinationConfiguration interface {
// contains filtered or unexported methods
}
Contains information about the destination of ingested data.
The following types satisfy this interface:
DestinationConfigurationMemberAuditLog
Example (OutputUsage) ¶
package main import ( "e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/appfabric/types" "fmt" ) func main() { var union types.DestinationConfiguration // type switches can be used to check the union value switch v := union.(type) { case *types.DestinationConfigurationMemberAuditLog: _ = v.Value // Value is types.AuditLogDestinationConfiguration case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
Output:
type DestinationConfigurationMemberAuditLog ¶
type DestinationConfigurationMemberAuditLog struct { Value AuditLogDestinationConfiguration // contains filtered or unexported fields }
Contains information about an audit log destination configuration.
type DestinationMemberFirehoseStream ¶
type DestinationMemberFirehoseStream struct { Value FirehoseStream // contains filtered or unexported fields }
Contains information about an Amazon Kinesis Data Firehose delivery stream.
type DestinationMemberS3Bucket ¶
type DestinationMemberS3Bucket struct { Value S3Bucket // contains filtered or unexported fields }
Contains information about an Amazon S3 bucket.
type FirehoseStream ¶
type FirehoseStream struct { // The name of the Amazon Kinesis Data Firehose delivery stream. // // This member is required. StreamName *string // contains filtered or unexported fields }
Contains information about an Amazon Kinesis Data Firehose delivery stream.
type Ingestion ¶
type Ingestion struct { // The name of the application. // // This member is required. App *string // The Amazon Resource Name (ARN) of the app bundle for the ingestion. // // This member is required. AppBundleArn *string // The Amazon Resource Name (ARN) of the ingestion. // // This member is required. Arn *string // The timestamp of when the ingestion was created. // // This member is required. CreatedAt *time.Time // The type of the ingestion. // // This member is required. IngestionType IngestionType // The status of the ingestion. // // This member is required. State IngestionState // The ID of the application tenant. // // This member is required. TenantId *string // The timestamp of when the ingestion was last updated. // // This member is required. UpdatedAt *time.Time // contains filtered or unexported fields }
Contains information about an ingestion.
type IngestionDestination ¶
type IngestionDestination struct { // The Amazon Resource Name (ARN) of the ingestion destination. // // This member is required. Arn *string // Contains information about the destination of ingested data. // // This member is required. DestinationConfiguration DestinationConfiguration // The Amazon Resource Name (ARN) of the ingestion. // // This member is required. IngestionArn *string // Contains information about how ingested data is processed. // // This member is required. ProcessingConfiguration ProcessingConfiguration // The timestamp of when the ingestion destination was created. CreatedAt *time.Time // The state of the ingestion destination. // // The following states are possible: // // - Active : The ingestion destination is active and is ready to be used. // // - Failed : The ingestion destination has failed. If the ingestion destination // is in this state, you should verify the ingestion destination configuration and // try again. Status IngestionDestinationStatus // The reason for the current status of the ingestion destination. // // Only present when the status of ingestion destination is Failed . StatusReason *string // The timestamp of when the ingestion destination was last updated. UpdatedAt *time.Time // contains filtered or unexported fields }
Contains information about an ingestion destination.
type IngestionDestinationStatus ¶
type IngestionDestinationStatus string
const ( IngestionDestinationStatusActive IngestionDestinationStatus = "Active" IngestionDestinationStatusFailed IngestionDestinationStatus = "Failed" )
Enum values for IngestionDestinationStatus
func (IngestionDestinationStatus) Values ¶
func (IngestionDestinationStatus) Values() []IngestionDestinationStatus
Values returns all known values for IngestionDestinationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type IngestionDestinationSummary ¶
type IngestionDestinationSummary struct { // The Amazon Resource Name (ARN) of the ingestion destination. // // This member is required. Arn *string // contains filtered or unexported fields }
Contains a summary of an ingestion destination.
type IngestionState ¶
type IngestionState string
const ( IngestionStateEnabled IngestionState = "enabled" IngestionStateDisabled IngestionState = "disabled" )
Enum values for IngestionState
func (IngestionState) Values ¶
func (IngestionState) Values() []IngestionState
Values returns all known values for IngestionState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type IngestionSummary ¶
type IngestionSummary struct { // The name of the application. // // This member is required. App *string // The Amazon Resource Name (ARN) of the ingestion. // // This member is required. Arn *string // The status of the ingestion. // // This member is required. State IngestionState // The ID of the application tenant. // // This member is required. TenantId *string // contains filtered or unexported fields }
Contains a summary of an ingestion.
type IngestionType ¶
type IngestionType string
const (
IngestionTypeAuditLog IngestionType = "auditLog"
)
Enum values for IngestionType
func (IngestionType) Values ¶
func (IngestionType) Values() []IngestionType
Values returns all known values for IngestionType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InternalServerException ¶
type InternalServerException struct { Message *string ErrorCodeOverride *string RetryAfterSeconds *int32 // contains filtered or unexported fields }
The request processing has failed because of an unknown error, exception, or failure with an internal server.
func (*InternalServerException) Error ¶
func (e *InternalServerException) Error() string
func (*InternalServerException) ErrorCode ¶
func (e *InternalServerException) ErrorCode() string
func (*InternalServerException) ErrorFault ¶
func (e *InternalServerException) ErrorFault() smithy.ErrorFault
func (*InternalServerException) ErrorMessage ¶
func (e *InternalServerException) ErrorMessage() string
type Oauth2Credential ¶
type Oauth2Credential struct { // The client ID of the client application. // // This member is required. ClientId *string // The client secret of the client application. // // This member is required. ClientSecret *string // contains filtered or unexported fields }
Contains OAuth2 client credential information.
type ProcessingConfiguration ¶
type ProcessingConfiguration interface {
// contains filtered or unexported methods
}
Contains information about how ingested data is processed.
The following types satisfy this interface:
ProcessingConfigurationMemberAuditLog
Example (OutputUsage) ¶
package main import ( "e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/appfabric/types" "fmt" ) func main() { var union types.ProcessingConfiguration // type switches can be used to check the union value switch v := union.(type) { case *types.ProcessingConfigurationMemberAuditLog: _ = v.Value // Value is types.AuditLogProcessingConfiguration case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
Output:
type ProcessingConfigurationMemberAuditLog ¶
type ProcessingConfigurationMemberAuditLog struct { Value AuditLogProcessingConfiguration // contains filtered or unexported fields }
Contains information about an audit log processing configuration.
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { Message *string ErrorCodeOverride *string ResourceId *string ResourceType *string // contains filtered or unexported fields }
The specified resource does not exist.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type ResultStatus ¶
type ResultStatus string
const ( ResultStatusInProgress ResultStatus = "IN_PROGRESS" ResultStatusCompleted ResultStatus = "COMPLETED" ResultStatusFailed ResultStatus = "FAILED" ResultStatusExpired ResultStatus = "EXPIRED" )
Enum values for ResultStatus
func (ResultStatus) Values ¶
func (ResultStatus) Values() []ResultStatus
Values returns all known values for ResultStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type S3Bucket ¶
type S3Bucket struct { // The name of the Amazon S3 bucket. // // This member is required. BucketName *string // The object key to use. Prefix *string // contains filtered or unexported fields }
Contains information about an Amazon S3 bucket.
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct { Message *string ErrorCodeOverride *string ResourceId *string ResourceType *string ServiceCode *string QuotaCode *string // contains filtered or unexported fields }
The request exceeds a service quota.
func (*ServiceQuotaExceededException) Error ¶
func (e *ServiceQuotaExceededException) Error() string
func (*ServiceQuotaExceededException) ErrorCode ¶
func (e *ServiceQuotaExceededException) ErrorCode() string
func (*ServiceQuotaExceededException) ErrorFault ¶
func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault
func (*ServiceQuotaExceededException) ErrorMessage ¶
func (e *ServiceQuotaExceededException) ErrorMessage() string
type Tag ¶
type Tag struct { // Tag key. // // This member is required. Key *string // Tag value. // // This member is required. Value *string // contains filtered or unexported fields }
The key or keys of the key-value pairs for the tag or tags assigned to a resource.
type TaskError ¶
type TaskError struct { // The code of the error. ErrorCode *string // The message of the error. ErrorMessage *string // contains filtered or unexported fields }
Contains information about an error returned from a user access task.
type Tenant ¶
type Tenant struct { // The display name of the tenant. // // This member is required. TenantDisplayName *string // The ID of the application tenant. // // This member is required. TenantIdentifier *string // contains filtered or unexported fields }
Contains information about an application tenant.
type ThrottlingException ¶
type ThrottlingException struct { Message *string ErrorCodeOverride *string ServiceCode *string QuotaCode *string RetryAfterSeconds *int32 // contains filtered or unexported fields }
The request rate exceeds the limit.
func (*ThrottlingException) Error ¶
func (e *ThrottlingException) Error() string
func (*ThrottlingException) ErrorCode ¶
func (e *ThrottlingException) ErrorCode() string
func (*ThrottlingException) ErrorFault ¶
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
func (*ThrottlingException) ErrorMessage ¶
func (e *ThrottlingException) ErrorMessage() string
type UnknownUnionMember ¶
type UnknownUnionMember struct { Tag string Value []byte // contains filtered or unexported fields }
UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.
type UserAccessResultItem ¶
type UserAccessResultItem struct { // The name of the application. App *string // The email address of the target user. Email *string // The status of the user access result item. // // The following states are possible: // // - IN_PROGRESS : The user access task is in progress. // // - COMPLETED : The user access task completed successfully. // // - FAILED : The user access task failed. // // - EXPIRED : The user access task expired. ResultStatus ResultStatus // Contains information about an error returned from a user access task. TaskError *TaskError // The unique ID of the task. TaskId *string // The display name of the tenant. TenantDisplayName *string // The ID of the application tenant. TenantId *string // The first name of the user. UserFirstName *string // The full name of the user. UserFullName *string // The unique ID of user. UserId *string // The last name of the user. UserLastName *string // The status of the user returned by the application. UserStatus *string // contains filtered or unexported fields }
Contains information about a user's access to an application.
type UserAccessTaskItem ¶
type UserAccessTaskItem struct { // The name of the application. // // This member is required. App *string // The ID of the application tenant. // // This member is required. TenantId *string // Error from the task, if any. Error *TaskError // The unique ID of the task. TaskId *string // contains filtered or unexported fields }
Contains information about a user access task.
type ValidationException ¶
type ValidationException struct { Message *string ErrorCodeOverride *string Reason ValidationExceptionReason FieldList []ValidationExceptionField // contains filtered or unexported fields }
The request has invalid or missing parameters.
func (*ValidationException) Error ¶
func (e *ValidationException) Error() string
func (*ValidationException) ErrorCode ¶
func (e *ValidationException) ErrorCode() string
func (*ValidationException) ErrorFault ¶
func (e *ValidationException) ErrorFault() smithy.ErrorFault
func (*ValidationException) ErrorMessage ¶
func (e *ValidationException) ErrorMessage() string
type ValidationExceptionField ¶
type ValidationExceptionField struct { // A message about the validation exception. // // This member is required. Message *string // The field name where the invalid entry was detected. // // This member is required. Name *string // contains filtered or unexported fields }
The input failed to meet the constraints specified by the Amazon Web Services service in a specified field.
type ValidationExceptionReason ¶
type ValidationExceptionReason string
const ( ValidationExceptionReasonUnknownOperation ValidationExceptionReason = "unknownOperation" ValidationExceptionReasonCannotParse ValidationExceptionReason = "cannotParse" ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "fieldValidationFailed" ValidationExceptionReasonOther ValidationExceptionReason = "other" )
Enum values for ValidationExceptionReason
func (ValidationExceptionReason) Values ¶
func (ValidationExceptionReason) Values() []ValidationExceptionReason
Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.