MqService overview
Added in v1.0.0
Table of contents
constructors
makeMqService
Signature
export declare const makeMqService: Effect.Effect<any, unknown, unknown>
Added in v1.0.0
models
MqService (class)
Signature
export declare class MqService
Added in v1.0.0
MqService$ (interface)
Signature
export interface MqService$ {
/**
* @see {@link CreateBrokerCommand}
*/
createBroker(
args: CreateBrokerCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateBrokerCommandOutput,
| Cause.TimeoutError
| SdkError
| BadRequestError
| ConflictError
| ForbiddenError
| InternalServerError
| UnauthorizedError
>
/**
* @see {@link CreateConfigurationCommand}
*/
createConfiguration(
args: CreateConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateConfigurationCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ConflictError | ForbiddenError | InternalServerError
>
/**
* @see {@link CreateTagsCommand}
*/
createTags(
args: CreateTagsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateTagsCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
>
/**
* @see {@link CreateUserCommand}
*/
createUser(
args: CreateUserCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateUserCommandOutput,
| Cause.TimeoutError
| SdkError
| BadRequestError
| ConflictError
| ForbiddenError
| InternalServerError
| NotFoundError
>
/**
* @see {@link DeleteBrokerCommand}
*/
deleteBroker(
args: DeleteBrokerCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteBrokerCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
>
/**
* @see {@link DeleteConfigurationCommand}
*/
deleteConfiguration(
args: DeleteConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteConfigurationCommandOutput,
| Cause.TimeoutError
| SdkError
| BadRequestError
| ConflictError
| ForbiddenError
| InternalServerError
| NotFoundError
>
/**
* @see {@link DeleteTagsCommand}
*/
deleteTags(
args: DeleteTagsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteTagsCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
>
/**
* @see {@link DeleteUserCommand}
*/
deleteUser(
args: DeleteUserCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteUserCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
>
/**
* @see {@link DescribeBrokerCommand}
*/
describeBroker(
args: DescribeBrokerCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeBrokerCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
>
/**
* @see {@link DescribeBrokerEngineTypesCommand}
*/
describeBrokerEngineTypes(
args: DescribeBrokerEngineTypesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeBrokerEngineTypesCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError
>
/**
* @see {@link DescribeBrokerInstanceOptionsCommand}
*/
describeBrokerInstanceOptions(
args: DescribeBrokerInstanceOptionsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeBrokerInstanceOptionsCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError
>
/**
* @see {@link DescribeConfigurationCommand}
*/
describeConfiguration(
args: DescribeConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeConfigurationCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
>
/**
* @see {@link DescribeConfigurationRevisionCommand}
*/
describeConfigurationRevision(
args: DescribeConfigurationRevisionCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeConfigurationRevisionCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
>
/**
* @see {@link DescribeSharedResourcesCommand}
*/
describeSharedResources(
args: DescribeSharedResourcesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeSharedResourcesCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
>
describeSharedResourcesStream(
args: DescribeSharedResourcesCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeSharedResourcesCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
>
/**
* @see {@link DescribeUserCommand}
*/
describeUser(
args: DescribeUserCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeUserCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
>
/**
* @see {@link ListBrokersCommand}
*/
listBrokers(
args: ListBrokersCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListBrokersCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError
>
listBrokersStream(
args: ListBrokersCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
ListBrokersCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError
>
/**
* @see {@link ListConfigurationRevisionsCommand}
*/
listConfigurationRevisions(
args: ListConfigurationRevisionsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListConfigurationRevisionsCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
>
/**
* @see {@link ListConfigurationsCommand}
*/
listConfigurations(
args: ListConfigurationsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListConfigurationsCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError
>
/**
* @see {@link ListTagsCommand}
*/
listTags(
args: ListTagsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListTagsCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
>
/**
* @see {@link ListUsersCommand}
*/
listUsers(
args: ListUsersCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListUsersCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
>
/**
* @see {@link PromoteCommand}
*/
promote(
args: PromoteCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
PromoteCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
>
/**
* @see {@link RebootBrokerCommand}
*/
rebootBroker(
args: RebootBrokerCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
RebootBrokerCommandOutput,
Cause.TimeoutError | SdkError | BadRequestError | ForbiddenError | InternalServerError | NotFoundError
>
/**
* @see {@link UpdateBrokerCommand}
*/
updateBroker(
args: UpdateBrokerCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
UpdateBrokerCommandOutput,
| Cause.TimeoutError
| SdkError
| BadRequestError
| ConflictError
| ForbiddenError
| InternalServerError
| NotFoundError
>
/**
* @see {@link UpdateConfigurationCommand}
*/
updateConfiguration(
args: UpdateConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
UpdateConfigurationCommandOutput,
| Cause.TimeoutError
| SdkError
| BadRequestError
| ConflictError
| ForbiddenError
| InternalServerError
| NotFoundError
>
/**
* @see {@link UpdateUserCommand}
*/
updateUser(
args: UpdateUserCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
UpdateUserCommandOutput,
| Cause.TimeoutError
| SdkError
| BadRequestError
| ConflictError
| ForbiddenError
| InternalServerError
| NotFoundError
>
}
Added in v1.0.0
utils
MqService (namespace)
Added in v1.0.0
Config (interface)
Signature
export interface Config extends Omit<MqClientConfig, "logger"> {
readonly logger?: ServiceLogger.ServiceLoggerConstructorProps | true
}
Added in v1.0.0
Type (type alias)
Signature
export type Type = MqService$
Added in v1.0.0