:doc:`SSMContacts <../../ssm-contacts>` / Client / get_rotation

************
get_rotation
************



.. py:method:: SSMContacts.Client.get_rotation(**kwargs)

  

  Retrieves information about an on-call rotation.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetRotation>`_  


  **Request Syntax**
  ::

    response = client.get_rotation(
        RotationId='string'
    )
    
  :type RotationId: string
  :param RotationId: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the on-call rotation to retrieve information about.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'RotationArn': 'string',
          'Name': 'string',
          'ContactIds': [
              'string',
          ],
          'StartTime': datetime(2015, 1, 1),
          'TimeZoneId': 'string',
          'Recurrence': {
              'MonthlySettings': [
                  {
                      'DayOfMonth': 123,
                      'HandOffTime': {
                          'HourOfDay': 123,
                          'MinuteOfHour': 123
                      }
                  },
              ],
              'WeeklySettings': [
                  {
                      'DayOfWeek': 'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT'|'SUN',
                      'HandOffTime': {
                          'HourOfDay': 123,
                          'MinuteOfHour': 123
                      }
                  },
              ],
              'DailySettings': [
                  {
                      'HourOfDay': 123,
                      'MinuteOfHour': 123
                  },
              ],
              'NumberOfOnCalls': 123,
              'ShiftCoverages': {
                  'string': [
                      {
                          'Start': {
                              'HourOfDay': 123,
                              'MinuteOfHour': 123
                          },
                          'End': {
                              'HourOfDay': 123,
                              'MinuteOfHour': 123
                          }
                      },
                  ]
              },
              'RecurrenceMultiplier': 123
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **RotationArn** *(string) --* 

        The Amazon Resource Name (ARN) of the on-call rotation.

        
      

      - **Name** *(string) --* 

        The name of the on-call rotation.

        
      

      - **ContactIds** *(list) --* 

        The Amazon Resource Names (ARNs) of the contacts assigned to the on-call rotation team.

        
        

        - *(string) --* 
    
      

      - **StartTime** *(datetime) --* 

        The specified start time for the on-call rotation.

        
      

      - **TimeZoneId** *(string) --* 

        The time zone that the rotation’s activity is based on, in Internet Assigned Numbers Authority (IANA) format.

        
      

      - **Recurrence** *(dict) --* 

        Specifies how long a rotation lasts before restarting at the beginning of the shift order.

        
        

        - **MonthlySettings** *(list) --* 

          Information about on-call rotations that recur monthly.

          
          

          - *(dict) --* 

            Information about on-call rotations that recur monthly.

            
            

            - **DayOfMonth** *(integer) --* 

              The day of the month when monthly recurring on-call rotations begin.

              
            

            - **HandOffTime** *(dict) --* 

              The time of day when a monthly recurring on-call shift rotation begins.

              
              

              - **HourOfDay** *(integer) --* 

                The hour when an on-call rotation shift begins or ends.

                
              

              - **MinuteOfHour** *(integer) --* 

                The minute when an on-call rotation shift begins or ends.

                
          
        
      
        

        - **WeeklySettings** *(list) --* 

          Information about on-call rotations that recur weekly.

          
          

          - *(dict) --* 

            Information about rotations that recur weekly.

            
            

            - **DayOfWeek** *(string) --* 

              The day of the week when weekly recurring on-call shift rotations begins.

              
            

            - **HandOffTime** *(dict) --* 

              The time of day when a weekly recurring on-call shift rotation begins.

              
              

              - **HourOfDay** *(integer) --* 

                The hour when an on-call rotation shift begins or ends.

                
              

              - **MinuteOfHour** *(integer) --* 

                The minute when an on-call rotation shift begins or ends.

                
          
        
      
        

        - **DailySettings** *(list) --* 

          Information about on-call rotations that recur daily.

          
          

          - *(dict) --* 

            Details about when an on-call rotation shift begins or ends.

            
            

            - **HourOfDay** *(integer) --* 

              The hour when an on-call rotation shift begins or ends.

              
            

            - **MinuteOfHour** *(integer) --* 

              The minute when an on-call rotation shift begins or ends.

              
        
      
        

        - **NumberOfOnCalls** *(integer) --* 

          The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule that contains ten contacts, a value of ``2`` designates that two of them are on call at any given time.

          
        

        - **ShiftCoverages** *(dict) --* 

          Information about the days of the week that the on-call rotation coverage includes.

          
          

          - *(string) --* 
            

            - *(list) --* 
              

              - *(dict) --* 

                Information about when an on-call shift begins and ends.

                
                

                - **Start** *(dict) --* 

                  Information about when the on-call rotation shift begins.

                  
                  

                  - **HourOfDay** *(integer) --* 

                    The hour when an on-call rotation shift begins or ends.

                    
                  

                  - **MinuteOfHour** *(integer) --* 

                    The minute when an on-call rotation shift begins or ends.

                    
              
                

                - **End** *(dict) --* 

                  Information about when the on-call rotation shift ends.

                  
                  

                  - **HourOfDay** *(integer) --* 

                    The hour when an on-call rotation shift begins or ends.

                    
                  

                  - **MinuteOfHour** *(integer) --* 

                    The minute when an on-call rotation shift begins or ends.

                    
              
            
          
      
    
        

        - **RecurrenceMultiplier** *(integer) --* 

          The number of days, weeks, or months a single rotation lasts.

          
    
  
  **Exceptions**
  
  *   :py:class:`SSMContacts.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`SSMContacts.Client.exceptions.InternalServerException`

  
  *   :py:class:`SSMContacts.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`SSMContacts.Client.exceptions.ThrottlingException`

  
  *   :py:class:`SSMContacts.Client.exceptions.ValidationException`

  