Package software.amazon.awssdk.services.ssmcontacts.model

Interface AcceptPageRequest.Builder

    • Method Detail

      • pageId

        AcceptPageRequest.Builder pageId​(String pageId)

        The Amazon Resource Name (ARN) of the engagement to a contact channel.

        Parameters:
        pageId - The Amazon Resource Name (ARN) of the engagement to a contact channel.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • contactChannelId

        AcceptPageRequest.Builder contactChannelId​(String contactChannelId)

        The ARN of the contact channel.

        Parameters:
        contactChannelId - The ARN of the contact channel.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • acceptType

        AcceptPageRequest.Builder acceptType​(String acceptType)

        The type indicates if the page was DELIVERED or READ.

        Parameters:
        acceptType - The type indicates if the page was DELIVERED or READ.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AcceptType, AcceptType

      • acceptType

        AcceptPageRequest.Builder acceptType​(AcceptType acceptType)

        The type indicates if the page was DELIVERED or READ.

        Parameters:
        acceptType - The type indicates if the page was DELIVERED or READ.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AcceptType, AcceptType

      • note

        AcceptPageRequest.Builder note​(String note)

        Information provided by the user when the user acknowledges the page.

        Parameters:
        note - Information provided by the user when the user acknowledges the page.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • acceptCode

        AcceptPageRequest.Builder acceptCode​(String acceptCode)

        A 6-digit code used to acknowledge the page.

        Parameters:
        acceptCode - A 6-digit code used to acknowledge the page.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • acceptCodeValidation

        AcceptPageRequest.Builder acceptCodeValidation​(String acceptCodeValidation)

        An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

        Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.

        Parameters:
        acceptCodeValidation - An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

        Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AcceptCodeValidation, AcceptCodeValidation

      • acceptCodeValidation

        AcceptPageRequest.Builder acceptCodeValidation​(AcceptCodeValidation acceptCodeValidation)

        An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

        Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.

        Parameters:
        acceptCodeValidation - An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

        Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AcceptCodeValidation, AcceptCodeValidation