Schemas

public struct Schemas

Client object for interacting with AWS Schemas service.

Amazon EventBridge Schema Registry

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the Schemas client

Declaration

Swift

public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

Parameters

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls


                    
                    
                    createDiscoverer(_:)

Creates a discoverer.

Declaration

Swift

public func createDiscoverer(_ input: CreateDiscovererRequest) -> EventLoopFuture<CreateDiscovererResponse>


                    
                    
                    createRegistry(_:)

Creates a registry.

Declaration

Swift

public func createRegistry(_ input: CreateRegistryRequest) -> EventLoopFuture<CreateRegistryResponse>

createSchema(_:)
Creates a schema definition. Inactive schemas will be deleted after two years.
Declaration
Swift

public func createSchema(_ input: CreateSchemaRequest) -> EventLoopFuture<CreateSchemaResponse>


                    
                    
                    deleteDiscoverer(_:)

Deletes a discoverer.

Declaration

Swift

@discardableResult
public func deleteDiscoverer(_ input: DeleteDiscovererRequest) -> EventLoopFuture<Void>


                    
                    
                    deleteRegistry(_:)

Deletes a Registry.

Declaration

Swift

@discardableResult
public func deleteRegistry(_ input: DeleteRegistryRequest) -> EventLoopFuture<Void>


                    
                    
                    deleteResourcePolicy(_:)

Delete the resource-based policy attached to the specified registry.

Declaration

Swift

@discardableResult
public func deleteResourcePolicy(_ input: DeleteResourcePolicyRequest) -> EventLoopFuture<Void>


                    
                    
                    deleteSchema(_:)

Delete a schema definition.

Declaration

Swift

@discardableResult
public func deleteSchema(_ input: DeleteSchemaRequest) -> EventLoopFuture<Void>


                    
                    
                    deleteSchemaVersion(_:)

Delete the schema version definition

Declaration

Swift

@discardableResult
public func deleteSchemaVersion(_ input: DeleteSchemaVersionRequest) -> EventLoopFuture<Void>


                    
                    
                    describeCodeBinding(_:)

Describe the code binding URI.

Declaration

Swift

public func describeCodeBinding(_ input: DescribeCodeBindingRequest) -> EventLoopFuture<DescribeCodeBindingResponse>


                    
                    
                    describeDiscoverer(_:)

Describes the discoverer.

Declaration

Swift

public func describeDiscoverer(_ input: DescribeDiscovererRequest) -> EventLoopFuture<DescribeDiscovererResponse>


                    
                    
                    describeRegistry(_:)

Describes the registry.

Declaration

Swift

public func describeRegistry(_ input: DescribeRegistryRequest) -> EventLoopFuture<DescribeRegistryResponse>


                    
                    
                    describeSchema(_:)

Retrieve the schema definition.

Declaration

Swift

public func describeSchema(_ input: DescribeSchemaRequest) -> EventLoopFuture<DescribeSchemaResponse>


                    
                    
                    getCodeBindingSource(_:)

Get the code binding source URI.

Declaration

Swift

public func getCodeBindingSource(_ input: GetCodeBindingSourceRequest) -> EventLoopFuture<GetCodeBindingSourceResponse>


                    
                    
                    getDiscoveredSchema(_:)

Get the discovered schema that was generated based on sampled events.

Declaration

Swift

public func getDiscoveredSchema(_ input: GetDiscoveredSchemaRequest) -> EventLoopFuture<GetDiscoveredSchemaResponse>


                    
                    
                    getResourcePolicy(_:)

Retrieves the resource-based policy attached to a given registry.

Declaration

Swift

public func getResourcePolicy(_ input: GetResourcePolicyRequest) -> EventLoopFuture<GetResourcePolicyResponse>


                    
                    
                    listDiscoverers(_:)

List the discoverers.

Declaration

Swift

public func listDiscoverers(_ input: ListDiscoverersRequest) -> EventLoopFuture<ListDiscoverersResponse>


                    
                    
                    listRegistries(_:)

List the registries.

Declaration

Swift

public func listRegistries(_ input: ListRegistriesRequest) -> EventLoopFuture<ListRegistriesResponse>


                    
                    
                    listSchemaVersions(_:)

Provides a list of the schema versions and related information.

Declaration

Swift

public func listSchemaVersions(_ input: ListSchemaVersionsRequest) -> EventLoopFuture<ListSchemaVersionsResponse>


                    
                    
                    listSchemas(_:)

List the schemas.

Declaration

Swift

public func listSchemas(_ input: ListSchemasRequest) -> EventLoopFuture<ListSchemasResponse>


                    
                    
                    listTagsForResource(_:)

Get tags for resource.

Declaration

Swift

public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>


                    
                    
                    putCodeBinding(_:)

Put code binding URI

Declaration

Swift

public func putCodeBinding(_ input: PutCodeBindingRequest) -> EventLoopFuture<PutCodeBindingResponse>


                    
                    
                    putResourcePolicy(_:)

The name of the policy.

Declaration

Swift

public func putResourcePolicy(_ input: PutResourcePolicyRequest) -> EventLoopFuture<PutResourcePolicyResponse>


                    
                    
                    searchSchemas(_:)

Search the schemas

Declaration

Swift

public func searchSchemas(_ input: SearchSchemasRequest) -> EventLoopFuture<SearchSchemasResponse>


                    
                    
                    startDiscoverer(_:)

Starts the discoverer

Declaration

Swift

public func startDiscoverer(_ input: StartDiscovererRequest) -> EventLoopFuture<StartDiscovererResponse>


                    
                    
                    stopDiscoverer(_:)

Stops the discoverer

Declaration

Swift

public func stopDiscoverer(_ input: StopDiscovererRequest) -> EventLoopFuture<StopDiscovererResponse>


                    
                    
                    tagResource(_:)

Add tags to a resource.

Declaration

Swift

@discardableResult
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<Void>


                    
                    
                    untagResource(_:)

Removes tags from a resource.

Declaration

Swift

@discardableResult
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<Void>


                    
                    
                    updateDiscoverer(_:)

Updates the discoverer

Declaration

Swift

public func updateDiscoverer(_ input: UpdateDiscovererRequest) -> EventLoopFuture<UpdateDiscovererResponse>


                    
                    
                    updateRegistry(_:)

Updates a registry.

Declaration

Swift

public func updateRegistry(_ input: UpdateRegistryRequest) -> EventLoopFuture<UpdateRegistryResponse>

updateSchema(_:)
Updates the schema definition Inactive schemas will be deleted after two years.
Declaration
Swift

public func updateSchema(_ input: UpdateSchemaRequest) -> EventLoopFuture<UpdateSchemaResponse>

Paginators


                    
                    
                    listDiscoverersPaginator(_:onPage:)

List the discoverers.

Declaration

Swift

public func listDiscoverersPaginator(_ input: ListDiscoverersRequest, onPage: @escaping (ListDiscoverersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listRegistriesPaginator(_:onPage:)

List the registries.

Declaration

Swift

public func listRegistriesPaginator(_ input: ListRegistriesRequest, onPage: @escaping (ListRegistriesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listSchemaVersionsPaginator(_:onPage:)

Provides a list of the schema versions and related information.

Declaration

Swift

public func listSchemaVersionsPaginator(_ input: ListSchemaVersionsRequest, onPage: @escaping (ListSchemaVersionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listSchemasPaginator(_:onPage:)

List the schemas.

Declaration

Swift

public func listSchemasPaginator(_ input: ListSchemasRequest, onPage: @escaping (ListSchemasResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    searchSchemasPaginator(_:onPage:)

Search the schemas

Declaration

Swift

public func searchSchemasPaginator(_ input: SearchSchemasRequest, onPage: @escaping (SearchSchemasResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListDiscoverersRequest

Undocumented

Declaration

Swift

public struct ListDiscoverersRequest : AWSShape

extension Schemas.ListDiscoverersRequest: AWSPaginateStringToken


                    
                    
                    ListRegistriesRequest

Undocumented

Declaration

Swift

public struct ListRegistriesRequest : AWSShape

extension Schemas.ListRegistriesRequest: AWSPaginateStringToken


                    
                    
                    ListSchemaVersionsRequest

Undocumented

Declaration

Swift

public struct ListSchemaVersionsRequest : AWSShape

extension Schemas.ListSchemaVersionsRequest: AWSPaginateStringToken


                    
                    
                    ListSchemasRequest

Undocumented

Declaration

Swift

public struct ListSchemasRequest : AWSShape

extension Schemas.ListSchemasRequest: AWSPaginateStringToken


                    
                    
                    SearchSchemasRequest

Undocumented

Declaration

Swift

public struct SearchSchemasRequest : AWSShape

extension Schemas.SearchSchemasRequest: AWSPaginateStringToken

CreateDiscovererRequest
Undocumented
See more
Declaration
Swift

public struct CreateDiscovererRequest : AWSShape
CreateDiscovererResponse
Undocumented
See more
Declaration
Swift

public struct CreateDiscovererResponse : AWSShape
CreateRegistryRequest
Undocumented
See more
Declaration
Swift

public struct CreateRegistryRequest : AWSShape
CreateRegistryResponse
Undocumented
See more
Declaration
Swift

public struct CreateRegistryResponse : AWSShape
CreateSchemaRequest
Undocumented
See more
Declaration
Swift

public struct CreateSchemaRequest : AWSShape
CreateSchemaResponse
Undocumented
See more
Declaration
Swift

public struct CreateSchemaResponse : AWSShape
DeleteDiscovererRequest
Undocumented
See more
Declaration
Swift

public struct DeleteDiscovererRequest : AWSShape
DeleteRegistryRequest
Undocumented
See more
Declaration
Swift

public struct DeleteRegistryRequest : AWSShape
DeleteResourcePolicyRequest
Undocumented
See more
Declaration
Swift

public struct DeleteResourcePolicyRequest : AWSShape
DeleteSchemaRequest
Undocumented
See more
Declaration
Swift

public struct DeleteSchemaRequest : AWSShape
DeleteSchemaVersionRequest
Undocumented
See more
Declaration
Swift

public struct DeleteSchemaVersionRequest : AWSShape
DescribeCodeBindingRequest
Undocumented
See more
Declaration
Swift

public struct DescribeCodeBindingRequest : AWSShape
DescribeCodeBindingResponse
Undocumented
See more
Declaration
Swift

public struct DescribeCodeBindingResponse : AWSShape
DescribeDiscovererRequest
Undocumented
See more
Declaration
Swift

public struct DescribeDiscovererRequest : AWSShape
DescribeDiscovererResponse
Undocumented
See more
Declaration
Swift

public struct DescribeDiscovererResponse : AWSShape
DescribeRegistryRequest
Undocumented
See more
Declaration
Swift

public struct DescribeRegistryRequest : AWSShape
DescribeRegistryResponse
Undocumented
See more
Declaration
Swift

public struct DescribeRegistryResponse : AWSShape
DescribeSchemaRequest
Undocumented
See more
Declaration
Swift

public struct DescribeSchemaRequest : AWSShape
DescribeSchemaResponse
Undocumented
See more
Declaration
Swift

public struct DescribeSchemaResponse : AWSShape
DiscovererSummary
Undocumented
See more
Declaration
Swift

public struct DiscovererSummary : AWSShape
GetCodeBindingSourceRequest
Undocumented
See more
Declaration
Swift

public struct GetCodeBindingSourceRequest : AWSShape
GetCodeBindingSourceResponse
Undocumented
See more
Declaration
Swift

public struct GetCodeBindingSourceResponse : AWSShape
GetDiscoveredSchemaRequest
Undocumented
See more
Declaration
Swift

public struct GetDiscoveredSchemaRequest : AWSShape
GetDiscoveredSchemaResponse
Undocumented
See more
Declaration
Swift

public struct GetDiscoveredSchemaResponse : AWSShape
GetResourcePolicyRequest
Undocumented
See more
Declaration
Swift

public struct GetResourcePolicyRequest : AWSShape
GetResourcePolicyResponse
Undocumented
See more
Declaration
Swift

public struct GetResourcePolicyResponse : AWSShape
ListDiscoverersResponse
Undocumented
See more
Declaration
Swift

public struct ListDiscoverersResponse : AWSShape
ListRegistriesResponse
Undocumented
See more
Declaration
Swift

public struct ListRegistriesResponse : AWSShape
ListSchemaVersionsResponse
Undocumented
See more
Declaration
Swift

public struct ListSchemaVersionsResponse : AWSShape
ListSchemasResponse
Undocumented
See more
Declaration
Swift

public struct ListSchemasResponse : AWSShape
ListTagsForResourceRequest
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceRequest : AWSShape
ListTagsForResourceResponse
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceResponse : AWSShape
PutCodeBindingRequest
Undocumented
See more
Declaration
Swift

public struct PutCodeBindingRequest : AWSShape
PutCodeBindingResponse
Undocumented
See more
Declaration
Swift

public struct PutCodeBindingResponse : AWSShape
PutResourcePolicyRequest
Undocumented
See more
Declaration
Swift

public struct PutResourcePolicyRequest : AWSShape
PutResourcePolicyResponse
Undocumented
See more
Declaration
Swift

public struct PutResourcePolicyResponse : AWSShape
RegistrySummary
Undocumented
See more
Declaration
Swift

public struct RegistrySummary : AWSShape
SchemaSummary
Undocumented
See more
Declaration
Swift

public struct SchemaSummary : AWSShape
SchemaVersionSummary
Undocumented
See more
Declaration
Swift

public struct SchemaVersionSummary : AWSShape
SearchSchemaSummary
Undocumented
See more
Declaration
Swift

public struct SearchSchemaSummary : AWSShape
SearchSchemaVersionSummary
Undocumented
See more
Declaration
Swift

public struct SearchSchemaVersionSummary : AWSShape
SearchSchemasResponse
Undocumented
See more
Declaration
Swift

public struct SearchSchemasResponse : AWSShape
StartDiscovererRequest
Undocumented
See more
Declaration
Swift

public struct StartDiscovererRequest : AWSShape
StartDiscovererResponse
Undocumented
See more
Declaration
Swift

public struct StartDiscovererResponse : AWSShape
StopDiscovererRequest
Undocumented
See more
Declaration
Swift

public struct StopDiscovererRequest : AWSShape
StopDiscovererResponse
Undocumented
See more
Declaration
Swift

public struct StopDiscovererResponse : AWSShape
TagResourceRequest
Undocumented
See more
Declaration
Swift

public struct TagResourceRequest : AWSShape
UntagResourceRequest
Undocumented
See more
Declaration
Swift

public struct UntagResourceRequest : AWSShape
UpdateDiscovererRequest
Undocumented
See more
Declaration
Swift

public struct UpdateDiscovererRequest : AWSShape
UpdateDiscovererResponse
Undocumented
See more
Declaration
Swift

public struct UpdateDiscovererResponse : AWSShape
UpdateRegistryRequest
Undocumented
See more
Declaration
Swift

public struct UpdateRegistryRequest : AWSShape
UpdateRegistryResponse
Undocumented
See more
Declaration
Swift

public struct UpdateRegistryResponse : AWSShape
UpdateSchemaRequest
Undocumented
See more
Declaration
Swift

public struct UpdateSchemaRequest : AWSShape
UpdateSchemaResponse
Undocumented
See more
Declaration
Swift

public struct UpdateSchemaResponse : AWSShape

Enums


                    
                    
                    CodeGenerationStatus

Undocumented

Declaration

Swift

public enum CodeGenerationStatus : String, CustomStringConvertible, Codable


                    
                    
                    DiscovererState

Undocumented

Declaration

Swift

public enum DiscovererState : String, CustomStringConvertible, Codable


                    
                    
                    Type

Undocumented

Declaration

Swift

public enum `Type` : String, CustomStringConvertible, Codable