pub struct SetPlatformApplicationAttributesFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to SetPlatformApplicationAttributes
.
Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.
Implementations§
Source§impl SetPlatformApplicationAttributesFluentBuilder
impl SetPlatformApplicationAttributesFluentBuilder
Sourcepub fn as_input(&self) -> &SetPlatformApplicationAttributesInputBuilder
pub fn as_input(&self) -> &SetPlatformApplicationAttributesInputBuilder
Access the SetPlatformApplicationAttributes as a reference.
Sourcepub async fn send(
self,
) -> Result<SetPlatformApplicationAttributesOutput, SdkError<SetPlatformApplicationAttributesError, HttpResponse>>
pub async fn send( self, ) -> Result<SetPlatformApplicationAttributesOutput, SdkError<SetPlatformApplicationAttributesError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<SetPlatformApplicationAttributesOutput, SetPlatformApplicationAttributesError, Self>
pub fn customize( self, ) -> CustomizableOperation<SetPlatformApplicationAttributesOutput, SetPlatformApplicationAttributesError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn platform_application_arn(self, input: impl Into<String>) -> Self
pub fn platform_application_arn(self, input: impl Into<String>) -> Self
PlatformApplicationArn
for SetPlatformApplicationAttributes
action.
Sourcepub fn set_platform_application_arn(self, input: Option<String>) -> Self
pub fn set_platform_application_arn(self, input: Option<String>) -> Self
PlatformApplicationArn
for SetPlatformApplicationAttributes
action.
Sourcepub fn get_platform_application_arn(&self) -> &Option<String>
pub fn get_platform_application_arn(&self) -> &Option<String>
PlatformApplicationArn
for SetPlatformApplicationAttributes
action.
Sourcepub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to Attributes
.
To override the contents of this collection use set_attributes
.
A map of the platform application attributes. Attributes in this map include the following:
-
PlatformCredential
– The credential received from the notification service.-
For ADM,
PlatformCredential
is client secret. -
For Apple Services using certificate credentials,
PlatformCredential
is private key. -
For Apple Services using token credentials,
PlatformCredential
is signing key. -
For GCM (Firebase Cloud Messaging) using key credentials, there is no
PlatformPrincipal
. ThePlatformCredential
isAPI key
. -
For GCM (Firebase Cloud Messaging) using token credentials, there is no
PlatformPrincipal
. ThePlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command:SERVICE_JSON=`jq @json <<< cat service.json`
.
-
-
PlatformPrincipal
– The principal received from the notification service.-
For ADM,
PlatformPrincipal
is client id. -
For Apple Services using certificate credentials,
PlatformPrincipal
is SSL certificate. -
For Apple Services using token credentials,
PlatformPrincipal
is signing key ID. -
For GCM (Firebase Cloud Messaging), there is no
PlatformPrincipal
.
-
-
EventEndpointCreated
– Topic ARN to whichEndpointCreated
event notifications are sent. -
EventEndpointDeleted
– Topic ARN to whichEndpointDeleted
event notifications are sent. -
EventEndpointUpdated
– Topic ARN to whichEndpointUpdate
event notifications are sent. -
EventDeliveryFailure
– Topic ARN to whichDeliveryFailure
event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints. -
SuccessFeedbackRoleArn
– IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf. -
FailureFeedbackRoleArn
– IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf. -
SuccessFeedbackSampleRate
– Sample rate percentage (0-100) of successfully delivered messages.
The following attributes only apply to APNs
token-based authentication:
-
ApplePlatformTeamID
– The identifier that's assigned to your Apple developer account team. -
ApplePlatformBundleID
– The bundle identifier that's assigned to your iOS app.
Sourcepub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self
A map of the platform application attributes. Attributes in this map include the following:
-
PlatformCredential
– The credential received from the notification service.-
For ADM,
PlatformCredential
is client secret. -
For Apple Services using certificate credentials,
PlatformCredential
is private key. -
For Apple Services using token credentials,
PlatformCredential
is signing key. -
For GCM (Firebase Cloud Messaging) using key credentials, there is no
PlatformPrincipal
. ThePlatformCredential
isAPI key
. -
For GCM (Firebase Cloud Messaging) using token credentials, there is no
PlatformPrincipal
. ThePlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command:SERVICE_JSON=`jq @json <<< cat service.json`
.
-
-
PlatformPrincipal
– The principal received from the notification service.-
For ADM,
PlatformPrincipal
is client id. -
For Apple Services using certificate credentials,
PlatformPrincipal
is SSL certificate. -
For Apple Services using token credentials,
PlatformPrincipal
is signing key ID. -
For GCM (Firebase Cloud Messaging), there is no
PlatformPrincipal
.
-
-
EventEndpointCreated
– Topic ARN to whichEndpointCreated
event notifications are sent. -
EventEndpointDeleted
– Topic ARN to whichEndpointDeleted
event notifications are sent. -
EventEndpointUpdated
– Topic ARN to whichEndpointUpdate
event notifications are sent. -
EventDeliveryFailure
– Topic ARN to whichDeliveryFailure
event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints. -
SuccessFeedbackRoleArn
– IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf. -
FailureFeedbackRoleArn
– IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf. -
SuccessFeedbackSampleRate
– Sample rate percentage (0-100) of successfully delivered messages.
The following attributes only apply to APNs
token-based authentication:
-
ApplePlatformTeamID
– The identifier that's assigned to your Apple developer account team. -
ApplePlatformBundleID
– The bundle identifier that's assigned to your iOS app.
Sourcepub fn get_attributes(&self) -> &Option<HashMap<String, String>>
pub fn get_attributes(&self) -> &Option<HashMap<String, String>>
A map of the platform application attributes. Attributes in this map include the following:
-
PlatformCredential
– The credential received from the notification service.-
For ADM,
PlatformCredential
is client secret. -
For Apple Services using certificate credentials,
PlatformCredential
is private key. -
For Apple Services using token credentials,
PlatformCredential
is signing key. -
For GCM (Firebase Cloud Messaging) using key credentials, there is no
PlatformPrincipal
. ThePlatformCredential
isAPI key
. -
For GCM (Firebase Cloud Messaging) using token credentials, there is no
PlatformPrincipal
. ThePlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command:SERVICE_JSON=`jq @json <<< cat service.json`
.
-
-
PlatformPrincipal
– The principal received from the notification service.-
For ADM,
PlatformPrincipal
is client id. -
For Apple Services using certificate credentials,
PlatformPrincipal
is SSL certificate. -
For Apple Services using token credentials,
PlatformPrincipal
is signing key ID. -
For GCM (Firebase Cloud Messaging), there is no
PlatformPrincipal
.
-
-
EventEndpointCreated
– Topic ARN to whichEndpointCreated
event notifications are sent. -
EventEndpointDeleted
– Topic ARN to whichEndpointDeleted
event notifications are sent. -
EventEndpointUpdated
– Topic ARN to whichEndpointUpdate
event notifications are sent. -
EventDeliveryFailure
– Topic ARN to whichDeliveryFailure
event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints. -
SuccessFeedbackRoleArn
– IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf. -
FailureFeedbackRoleArn
– IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf. -
SuccessFeedbackSampleRate
– Sample rate percentage (0-100) of successfully delivered messages.
The following attributes only apply to APNs
token-based authentication:
-
ApplePlatformTeamID
– The identifier that's assigned to your Apple developer account team. -
ApplePlatformBundleID
– The bundle identifier that's assigned to your iOS app.
Trait Implementations§
Source§impl Clone for SetPlatformApplicationAttributesFluentBuilder
impl Clone for SetPlatformApplicationAttributesFluentBuilder
Source§fn clone(&self) -> SetPlatformApplicationAttributesFluentBuilder
fn clone(&self) -> SetPlatformApplicationAttributesFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for SetPlatformApplicationAttributesFluentBuilder
impl !RefUnwindSafe for SetPlatformApplicationAttributesFluentBuilder
impl Send for SetPlatformApplicationAttributesFluentBuilder
impl Sync for SetPlatformApplicationAttributesFluentBuilder
impl Unpin for SetPlatformApplicationAttributesFluentBuilder
impl !UnwindSafe for SetPlatformApplicationAttributesFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);