Class SqsAPI

constructor

• new SqsAPI(client): SqsAPI

• Parameters

  • client: Client

  Returns SqsAPI

Static ReadonlyLOCALITIES

activateSqs

• activateSqs(request?): Promise<SqsInfo>

• Activate SQS. Activate SQS for the specified Project ID. SQS must be activated before any usage such as creating credentials and queues. Activating SQS does not trigger any billing, and you can deactivate at any time.

  Parameters

  • request: Readonly<SqsApiActivateSqsRequest> = {}

    The request SqsApiActivateSqsRequest

  Returns Promise<SqsInfo>

  A Promise of SqsInfo

createSqsCredentials

• createSqsCredentials(request?): Promise<MNQ.v1beta1.SqsCredentials>

• Create SQS credentials. Create a set of credentials for SQS, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly.

  Parameters

  • request: Readonly<MNQ.v1beta1.SqsApiCreateSqsCredentialsRequest> = {}

    The request SqsApiCreateSqsCredentialsRequest

  Returns Promise<MNQ.v1beta1.SqsCredentials>

  A Promise of SqsCredentials

deactivateSqs

• deactivateSqs(request?): Promise<SqsInfo>

• Deactivate SQS. Deactivate SQS for the specified Project ID. You must delete all queues and credentials before this call or you need to set the force_delete parameter.

  Parameters

  • request: Readonly<SqsApiDeactivateSqsRequest> = {}

    The request SqsApiDeactivateSqsRequest

  Returns Promise<SqsInfo>

  A Promise of SqsInfo

deleteSqsCredentials

• deleteSqsCredentials(request): Promise<void>

• Delete SQS credentials. Delete a set of SQS credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access SQS.

  Parameters

  • request: Readonly<SqsApiDeleteSqsCredentialsRequest>

    The request SqsApiDeleteSqsCredentialsRequest

  Returns Promise<void>

getSqsCredentials

• getSqsCredentials(request): Promise<MNQ.v1beta1.SqsCredentials>

• Get SQS credentials. Retrieve an existing set of credentials, identified by the credentials_id. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response.

  Parameters

  • request: Readonly<SqsApiGetSqsCredentialsRequest>

    The request SqsApiGetSqsCredentialsRequest

  Returns Promise<MNQ.v1beta1.SqsCredentials>

  A Promise of SqsCredentials

getSqsInfo

• getSqsInfo(request?): Promise<SqsInfo>

• Get SQS info. Retrieve the SQS information of the specified Project ID. Informations include the activation status and the SQS API endpoint URL.

  Parameters

  • request: Readonly<SqsApiGetSqsInfoRequest> = {}

    The request SqsApiGetSqsInfoRequest

  Returns Promise<SqsInfo>

  A Promise of SqsInfo

listSqsCredentials

• listSqsCredentials(request?): Promise<ListSqsCredentialsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<MNQ.v1beta1.SqsCredentials[], void, void>);
      all: (() => Promise<MNQ.v1beta1.SqsCredentials[]>);
  }

• List SQS credentials. List existing SQS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.

  Parameters

  • request: Readonly<SqsApiListSqsCredentialsRequest> = {}

    The request SqsApiListSqsCredentialsRequest

  Returns Promise<ListSqsCredentialsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<MNQ.v1beta1.SqsCredentials[], void, void>);
      all: (() => Promise<MNQ.v1beta1.SqsCredentials[]>);
  }

  A Promise of ListSqsCredentialsResponse

updateSqsCredentials

• updateSqsCredentials(request): Promise<MNQ.v1beta1.SqsCredentials>

• Update SQS credentials. Update a set of SQS credentials. You can update the credentials' name, or their permissions.

  Parameters

  • request: Readonly<MNQ.v1beta1.SqsApiUpdateSqsCredentialsRequest>

    The request SqsApiUpdateSqsCredentialsRequest

  Returns Promise<MNQ.v1beta1.SqsCredentials>

  A Promise of SqsCredentials