sns.md

sns

Index

• fn withApiUrl(value)
• fn withAttributes(value)
• fn withAttributesMixin(value)
• fn withHttpConfig(value)
• fn withHttpConfigMixin(value)
• fn withMessage(value)
• fn withPhoneNumber(value)
• fn withSendResolved(value=true)
• fn withSigv4(value)
• fn withSigv4Mixin(value)
• fn withSubject(value)
• fn withTargetArn(value)
• fn withTopicArn(value)
• obj http_config
  • fn withAuthorization(value)
  • fn withAuthorizationMixin(value)
  • fn withBasicAuth(value)
  • fn withBasicAuthMixin(value)
  • fn withBearerToken(value)
  • fn withBearerTokenFile(value)
  • fn withEnableHttp2(value=true)
  • fn withFollowRedirects(value=true)
  • fn withNoProxy(value)
  • fn withOauth2(value)
  • fn withOauth2Mixin(value)
  • fn withProxyConnectHeader(value)
  • fn withProxyConnectHeaderMixin(value)
  • fn withProxyFromEnvironment(value=true)
  • fn withProxyUrl(value)
  • fn withProxyUrlMixin(value)
  • fn withTlsConfig(value)
  • fn withTlsConfigMixin(value)
  • obj authorization
    • fn withCredentials(value)
    • fn withCredentialsFile(value)
    • fn withType(value)
  • obj basic_auth
    • fn withPassword(value)
    • fn withPasswordFile(value)
    • fn withUsername(value)
    • fn withUsernameFile(value)
  • obj oauth2
    • fn withClientId(value)
    • fn withClientSecret(value)
    • fn withClientSecretFile(value)
    • fn withEndpointParams(value)
    • fn withEndpointParamsMixin(value)
    • fn withNoProxy(value)
    • fn withProxyConnectHeader(value)
    • fn withProxyConnectHeaderMixin(value)
    • fn withProxyFromEnvironment(value=true)
    • fn withProxyUrl(value)
    • fn withProxyUrlMixin(value)
    • fn withScopes(value)
    • fn withScopesMixin(value)
    • fn withTLSConfig(value)
    • fn withTLSConfigMixin(value)
    • fn withTokenUrl(value)
    • obj TLSConfig
      • fn withCa(value)
      • fn withCaFile(value)
      • fn withCert(value)
      • fn withCertFile(value)
      • fn withInsecureSkipVerify(value=true)
      • fn withKey(value)
      • fn withKeyFile(value)
      • fn withMaxVersion(value)
      • fn withMinVersion(value)
      • fn withServerName(value)
    • obj proxy_url
      • fn withForceQuery(value=true)
      • fn withFragment(value)
      • fn withHost(value)
      • fn withOmitHost(value=true)
      • fn withOpaque(value)
      • fn withPath(value)
      • fn withRawFragment(value)
      • fn withRawPath(value)
      • fn withRawQuery(value)
      • fn withScheme(value)
      • fn withUser(value)
      • fn withUserMixin(value)
  • obj proxy_url
    • fn withForceQuery(value=true)
    • fn withFragment(value)
    • fn withHost(value)
    • fn withOmitHost(value=true)
    • fn withOpaque(value)
    • fn withPath(value)
    • fn withRawFragment(value)
    • fn withRawPath(value)
    • fn withRawQuery(value)
    • fn withScheme(value)
    • fn withUser(value)
    • fn withUserMixin(value)
  • obj tls_config
    • fn withCa(value)
    • fn withCaFile(value)
    • fn withCert(value)
    • fn withCertFile(value)
    • fn withInsecureSkipVerify(value=true)
    • fn withKey(value)
    • fn withKeyFile(value)
    • fn withMaxVersion(value)
    • fn withMinVersion(value)
    • fn withServerName(value)
• obj sigv4
  • fn withAccessKey(value)
  • fn withProfile(value)
  • fn withRegion(value)
  • fn withRoleARN(value)
  • fn withSecretKey(value)

Fields

fn withApiUrl

withApiUrl(value)

PARAMETERS:

• value (string)

fn withAttributes

withAttributes(value)

PARAMETERS:

• value (object)

fn withAttributesMixin

withAttributesMixin(value)

PARAMETERS:

• value (object)

fn withHttpConfig

withHttpConfig(value)

PARAMETERS:

• value (object)

fn withHttpConfigMixin

withHttpConfigMixin(value)

PARAMETERS:

• value (object)

fn withMessage

withMessage(value)

PARAMETERS:

• value (string)

fn withPhoneNumber

withPhoneNumber(value)

PARAMETERS:

• value (string)

fn withSendResolved

withSendResolved(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn withSigv4

withSigv4(value)

PARAMETERS:

• value (object)

fn withSigv4Mixin

withSigv4Mixin(value)

PARAMETERS:

• value (object)

fn withSubject

withSubject(value)

PARAMETERS:

• value (string)

fn withTargetArn

withTargetArn(value)

PARAMETERS:

• value (string)

fn withTopicArn

withTopicArn(value)

PARAMETERS:

• value (string)

obj http_config

fn http_config.withAuthorization

http_config.withAuthorization(value)

PARAMETERS:

• value (object)

fn http_config.withAuthorizationMixin

http_config.withAuthorizationMixin(value)

PARAMETERS:

• value (object)

fn http_config.withBasicAuth

http_config.withBasicAuth(value)

PARAMETERS:

• value (object)

fn http_config.withBasicAuthMixin

http_config.withBasicAuthMixin(value)

PARAMETERS:

• value (object)

fn http_config.withBearerToken

http_config.withBearerToken(value)

PARAMETERS:

• value (string)

fn http_config.withBearerTokenFile

http_config.withBearerTokenFile(value)

PARAMETERS:

• value (string)

fn http_config.withEnableHttp2

http_config.withEnableHttp2(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn http_config.withFollowRedirects

http_config.withFollowRedirects(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn http_config.withNoProxy

http_config.withNoProxy(value)

PARAMETERS:

• value (string)

fn http_config.withOauth2

http_config.withOauth2(value)

PARAMETERS:

• value (object)

fn http_config.withOauth2Mixin

http_config.withOauth2Mixin(value)

PARAMETERS:

• value (object)

fn http_config.withProxyConnectHeader

http_config.withProxyConnectHeader(value)

PARAMETERS:

• value (object)

fn http_config.withProxyConnectHeaderMixin

http_config.withProxyConnectHeaderMixin(value)

PARAMETERS:

• value (object)

fn http_config.withProxyFromEnvironment

http_config.withProxyFromEnvironment(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn http_config.withProxyUrl

http_config.withProxyUrl(value)

PARAMETERS:

• value (object)

fn http_config.withProxyUrlMixin

http_config.withProxyUrlMixin(value)

PARAMETERS:

• value (object)

fn http_config.withTlsConfig

http_config.withTlsConfig(value)

PARAMETERS:

• value (object)

fn http_config.withTlsConfigMixin

http_config.withTlsConfigMixin(value)

PARAMETERS:

• value (object)

obj http_config.authorization

fn http_config.authorization.withCredentials

http_config.authorization.withCredentials(value)

PARAMETERS:

• value (string)

fn http_config.authorization.withCredentialsFile

http_config.authorization.withCredentialsFile(value)

PARAMETERS:

• value (string)

fn http_config.authorization.withType

http_config.authorization.withType(value)

PARAMETERS:

• value (string)

obj http_config.basic_auth

fn http_config.basic_auth.withPassword

http_config.basic_auth.withPassword(value)

PARAMETERS:

• value (string)

fn http_config.basic_auth.withPasswordFile

http_config.basic_auth.withPasswordFile(value)

PARAMETERS:

• value (string)

fn http_config.basic_auth.withUsername

http_config.basic_auth.withUsername(value)

PARAMETERS:

• value (string)

fn http_config.basic_auth.withUsernameFile

http_config.basic_auth.withUsernameFile(value)

PARAMETERS:

• value (string)

obj http_config.oauth2

fn http_config.oauth2.withClientId

http_config.oauth2.withClientId(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.withClientSecret

http_config.oauth2.withClientSecret(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.withClientSecretFile

http_config.oauth2.withClientSecretFile(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.withEndpointParams

http_config.oauth2.withEndpointParams(value)

PARAMETERS:

• value (object)

fn http_config.oauth2.withEndpointParamsMixin

http_config.oauth2.withEndpointParamsMixin(value)

PARAMETERS:

• value (object)

fn http_config.oauth2.withNoProxy

http_config.oauth2.withNoProxy(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.withProxyConnectHeader

http_config.oauth2.withProxyConnectHeader(value)

PARAMETERS:

• value (object)

fn http_config.oauth2.withProxyConnectHeaderMixin

http_config.oauth2.withProxyConnectHeaderMixin(value)

PARAMETERS:

• value (object)

fn http_config.oauth2.withProxyFromEnvironment

http_config.oauth2.withProxyFromEnvironment(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn http_config.oauth2.withProxyUrl

http_config.oauth2.withProxyUrl(value)

PARAMETERS:

• value (object)

fn http_config.oauth2.withProxyUrlMixin

http_config.oauth2.withProxyUrlMixin(value)

PARAMETERS:

• value (object)

fn http_config.oauth2.withScopes

http_config.oauth2.withScopes(value)

PARAMETERS:

• value (array)

fn http_config.oauth2.withScopesMixin

http_config.oauth2.withScopesMixin(value)

PARAMETERS:

• value (array)

fn http_config.oauth2.withTLSConfig

http_config.oauth2.withTLSConfig(value)

PARAMETERS:

• value (object)

fn http_config.oauth2.withTLSConfigMixin

http_config.oauth2.withTLSConfigMixin(value)

PARAMETERS:

• value (object)

fn http_config.oauth2.withTokenUrl

http_config.oauth2.withTokenUrl(value)

PARAMETERS:

• value (string)

obj http_config.oauth2.TLSConfig

fn http_config.oauth2.TLSConfig.withCa

http_config.oauth2.TLSConfig.withCa(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.TLSConfig.withCaFile

http_config.oauth2.TLSConfig.withCaFile(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.TLSConfig.withCert

http_config.oauth2.TLSConfig.withCert(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.TLSConfig.withCertFile

http_config.oauth2.TLSConfig.withCertFile(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.TLSConfig.withInsecureSkipVerify

http_config.oauth2.TLSConfig.withInsecureSkipVerify(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn http_config.oauth2.TLSConfig.withKey

http_config.oauth2.TLSConfig.withKey(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.TLSConfig.withKeyFile

http_config.oauth2.TLSConfig.withKeyFile(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.TLSConfig.withMaxVersion

http_config.oauth2.TLSConfig.withMaxVersion(value)

PARAMETERS:

• value (integer)

fn http_config.oauth2.TLSConfig.withMinVersion

http_config.oauth2.TLSConfig.withMinVersion(value)

PARAMETERS:

• value (integer)

fn http_config.oauth2.TLSConfig.withServerName

http_config.oauth2.TLSConfig.withServerName(value)

PARAMETERS:

• value (string)

obj http_config.oauth2.proxy_url

fn http_config.oauth2.proxy_url.withForceQuery

http_config.oauth2.proxy_url.withForceQuery(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn http_config.oauth2.proxy_url.withFragment

http_config.oauth2.proxy_url.withFragment(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.proxy_url.withHost

http_config.oauth2.proxy_url.withHost(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.proxy_url.withOmitHost

http_config.oauth2.proxy_url.withOmitHost(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn http_config.oauth2.proxy_url.withOpaque

http_config.oauth2.proxy_url.withOpaque(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.proxy_url.withPath

http_config.oauth2.proxy_url.withPath(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.proxy_url.withRawFragment

http_config.oauth2.proxy_url.withRawFragment(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.proxy_url.withRawPath

http_config.oauth2.proxy_url.withRawPath(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.proxy_url.withRawQuery

http_config.oauth2.proxy_url.withRawQuery(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.proxy_url.withScheme

http_config.oauth2.proxy_url.withScheme(value)

PARAMETERS:

• value (string)

fn http_config.oauth2.proxy_url.withUser

http_config.oauth2.proxy_url.withUser(value)

PARAMETERS:

• value (object)

fn http_config.oauth2.proxy_url.withUserMixin

http_config.oauth2.proxy_url.withUserMixin(value)

PARAMETERS:

• value (object)

obj http_config.proxy_url

fn http_config.proxy_url.withForceQuery

http_config.proxy_url.withForceQuery(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn http_config.proxy_url.withFragment

http_config.proxy_url.withFragment(value)

PARAMETERS:

• value (string)

fn http_config.proxy_url.withHost

http_config.proxy_url.withHost(value)

PARAMETERS:

• value (string)

fn http_config.proxy_url.withOmitHost

http_config.proxy_url.withOmitHost(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn http_config.proxy_url.withOpaque

http_config.proxy_url.withOpaque(value)

PARAMETERS:

• value (string)

fn http_config.proxy_url.withPath

http_config.proxy_url.withPath(value)

PARAMETERS:

• value (string)

fn http_config.proxy_url.withRawFragment

http_config.proxy_url.withRawFragment(value)

PARAMETERS:

• value (string)

fn http_config.proxy_url.withRawPath

http_config.proxy_url.withRawPath(value)

PARAMETERS:

• value (string)

fn http_config.proxy_url.withRawQuery

http_config.proxy_url.withRawQuery(value)

PARAMETERS:

• value (string)

fn http_config.proxy_url.withScheme

http_config.proxy_url.withScheme(value)

PARAMETERS:

• value (string)

fn http_config.proxy_url.withUser

http_config.proxy_url.withUser(value)

PARAMETERS:

• value (object)

fn http_config.proxy_url.withUserMixin

http_config.proxy_url.withUserMixin(value)

PARAMETERS:

• value (object)

obj http_config.tls_config

fn http_config.tls_config.withCa

http_config.tls_config.withCa(value)

PARAMETERS:

• value (string)

fn http_config.tls_config.withCaFile

http_config.tls_config.withCaFile(value)

PARAMETERS:

• value (string)

fn http_config.tls_config.withCert

http_config.tls_config.withCert(value)

PARAMETERS:

• value (string)

fn http_config.tls_config.withCertFile

http_config.tls_config.withCertFile(value)

PARAMETERS:

• value (string)

fn http_config.tls_config.withInsecureSkipVerify

http_config.tls_config.withInsecureSkipVerify(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn http_config.tls_config.withKey

http_config.tls_config.withKey(value)

PARAMETERS:

• value (string)

fn http_config.tls_config.withKeyFile

http_config.tls_config.withKeyFile(value)

PARAMETERS:

• value (string)

fn http_config.tls_config.withMaxVersion

http_config.tls_config.withMaxVersion(value)

PARAMETERS:

• value (integer)

fn http_config.tls_config.withMinVersion

http_config.tls_config.withMinVersion(value)

PARAMETERS:

• value (integer)

fn http_config.tls_config.withServerName

http_config.tls_config.withServerName(value)

PARAMETERS:

• value (string)

obj sigv4

fn sigv4.withAccessKey

sigv4.withAccessKey(value)

PARAMETERS:

• value (string)

fn sigv4.withProfile

sigv4.withProfile(value)

PARAMETERS:

• value (string)

fn sigv4.withRegion

sigv4.withRegion(value)

PARAMETERS:

• value (string)

fn sigv4.withRoleARN

sigv4.withRoleARN(value)

PARAMETERS:

• value (string)

fn sigv4.withSecretKey

sigv4.withSecretKey(value)

PARAMETERS:

• value (string)